Add Ip Pool To Network Of Network Pool

Add Ip Pool To Network Of Network Pool

Add an IP Pool to a Network of a Network Pool

Request
URI
POST
https://{api_host}/v1/network-pools/{id}/networks/{networkId}/ip-pools
COPY
Path Parameters
string
id
Required

Id of the networkpoolk

string
networkId
Required

Id of the network

Request Body
IpPool of type(s) application/json
Required 
{
    "start": "string",
    "end": "string"
}
string As ^([01]?\d\d?|2[0-4]\d|25[0-5])\.([01]?\d\d?|2[0-4]\d|25[0-5])\.([01]?\d\d?|2[0-4]\d|25[0-5])\.([01]?\d\d?|2[0-4]\d|25[0-5])$
start
Required

Start IP address of the IP pool

string As ^([01]?\d\d?|2[0-4]\d|25[0-5])\.([01]?\d\d?|2[0-4]\d|25[0-5])\.([01]?\d\d?|2[0-4]\d|25[0-5])\.([01]?\d\d?|2[0-4]\d|25[0-5])$
end
Required

End IP address of the IP pool

Responses
200

Add the IP Pool associated with a Network of a Network Pool

Returns Network of type(s) application/json 
{
    "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

string
type
Required

Network Type of the network

integer As int32 As int32
vlanId
Required

VLAN ID associated with the network

integer As int32 As int32
mtu
Required

MTU of the network

string
subnet
Required

Subnet associated with the network

string
mask
Required

Subnet mask for the subnet of the network

string
gateway
Required

Gateway for the network

array of IpPool
ipPools
Optional

List of IP pool ranges to use

array of string
freeIps
Optional

List of free IPs to use

array of string
usedIps
Optional

List of used IPs


400

IP range validation failed error

Returns Error of type(s) application/json 
{
    "errorCode": "string",
    "errorType": "string",
    "arguments": [
        "string"
    ],
    "context": {
        "context": "string"
    },
    "message": "string",
    "remediationMessage": "string",
    "causes": [
        {
            "type": "string",
            "message": "string"
        }
    ],
    "nestedErrors": [
        "Error Object"
    ],
    "referenceToken": "string"
}
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 ErrorCause
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.


404

Either Network Pool ID or Network ID not found

Returns Error of type(s) application/json 
{
    "errorCode": "string",
    "errorType": "string",
    "arguments": [
        "string"
    ],
    "context": {
        "context": "string"
    },
    "message": "string",
    "remediationMessage": "string",
    "causes": [
        {
            "type": "string",
            "message": "string"
        }
    ],
    "nestedErrors": [
        "Error Object"
    ],
    "referenceToken": "string"
}
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 ErrorCause
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 
{
    "errorCode": "string",
    "errorType": "string",
    "arguments": [
        "string"
    ],
    "context": {
        "context": "string"
    },
    "message": "string",
    "remediationMessage": "string",
    "causes": [
        {
            "type": "string",
            "message": "string"
        }
    ],
    "nestedErrors": [
        "Error Object"
    ],
    "referenceToken": "string"
}
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 ErrorCause
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.


On This Page
Network Pools Operations
POST
Add Ip Pool To Network Of Network Pool
POST
Create Network Pool
DELETE
Delete Ip Pool From Network Of Network Pool
DELETE
Delete Network Pool
GET
Get Network Of Network Pool
GET
Get Network Pool
GET
Get Network Pool By ID
GET
Get Networks Of Network Pool
PATCH
Update Network Pool