Attributes
Attribute | Type | Required | Modifiable | Since | Deprecated | Description | Filter | Sort |
---|---|---|---|---|---|---|---|---|
href | anyURI | No | always | 5.7 | Contains the URI to the resource. | Yes | Yes | |
id | string | No | always | 5.7 | The resource identifier, expressed in URN format. The value of this attribute uniquely identifies the resource, persists for the life of the resource, and is never reused. | Yes | Yes | |
type | string | No | always | 5.7 | Contains the type of the resource. | Yes | Yes | |
name | string | No | none | 5.1 | Network Name | Yes | Yes | |
defaultGateway | string | No | none | 5.1 | Default Gateway | Yes | Yes | |
netmask | string | No | none | 5.1 | Netmask | Yes | Yes | |
dns1 | string | No | none | 5.1 | Primary DNS | Yes | Yes | |
dns2 | string | No | none | 5.1 | Secondary DNS | Yes | Yes | |
dnsSuffix | string | No | none | 5.1 | DNS Suffix | Yes | Yes | |
linkType | int | No | none | 5.1 | Link Type | Yes | Yes | |
connectedTo | string | No | none | 5.1 | Network or Gateway that it connects to | Yes | Yes | |
vdc | string | No | none | 5.1 | VDC Reference or ID | Yes | Yes | |
isBusy | boolean | No | none | 5.1 | True if this network is busy. | Yes | Yes | |
isShared | boolean | No | none | 5.1 | True if this network is shared. | Yes | Yes | |
vdcName | string | No | none | 5.1 | VDC Name | Yes | Yes | |
isIpScopeInherited | boolean | No | none | 5.1 | True if this network's IP scope is inherited. | Yes | Yes | |
fenceMode | string | No | none | 5.7 | Allowed values are: "isolated", "bridged" and "natRouted". | Yes | Yes | |
vmsAllocated | int | No | none | 5.7 | The number of VMs connected to the network. | Yes | Yes | |
vmsPoweredOn | int | No | none | 5.7 | The number of VMs connected to the network that are Powered ON. | Yes | Yes | |
ipRanges | string | No | none | 5.7 | List of IP ranges this Network is associated to (for 'isolated' and 'natRouted'), delimited by ';'. Example: "xxx.xxx.xxx.xxx - yyy.yyy.yyy.yyy ; xxx.xxx.xxx.xxx - yyy.yyy.yyy.yyy". | Yes | Yes | |
externalIpAddress | string | No | none | 5.7 | Applicable if the fencemode is 'natRouted'. | Yes | Yes | |
numberOfExternalIpAddressesAllocated | int | No | none | 5.7 | Applicable if the fencemode is 'natRouted'. | Yes | Yes | |
numberOfExternalIpAddressesUsed | int | No | none | 5.7 | Applicable if the fencemode is 'natRouted'. | Yes | Yes | |
vdcId | string | No | none | 5.7 | The ID of the VDC this network belongs to. | Yes | Yes | |
state | string | No | none | 5.7 | Status of this entity. The allowed values are: "Inactive", "Activating", "Active", "Suspending", "Suspended", "Deleting", "Deleted", "Error"". | Yes | Yes |
Elements
Element | Type | Required | Modifiable | Since | Deprecated | Description |
---|---|---|---|---|---|---|
Link | LinkType | No | none | 5.7 | Contains a link to an operation associated with a specific relation type. | |
Metadata | MetadataType | No | 5.1 |