Class

VMware_VCloud_SDK_AdminNetwork

class VMware_VCloud_SDK_AdminNetwork extends VMware_VCloud_SDK_Abstract

Methods

string getEntityId()

Get vCloud ID of the vCloud resource entity from its data object.

 from VMware_VCloud_SDK_Abstract
VMware_VCloud_API_ReferenceType getAdminNetworkRef()

Get a reference to a VMware vCloud network entity.
VMware_VCloud_API_OrgNetworkType|VMware_VCloud_API_ExternalNetworkType getAdminNetwork()

Get a VMware vCloud network entity in an administrative view.
string getId()

Constructs vCloud ID of this network from its UUID.
VMware_VCloud_API_LinkType getAdminVdcRef()

Get up link to the admin org vdc reference.
VMware_VCloud_API_AdminVdcType getAdminVdc()

Get admin org vdc this network belongs to.
VMware_VCloud_API_LinkType|null getNetworkRef($type = 'orgNetwork')

Get a link to a VMware vCloud network entity.
VMware_VCloud_API_OrgNetworkType getNetwork()

Get a VMware vCloud network entity.
VMware_VCloud_API_LinkType|null getAdminOrgRef()

Get the link to the container entity of the organization network in an administrator view.
VMware_VCloud_API_AdminOrgType|null getAdminOrg()

Get the container entity of the organization network in an administrator view.
VMware_VCloud_API_TaskType modify(VMware_VCloud_API_OrgNetworkType $orgNetwork)

Modify an organization network.
VMware_VCloud_API_TaskType updateOrgVdcNetwork(VMware_VCloud_API_OrgVdcNetworkType $orgVdcNetwork)

Update an organization vdc network.
VMware_VCloud_API_TaskType reset()

Reset only Isolated Organization Vdc Network.
VMware_VCloud_API_TaskType delete()

Delete an organization network or an organization Vdc Network.
VMware_VCloud_API_MetadataType|VMware_VCloud_API_MetadataValueType getMetadata(string $key = null, string $domain = null)

Get metadata associated with the network or metadata associated with the organization network for the specified key in the specified domain.
VMware_VCloud_API_TaskType mergeMetadata(VMware_VCloud_API_MetadataType $meta)

Merges the metadata for the organization network with the information provided.
VMware_VCloud_API_TaskType setMetadataByKey(string $key, VMware_VCloud_API_MetadataValueType $value, string $domain = null)

Sets the metadata for the particular key in the specified domain for the organization network to the value provided.
VMware_VCloud_API_TaskType deleteMetadataByKey(string $key, string $domain = null)

Deletes the metadata for the particular key in the specified domain for the organization network.
VMware_VCloud_API_TaskType syncSyslogServerSettings()

Synchronize syslog server settings of a logical network with system defaults.
VMware_VCloud_SDK_Network|null getSdkNetwork()

Return an alternate SDK organization network object.
array|null getAllocatedIpAddresses()

Returns the allocated IPs associated with the network.

Details

in VMware_VCloud_SDK_Abstract at line 85
public string getEntityId()

Get vCloud ID of the vCloud resource entity from its data object.

Return Value

string

at line 10
public VMware_VCloud_API_ReferenceType getAdminNetworkRef()

Get a reference to a VMware vCloud network entity.

Return Value

VMware_VCloud_API_ReferenceType

at line 22
public VMware_VCloud_API_OrgNetworkType|VMware_VCloud_API_ExternalNetworkType getAdminNetwork()

Get a VMware vCloud network entity in an administrative view.

Return Value

VMware_VCloud_API_OrgNetworkType|VMware_VCloud_API_ExternalNetworkType

at line 33
public string getId()

Constructs vCloud ID of this network from its UUID.

Return Value

string

at line 44
public VMware_VCloud_API_LinkType getAdminVdcRef()

Get up link to the admin org vdc reference.

Return Value

VMware_VCloud_API_LinkType object

at line 64
public VMware_VCloud_API_AdminVdcType getAdminVdc()

Get admin org vdc this network belongs to.

Return Value

VMware_VCloud_API_AdminVdcType object

at line 76
public VMware_VCloud_API_LinkType|null getNetworkRef($type = 'orgNetwork')

Get a link to a VMware vCloud network entity.

This method works only for API 1.5 which contains Org Networks.

Parameters

$type

Return Value

VMware_VCloud_API_LinkType|null

at line 89
public VMware_VCloud_API_OrgNetworkType getNetwork()

Get a VMware vCloud network entity.

Return Value

VMware_VCloud_API_OrgNetworkType for API 1.5

at line 103
public VMware_VCloud_API_LinkType|null getAdminOrgRef()

Get the link to the container entity of the organization network in an administrator view.

This method works only for API 1.5 which returns Org Networks.

Return Value

VMware_VCloud_API_LinkType|null

at line 116
public VMware_VCloud_API_AdminOrgType|null getAdminOrg()

Get the container entity of the organization network in an administrator view.

Return Value

VMware_VCloud_API_AdminOrgType|null

at line 130
public VMware_VCloud_API_TaskType modify(VMware_VCloud_API_OrgNetworkType $orgNetwork)

Modify an organization network.

This method works only for API 1.5.

Parameters

VMware_VCloud_API_OrgNetworkType $orgNetwork

Return Value

VMware_VCloud_API_TaskType

at line 143
public VMware_VCloud_API_TaskType updateOrgVdcNetwork(VMware_VCloud_API_OrgVdcNetworkType $orgVdcNetwork)

Update an organization vdc network.

Parameters

VMware_VCloud_API_OrgVdcNetworkType $orgVdcNetwork

Return Value

VMware_VCloud_API_TaskType

at line 157
public VMware_VCloud_API_TaskType reset()

Reset only Isolated Organization Vdc Network.

Return Value

VMware_VCloud_API_TaskType

at line 169
public VMware_VCloud_API_TaskType delete()

Delete an organization network or an organization Vdc Network.

Return Value

VMware_VCloud_API_TaskType

at line 186
public VMware_VCloud_API_MetadataType|VMware_VCloud_API_MetadataValueType getMetadata(string $key = null, string $domain = null)

Get metadata associated with the network or metadata associated with the organization network for the specified key in the specified domain.

Parameters

string $key
string $domain

Return Value

VMware_VCloud_API_MetadataType|VMware_VCloud_API_MetadataValueType

at line 200
public VMware_VCloud_API_TaskType mergeMetadata(VMware_VCloud_API_MetadataType $meta)

Merges the metadata for the organization network with the information provided.

Parameters

VMware_VCloud_API_MetadataType $meta

Return Value

VMware_VCloud_API_TaskType

at line 219
public VMware_VCloud_API_TaskType setMetadataByKey(string $key, VMware_VCloud_API_MetadataValueType $value, string $domain = null)

Sets the metadata for the particular key in the specified domain for the organization network to the value provided.

Note: This will replace any existing metadata information.

Parameters

string $key
VMware_VCloud_API_MetadataValueType $value
string $domain

Return Value

VMware_VCloud_API_TaskType

at line 236
public VMware_VCloud_API_TaskType deleteMetadataByKey(string $key, string $domain = null)

Deletes the metadata for the particular key in the specified domain for the organization network.

Parameters

string $key
string $domain

Return Value

VMware_VCloud_API_TaskType

at line 252
public VMware_VCloud_API_TaskType syncSyslogServerSettings()

Synchronize syslog server settings of a logical network with system defaults.

Synchronize operation can be performed on: - routed organization network - routed/fenced vApp networks

Return Value

VMware_VCloud_API_TaskType

at line 265
public VMware_VCloud_SDK_Network|null getSdkNetwork()

Return an alternate SDK organization network object.

Return Value

VMware_VCloud_SDK_Network|null

at line 278
public array|null getAllocatedIpAddresses()

Returns the allocated IPs associated with the network.

Return Value

array|null VMwareVCloudAPI_AllocatedIpAddressType objects array or null