UsedIpAddress

UsedIpAddress

Describes a used IP address for a network.

JSON Example

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

string

entityId

Optional

Id of the entity using the IP address, such as a VM.

string

entityName

Optional

Name of the entity using the IP address.

string

vAppName

Optional

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

string

ipAddress

Optional

The IP address in use.

boolean

deployed

Optional

Whether the entity using this IP address is currently deployed.

UsedIpAddressAllocationType

allocationType

Optional

The possible allocation types for allocated network IP address. VM_ALLOCATED means that the IP address is used by a VM, EDGE means that the IP address is in use by an NSX edge gateway interface.

Possible values are : VM_ALLOCATED, EDGE,

EntityReference

networkRef

Optional

Entity reference used to describe VCD entities

EntityReference

orgRef

Optional

Entity reference used to describe VCD entities

Availability

Added in 33.0