UsedIpAddress

Describes a used IP address for a network.


Properties

allocationType Optional

The possible allocation types for 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 using the IP address, such as a VM.


string
entityName Optional

Name of the entity using the IP address.


string
ipAddress Optional

The IP address in use.


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 this IP address.

JSON Example

{
	"allocationType": "enum",
	"deployed": false,
	"entityId": "string",
	"entityName": "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
  networkRef:
    x-vcloud-constraints:
    - constraint: NonSearchable
    - constraint: NonSortable
  orgRef:
    x-vcloud-constraints:
    - constraint: NonSearchable
    - constraint: NonSortable
  vAppName:
    x-vcloud-constraints:
    - constraint: NonSearchable
    - constraint: NonSortable
Availability
Added in 33.0
Property Of

InlineUsedIpAddresses

Feedback

Was this page helpful?