Class

# VMware_VCloud_SDK_Extension_VimServer

class VMware_VCloud_SDK_Extension_VimServer 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 | getVimServerRef() Get a reference to a Vim server entity. |
VMware_VCloud_API_Extension_VimServerType | getVimServer() Get a Vim server settings. |
string | getId() Constructs vCloud ID of the Vim server from its UUID. |
VMware_VCloud_API_TaskType | modify(VMware_VCloud_API_Extension_VimServerType $vc) Modify a vim server. |
VMware_VCloud_API_TaskType | enable(boolean $enable = true) Enable the Vim server. |
VMware_VCloud_API_TaskType | disable() Disable the Vim server. |
boolean | isEnabled() Check whether the Vim server is enabled or not. |
VMware_VCloud_API_Extension_VmObjectRefsListType | getVmRefsList() Get references to all VMs. |
VMware_VCloud_API_Extension_VmObjectRefsListType | getVmRefsListByPage(int $page = 1, int $size = null) Get VMs list by page number. |
VMware_VCloud_API_Extension_ResourcePoolListType | getResourcePoolList() Retrieves references to all resource pools. |
array|null | getResourcePools(string $name = null) Get resource pools or resource pool with specified name. |
array|null | getAvailableNetworks() Get references for all the available networks for the Vim server. |
VMware_VCloud_API_VAppType | importVmAsVApp(VMware_VCloud_API_Extension_ImportVmAsVAppParamsType $params) Imports a VM from vSphere to a vDC as a vApp. |
VMware_VCloud_API_VAppTemplateType | importVmAsVAppTemplate(VMware_VCloud_API_Extension_ImportVmAsVAppTemplateParamsType $params) Imports a VM from vSphere to a vDC as a vApp template. |
VMware_VCloud_API_MediaType | importMedia(VMware_VCloud_API_Extension_ImportMediaParamsType $params) Import media from vSphere to a vDC. |
VMware_VCloud_API_TaskType | importVmIntoExistingVApp(VMware_VCloud_API_Extension_ImportVmIntoExistingVAppParamsType $params) Import a vSphere VM into an existing vApp. |
VMware_VCloud_API_TaskType | forceReconnect() Force Vim server reconnect. |
VMware_VCloud_API_TaskType | refreshStorageProfiles() Refresh storage profiles data from a registered Vim server. |
VMware_VCloud_API_TaskType | refresh() Refresh vCenter server. |
array|null | getHostRefs() Gets all the references for each host attached to the Vim server. |
VMware_VCloud_API_Extension_VMWStorageProfilesType | getStorageProfiles() Retrieves all storage profiles in the Vim server. |
VMware_VCloud_API_LinkType | getVsmRef() Get a link to the registered vShield Manager. |
VMware_VCloud_API_Extension_ShieldManagerType | getVsm() Get configuration details of registered vShield Manager. |
VMware_VCloud_API_TaskType | updateVsm(VMware_VCloud_API_Extension_ShieldManagerType $vsm) Update configuration details of registered vShield Manager. |
VMware_VCloud_API_Extension_VSphereWebClientUrlType | getVSphereWebClientUrl(vimObjectType $vimObjectType, vimObjectMoref $vimObjectMoref) Retrieve the vSphere URL of an object. |

## 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 11
`public VMware_VCloud_API_ReferenceType getVimServerRef()`

Get a reference to a Vim server entity.

#### Return Value

VMware_VCloud_API_ReferenceType |

###
at line 23
`public VMware_VCloud_API_Extension_VimServerType getVimServer()`

Get a Vim server settings.

#### Return Value

VMware_VCloud_API_Extension_VimServerType |

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

Constructs vCloud ID of the Vim server from its UUID.

#### Return Value

string |

###
at line 46
`public VMware_VCloud_API_TaskType modify(VMware_VCloud_API_Extension_VimServerType $vc)`

Modify a vim server.

#### Parameters

VMware_VCloud_API_Extension_VimServerType | $vc |

#### Return Value

VMware_VCloud_API_TaskType |

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

Enable the Vim server.

#### Parameters

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

#### Return Value

VMware_VCloud_API_TaskType |

#### Exceptions

VMware_VCloud_SDK_Exception |

###
at line 83
`public VMware_VCloud_API_TaskType disable()`

Disable the Vim server.

#### Return Value

VMware_VCloud_API_TaskType |

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

Check whether the Vim server is enabled or not.

#### Return Value

boolean |

###
at line 104
`public VMware_VCloud_API_Extension_VmObjectRefsListType getVmRefsList()`

Get references to all VMs.

#### Return Value

VMware_VCloud_API_Extension_VmObjectRefsListType |

###
at line 117
`public VMware_VCloud_API_Extension_VmObjectRefsListType getVmRefsListByPage(int $page = 1, int $size = null)`

Get VMs list by page number.

#### Parameters

int | $page | Page number, starts from 1. Default to 0.
int | $size | Page size, maximum to 100. Default to null.

#### Return Value

VMware_VCloud_API_Extension_VmObjectRefsListType |

###
at line 134
`public VMware_VCloud_API_Extension_ResourcePoolListType getResourcePoolList()`

Retrieves references to all resource pools.

Resource pools that are not assigned to org or provider vDC.

#### Return Value

VMware_VCloud_API_Extension_ResourcePoolListType |

###
at line 148
`public array|null getResourcePools(string $name = null)`

Get resource pools or resource pool with specified name.

#### Parameters

string | $name | Name of the resource pool to retrieve. If null, returns all

#### Return Value

array|null | VMwareVCloudAPIExtensionResourcePoolType array object or null.

###
at line 179
`public array|null getAvailableNetworks()`

Get references for all the available networks for the Vim server.

#### Return Value

array|null | VMwareVCloudAPIExtensionVimObjectRefType objects array or null

###
at line 198
`public VMware_VCloud_API_VAppType importVmAsVApp(VMware_VCloud_API_Extension_ImportVmAsVAppParamsType $params)`

Imports a VM from vSphere to a vDC as a vApp.

#### Parameters

VMware_VCloud_API_Extension_ImportVmAsVAppParamsType | $params |

#### Return Value

VMware_VCloud_API_VAppType |

###
at line 212
`public VMware_VCloud_API_VAppTemplateType importVmAsVAppTemplate(VMware_VCloud_API_Extension_ImportVmAsVAppTemplateParamsType $params)`

Imports a VM from vSphere to a vDC as a vApp template.

#### Parameters

VMware_VCloud_API_Extension_ImportVmAsVAppTemplateParamsType | $params |

#### Return Value

VMware_VCloud_API_VAppTemplateType |

###
at line 227
`public VMware_VCloud_API_MediaType importMedia(VMware_VCloud_API_Extension_ImportMediaParamsType $params)`

Import media from vSphere to a vDC.

#### Parameters

VMware_VCloud_API_Extension_ImportMediaParamsType | $params |

#### Return Value

VMware_VCloud_API_MediaType |

###
at line 241
`public VMware_VCloud_API_TaskType importVmIntoExistingVApp(VMware_VCloud_API_Extension_ImportVmIntoExistingVAppParamsType $params)`

Import a vSphere VM into an existing vApp.

#### Parameters

VMware_VCloud_API_Extension_ImportVmIntoExistingVAppParamsType | $params |

#### Return Value

VMware_VCloud_API_TaskType |

###
at line 255
`public VMware_VCloud_API_TaskType forceReconnect()`

Force Vim server reconnect.

#### Return Value

VMware_VCloud_API_TaskType |

###
at line 267
`public VMware_VCloud_API_TaskType refreshStorageProfiles()`

Refresh storage profiles data from a registered Vim server.

#### Return Value

VMware_VCloud_API_TaskType |

###
at line 279
`public VMware_VCloud_API_TaskType refresh()`

Refresh vCenter server.

#### Return Value

VMware_VCloud_API_TaskType |

###
at line 291
`public array|null getHostRefs()`

Gets all the references for each host attached to the Vim server.

#### Return Value

array|null | VMwareVCloudAPI_ReferenceType object array or null

###
at line 305
`public VMware_VCloud_API_Extension_VMWStorageProfilesType getStorageProfiles()`

Retrieves all storage profiles in the Vim server.

#### Return Value

VMware_VCloud_API_Extension_VMWStorageProfilesType |

###
at line 317
`public VMware_VCloud_API_LinkType getVsmRef()`

Get a link to the registered vShield Manager.

#### Return Value

VMware_VCloud_API_LinkType |

###
at line 329
`public VMware_VCloud_API_Extension_ShieldManagerType getVsm()`

Get configuration details of registered vShield Manager.

#### Return Value

VMware_VCloud_API_Extension_ShieldManagerType |

###
at line 349
`public VMware_VCloud_API_TaskType updateVsm(VMware_VCloud_API_Extension_ShieldManagerType $vsm)`

Update configuration details of registered vShield Manager.

#### Parameters

VMware_VCloud_API_Extension_ShieldManagerType | $vsm |

#### Return Value

VMware_VCloud_API_TaskType |

###
at line 372
`public VMware_VCloud_API_Extension_VSphereWebClientUrlType getVSphereWebClientUrl(vimObjectType $vimObjectType, vimObjectMoref $vimObjectMoref)`

Retrieve the vSphere URL of an object.

#### Parameters

vimObjectType | $vimObjectType |
vimObjectMoref | $vimObjectMoref |

#### Return Value

VMware_VCloud_API_Extension_VSphereWebClientUrlType |