AllocatedIpAddress

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. 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,
    "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

Id of the entity to which the IP address is allocated such as a VM.

string
entityName
Optional

Name of the entity to which the IP address is allocated.

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.

allocationType
Optional

allocationType

networkRef
Optional

networkRef

orgRef
Optional

orgRef

Availability
Added in 32.0