Create Network Pool

Create Network Pool

Create a Network Pool

Request
URI
POST
https://{api_host}/v1/network-pools
COPY
Request Body
NetworkPool of type(s) application/json
Required

Show optional properties

{
    "name": "string",
    "networks": [
        {
            "type": "VSAN, VMOTION, VXLAN, NFS, ISCSI, VSAN_EXTERNAL",
            "vlanId": 0,
            "mtu": 0,
            "subnet": "string",
            "mask": "string",
            "gateway": "string"
        }
    ]
}
{
    "id": "string",
    "name": "string",
    "networks": [
        {
            "id": "string",
            "type": "VSAN, VMOTION, VXLAN, NFS, ISCSI, VSAN_EXTERNAL",
            "vlanId": 0,
            "mtu": 0,
            "subnet": "string",
            "mask": "string",
            "gateway": "string",
            "ipPools": [
                {
                    "start": "string",
                    "end": "string"
                }
            ],
            "freeIps": [
                "string"
            ],
            "usedIps": [
                "string"
            ]
        }
    ]
}
string
id
Optional

The ID of the network pool

string
name
Required

User specified name of the network pool

array of object
networks
Required

Representing the networks associated with the network pool

Responses
201

The newly created network pool

Returns NetworkPool of type(s) application/json
"NetworkPool Object"
string
id
Optional

The ID of the network pool

string
name
Required

User specified name of the network pool

array of object
networks
Required

Representing the networks associated with the network pool


400

Errors due to network pool validations failures

Returns Error of type(s) application/json
"Error Object"
string
errorCode
Optional

The minor error code

string
errorType
Optional

The error type

array of string
arguments
Optional

The arguments used to localize the message, Can be used by scripts to automate the error processing.

object
context
Optional

The error context (e.g. the component where it occurred).

string
message
Optional

The localized error message

string
remediationMessage
Optional

The localized remediation error message

array of object
causes
Optional

The underlying cause exceptions.

array of Error
nestedErrors
Optional

The nested errors when the error is a composite one

string
referenceToken
Optional

A reference token correlating the error with the relevant detailed error logs. Should be sent to the service provider when reporting issues.


500

Unexpected error

Returns Error of type(s) application/json
"Error Object"
string
errorCode
Optional

The minor error code

string
errorType
Optional

The error type

array of string
arguments
Optional

The arguments used to localize the message, Can be used by scripts to automate the error processing.

object
context
Optional

The error context (e.g. the component where it occurred).

string
message
Optional

The localized error message

string
remediationMessage
Optional

The localized remediation error message

array of object
causes
Optional

The underlying cause exceptions.

array of Error
nestedErrors
Optional

The nested errors when the error is a composite one

string
referenceToken
Optional

A reference token correlating the error with the relevant detailed error logs. Should be sent to the service provider when reporting issues.


Code Samples
COPY
                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"name:"string","networks":["object"]}' https://{api_host}/v1/network-pools