InlineIpAddressSpace1

InlineIpAddressSpace1
InlineIpAddressSpace1
JSON Example undefined undefined
{
    "id": "urn:vcloud:ipSpace:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
    "name": "string",
    "description": "string",
    "internalScopeCidrBlocks": [
        {
            "id": "string",
            "name": "string",
            "cidr": "10.0.0.0/8"
        }
    ],
    "ipAddressRanges": [
        {
            "id": "string",
            "startIpAddress": "string",
            "endIpAddress": "string"
        }
    ],
    "reservedIpAddressRanges": [
        "IpAddressSpaceRange Object"
    ],
    "backingId": "string",
    "isImportedIpBlock": false,
    "externalScopeCidr": "10.0.0.0/8",
    "regionRef": {
        "name": "string",
        "id": "string"
    },
    "defaultQuota": {
        "maxIpCount": 0,
        "maxCidrCount": 0,
        "maxSubnetSize": 24
    },
    "subnetExclusive": false,
    "dedicatedDistributedVlanConnectionRef": "EntityReference Object",
    "providerVisibilityOnly": false
}
string
id
Optional

The identifier of the IP Block in URN format.

string
name
Required
Constraints: minLength: 1 maxLength: 128

The name of the IP Block. Name is unique across all IP Blocks of a given type and organization.

string
description
Optional

The description of the IP Block.

internalScopeCidrBlocks
Optional
Constraints: minItems: 0 maxItems: 30

This along with IP Address Ranges typically defines the span of IP addresses used within a Data Center. For new CIDR value not in the existing list, a new IP Block will be created. For existing CIDR value, the IP Block's name can be updated. If an existing CIDR value is removed from the list, the IP Block is removed from the IP Block. This field is read-only when the IP Block is imported from an existing NSX IP Block (i.e., when isImportedIpBlock is true).

ipAddressRanges
Optional
Constraints: minItems: 0 maxItems: 30

This along with internal scope Cidr Blocks typically defines the span of IP addresses used within a Data Center. This field is read-only when the IP Block is imported from an existing NSX IP Block (i.e., when isImportedIpBlock is true).

reservedIpAddressRanges
Optional
Constraints: minItems: 0 maxItems: 128

Reserved IPs have to be part of one of the CIDRs or IP Ranges. Reserved IPs will not be considered for IP allocation. This field is read-only when the IP Block is imported from an existing NSX IP Block (i.e., when isImportedIpBlock is true).

string
backingId
Optional

Id for the matching IP Block in NSX. This is not a Provider Management URN. This is only set for IP Blocks backed by enhanced NSX IP Blocks. These IP Blocks can have IP ranges and reserved IP ranges in addition to IP Blocks. When creating an IP Block, this field is optional. If not provided, the IP Block will be managed by Provider Management, backingId will effectively be read-only and isImportedIpBlock property will be false If provided, the IP Block is imported from an existing NSX IP Block, backingId will effectively be immutable and isImportedIpBlock property will be true.

boolean
isImportedIpBlock
Optional

Whether this IP Block is imported from an existing IP Block in NSX. Read-only.

string
externalScopeCidr
Optional

This defines the total span of IP addresses to which the IP Block has access. This typically defines the span of IP addresses outside the bounds of a Data Center. For the internet, this may be 0.0.0.0/0. For a WAN, this could be 10.0.0.0/8.

regionRef
Optional

Entity reference used to describe VCD entities

defaultQuota
Optional

IP Block quota defines the maximum number of IPv4 IPs and CIDRs that can be allocated and used by the IP Block across all its Internal Scopes.

boolean
subnetExclusive
Optional

Whether this IP Block is exclusively for a single CIDR. Set if auto created by a Shared Subnet or a Distributed VLAN Connection that is exclusively for a subnet.

dedicatedDistributedVlanConnectionRef
Optional

Entity reference used to describe VCD entities

boolean
providerVisibilityOnly
Optional

If set to true, the IP Block details will be hidden from organizations.