Create Internal Network IP Range

Creates an internal network IP range.

Request

URI

POST

https://vra-interop-222-139.lvn.broadcom.net/iaas/api/network-ip-ranges

COPY

Query Parameters

string

apiVersion

Optional

The version of the API in yyyy-MM-dd format (UTC). For versioning information refer to /iaas/api/about

Request Body

Network IP Range Specification instance

NetworkIPRangeSpecification of type(s) application/json

Required

Show optional properties

{
    "name": "string",
    "startIPAddress": "string",
    "endIPAddress": "string"
}

{
    "name": "string",
    "description": "string",
    "fabricNetworkIds": [
        "string"
    ],
    "ipVersion": "string",
    "startIPAddress": "string",
    "endIPAddress": "string",
    "tags": [
        {
            "key": "fast-network",
            "value": "true"
        }
    ]
}

string

name

Required

A human-friendly name used as an identifier in APIs that support this option.

string

description

Optional

A human-friendly description.

array of string

fabricNetworkIds

Optional

The Ids of the fabric networks.

string

ipVersion

Optional

IP address version: IPv4 or IPv6. Default: IPv4.

Possible values are : IPv4, IPv6,

string

startIPAddress

Required

Start IP address of the range.

string

endIPAddress

Required

End IP address of the range.

array of object

tags

Optional

A set of tag keys and optional values that were set on this resource instance.

Authentication

This operation uses the following authentication methods.

Authorization

Responses

201

Created

Returns NetworkIPRangeBase of type(s) application/json

"NetworkIPRangeBase Object"

string

Required

The id of this resource instance

string

createdAt

Optional

Date when the entity was created. The date is in ISO 8601 and UTC.

string

updatedAt

Optional

Date when the entity was last updated. The date is ISO 8601 and UTC.

string

owner

Optional

Email of the user or display name of the group that owns the entity.

string

ownerType

Optional

Type of a owner(user/ad_group) that owns the entity.

string

orgId

Optional

The id of the organization this entity belongs to.

object

_links

Required

HATEOAS of the entity

string

name

Optional

A human-friendly name used as an identifier in APIs that support this option.

string

description

Optional

A human-friendly description.

string

externalId

Optional

External entity Id on the provider side.

string

startIPAddress

Required

Start IP address of the range.

string

endIPAddress

Required

End IP address of the range.

string

ipVersion

Optional

IP address version: IPv4 or IPv6. Default: IPv4.

Possible values are : IPv4, IPv6,

array of object

tags

Optional

A set of tag keys and optional values that were set on this resource instance.

400

Invalid Request - bad data

Returns ServiceErrorResponse of type(s) application/json

"ServiceErrorResponse Object"

string

message

Optional

message

string

messageId

Optional

messageId

array of string

stackTrace

Optional

stackTrace

integer As int32 As int32

statusCode

Optional

statusCode

integer As int32 As int32

errorCode

Optional

errorCode

array of string

details

Optional

details

string

serverErrorId

Optional

serverErrorId

string

documentKind

Optional

documentKind

integer As int32 As int32

internalErrorCode

Optional

internalErrorCode

403

Forbidden

Returns ServiceErrorResponse of type(s) application/json

"ServiceErrorResponse Object"

string

message

Optional

message

string

messageId

Optional

messageId

array of string

stackTrace

Optional

stackTrace

integer As int32 As int32

statusCode

Optional

statusCode

integer As int32 As int32

errorCode

Optional

errorCode

array of string

details

Optional

details

string

serverErrorId

Optional

serverErrorId

string

documentKind

Optional

documentKind

integer As int32 As int32

internalErrorCode

Optional

internalErrorCode

Code Samples

COPY

                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"endIPAddress:"string","name:"string","startIPAddress:"string"}' https://{api_host}/iaas/api/network-ip-ranges

On This Page

Description

Request

Query Parameters

Request Body

Authentication

Response

201 Response Body

Errors

Network Ip Range Operations

POST

Release Unregistered Network Ips