Class

# VMware_VCloud_SDK_AdminVdc

class VMware_VCloud_SDK_AdminVdc 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 | getAdminVdcRef() Get a reference to a VMware vCloud admin vDC entity. |
VMware_VCloud_API_AdminVdcType | getAdminVdc() Get a VMware vCloud vDC entity in administrative view. |
string | getId() Constructs vCloud ID of this vDc from its UUID. |
VMware_VCloud_API_LinkType|null | getVdcRef() Get a link to a VMware vCloud vDC entity. |
VMware_VCloud_API_VdcType|null | getVdc() Get a VMware vCloud vDC entity. |
VMware_VCloud_API_LinkType|null | getAdminOrgRef() Get the link to the container entity of the VMware vCloud vDC in an administrator view. |
VMware_VCloud_API_AdminOrgType|null | getAdminOrg() Get the container entity of the VMware vCloud vDC in an administrator view. |
VMware_VCloud_API_TaskType | modify(VMware_VCloud_API_AdminVdcType $adminVdc) Modify vDC. |
boolean | isEnabled() Check whether the vDC is enabled. |
null | enable(boolean $enable = true) Enable the vDC. |
null | disable() Disable the vDC. |
VMware_VCloud_API_TaskType | delete() Delete the vDC. |
boolean | isFastProvisioningEnabled() Check whether fast provisioning is enabled. |
VMware_VCloud_API_TaskType | enableFastProvisioning(boolean $enable = true) Enable fast provisioning. |
VMware_VCloud_API_TaskType | disableFastProvisioning() Disable fast provisioning. |
VMware_VCloud_API_MetadataType| | getMetadata(string $key = null, string $domain = null) Get metadata associated with the vDC or metadata associated with the vDC for the specified key in the specified domain. |
VMware_VCloud_API_TaskType | mergeMetadata(VMware_VCloud_API_MetadataType $meta) Merges the metadata for the vDC item 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 vDC 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 vDC. |
VMware_VCloud_API_Extension_OrganizationResourcePoolSetType|null | getResourcePools() Retrieves resource pools associated with an organization vDC. |
VMware_VCloud_SDK_Vdc|null | getSdkVdc() Return an alternate SDK vDC object. |
array|null | getOrgVdcNetworks($name = null) List all networks for this Org vDC. |
VMware_VCloud_API_OrgVdcNetworkType | addvdcNetwork(VMware_VCloud_API_OrgVdcNetworkType $vdcNetwork) Create an Org vDC network. |
array|null | getAdminVdcStorageProfileRefs(string $name = null) Get vDC storage profile references. |
array|null | getAdminVdcStorageProfiles(string $name = null) Get vDC storage profiles. |
VMware_VCloud_API_TaskType | updateVdcStorageProfiles(VMware_VCloud_API_UpdateVdcStorageProfilesType $profile) Add or remove vDC storage profiles. |
array | getEdgeGatewayRefs(string $name = null) Get references to all edgegateways for this Org vDC with the given name. |
VMware_VCloud_API_GatewayType | createEdgeGateways(VMware_VCloud_API_GatewayType $params) Create a edgegateway. |
VMware_VCloud_API_TaskType | registerVApp(VMware_VCloud_API_RegisterVAppParamsType $params) Create a vApp based on a set of .vmx files and resource mappings |

## 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 getAdminVdcRef()`

Get a reference to a VMware vCloud admin vDC entity.

#### Return Value

VMware_VCloud_API_ReferenceType |

###
at line 21
`public VMware_VCloud_API_AdminVdcType getAdminVdc()`

Get a VMware vCloud vDC entity in administrative view.

#### Return Value

VMware_VCloud_API_AdminVdcType |

###
at line 32
`public string getId()`

Constructs vCloud ID of this vDc from its UUID.

#### Return Value

string |

###
at line 43
`public VMware_VCloud_API_LinkType|null getVdcRef()`

Get a link to a VMware vCloud vDC entity.

#### Return Value

VMware_VCloud_API_LinkType|null |

###
at line 55
`public VMware_VCloud_API_VdcType|null getVdc()`

Get a VMware vCloud vDC entity.

#### Return Value

VMware_VCloud_API_VdcType|null |

###
at line 68
`public VMware_VCloud_API_LinkType|null getAdminOrgRef()`

Get the link to the container entity of the VMware vCloud vDC in an administrator view.

#### Return Value

VMware_VCloud_API_LinkType|null |

###
at line 80
`public VMware_VCloud_API_AdminOrgType|null getAdminOrg()`

Get the container entity of the VMware vCloud vDC in an administrator view.

#### Return Value

VMware_VCloud_API_AdminOrgType|null |

###
at line 93
`public VMware_VCloud_API_TaskType modify(VMware_VCloud_API_AdminVdcType $adminVdc)`

Modify vDC.

#### Parameters

VMware_VCloud_API_AdminVdcType | $adminVdc |

#### Return Value

VMware_VCloud_API_TaskType |

###
at line 105
`public boolean isEnabled()`

Check whether the vDC is enabled.

#### Return Value

boolean |

###
at line 117
`public null enable(boolean $enable = true)`

Enable the vDC.

#### Parameters

boolean | $enable | To enable, set to true; to disable, set to false

#### Return Value

null |

###
at line 137
`public null disable()`

Disable the vDC.

#### Return Value

null |

###
at line 148
`public VMware_VCloud_API_TaskType delete()`

Delete the vDC.

#### Return Value

VMware_VCloud_API_TaskType |

###
at line 161
`public boolean isFastProvisioningEnabled()`

Check whether fast provisioning is enabled.

#### Return Value

boolean |

###
at line 175
`public VMware_VCloud_API_TaskType enableFastProvisioning(boolean $enable = true)`

Enable fast provisioning.

#### Parameters

boolean | $enable |

#### Return Value

VMware_VCloud_API_TaskType |

###
at line 188
`public VMware_VCloud_API_TaskType disableFastProvisioning()`

Disable fast provisioning.

#### Return Value

VMware_VCloud_API_TaskType |

###
at line 204
`public VMware_VCloud_API_MetadataType| getMetadata(string $key = null, string $domain = null)`

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

#### Parameters

string | $key |
string | $domain |

#### Return Value

VMware_VCloud_API_MetadataType| | VMwareVCloudAPI_MetadataValueType|null

###
at line 216
`public VMware_VCloud_API_TaskType mergeMetadata(VMware_VCloud_API_MetadataType $meta)`

Merges the metadata for the vDC item with the information provided.

#### Parameters

VMware_VCloud_API_MetadataType | $meta |

#### Return Value

VMware_VCloud_API_TaskType |

###
at line 235
`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 vDC 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 252
`public VMware_VCloud_API_TaskType deleteMetadataByKey(string $key, string $domain = null)`

Deletes the metadata for the particular key in the specified domain for the vDC.

#### Parameters

string | $key |
string | $domain |

#### Return Value

VMware_VCloud_API_TaskType |

###
at line 264
`public VMware_VCloud_API_Extension_OrganizationResourcePoolSetType|null getResourcePools()`

Retrieves resource pools associated with an organization vDC.

#### Return Value

VMware_VCloud_API_Extension_OrganizationResourcePoolSetType|null |

###
at line 277
`public VMware_VCloud_SDK_Vdc|null getSdkVdc()`

Return an alternate SDK vDC object.

#### Return Value

VMware_VCloud_SDK_Vdc|null |

###
at line 289
`public array|null getOrgVdcNetworks($name = null)`

List all networks for this Org vDC.

#### Parameters

| $name |

#### Return Value

array|null | VMwareVCloudAPI_ReferenceType object array or null

###
at line 304
`public VMware_VCloud_API_OrgVdcNetworkType addvdcNetwork(VMware_VCloud_API_OrgVdcNetworkType $vdcNetwork)`

Create an Org vDC network.

#### Parameters

VMware_VCloud_API_OrgVdcNetworkType | $vdcNetwork |

#### Return Value

VMware_VCloud_API_OrgVdcNetworkType |

###
at line 318
`public array|null getAdminVdcStorageProfileRefs(string $name = null)`

Get vDC storage profile references.

#### Parameters

string | $name | Name of the vDC storage profile. If null, returns all

#### Return Value

array|null | VMwareVCloudAPI_ReferenceType object array or null

###
at line 332
`public array|null getAdminVdcStorageProfiles(string $name = null)`

Get vDC storage profiles.

#### Parameters

string | $name | Name of the vDC storage profile. If null, returns all

#### Return Value

array|null | VMwareVCloudAPI_AdminVdcStorageProfileType object array or null

###
at line 345
`public VMware_VCloud_API_TaskType updateVdcStorageProfiles(VMware_VCloud_API_UpdateVdcStorageProfilesType $profile)`

Add or remove vDC storage profiles.

#### Parameters

VMware_VCloud_API_UpdateVdcStorageProfilesType | $profile |

#### Return Value

VMware_VCloud_API_TaskType |

###
at line 360
`public array getEdgeGatewayRefs(string $name = null)`

Get references to all edgegateways for this Org vDC with the given name.

#### Parameters

string | $name | Name of the edgegateway to get. If null, returns all

#### Return Value

array | VMwareVCloudAPI_ReferenceType object array

###
at line 375
`public VMware_VCloud_API_GatewayType createEdgeGateways(VMware_VCloud_API_GatewayType $params)`

Create a edgegateway.

#### Parameters

VMware_VCloud_API_GatewayType | $params |

#### Return Value

VMware_VCloud_API_GatewayType |

###
at line 391
`public VMware_VCloud_API_TaskType registerVApp(VMware_VCloud_API_RegisterVAppParamsType $params)`

Create a vApp based on a set of .vmx files and resource mappings

#### Parameters

VMware_VCloud_API_RegisterVAppParamsType | $params |

#### Return Value

VMware_VCloud_API_TaskType |