AllocatedIpAddress

AllocatedIpAddress

Describes an allocated IP address for a network. IP addresses can be allocated to a vApp VM, an edge gateway interface or may be used in a NAT routed environment. An IP address can also be allocated for some services configured on the network itself such as DHCP bindings. If the address is allocated to an edge gateway, the name of the entity will be 'Edge Gateway'.

JSON Example

{
    "id": "string",
    "entityId": "string",
    "entityName": "string",
    "vAppName": "string",
    "ipAddress": "string",
    "deployed": false,
    "allocationType": {},
    "allocationTypeValue": "string",
    "networkRef": {
        "name": "string",
        "id": "string"
    },
    "orgRef": {
        "name": "string",
        "id": "string"
    }
}

string

id

Optional

Unique identifier for record. This is to support UI operations.

string

entityId

Optional

URN of the entity to which the IP address is allocated such as a VM. If the IP address is allocated for some service configured on the network, this will be set to the URN of the network.

string

entityName

Optional

Name of the entity to which the IP address is allocated. If the IP address is allocated for some service configured on the network, this will be set to the name of the network.

string

vAppName

Optional

Name of the vApp whose VM is using allocated IP address.

string

ipAddress

Optional

The allocated IP address.

boolean

deployed

Optional

Whether the entity using this IP address is currently deployed.

AllocatedIpAddressAllocationType

allocationType

Optional

The possible allocation types for allocated network address. VM_ALLOCATED means that the IP address is allocated by a VM, NAT_ROUTED means that the IP address is used in a NAT routed environment and VSM_ALLOCATED means that the IP address is allocated to an NSX edge gateway interface.

Possible values are : VM_ALLOCATED, NAT_ROUTED, VSM_ALLOCATED,

string

allocationTypeValue

Optional

The allocation types for an allocated network address. It describes the usage category for the allocated IP address. Possible values are:

• VM_ALLOCATED
• NAT_ROUTED
• VSM_ALLOCATED
• DHCP_BINDING

EntityReference

networkRef

Optional

Entity reference used to describe VCD entities

EntityReference

orgRef

Optional

Entity reference used to describe VCD entities

Availability

Added in 32.0