NetworkConnector create request (Provider API)

Description

This API creates a NetworkConnector for each network interface found on the Server. The network interfaces must have their zone and networkLabel attributes set beforehand.

API stability classification

Unstable

API overview

HTTP
method

URI

Return
type

Return type
multiplicity

POST

csm/NetworkConnector/create

NetworkConnector

1..*

HTTP request message

Query string parameters

This API does not use query string parameters.

Request message headers

This API uses only common headers listed in HTTP request and response headers.

Request message body

This API uses the following objects in the request message body JSON.

Top-level objects

Name

Type

Multi-
plicity

Description

callbackURL

String

0..1

URL to call when the operation finishes

postCallout

String

0..1

Identifier of a callout to run after the operation executes

preCallout

String

0..1

Identifier of a callout to run before the operation executes

timeout

Integer

0..1

Timeout setting. For more information about using the timeout, see Synchronous and asynchronous operations. Timeout values:

  • 0: Immediate timeout
  • -1: Uses the system default timeout value
  • 1..*: Times out in the specified number of seconds

operationParams

OperationParameter

1

Array of input parameters. The following table contains the list of input parameters. For information about setting up the input parameters, see Passing input parameters with an API request.


Input parameters to include in operationParams

Name

Type

Multi-
plicity

Description

deploymentParameterValue

DeploymentParameterValue

0..*

List of deployment parameter values

NetworkContainer

NetworkContainer

1

Network container

networkInterfaceList

ServerNetworkInterface

1..*

List of network interfaces

physicalServer

PhysicalServer

0..1

Physical server

switchPortList

SwitchPort

0..*

List of switch ports

vendorName

String

0..1

Vendor name

virtualGuest

VirtualGuest

0..1

Virtual guest

HTTP response message

Response message headers

This API uses only common headers listed in HTTP request and response headers.

Response message body

The response message body contains a Task object.

Was this page helpful? Yes No Submitting... Thank you

Comments