vmware.vsphere.datacenter

vmware.vsphere.datacenter.get(attr_name, attr_value, obj, **kwargs):

Get a specific datacenter identified by an attribute. Will only return the first object that matches

Parameters:

• attr_name – Name of the attribute that shall be used for selecting the object. Can also be “rel_path” to match a specific path within a folder-structure. Be aware, that this will trigger a ‘get_dict’ which may take a while.

• attr_value – Value which attr_name must contain

• obj (object) – The object within we shall search for clusters (vCenter or folder)

Returns:

First object that matched the selection. Returns bool:False if no match was found

Return type:

object

Keyword Arguments:

• vc_obj (object) vCenter-object that was created by vmware.vsphere.get_content(). This will overwrite the object that was registered as default by vmware.vsphere.default()

vmware.vsphere.datacenter.get_dict(obj, **kwargs):

Get all datacenters beneath the object and return a dictionary.

Parameters:

obj (object) – The object within we shall search for datacenters (vCenter or folder)

Returns:

Dictionary containing a key -> value pair per datacenter

Return type:

dict

Keyword Arguments:

• key (string) String containing the attribute-name that shall be used as the dictionary-key. May be “rel_path” to construct a relative path, which is descriptive and unique containing all the folders (default). Make sure to choose a unique attribute, otherwise elements will overwrite each other.

• key_prepend (string) String which should be prepended to all keys that are built within this function

vmware.vsphere.datacenter.get_list(obj, **kwargs):

Get all datacenters beneath the object and return a list. This function is much faster than get_dict() when the vCenter-object is present (passed within kwargs or present as default)

Parameters:

obj (object) – The object within we shall search for datacenters (vCenter or folder)

Returns:

List of objects

Return type:

list

Keyword Arguments:

• vc_obj (object) vCenter-object that was created by vmware.vsphere.get_content(). This will overwrite the object that was registered as default by vmware.vsphere.default()

vmware.vsphere.datacenter.is_datacenter(obj):

Check if passed object is a datacenter

Parameters:

obj (object) – The object

Returns:

True if it is a datacenter, false if not

Return type:

bool

vmware.vsphere.datacenter.is_type(obj):

Check if passed object is a datacenter

Parameters:

obj (object) – The object

Returns:

True if it is a datacenter, false if not

Return type:

bool