[{"label":"Latest (v36.3)","version":"latest"},{"version":"v36.2"},{"version":"v36.1"},{"version":"v36.0"},{"link":"https://developer.vmware.com/apis/1046/vmware-cloud-director","version":"v35.0"}]
vmware-cloud-director

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’.


Properties

allocationType Optional

The possible allocation types for allocated network address like VSM allocated, VM allocated or NAT routed.


boolean
deployed Optional

Whether the entity using this IP address is currently deployed.


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
id Optional

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


string
ipAddress Optional

The allocated IP address.


networkRef Optional

The vApp network or Org vDC network to which this entity is connected.


orgRef Optional

The organization that this entity belongs to.


string
vAppName Optional

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

JSON Example

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

Vendor Extensions

This class contains the following vendor extensions defined in the spec:
x-vcloud-property-annotations:
    allocationType:
        x-vcloud-constraints:
            - constraint: NonSearchable
            - constraint: NonSortable
    deployed:
        x-vcloud-constraints:
            - constraint: NonSearchable
            - constraint: NonSortable
    entityId:
        x-vcloud-constraints:
            - args:
                - arg: gateway
                - arg: vm
              constraint: Urn
            - constraint: NonSearchable
            - constraint: NonSortable
    entityName:
        x-vcloud-constraints:
            - constraint: NonSearchable
            - constraint: NonSortable
    id:
        x-vcloud-constraints:
            - constraint: NonSearchable
            - constraint: NonSortable
    networkRef:
        x-vcloud-added-in: "33.0"
        x-vcloud-constraints:
            - constraint: NonSearchable
            - constraint: NonSortable
    orgRef:
        x-vcloud-added-in: "33.0"
        x-vcloud-constraints:
            - constraint: NonSearchable
            - constraint: NonSortable
    vAppName:
        x-vcloud-constraints:
            - constraint: NonSearchable
            - constraint: NonSortable
[{"label":"Latest (v36.3)","version":"latest"},{"version":"v36.2"},{"version":"v36.1"},{"version":"v36.0"},{"link":"https://developer.vmware.com/apis/1046/vmware-cloud-director","version":"v35.0"}]
vmware-cloud-director
Availability
Added in 32.0
Property Of

InlineAllocatedIpAddresses1

Feedback

Was this page helpful?