vmware.vsphere.vm¶
- vmware.vsphere.vm.get(attr_name, attr_value, obj, **kwargs):
Get a specific VM 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 the host
- 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.vm.get_cluster(obj):
Get the cluster which hosts the VM
- Parameters:
obj (object) – The VM-object
- Returns:
List of objects
- Return type:
list
- vmware.vsphere.vm.get_datastore_clusters(obj):
Get a list of all datastore-clusters that are used by the VM
- Parameters:
obj (object) – The VM-object
- Returns:
List of objects
- Return type:
list
- vmware.vsphere.vm.get_datastores(obj):
Get a list of all datastores that are used by the VM
- Parameters:
obj (object) – The VM-object
- Returns:
List of objects
- Return type:
list
- vmware.vsphere.vm.get_dict(obj, **kwargs):
Get all VMs beneath the object and return a dictionary.
- Parameters:
obj (object) – The object within we shall search for VMs (datacenter; cluster is not yet implemented)
- Returns:
Dictionary containing a key -> value pair per VM
- 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.vm.get_folder(obj):
Get the parent folder in which the VM is situated
- Parameters:
obj (object) – The VM-object
- Returns:
List of objects
- Return type:
list
- vmware.vsphere.vm.get_host(obj):
Get the host which hosts the VM
- Parameters:
obj (object) – The VM-object
- Returns:
List of objects
- Return type:
list
- vmware.vsphere.vm.get_list(obj, **kwargs):
Get all VMs 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 VMs
- 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.vm.get_networks(obj):
Get a list of all networks (portgroups) that are used by the VM
- Parameters:
obj (object) – The VM-object
- Returns:
List of objects
- Return type:
list
- vmware.vsphere.vm.get_respool(obj):
Get the respool in which the VM resides
- Parameters:
obj (object) – The VM-object
- Returns:
List of objects
- Return type:
list
- vmware.vsphere.vm.is_type(obj):
Check if passed object is a VM
- Parameters:
obj (object) – The object
- Returns:
True if it is a VM, false if not
- Return type:
bool
- vmware.vsphere.vm.is_vm(obj):
Check if passed object is a VM
- Parameters:
obj (object) – The object
- Returns:
True if it is a VM, false if not
- Return type:
bool