com.vmware.vcenter package¶

Subpackages¶

Submodules¶

com.vmware.vcenter.hvc_client module¶

The com.vmware.vcenter.hvc_client module provides classes to manage hybrid links between a local and remote Platform Service Controller. Copyright 2017 VMware, Inc. All rights reserved. – VMware Confidential

class com.vmware.vcenter.hvc_client.Links(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

The Links class provides methods to create, delete, get information, and list hybrid links between the local and foreign Platform Service Controller (PSC).

Parameters:	config (`vmware.vapi.bindings.stub.StubConfiguration`) – Configuration to be used for creating the stub.

class CreateSpec(psc_hostname=None, port=None, domain_name=None, username=None, password=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The Links.CreateSpec class is the specification used for the hybrid link creation.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters:	psc_hostname (`str`) – The PSC hostname for the domain to be linked. port (`str` or `None`) – The HTTPS port of the PSC to be linked. If None 443 will be used as default. domain_name (`str`) – The domain to which the PSC belongs. username (`str`) – The administrator username of the PSC. password (`str`) – The administrator password of the PSC.

class Links.Summary(link=None, display_name=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The Links.Summary class contains information about the hybrid link.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters:

link (str) – Unique identifier for the link. When clients pass a value of this class as a parameter, the attribute must be an identifier for the resource type: com.vmware.vcenter.hvc.Links. When methods return a value of this class as a return value, the attribute will be an identifier for the resource type: com.vmware.vcenter.hvc.Links.
display_name (str) – The display name is set to the domain name which was set during create.

Links.create(spec)¶

Creates a new hybrid link between the local and foreign PSC.

Parameters:	spec (`Links.CreateSpec`) – Specification for the new link to be created.
Return type:	`str`
Returns:	The identifier of the newly linked domain. The return value will be an identifier for the resource type: `com.vmware.vcenter.hvc.Links`.
Raise:	`com.vmware.vapi.std.errors_client.AlreadyExists` If the link already exists.
Raise:	`com.vmware.vapi.std.errors_client.InvalidArgument` If the spec is not valid.
Raise:	`com.vmware.vapi.std.errors_client.Unsupported` If the PSC or the VC version is not supported.
Raise:	`com.vmware.vapi.std.errors_client.Unauthorized` If the user is not authorized.
Raise:	`com.vmware.vapi.std.errors_client.Error` if the system reports an error while responding to the request.

Links.delete(link)¶

Deletes an existing hybrid link.

Parameters:	link (`str`) – Identifier of the hybrid link. The parameter must be an identifier for the resource type: `com.vmware.vcenter.hvc.Links`.
Raise:	`com.vmware.vapi.std.errors_client.NotFound` If the hybrid link associated with `link` does not exist.
Raise:	`com.vmware.vapi.std.errors_client.Unauthorized` If the user is not authorized.
Raise:	`com.vmware.vapi.std.errors_client.Error` if the system reports an error while responding to the request.

Links.list()¶

Enumerates the list of registered hybrid links.

Return type:	`list` of `Links.Summary`
Returns:	The `list` of hybrid link information.
Raise:	`com.vmware.vapi.std.errors_client.Error` if the system reports an error while responding to the request.

com.vmware.vcenter.inventory_client module¶

The com.vmware.vcenter.inventory_client component provides methods and classes for retrieving vCenter datastore and network information for a given list of identifiers.

class com.vmware.vcenter.inventory_client.Datastore(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

The Datastore class provides methods to retrieve information about datastores.

Parameters:	config (`vmware.vapi.bindings.stub.StubConfiguration`) – Configuration to be used for creating the stub.

class Info(type=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The Datastore.Info class contains information about a datastore.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters:	type (`str`) – Type of the datastore. When clients pass a value of this class as a parameter, the attribute must be one of `Datastore` or `StoragePod`. When methods return a value of this class as a return value, the attribute will be one of `Datastore` or `StoragePod`.

Datastore.find(datastores)¶

Returns datastore information for the specified datastores. The key in the return value dict is the datastore identifier and the value in the dict is the datastore information.

Parameters:	datastores (`list` of `str`) – Identifiers of the datastores for which information will be returned. The parameter must contain identifiers for the resource type: `Datastore`.
Return type:	`dict` of `str` and (`Datastore.Info` or `None`)
Returns:	Datastore information for the specified datastores. The key in the return value `dict` is the datastore identifier and the value in the `dict` is the datastore information. The key in the return value `dict` will be an identifier for the resource type: `Datastore`.
Raise:	`com.vmware.vapi.std.errors_client.NotFound` if no datastore can be found for one or more of the datastore identifiers in `datastores`
Raise:	`com.vmware.vapi.std.errors_client.Unauthorized` if you do not have all of the privileges described as follows: Method execution requires `System.Read`. The resource `Datastore` referenced by the parameter `datastores` requires `System.Read`.

class com.vmware.vcenter.inventory_client.Network(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

The Network class provides methods to retrieve information about vCenter Server networks.

Parameters:	config (`vmware.vapi.bindings.stub.StubConfiguration`) – Configuration to be used for creating the stub.

class Info(type=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The Network.Info class contains information about a vCenter Server network.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters:	type (`str`) – Type of the vCenter Server network. When clients pass a value of this class as a parameter, the attribute must be one of `Network`, `DistributedVirtualPortgroup`, or `OpaqueNetwork`. When methods return a value of this class as a return value, the attribute will be one of `Network`, `DistributedVirtualPortgroup`, or `OpaqueNetwork`.

Network.find(networks)¶

Returns network information for the specified vCenter Server networks. The key in the return value dict is the network identifier and the value in the dict is the network information.

Parameters:	networks (`list` of `str`) – Identifiers of the vCenter Server networks for which information will be returned. The parameter must contain identifiers for the resource type: `Network`.
Return type:	`dict` of `str` and (`Network.Info` or `None`)
Returns:	Network information for the specified vCenter Server networks. The key in the return value `dict` is the network identifier and the value in the `dict` is the network information. The key in the return value `dict` will be an identifier for the resource type: `Network`.
Raise:	`com.vmware.vapi.std.errors_client.NotFound` if no datastore can be found for one or more of the vCenter Server network identifiers in `networks`
Raise:	`com.vmware.vapi.std.errors_client.Unauthorized` if you do not have all of the privileges described as follows: Method execution requires `System.Read`. The resource `Network` referenced by the parameter `networks` requires `System.Read`.

com.vmware.vcenter.iso_client module¶

The com.vmware.vcenter.iso_client module provides classes and classes that will let its client mount or unmount an ISO image on a virtual machine as a CD-ROM.

class com.vmware.vcenter.iso_client.Image(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

Provides an interface to mount and unmount an ISO image on a virtual machine.

This is an API that will let its client mount or unmount an ISO image on a virtual machine as a CD-ROM.

Parameters:	config (`vmware.vapi.bindings.stub.StubConfiguration`) – Configuration to be used for creating the stub.

mount(library_item, vm)¶

Mounts an ISO image from a content library on a virtual machine.

Parameters:	library_item (`str`) – The identifier of the library item having the ISO image to mount on the virtual machine. The parameter must be an identifier for the resource type: `com.vmware.content.library.Item`. vm (`str`) – The identifier of the virtual machine where the specified ISO image will be mounted. The parameter must be an identifier for the resource type: `VirtualMachine`.
Return type:	`str`
Returns:	The identifier of the newly created virtual CD-ROM backed by the specified ISO image. The return value will be an identifier for the resource type: `com.vmware.vcenter.vm.hardware.Cdrom`.
Raise:	`com.vmware.vapi.std.errors_client.NotFound` If either `vm` or the `library_item` is not found.
Raise:	`com.vmware.vapi.std.errors_client.InvalidArgument` If no .iso file is present on the library item.
Raise:	`com.vmware.vapi.std.errors_client.NotAllowedInCurrentState` When the operation is not allowed on the virtual machine in its current state.

unmount(vm, cdrom)¶

Unmounts a previously mounted CD-ROM using an ISO image as a backing.

Parameters:	vm (`str`) – The identifier of the virtual machine from which to unmount the virtual CD-ROM. The parameter must be an identifier for the resource type: `VirtualMachine`. cdrom (`str`) – The device identifier of the CD-ROM. The parameter must be an identifier for the resource type: `com.vmware.vcenter.vm.hardware.Cdrom`.
Raise:	`com.vmware.vapi.std.errors_client.NotFound` If the virtual machine identified by `vm` is not found or the `cdrom` does not identify a virtual CD-ROM in the virtual machine.
Raise:	`com.vmware.vapi.std.errors_client.NotAllowedInCurrentState` When the operation is not allowed on the virtual machine in its current state.

com.vmware.vcenter.ovf_client module¶

The com.vmware.vcenter.ovf_client module provides services to capture and deploy Open Virtualization Format (OVF) packages to and from the content library.

It provides the ability to deploy OVF packages from the content library with support for advanced network topologies, network services, creating virtual appliances and virtual machines in hosts, resource pools or clusters. It also provides the ability to export virtual appliances and virtual machines from hosts, resource pools or clusters as OVF packages to the content library.

class com.vmware.vcenter.ovf_client.CertificateParams(issuer=None, subject=None, is_valid=None, is_self_signed=None, x509=None, type=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The CertificateParams class contains information about the public key certificate used to sign the OVF package. This class will only be returned if the OVF package is signed.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters:

issuer (str) – Certificate issuer. For example: /C=US/ST=California/L=Palo Alto/O=VMware, Inc. This attribute is not used in the input parameters when deploying an OVF package. This attribute will always be present in the result when retrieving information about an OVF package.
subject (str) – Certificate subject. For example: /C=US/ST=Massachusetts/L=Hopkinton/O=EMC Corporation/OU=EMC Avamar/CN=EMC Corporation. This attribute is not used in the input parameters when deploying an OVF package. This attribute will always be present in the result when retrieving information about an OVF package.
is_valid (bool) – Is the certificate chain validated. This attribute is not used in the input parameters when deploying an OVF package. This attribute will always be present in the result when retrieving information about an OVF package.
is_self_signed (bool) – Is the certificate self-signed. This attribute is not used in the input parameters when deploying an OVF package. This attribute will always be present in the result when retrieving information about an OVF package.
x509 (str) – The X509 representation of the certificate. This attribute is not used in the input parameters when deploying an OVF package. This attribute will always be present in the result when retrieving information about an OVF package.
type (str) – Unique identifier describing the type of the OVF parameters. The value is the name of the OVF parameters class. This attribute must be provided in the input parameters when deploying an OVF package. This attribute will always be present in the result when retrieving information about an OVF package.

class com.vmware.vcenter.ovf_client.DeploymentOption(key=None, label=None, description=None, default_choice=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The DeploymentOption class contains the information about a deployment option as defined in the OVF specification.

This corresponds to the ovf:Configuration element of the ovf:DeploymentOptionSection in the specification. The ovf:DeploymentOptionSection specifies a discrete set of intended resource allocation configurations. This class represents one item from that set.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters:

key (str) – The key of the deployment option, corresponding to the ovf:id attribute in the OVF descriptor. This attribute is not used in the input parameters when deploying an OVF package. This attribute will always be present in the result when retrieving information about an OVF package.
label (str) – A localizable label for the deployment option. This attribute is not used in the input parameters when deploying an OVF package. This attribute will always be present in the result when retrieving information about an OVF package.
description (str) – A localizable description for the deployment option. This attribute is not used in the input parameters when deploying an OVF package. This attribute will always be present in the result when retrieving information about an OVF package.
default_choice (bool) – A bool flag indicates whether this deployment option is the default choice. This attribute is not used in the input parameters when deploying an OVF package. This attribute is optional in the result when retrieving information about an OVF package. If None or false, it is not the default.

class com.vmware.vcenter.ovf_client.DeploymentOptionParams(deployment_options=None, selected_key=None, type=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The DeploymentOptionParams class describes the possible deployment options as well as the choice provided by the user.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters:

deployment_options (list of DeploymentOption) – list of deployment options. This attribute corresponds to the ovf:Configuration elements of the ovf:DeploymentOptionSection in the specification. It is a discrete set of intended resource allocation configurations from which one can be selected. This attribute is not used in the input parameters when deploying an OVF package. This attribute will always be present in the result when retrieving information about an OVF package.
selected_key (str) – The selected deployment option. Identifies the DeploymentOption in the list in the deploymentOptions attribute with a matching value in the DeploymentOption.key attribute. This attribute is optional in the input parameters when deploying an OVF package. If None the server will use the default deployment configuration, usually it’s the first one in DeploymentOptionParams.deployment_options list. This attribute is optional in the result when retrieving information about an OVF package. The value will be set only if it is specified with the optional ovf:default attribute.
type (str) – Unique identifier describing the type of the OVF parameters. The value is the name of the OVF parameters class. This attribute must be provided in the input parameters when deploying an OVF package. This attribute will always be present in the result when retrieving information about an OVF package.

class com.vmware.vcenter.ovf_client.DiskProvisioningType(string)¶

Bases: vmware.vapi.bindings.enum.Enum

The DiskProvisioningType class defines the virtual disk provisioning types that can be set for a disk on the target platform.

Note

This class represents an enumerated type in the interface language definition. The class contains class attributes which represent the values in the current version of the enumerated type. Newer versions of the enumerated type may contain new values. To use new values of the enumerated type in communication with a server that supports the newer version of the API, you instantiate this class. See enumerated type description page.

Parameters:	string (`str`) – String value for the `DiskProvisioningType` instance.

eagerZeroedThick = DiskProvisioningType(string=u'eagerZeroedThick')¶

An eager zeroed thick provisioned virtual disk has all space allocated and wiped clean of any previous contents on the physical media at creation time.

Disks specified as eager zeroed thick may take longer time to create than disks specified with the other disk provisioning types.

thick = DiskProvisioningType(string=u'thick')¶: A thick provisioned virtual disk has all space allocated at creation time and the space is zeroed on demand as the space is used.

thin = DiskProvisioningType(string=u'thin')¶: A thin provisioned virtual disk has space allocated and zeroed on demand as the space is used.

class com.vmware.vcenter.ovf_client.ExportFlag(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

The ExportFlag class provides methods for retrieving information about the export flags supported by the server. Export flags can be specified in a LibraryItem.CreateSpec to customize an OVF export.

Parameters:	config (`vmware.vapi.bindings.stub.StubConfiguration`) – Configuration to be used for creating the stub.

class Info(option=None, description=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The ExportFlag.Info class describes an export flag supported by the server.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters:	option (`str`) – The name of the export flag that is supported by the server. description (`com.vmware.vapi.std_client.LocalizableMessage`) – Localizable description of the export flag.

ExportFlag.list()¶

Returns information about the supported export flags by the server.

PRESERVE_MAC: Include MAC addresses for network adapters.
EXTRA_CONFIG: Include extra configuration in OVF export.

Future server versions might support additional flags.

Return type:

list of ExportFlag.Info

Returns:

A list of supported export flags.

Raise:

com.vmware.vapi.std.errors_client.Unauthorized if you do not have all of the privileges described as follows:

Method execution requires System.Read.

class com.vmware.vcenter.ovf_client.ExtraConfig(key=None, value=None, virtual_system_id=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The ExtraConfig class contains the information about a vmw:ExtraConfig element which can be used to specify configuration settings that are transferred directly to the .vmx file. The behavior of the vmw:ExtraConfig element is similar to the extraConfig property of the VirtualMachineConfigSpec object in the VMware vSphere API. Thus, the same restrictions apply, such as you cannot set values that could otherwise be set with other properties in the VirtualMachineConfigSpec object. See the VMware vSphere API reference for details on this.

vmw:ExtraConfig elements may occur as direct child elements of a VirtualHardwareSection, or as child elements of individual virtual hardware items.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters:

key (str) – The key of the ExtraConfig element. This attribute must be provided in the input parameters when deploying an OVF package. This attribute will always be present in the result when retrieving information about an OVF package.
value (str) – The value of the ExtraConfig element. This attribute must be provided in the input parameters when deploying an OVF package. This attribute will always be present in the result when retrieving information about an OVF package.
virtual_system_id (str) – The identifier of the virtual system containing the vmw:ExtraConfig element. This attribute is not used in the input parameters when deploying an OVF package. This attribute will always be present in the result when retrieving information about an OVF package.

class com.vmware.vcenter.ovf_client.ExtraConfigParams(extra_configs=None, exclude_keys=None, include_keys=None, type=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The ExtraConfigParams class contains the parameters with information about the vmw:ExtraConfig elements in an OVF package.

vmw:ExtraConfig elements can be used to specify configuration settings that are transferred directly to the .vmx file.

The behavior of the vmw:ExtraConfig element is similar to the extraConfig property of the VirtualMachineConfigSpec object in the VMware vSphere API. Thus, the same restrictions apply, such as you cannot set values that could otherwise be set with other properties in the VirtualMachineConfigSpec object. See the VMware vSphere API reference for details on this.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters:

extra_configs (list of ExtraConfig) – list of vmw:ExtraConfig elements in the OVF package. This attribute is optional in the input parameters when deploying an OVF package. If None there are no extra configuration elements to use for this OVF package deployment. This attribute will always be present in the result when retrieving information about an OVF package. It will be an empty list if there are no extra configuration elements in the OVF package.
exclude_keys (list of str) –
Specifies which extra configuration items in the list in the extraConfigs field should be ignored during deployment.

If set, the given keys for extra configurations will be ignored during deployment. The key is defined in the ExtraConfig.key attribute. This attribute is optional in the input parameters when deploying an OVF package. It is an error to set both this and ExtraConfigParams.include_keys. This attribute is optional in the result when retrieving information about an OVF package. It is an error to set both this and ExtraConfigParams.include_keys.
include_keys (list of str) –
Specifies which extra configuration items in the list in the extraConfigs field should be included during deployment.

If set, all but the given keys for extra configurations will be ignored during deployment. The key is defined in the ExtraConfig.key attribute. This attribute is optional in the input parameters when deploying an OVF package. It is an error to set both this and ExtraConfigParams.exclude_keys. This attribute is optional in the result when retrieving information about an OVF package. It is an error to set both this and ExtraConfigParams.exclude_keys.
type (str) – Unique identifier describing the type of the OVF parameters. The value is the name of the OVF parameters class. This attribute must be provided in the input parameters when deploying an OVF package. This attribute will always be present in the result when retrieving information about an OVF package.

class com.vmware.vcenter.ovf_client.ImportFlag(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

The ImportFlag class provides methods for retrieving information about the import flags supported by the deployment platform. Import flags can be specified in a LibraryItem.ResourcePoolDeploymentSpec to customize an OVF deployment.

Parameters:	config (`vmware.vapi.bindings.stub.StubConfiguration`) – Configuration to be used for creating the stub.

class Info(option=None, description=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The ImportFlag.Info class describes an import flag supported by the deployment platform.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters:	option (`str`) – The name of the import flag that is supported by the deployment platform. description (`com.vmware.vapi.std_client.LocalizableMessage`) – Localizable description of the import flag.

ImportFlag.list(rp)¶

Returns information about the import flags supported by the deployment platform.

LAX: Lax mode parsing of the OVF descriptor.

Future server versions might support additional flags.

Parameters:	rp (`str`) – The identifier of resource pool target for retrieving the import flag(s). The parameter must be an identifier for the resource type: `ResourcePool`.
Return type:	`list` of `ImportFlag.Info`
Returns:	A `list` of supported import flags.
Raise:	`com.vmware.vapi.std.errors_client.NotFound` If the resource pool associated with `rp` does not exist.
Raise:	`com.vmware.vapi.std.errors_client.Unauthorized` if you do not have all of the privileges described as follows: Method execution requires `System.Read`. The resource `ResourcePool` referenced by the parameter `rp` requires `System.Read`.

class com.vmware.vcenter.ovf_client.IpAllocationParams(supported_allocation_scheme=None, supported_ip_allocation_policy=None, ip_allocation_policy=None, supported_ip_protocol=None, ip_protocol=None, type=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The IpAllocationParams class specifies how IP addresses are allocated to OVF properties. In particular, it informs the deployment platform whether the guest supports IPv4, IPv6, or both. It also specifies whether the IP addresses can be obtained through DHCP or through the properties provided in the OVF environment.

Ovf Property elements are exposed to the guest software through the OVF environment. Each Property element exposed in the OVF environment shall be constructed from the value of the ovf:key attribute. A Property element contains a key/value pair, it may optionally specify type qualifiers using the ovf:qualifiers attribute with multiple qualifiers separated by commas.

The settings in IpAllocationParams class are global to a deployment. Thus, if a virtual machine is part of a virtual appliance, then its settings are ignored and the settings for the virtual appliance is used.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters:

supported_allocation_scheme (list of IpAllocationParams.IpAllocationScheme) – Specifies the IP allocation schemes supported by the guest software. This attribute defines the valid values for the IP allocation policy. This setting is often configured by the virtual appliance template author or OVF package author to reflect what the guest software supports, and the IP allocation policy is configured at deployment time. See IpAllocationParams.ip_allocation_policy. This attribute is not used in the input parameters when deploying an OVF package. This attribute will always be present in the result when retrieving information about an OVF package.
supported_ip_allocation_policy (list of IpAllocationParams.IpAllocationPolicy) – Specifies the IP allocation policies supported. The set of valid options for the policy is based on the capabilities of the virtual appliance software, as specified by the IpAllocationParams.supported_allocation_scheme attribute. This attribute is not used in the input parameters when deploying an OVF package. This attribute will always be present in the result when retrieving information about an OVF package.
ip_allocation_policy (IpAllocationParams.IpAllocationPolicy) – Specifies how IP allocation is done through an IP Pool. This is typically specified by the deployer. This attribute is optional in the input parameters when deploying an OVF package. If None there is no IP allocation policy. This attribute will always be present in the result when retrieving information about an OVF package.
supported_ip_protocol (list of IpAllocationParams.IpProtocol) – Specifies the IP protocols supported by the guest. This attribute is not used in the input parameters when deploying an OVF package. This attribute will always be present in the result when retrieving information about an OVF package.
ip_protocol (IpAllocationParams.IpProtocol) – Specifies the chosen IP protocol for this deployment. This must be one of the IP protocols supported by the guest software. See IpAllocationParams.supported_ip_protocol. This attribute is optional in the input parameters when deploying an OVF package. If None there is no IP protocol chosen. This attribute will always be present in the result when retrieving information about an OVF package.
type (str) – Unique identifier describing the type of the OVF parameters. The value is the name of the OVF parameters class. This attribute must be provided in the input parameters when deploying an OVF package. This attribute will always be present in the result when retrieving information about an OVF package.

class IpAllocationPolicy(string)¶

Bases: vmware.vapi.bindings.enum.Enum

The IpAllocationParams.IpAllocationPolicy class defines the possible IP allocation policy for a deployment.

Note

This class represents an enumerated type in the interface language definition. The class contains class attributes which represent the values in the current version of the enumerated type. Newer versions of the enumerated type may contain new values. To use new values of the enumerated type in communication with a server that supports the newer version of the API, you instantiate this class. See enumerated type description page.

Parameters:	string (`str`) – String value for the `IpAllocationPolicy` instance.

DHCP = IpAllocationPolicy(string=u'DHCP')¶: Specifies that DHCP will be used to allocate IP addresses.

STATIC_IPPOOL = IpAllocationPolicy(string=u'STATIC_IPPOOL')¶: Specifies that IP addresses are allocated from the range managed by an IP pool. The IP addresses are allocated at first power-on, and remain allocated at power-off. This ensures that a virtual appliance gets a consistent IP for its life-time.

STATIC_MANUAL = IpAllocationPolicy(string=u'STATIC_MANUAL')¶: Specifies that IP addresses are configured manually upon deployment, and will be kept until reconfigured or the virtual appliance destroyed. This ensures that a property gets a consistent IP for its lifetime.

TRANSIENT_IPPOOL = IpAllocationPolicy(string=u'TRANSIENT_IPPOOL')¶: Specifies that IP addresses are allocated from an IP pool. The IP addresses are allocated when needed, typically at power-on, and deallocated during power-off. There is no guarantee that a property will receive same IP address when restarted.

class IpAllocationParams.IpAllocationScheme(string)¶

Bases: vmware.vapi.bindings.enum.Enum

The IpAllocationParams.IpAllocationScheme class defines the possible IP allocation schemes that can be supported by the guest software.

Note

This class represents an enumerated type in the interface language definition. The class contains class attributes which represent the values in the current version of the enumerated type. Newer versions of the enumerated type may contain new values. To use new values of the enumerated type in communication with a server that supports the newer version of the API, you instantiate this class. See enumerated type description page.

Parameters:	string (`str`) – String value for the `IpAllocationScheme` instance.

DHCP = IpAllocationScheme(string=u'DHCP')¶: It supports DHCP to acquire IP configuration.

OVF_ENVIRONMENT = IpAllocationScheme(string=u'OVF_ENVIRONMENT')¶: It supports setting the IP configuration through the properties provided in the OVF environment.

class IpAllocationParams.IpProtocol(string)¶

Bases: vmware.vapi.bindings.enum.Enum

The IpAllocationParams.IpProtocol class defines the IP protocols supported by the guest software.

Note

This class represents an enumerated type in the interface language definition. The class contains class attributes which represent the values in the current version of the enumerated type. Newer versions of the enumerated type may contain new values. To use new values of the enumerated type in communication with a server that supports the newer version of the API, you instantiate this class. See enumerated type description page.

Parameters:	string (`str`) – String value for the `IpProtocol` instance.

IPV4 = IpProtocol(string=u'IPV4')¶: It supports the IPv4 protocol.

IPV6 = IpProtocol(string=u'IPV6')¶: It supports the IPv6 protocol.

class com.vmware.vcenter.ovf_client.LibraryItem(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

The LibraryItem class provides methods to deploy virtual machines and virtual appliances from library items containing Open Virtualization Format (OVF) packages in content library, as well as methods to create library items in content library from virtual machines and virtual appliances.

Create a LibraryItem.DeploymentTarget to specify the target deployment type and target deployment designation.
Create a LibraryItem.ResourcePoolDeploymentSpec to specify the parameters for the target deployment.
Use the deploy method with the created target and parameter specifications, along with the identifier of the specified source content library item. See LibraryItem.deploy().

To create a library item in content library from a virtual machine or virtual appliance:

Create a LibraryItem.DeployableIdentity to specify the source virtual machine or virtual appliance to be used as the OVF template source.
Create a LibraryItem.CreateTarget to specify the target library and library item.
Create a LibraryItem.CreateSpec to specify the settings for the OVF package to be created.
Use the create method with the created target and parameter specifications, along with the specified source entity. See LibraryItem.create().

Parameters:	config (`vmware.vapi.bindings.stub.StubConfiguration`) – Configuration to be used for creating the stub.

class CreateResult(succeeded=None, ovf_library_item_id=None, error=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The LibraryItem.CreateResult class defines the result of the create method. See LibraryItem.create().

Tip

The arguments are used to initialize data attributes with the same names.

Parameters:

succeeded (bool) – Whether the create method completed successfully.
ovf_library_item_id (str or None) – Identifier of the created or updated library item. When clients pass a value of this class as a parameter, the attribute must be an identifier for the resource type: com.vmware.content.library.Item. When methods return a value of this class as a return value, the attribute will be an identifier for the resource type: com.vmware.content.library.Item. If None, the create method failed and LibraryItem.CreateResult.error will describe the error(s) that caused the failure.
error (LibraryItem.ResultInfo or None) – Errors, warnings, and informational messages produced by the create method. If None, no errors, warnings, or informational messages were reported by the create method.

class LibraryItem.CreateSpec(name=None, description=None, flags=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The LibraryItem.CreateSpec class defines the information used to create or update a library item containing an OVF package.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters:

name (str or None) – Name to use in the OVF descriptor stored in the library item. If None, the server will use source’s current name.
description (str or None) – Description to use in the OVF descriptor stored in the library item. If None, the server will use source’s current annotation.
flags (list of str or None) – Flags to use for OVF package creation. The supported flags can be obtained using ExportFlag.list(). If None, no flags will be used.

class LibraryItem.CreateTarget(library_id=None, library_item_id=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The LibraryItem.CreateTarget class specifies the target library item when capturing a virtual machine or virtual appliance as an OVF package in a library item in a content library. The target can be an existing library item, which will be updated, creating a new version, or it can be a newly created library item in a specified library. See LibraryItem.create().

Tip

The arguments are used to initialize data attributes with the same names.

Parameters:

library_id (str or None) – Identifier of the library in which a new library item should be created. This attribute is not used if the libraryItemId attribute is specified. When clients pass a value of this class as a parameter, the attribute must be an identifier for the resource type: com.vmware.content.Library. When methods return a value of this class as a return value, the attribute will be an identifier for the resource type: com.vmware.content.Library. If None, the libraryItemId attribute must be specified.
library_item_id (str or None) – Identifier of the library item that should be should be updated. When clients pass a value of this class as a parameter, the attribute must be an identifier for the resource type: com.vmware.content.library.Item. When methods return a value of this class as a return value, the attribute will be an identifier for the resource type: com.vmware.content.library.Item. If None, a new library item will be created. The libraryId attribute must be specified if this attribute is None.

LibraryItem.DEPLOYABLE = ['VirtualMachine', 'VirtualApp']¶: The types of resources that can be created by deploying an OVF package and can be captured to create a library item using the LibraryItem class.

class LibraryItem.DeployableIdentity(type=None, id=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The LibraryItem.DeployableIdentity class describes the resource created by a deployment, or the source resource from which library item can be created, by specifying its resource type and resource identifier.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters:

type (str) – Type of the deployable resource. When clients pass a value of this class as a parameter, the attribute must be one of VirtualMachine or VirtualApp. When methods return a value of this class as a return value, the attribute will be one of VirtualMachine or VirtualApp.
id (str) – Identifier of the deployable resource. When clients pass a value of this class as a parameter, the attribute type must contain the actual resource type. When methods return a value of this class as a return value, the attribute type will contain the actual resource type.

class LibraryItem.DeploymentResult(succeeded=None, resource_id=None, error=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The LibraryItem.DeploymentResult class defines the result of the deploy method. See LibraryItem.deploy().

Tip

The arguments are used to initialize data attributes with the same names.

Parameters:

succeeded (bool) – Whether the deploy method completed successfully.
resource_id (LibraryItem.DeployableIdentity or None) – Identifier of the deployed resource entity. If None, the deploy method failed and LibraryItem.DeploymentResult.error will describe the error(s) that caused the failure.
error (LibraryItem.ResultInfo or None) – Errors, warnings, and informational messages produced by the deploy method. If None, no errors, warnings, or informational messages were reported by the deploy method.

class LibraryItem.DeploymentTarget(resource_pool_id=None, host_id=None, folder_id=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The LibraryItem.DeploymentTarget class describes the location (target) where a virtual machine or virtual appliance should be deployed. It is used in the deploy and filter methods. See LibraryItem.deploy() and LibraryItem.filter().

Tip

The arguments are used to initialize data attributes with the same names.

Parameters:

resource_pool_id (str) – Identifier of the resource pool to which the virtual machine or virtual appliance should be attached. When clients pass a value of this class as a parameter, the attribute must be an identifier for the resource type: ResourcePool. When methods return a value of this class as a return value, the attribute will be an identifier for the resource type: ResourcePool.
host_id (str or None) – Identifier of the target host on which the virtual machine or virtual appliance will run. The target host must be a member of the cluster that contains the resource pool identified by LibraryItem.DeploymentTarget.resource_pool_id. When clients pass a value of this class as a parameter, the attribute must be an identifier for the resource type: HostSystem. When methods return a value of this class as a return value, the attribute will be an identifier for the resource type: HostSystem. If None, the server will automatically select a target host from the resource pool if LibraryItem.DeploymentTarget.resource_pool_id is a stand-alone host or a cluster with Distributed Resource Scheduling (DRS) enabled.
folder_id (str or None) – Identifier of the vCenter folder that should contain the virtual machine or virtual appliance. The folder must be virtual machine folder. When clients pass a value of this class as a parameter, the attribute must be an identifier for the resource type: Folder. When methods return a value of this class as a return value, the attribute will be an identifier for the resource type: Folder. If None, the server will choose the deployment folder.

class LibraryItem.OvfSummary(name=None, annotation=None, eulas=None, networks=None, storage_groups=None, additional_params=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The LibraryItem.OvfSummary class defines the result of the filter method. See LibraryItem.filter(). The attributes in the class describe parameterizable information in the OVF descriptor, with respect to a deployment target, for the deploy method. See LibraryItem.deploy().

Tip

The arguments are used to initialize data attributes with the same names.

Parameters:

name (str or None) – Default name for the virtual machine or virtual appliance. If None, the OVF descriptor did not specify a name.
annotation (str or None) – Default annotation for the virtual machine or virtual appliance. If None, the OVF descriptor did not specify an annotation.
eulas (list of str) – End User License Agreements specified in the OVF descriptor. All end user license agreements must be accepted in order for the deploy method to succeed. See LibraryItem.ResourcePoolDeploymentSpec.accept_all_eula.
networks (list of str or None) – Section identifiers for sections of type ovf:NetworkSection in the OVF descriptor. These identifiers can be used as keys in LibraryItem.ResourcePoolDeploymentSpec.network_mappings. If None, the OVF descriptor did not specify any networks.
storage_groups (list of str or None) – Section identifiers for sections of type vmw:StorageGroupSection in the OVF descriptor. These identifiers can be used as keys in LibraryItem.ResourcePoolDeploymentSpec.storage_mappings. If None, the OVF descriptor did not specify any storage groups.
additional_params (list of vmware.vapi.struct.VapiStruct or None) – Additional OVF parameters which can be specified for the deployment target. These OVF parameters can be inspected, optionally modified, and used as values in LibraryItem.ResourcePoolDeploymentSpec.additional_parameters for the deploy method. When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined in OvfParams. When methods return a value of this class as a return value, the attribute will contain all the attributes defined in OvfParams. If None, the OVF descriptor does not require addtional parameters or does not have additional parameters suitable for the deployment target.

class LibraryItem.ResourcePoolDeploymentSpec(name=None, annotation=None, accept_all_eula=None, network_mappings=None, storage_mappings=None, storage_provisioning=None, storage_profile_id=None, locale=None, flags=None, additional_parameters=None, default_datastore_id=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The LibraryItem.ResourcePoolDeploymentSpec class defines the deployment parameters that can be specified for the deploy method where the deployment target is a resource pool. See LibraryItem.deploy().

Tip

The arguments are used to initialize data attributes with the same names.

Parameters:

name (str or None) – Name assigned to the deployed target virtual machine or virtual appliance. If None, the server will use the name from the OVF package.
annotation (str or None) – Annotation assigned to the deployed target virtual machine or virtual appliance. If None, the server will use the annotation from the OVF package.
accept_all_eula (bool) – Whether to accept all End User License Agreements. See LibraryItem.OvfSummary.eulas.
network_mappings ((dict of str and str) or None) – Specification of the target network to use for sections of type ovf:NetworkSection in the OVF descriptor. The key in the dict is the section identifier of the ovf:NetworkSection section in the OVF descriptor and the value is the target network to be used for deployment. When clients pass a value of this class as a parameter, the value in the attribute dict must be an identifier for the resource type: Network. When methods return a value of this class as a return value, the value in the attribute dict will be an identifier for the resource type: Network. If None, the server will choose a network mapping.
storage_mappings ((dict of str and LibraryItem.StorageGroupMapping) or None) – Specification of the target storage to use for sections of type vmw:StorageGroupSection in the OVF descriptor. The key in the dict is the section identifier of the ovf:StorageGroupSection section in the OVF descriptor and the value is the target storage specification to be used for deployment. See LibraryItem.StorageGroupMapping. If None, the server will choose a storage mapping.
storage_provisioning (DiskProvisioningType or None) – Default storage provisioning type to use for all sections of type vmw:StorageSection in the OVF descriptor. If None, the server will choose the provisioning type.
storage_profile_id (str or None) – Default storage profile to use for all sections of type vmw:StorageSection in the OVF descriptor. When clients pass a value of this class as a parameter, the attribute must be an identifier for the resource type: StorageProfile. When methods return a value of this class as a return value, the attribute will be an identifier for the resource type: StorageProfile. If None, the server will choose the default profile.
locale (str or None) – The locale to use for parsing the OVF descriptor. If None, the server locale will be used.
flags (list of str or None) – Flags to be use for deployment. The supported flag values can be obtained using ImportFlag.list(). If None, no flags will be used.
additional_parameters (list of vmware.vapi.struct.VapiStruct or None) –
Additional OVF parameters that may be needed for the deployment. Additional OVF parameters may be required by the OVF descriptor of the OVF package in the library item. Examples of OVF parameters that can be specified through this attribute include, but are not limited to:
When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined in OvfParams. When methods return a value of this class as a return value, the attribute will contain all the attributes defined in OvfParams. If None, the server will choose default settings for all parameters necessary for the deploy method. See LibraryItem.deploy().
default_datastore_id (str or None) – Default datastore to use for all sections of type vmw:StorageSection in the OVF descriptor. When clients pass a value of this class as a parameter, the attribute must be an identifier for the resource type: Datastore. When methods return a value of this class as a return value, the attribute will be an identifier for the resource type: Datastore. If None, the server will choose the default datastore.

class LibraryItem.ResultInfo(errors=None, warnings=None, information=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The LibraryItem.ResultInfo class defines the information returned along with the result of a create or deploy method to describe errors, warnings, and informational messages produced by the server.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters:

errors (list of OvfError) – Errors reported by the create or deploy method. These errors would have prevented the create or deploy method from completing successfully.
warnings (list of OvfWarning) – Warnings reported by the create or deploy method. These warnings would not have prevented the create or deploy method from completing successfully, but there might be issues that warrant attention.
information (list of OvfInfo) – Information messages reported by the create or deploy method. For example, a non-required parameter was ignored.

class LibraryItem.StorageGroupMapping(type=None, datastore_id=None, storage_profile_id=None, provisioning=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The LibraryItem.StorageGroupMapping class defines the storage deployment target and storage provisioning type for a section of type vmw:StorageGroupSection in the OVF descriptor.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters:

type (LibraryItem.StorageGroupMapping.Type) – Type of storage deployment target to use for the vmw:StorageGroupSection section. The specified value must be LibraryItem.StorageGroupMapping.Type.DATASTORE or LibraryItem.StorageGroupMapping.Type.STORAGE_PROFILE.
datastore_id (str) – Target datastore to be used for the storage group. When clients pass a value of this class as a parameter, the attribute must be an identifier for the resource type: Datastore. When methods return a value of this class as a return value, the attribute will be an identifier for the resource type: Datastore. This attribute is optional and it is only relevant when the value of type is LibraryItem.StorageGroupMapping.Type.DATASTORE.
storage_profile_id (str) – Target storage profile to be used for the storage group. When clients pass a value of this class as a parameter, the attribute must be an identifier for the resource type: StorageProfile. When methods return a value of this class as a return value, the attribute will be an identifier for the resource type: StorageProfile. This attribute is optional and it is only relevant when the value of type is LibraryItem.StorageGroupMapping.Type.STORAGE_PROFILE.
provisioning (DiskProvisioningType or None) – Target provisioning type to use for the storage group. If None, LibraryItem.ResourcePoolDeploymentSpec.storage_provisioning will be used.

class Type(string)¶

Bases: vmware.vapi.bindings.enum.Enum

The LibraryItem.StorageGroupMapping.Type class defines the supported types of storage targets for sections of type vmw:StroageGroupSection in the OVF descriptor.

Note

This class represents an enumerated type in the interface language definition. The class contains class attributes which represent the values in the current version of the enumerated type. Newer versions of the enumerated type may contain new values. To use new values of the enumerated type in communication with a server that supports the newer version of the API, you instantiate this class. See enumerated type description page.

Parameters:	string (`str`) – String value for the `Type` instance.

DATASTORE = Type(string=u'DATASTORE')¶: Storage deployment target is a datastore.

STORAGE_PROFILE = Type(string=u'STORAGE_PROFILE')¶: Storage deployment target is a storage profile.

LibraryItem.create(source, target, create_spec, client_token=None)¶

Creates a library item in content library from a virtual machine or virtual appliance.

This method creates a library item in content library whose content is an OVF package derived from a source virtual machine or virtual appliance, using the supplied create specification. The OVF package may be stored as in a newly created library item or in an in an existing library item. For an existing library item whose content is updated by this method, the original content is overwritten.

Parameters:	client_token (`str` or `None`) – Client-generated token used to retry a request if the client fails to get a response from the server. If the original request succeeded, the result of that request will be returned, otherwise the operation will be retried. If None, the server will create a token. source (`LibraryItem.DeployableIdentity`) – Identifier of the virtual machine or virtual appliance to use as the source. target (`LibraryItem.CreateTarget`) – Specification of the target content library and library item. create_spec (`LibraryItem.CreateSpec`) – Information used to create the OVF package from the source virtual machine or virtual appliance.
Return type:	`LibraryItem.CreateResult`
Returns:	Information about the success or failure of the method, along with the details of the result or failure.
Raise:	`com.vmware.vapi.std.errors_client.InvalidArgument` if `create_spec` contains invalid arguments.
Raise:	`com.vmware.vapi.std.errors_client.InvalidArgument` if `source` describes an unexpected resource type.
Raise:	`com.vmware.vapi.std.errors_client.NotFound` if the virtual machine or virtual appliance specified by `source` does not exist.
Raise:	`com.vmware.vapi.std.errors_client.NotFound` if the library or library item specified by `target` does not exist.
Raise:	`com.vmware.vapi.std.errors_client.NotAllowedInCurrentState` if the operation cannot be performed because of the specified virtual machine or virtual appliance’s current state. For example, if the virtual machine configuration information is not available, or if the virtual appliance is running.
Raise:	`com.vmware.vapi.std.errors_client.ResourceInaccessible` if there was an error accessing a file from the source virtual machine or virtual appliance.
Raise:	`com.vmware.vapi.std.errors_client.ResourceBusy` if the specified virtual machine or virtual appliance is busy.
Raise:	`com.vmware.vapi.std.errors_client.Unauthorized` if you do not have all of the privileges described as follows: Method execution requires `System.Read`. The attribute `LibraryItem.DeployableIdentity.id` requires `VApp.Export`. The resource `com.vmware.content.Library` referenced by the attribute `LibraryItem.CreateTarget.library_id` requires `ContentLibrary.AddLibraryItem`. The resource `com.vmware.content.library.Item` referenced by the attribute `LibraryItem.CreateTarget.library_item_id` requires `System.Read`.

LibraryItem.deploy(ovf_library_item_id, target, deployment_spec, client_token=None)¶

Deploys an OVF package stored in content library to a newly created virtual machine or virtual appliance.

This method deploys an OVF package which is stored in the library item specified by ovf_library_item_id. It uses the deployment specification in deployment_spec to deploy the OVF package to the location specified by target.

Parameters:	client_token (`str` or `None`) – Client-generated token used to retry a request if the client fails to get a response from the server. If the original request succeeded, the result of that request will be returned, otherwise the operation will be retried. If None, the server will create a token. ovf_library_item_id (`str`) – Identifier of the content library item containing the OVF package to be deployed. The parameter must be an identifier for the resource type: `com.vmware.content.library.Item`. target (`LibraryItem.DeploymentTarget`) – Specification of the deployment target. deployment_spec (`LibraryItem.ResourcePoolDeploymentSpec`) – Specification of how the OVF package should be deployed to the target.
Return type:	`LibraryItem.DeploymentResult`
Returns:	Information about the success or failure of the method, along with the details of the result or failure.
Raise:	`com.vmware.vapi.std.errors_client.InvalidArgument` if `target` contains invalid arguments.
Raise:	`com.vmware.vapi.std.errors_client.InvalidArgument` if `deployment_spec` contains invalid arguments or has attributes that are inconsistent with `target`.
Raise:	`com.vmware.vapi.std.errors_client.NotFound` if the library item specified by `ovf_library_item_id` does not exist.
Raise:	`com.vmware.vapi.std.errors_client.NotFound` if any resource specified by a attribute of the `LibraryItem.DeploymentTarget` class, specified by `target`, does not exist.
Raise:	`com.vmware.vapi.std.errors_client.ResourceInaccessible` if there was an error accessing the OVF package stored in the library item specified by `ovf_library_item_id`.
Raise:	`com.vmware.vapi.std.errors_client.Unauthorized` if you do not have all of the privileges described as follows : Method execution requires VirtualMachine.Config.AddNewDisk if the OVF descriptor has a disk drive (type 17) section. Method execution requires VirtualMachine.Config.AdvancedConfig if the OVF descriptor has an ExtraConfig section. Method execution requires Extension.Register for specified resource group if the OVF descriptor has a vServiceDependency section. Method execution requires Network.Assign for target network if specified. Method execution requires Datastore.AllocateSpace for target datastore if specified.
Raise:	`com.vmware.vapi.std.errors_client.Unauthorized` if you do not have all of the privileges described as follows: Method execution requires `System.Read`. The resource `com.vmware.content.library.Item` referenced by the parameter `ovf_library_item_id` requires `System.Read`. The resource `HostSystem` referenced by the attribute `LibraryItem.DeploymentTarget.host_id` requires `System.Read`. The resource `Network` referenced by the `dict` value of attribute `LibraryItem.ResourcePoolDeploymentSpec.network_mappings` requires `System.Read`. The resource `StorageProfile` referenced by the attribute `LibraryItem.ResourcePoolDeploymentSpec.storage_profile_id` requires `System.Read`. The resource `Datastore` referenced by the attribute `LibraryItem.ResourcePoolDeploymentSpec.default_datastore_id` requires `System.Read`. The resource `ResourcePool` referenced by the attribute `LibraryItem.DeploymentTarget.resource_pool_id` requires `VApp.Import`. The resource `Folder` referenced by the attribute `LibraryItem.DeploymentTarget.folder_id` requires `VApp.Import`.

LibraryItem.filter(ovf_library_item_id, target)¶

Queries an OVF package stored in content library to retrieve information to use when deploying the package. See LibraryItem.deploy().

This method retrieves information from the descriptor of the OVF package stored in the library item specified by ovf_library_item_id. The information returned by the method can be used to populate the deployment specification (see LibraryItem.ResourcePoolDeploymentSpec when deploying the OVF package to the deployment target specified by target.

Parameters:	ovf_library_item_id (`str`) – Identifier of the content library item containing the OVF package to query. The parameter must be an identifier for the resource type: `com.vmware.content.library.Item`. target (`LibraryItem.DeploymentTarget`) – Specification of the deployment target.
Return type:	`LibraryItem.OvfSummary`
Returns:	Information that can be used to populate the deployment specification (see `LibraryItem.ResourcePoolDeploymentSpec`) when deploying the OVF package to the deployment target specified by `target`.
Raise:	`com.vmware.vapi.std.errors_client.InvalidArgument` if `target` contains invalid arguments.
Raise:	`com.vmware.vapi.std.errors_client.NotFound` if the library item specified by `ovf_library_item_id` does not exist.
Raise:	`com.vmware.vapi.std.errors_client.NotFound` if any resource specified by a attribute of the `LibraryItem.DeploymentTarget` class, specified by `target`, does not exist.
Raise:	`com.vmware.vapi.std.errors_client.ResourceInaccessible` if there was an error accessing the OVF package at the specified `ovf_library_item_id`.
Raise:	`com.vmware.vapi.std.errors_client.Unauthorized` if you do not have all of the privileges described as follows: Method execution requires `System.Read`. The resource `com.vmware.content.library.Item` referenced by the parameter `ovf_library_item_id` requires `System.Read`. The resource `ResourcePool` referenced by the attribute `LibraryItem.DeploymentTarget.resource_pool_id` requires `System.Read`. The resource `HostSystem` referenced by the attribute `LibraryItem.DeploymentTarget.host_id` requires `System.Read`. The resource `Folder` referenced by the attribute `LibraryItem.DeploymentTarget.folder_id` requires `System.Read`.

class com.vmware.vcenter.ovf_client.OvfError(category=None, issues=None, name=None, value=None, message=None, error=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The OvfError class describes an error related to accessing, validating, deploying, or exporting an OVF package.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters:

category (OvfMessage.Category) – The message category.
issues (list of ParseIssue) – list of parse issues (see ParseIssue). This attribute is optional and it is only relevant when the value of category is OvfMessage.Category.VALIDATION.
name (str) – The name of input parameter. This attribute is optional and it is only relevant when the value of category is OvfMessage.Category.INPUT.
value (str) – The value of input parameter. This attribute is optional and it is only relevant when the value of category is OvfMessage.Category.INPUT.
message (com.vmware.vapi.std_client.LocalizableMessage) – A localizable message. This attribute is optional and it is only relevant when the value of category is OvfMessage.Category.INPUT.
error (vmware.vapi.struct.VapiStruct) – Represents a server com.vmware.vapi.std.errors_client.Error. When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined in com.vmware.vapi.std.errors_client.Error. When methods return a value of this class as a return value, the attribute will contain all the attributes defined in com.vmware.vapi.std.errors_client.Error. This attribute is optional and it is only relevant when the value of category is OvfMessage.Category.SERVER.

class com.vmware.vcenter.ovf_client.OvfInfo(messages=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The OvfInfo class contains informational messages related to accessing, validating, deploying, or exporting an OVF package.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters:	messages (`list` of `com.vmware.vapi.std_client.LocalizableMessage`) – A `list` of localizable messages (see `com.vmware.vapi.std_client.LocalizableMessage`).

class com.vmware.vcenter.ovf_client.OvfMessage(category=None, issues=None, name=None, value=None, message=None, error=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The OvfMessage class describes a base OVF handling error message related to accessing, validating, deploying, or exporting an OVF package.

These messages fall into different categories defined in OvfMessage.Category:

Tip

The arguments are used to initialize data attributes with the same names.

Parameters:

category (OvfMessage.Category) – The message category.
issues (list of ParseIssue) – list of parse issues (see ParseIssue). This attribute is optional and it is only relevant when the value of category is OvfMessage.Category.VALIDATION.
name (str) – The name of input parameter. This attribute is optional and it is only relevant when the value of category is OvfMessage.Category.INPUT.
value (str) – The value of input parameter. This attribute is optional and it is only relevant when the value of category is OvfMessage.Category.INPUT.
message (com.vmware.vapi.std_client.LocalizableMessage) – A localizable message. This attribute is optional and it is only relevant when the value of category is OvfMessage.Category.INPUT.
error (vmware.vapi.struct.VapiStruct) – Represents a server com.vmware.vapi.std.errors_client.Error. When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined in com.vmware.vapi.std.errors_client.Error. When methods return a value of this class as a return value, the attribute will contain all the attributes defined in com.vmware.vapi.std.errors_client.Error. This attribute is optional and it is only relevant when the value of category is OvfMessage.Category.SERVER.

class Category(string)¶

Bases: vmware.vapi.bindings.enum.Enum

The OvfMessage.Category class defines the categories of messages (see OvfMessage).

Note

This class represents an enumerated type in the interface language definition. The class contains class attributes which represent the values in the current version of the enumerated type. Newer versions of the enumerated type may contain new values. To use new values of the enumerated type in communication with a server that supports the newer version of the API, you instantiate this class. See enumerated type description page.

Parameters:	string (`str`) – String value for the `Category` instance.

INPUT = Category(string=u'INPUT')¶: The user provided input parameters are invalid.

SERVER = Category(string=u'SERVER')¶: Server error.

VALIDATION = Category(string=u'VALIDATION')¶: The OVF descriptor is invalid, for example, syntax errors or schema errors.

class com.vmware.vcenter.ovf_client.OvfParams(type=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The OvfParams class defines the common attributes for all OVF deployment parameters. OVF parameters serve several purposes:

Describe information about a given OVF package.
Describe default deployment configuration.
Describe possible deployment values based on the deployment environment.
Provide deployment-specific configuration.

Each OVF parameters class specifies a particular configurable aspect of OVF deployment. An aspect has both a query-model and a deploy-model. The query-model is used when the OVF package is queried, and the deploy-model is used when deploying an OVF package.

Most OVF parameter classes provide both informational and deployment parameters. However, some are purely informational (for example, download size) and some are purely deployment parameters (for example, the flag to indicate whether registration as a vCenter extension is accepted).

Tip

The arguments are used to initialize data attributes with the same names.

Parameters:	type (`str`) – Unique identifier describing the type of the OVF parameters. The value is the name of the OVF parameters class. This attribute must be provided in the input parameters when deploying an OVF package. This attribute will always be present in the result when retrieving information about an OVF package.

class com.vmware.vcenter.ovf_client.OvfWarning(category=None, issues=None, name=None, value=None, message=None, error=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The OvfWarning class describes a warning related to accessing, validating, deploying, or exporting an OVF package.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters:

category (OvfMessage.Category) – The message category.
issues (list of ParseIssue) – list of parse issues (see ParseIssue). This attribute is optional and it is only relevant when the value of category is OvfMessage.Category.VALIDATION.
name (str) – The name of input parameter. This attribute is optional and it is only relevant when the value of category is OvfMessage.Category.INPUT.
value (str) – The value of input parameter. This attribute is optional and it is only relevant when the value of category is OvfMessage.Category.INPUT.
message (com.vmware.vapi.std_client.LocalizableMessage) – A localizable message. This attribute is optional and it is only relevant when the value of category is OvfMessage.Category.INPUT.
error (vmware.vapi.struct.VapiStruct) – Represents a server com.vmware.vapi.std.errors_client.Error. When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined in com.vmware.vapi.std.errors_client.Error. When methods return a value of this class as a return value, the attribute will contain all the attributes defined in com.vmware.vapi.std.errors_client.Error. This attribute is optional and it is only relevant when the value of category is OvfMessage.Category.SERVER.

class com.vmware.vcenter.ovf_client.ParseIssue(category=None, file=None, line_number=None, column_number=None, message=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The ParseIssue class contains the information about the issue found when parsing an OVF package during deployment or exporting an OVF package including:

Parsing and validation error on OVF descriptor (which is an XML document), manifest and certificate files.
OVF descriptor generating and device error.
Unexpected server error.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters:

category (ParseIssue.Category) – The category of the parse issue.
file (str) – The name of the file in which the parse issue was found.
line_number (long) – The line number of the line in the file (see ParseIssue.file) where the parse issue was found (or -1 if not applicable).
column_number (long) – The position in the line (see ParseIssue.line_number) (or -1 if not applicable).
message (com.vmware.vapi.std_client.LocalizableMessage) – A localizable message describing the parse issue.

class Category(string)¶

Bases: vmware.vapi.bindings.enum.Enum

The ParseIssue.Category class defines the categories of issues that can be found when parsing files inside an OVF package (see ParseIssue) including OVF descriptor (which is an XML document), manifest and certificate files, or exporting an OVF package.

Note

This class represents an enumerated type in the interface language definition. The class contains class attributes which represent the values in the current version of the enumerated type. Newer versions of the enumerated type may contain new values. To use new values of the enumerated type in communication with a server that supports the newer version of the API, you instantiate this class. See enumerated type description page.

Parameters:	string (`str`) – String value for the `Category` instance.

ATTRIBUTE_ILLEGAL = Category(string=u'ATTRIBUTE_ILLEGAL')¶: Illegal attribute error. It indicates that an illegal attribute is set for an element in the OVF descriptor. For example, empty disks do not use format, parentRef, and populatedSize attributes, if these attributes are present in an empty disk element then will get this pasrse issue.

ATTRIBUTE_REQUIRED = Category(string=u'ATTRIBUTE_REQUIRED')¶: Required attribute error. It indicates that a required attribute is missing from an element in the OVF descriptor.

ELEMENT_ILLEGAL = Category(string=u'ELEMENT_ILLEGAL')¶: Illegal element error. It indicates that an element is present in a location which is not allowed, or found multiple elements but only one is allowed at the location in the OVF descriptor.

ELEMENT_REQUIRED = Category(string=u'ELEMENT_REQUIRED')¶: Required element error. It indicates that a required element is missing from the OVF descriptor.

ELEMENT_UNKNOWN = Category(string=u'ELEMENT_UNKNOWN')¶: Unknown element error. It indicates that an element is unsupported when parsing an OVF descriptor.

EXPORT_ERROR = Category(string=u'EXPORT_ERROR')¶: Issue during OVF export, for example, malformed deviceId, controller not found, or file backing for a device not found.

GENERATE_ERROR = Category(string=u'GENERATE_ERROR')¶: OVF descriptor (which is an XML document) generating error, for example, well-formedness errors as well as unexpected processing conditions.

INTERNAL_ERROR = Category(string=u'INTERNAL_ERROR')¶: Server encountered an unexpected error which prevented it from fulfilling the request.

PARSE_ERROR = Category(string=u'PARSE_ERROR')¶

OVF package parsing error, including:

OVF descriptor parsing errors, for example, syntax errors or schema errors.
Manifest file parsing and verification errors.
Certificate file parsing and verification errors.

SECTION_RESTRICTION = Category(string=u'SECTION_RESTRICTION')¶: Section restriction error. It indicates that a section appears in place in the OVF descriptor where it is not allowed, a section appears fewer times than is required, or a section appears more times than is allowed.

SECTION_UNKNOWN = Category(string=u'SECTION_UNKNOWN')¶: Section unknown error. It indicates that a section is unsupported when parsing an OVF descriptor.

VALIDATION_ERROR = Category(string=u'VALIDATION_ERROR')¶: An issue with the manifest and signing.

VALUE_ILLEGAL = Category(string=u'VALUE_ILLEGAL')¶: Illegal value error. For example, the value is malformed, not a number, or outside of the given range, and so on.

class com.vmware.vcenter.ovf_client.Property(class_id=None, id=None, instance_id=None, category=None, ui_optional=None, label=None, description=None, type=None, value=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The Property class contains the information about a property in an OVF package.

A property is uniquely identified by its [classid.]id[.instanceid] fully-qualified name (see Property.class_id, Property.id, and Property.instance_id). If multiple properties in an OVF package have the same fully-qualified name, then the property is excluded and cannot be set. We do warn about this during import.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters:

class_id (str) – The classId of this OVF property. This attribute is not used in the input parameters when deploying an OVF package. This attribute will always be present in the result when retrieving information about an OVF package.
id (str) – The identifier of this OVF property. This attribute must be provided in the input parameters when deploying an OVF package. This attribute will always be present in the result when retrieving information about an OVF package.
instance_id (str) – The instanceId of this OVF property. This attribute is not used in the input parameters when deploying an OVF package. This attribute will always be present in the result when retrieving information about an OVF package.
category (str) – If this is set to a non-empty string, this property starts a new category. This attribute is not used in the input parameters when deploying an OVF package. This attribute is optional in the result when retrieving information about an OVF package. If None, the property is in the same category as the previous item, otherwise, it starts a new category.
ui_optional (bool) –
Whether a category is UI optional. This is only used if this property starts a new category (see Property.category).

The value is stored in an optional attribute vmw:uioptional to the ovf:Category element. The default value is false. If this value is true, the properties within this category are optional. The UI renders this as a group with a check box, and the group is grayed out until the check box is selected. When the check box is selected, the input values are read and used in deployment. If properties within the same category specify conflicting values the default is used. Only implemented in vSphere Web Client 5.1 and later as of Nov 2012. This attribute is not used in the input parameters when deploying an OVF package. This attribute is optional in the result when retrieving information about an OVF package.
label (str) – The display name of this OVF property. This attribute is not used in the input parameters when deploying an OVF package. This attribute will always be present in the result when retrieving information about an OVF package.
description (str) – A description of this OVF property. This attribute is not used in the input parameters when deploying an OVF package. This attribute is optional in the result when retrieving information about an OVF package.
type (str) – The type of this OVF property. Refer to the configuration of a virtual appliance/virtual machine for the valid values. This attribute is not used in the input parameters when deploying an OVF package. This attribute will always be present in the result when retrieving information about an OVF package.
value (str) – The OVF property value. This contains the default value from ovf:defaultValue if ovf:value is not present when read. This attribute must be provided in the input parameters when deploying an OVF package. This attribute will always be present in the result when retrieving information about an OVF package.

class com.vmware.vcenter.ovf_client.PropertyParams(properties=None, type=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The PropertyParams class contains a list of OVF properties that can be configured when the OVF package is deployed.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters:

properties (list of Property) – list of OVF properties. This attribute is optional in the input parameters when deploying an OVF package. This attribute will always be present in the result when retrieving information about an OVF package.
type (str) – Unique identifier describing the type of the OVF parameters. The value is the name of the OVF parameters class. This attribute must be provided in the input parameters when deploying an OVF package. This attribute will always be present in the result when retrieving information about an OVF package.

class com.vmware.vcenter.ovf_client.ScaleOutGroup(id=None, description=None, instance_count=None, minimum_instance_count=None, maximum_instance_count=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The ScaleOutGroup class contains information about a scale-out group.

It allows a virtual system collection to contain a set of children that are homogeneous with respect to a prototypical virtual system or virtual system collection. It shall cause the deployment function to replicate the prototype a number of times, thus allowing the number of instantiated virtual systems to be configured dynamically at deployment time.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters:

id (str) – The identifier of the scale-out group. This attribute must be provided in the input parameters when deploying an OVF package. This attribute will always be present in the result when retrieving information about an OVF package.
description (str) – The description of the scale-out group. This attribute is not used in the input parameters when deploying an OVF package. This attribute will always be present in the result when retrieving information about an OVF package.
instance_count (long) – The scaling factor to use. It defines the number of replicas of the prototypical virtual system or virtual system collection. This attribute must be provided in the input parameters when deploying an OVF package. This attribute will always be present in the result when retrieving information about an OVF package.
minimum_instance_count (long) – The minimum scaling factor. This attribute is not used in the input parameters when deploying an OVF package. This attribute will always be present in the result when retrieving information about an OVF package. This will be 1 if there is no explicit limit.
maximum_instance_count (long) – The maximum scaling factor. This attribute is not used in the input parameters when deploying an OVF package. This attribute is optional in the result when retrieving information about an OVF package. This will be None if there is no explicit limit.

class com.vmware.vcenter.ovf_client.ScaleOutParams(groups=None, type=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The ScaleOutParams class contains information about the scale-out groups described in the OVF package.

When deploying an OVF package, a deployment specific instance count can be specified (see ScaleOutGroup.instance_count.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters:

groups (list of ScaleOutGroup) – The list of scale-out groups. This attribute is optional in the input parameters when deploying an OVF package. If None there are no scale-out groups. This attribute will always be present in the result when retrieving information about an OVF package.
type (str) – Unique identifier describing the type of the OVF parameters. The value is the name of the OVF parameters class. This attribute must be provided in the input parameters when deploying an OVF package. This attribute will always be present in the result when retrieving information about an OVF package.

class com.vmware.vcenter.ovf_client.SizeParams(approximate_download_size=None, approximate_flat_deployment_size=None, approximate_sparse_deployment_size=None, variable_disk_size=None, type=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The SizeParams class contains estimates of the download and deployment sizes.

This information is based on the file references and the ovf:DiskSection in the OVF descriptor.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters:

approximate_download_size (long) –
A best guess as to the total amount of data that must be transferred to download the OVF package.

This may be inaccurate due to disk compression etc.

This attribute is not used in the input parameters when deploying an OVF package. This attribute is optional in the result when retrieving information about an OVF package. It will be None if there is insufficient information to provide a proper estimate.
approximate_flat_deployment_size (long) – A best guess as to the total amount of space required to deploy the OVF package if using flat disks. This attribute is not used in the input parameters when deploying an OVF package. This attribute is optional in the result when retrieving information about an OVF package. It will be None if there is insufficient information to provide a proper estimate.
approximate_sparse_deployment_size (long) – A best guess as to the total amount of space required to deploy the OVF package using sparse disks. This attribute is not used in the input parameters when deploying an OVF package. This attribute is optional in the result when retrieving information about an OVF package. It will be None if there is insufficient information to provide a proper estimate.
variable_disk_size (bool) –
Whether the OVF uses variable disk sizes.

For empty disks, rather than specifying a fixed virtual disk capacity, the capacity may be given using a reference to a ovf:Property element in a ovf:ProductSection element in OVF package. This attribute is not used in the input parameters when deploying an OVF package. This attribute is optional in the result when retrieving information about an OVF package. If None or false, the OVF does not use variable disk sizes.
type (str) – Unique identifier describing the type of the OVF parameters. The value is the name of the OVF parameters class. This attribute must be provided in the input parameters when deploying an OVF package. This attribute will always be present in the result when retrieving information about an OVF package.

class com.vmware.vcenter.ovf_client.UnknownSection(tag=None, info=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The UnknownSection class contains information about an unknown section in an OVF package.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters:	tag (`str`) – A namespace-qualified tag in the form `{ns}tag`. info (`str`) – The description of the Info element.

class com.vmware.vcenter.ovf_client.UnknownSectionParams(unknown_sections=None, type=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The UnknownSectionParams class contains a list of unknown, non-required sections.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters:

unknown_sections (list of UnknownSection) – list of unknown, non-required sections. This attribute is not used in the input parameters when deploying an OVF package. This attribute will always be present in the result when retrieving information about an OVF package.
type (str) – Unique identifier describing the type of the OVF parameters. The value is the name of the OVF parameters class. This attribute must be provided in the input parameters when deploying an OVF package. This attribute will always be present in the result when retrieving information about an OVF package.

class com.vmware.vcenter.ovf_client.VcenterExtensionParams(required=None, registration_accepted=None, type=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The VcenterExtensionParams class specifies that the OVF package should be registered as a vCenter extension. The virtual machine or virtual appliance will gain unrestricted access to the vCenter Server APIs. It must be connected to a network with connectivity to the vCenter server.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters:

required (bool) – Whether registration as a vCenter extension is required. This attribute is not used in the input parameters when deploying an OVF package. This attribute will always be present in the result when retrieving information about an OVF package.
registration_accepted (bool) –
Whether registration as a vCenter extension is accepted.

If registration as a vCenter extension is required (see VcenterExtensionParams.required), this must be set to true during deployment. Defaults to false when returned from server. This attribute must be provided in the input parameters when deploying an OVF package. This attribute will always be present in the result when retrieving information about an OVF package.
type (str) – Unique identifier describing the type of the OVF parameters. The value is the name of the OVF parameters class. This attribute must be provided in the input parameters when deploying an OVF package. This attribute will always be present in the result when retrieving information about an OVF package.

com.vmware.vcenter.vm_client module¶

The com.vmware.vcenter.vm_client module provides classes for managing virtual machines.

class com.vmware.vcenter.vm_client.GuestOS(string)¶

Bases: vmware.vapi.bindings.enum.Enum

The GuestOS class defines the valid guest operating system types used for configuring a virtual machine.

Note

This class represents an enumerated type in the interface language definition. The class contains class attributes which represent the values in the current version of the enumerated type. Newer versions of the enumerated type may contain new values. To use new values of the enumerated type in communication with a server that supports the newer version of the API, you instantiate this class. See enumerated type description page.

Parameters:	string (`str`) – String value for the `GuestOS` instance.

ASIANUX_3 = GuestOS(string=u'ASIANUX_3')¶: Asianux Server 3

ASIANUX_3_64 = GuestOS(string=u'ASIANUX_3_64')¶: Asianux Server 3 (64 bit)

ASIANUX_4 = GuestOS(string=u'ASIANUX_4')¶: Asianux Server 4

ASIANUX_4_64 = GuestOS(string=u'ASIANUX_4_64')¶: Asianux Server 4 (64 bit)

ASIANUX_5_64 = GuestOS(string=u'ASIANUX_5_64')¶: Asianux Server 5 (64 bit)

ASIANUX_7_64 = GuestOS(string=u'ASIANUX_7_64')¶: Asianux Server 7 (64 bit)

CENTOS = GuestOS(string=u'CENTOS')¶: CentOS 4/5

CENTOS_6 = GuestOS(string=u'CENTOS_6')¶: CentOS 6

CENTOS_64 = GuestOS(string=u'CENTOS_64')¶: CentOS 4/5 (64-bit)

CENTOS_6_64 = GuestOS(string=u'CENTOS_6_64')¶: CentOS 6 (64-bit)

CENTOS_7 = GuestOS(string=u'CENTOS_7')¶: CentOS 7

CENTOS_7_64 = GuestOS(string=u'CENTOS_7_64')¶: CentOS 7 (64-bit)

COREOS_64 = GuestOS(string=u'COREOS_64')¶: CoreOS Linux (64 bit)

DARWIN = GuestOS(string=u'DARWIN')¶: Mac OS 10.5

DARWIN_10 = GuestOS(string=u'DARWIN_10')¶: Mac OS 10.6

DARWIN_10_64 = GuestOS(string=u'DARWIN_10_64')¶: Mac OS 10.6 (64 bit)

DARWIN_11 = GuestOS(string=u'DARWIN_11')¶: Mac OS 10.7

DARWIN_11_64 = GuestOS(string=u'DARWIN_11_64')¶: Mac OS 10.7 (64 bit)

DARWIN_12_64 = GuestOS(string=u'DARWIN_12_64')¶: Mac OS 10.8 (64 bit)

DARWIN_13_64 = GuestOS(string=u'DARWIN_13_64')¶: Mac OS 10.9 (64 bit)

DARWIN_14_64 = GuestOS(string=u'DARWIN_14_64')¶: Mac OS 10.10 (64 bit)

DARWIN_15_64 = GuestOS(string=u'DARWIN_15_64')¶: Mac OS 10.11 (64 bit)

DARWIN_16_64 = GuestOS(string=u'DARWIN_16_64')¶: Mac OS 10.12 (64 bit)

DARWIN_64 = GuestOS(string=u'DARWIN_64')¶: Mac OS 10.5 (64 bit)

DEBIAN_10 = GuestOS(string=u'DEBIAN_10')¶: Debian GNU/Linux 10

DEBIAN_10_64 = GuestOS(string=u'DEBIAN_10_64')¶: Debian GNU/Linux 10 (64 bit)

DEBIAN_4 = GuestOS(string=u'DEBIAN_4')¶: Debian GNU/Linux 4

DEBIAN_4_64 = GuestOS(string=u'DEBIAN_4_64')¶: Debian GNU/Linux 4 (64 bit)

DEBIAN_5 = GuestOS(string=u'DEBIAN_5')¶: Debian GNU/Linux 5

DEBIAN_5_64 = GuestOS(string=u'DEBIAN_5_64')¶: Debian GNU/Linux 5 (64 bit)

DEBIAN_6 = GuestOS(string=u'DEBIAN_6')¶: Debian GNU/Linux 6

DEBIAN_6_64 = GuestOS(string=u'DEBIAN_6_64')¶: Debian GNU/Linux 6 (64 bit)

DEBIAN_7 = GuestOS(string=u'DEBIAN_7')¶: Debian GNU/Linux 7

DEBIAN_7_64 = GuestOS(string=u'DEBIAN_7_64')¶: Debian GNU/Linux 7 (64 bit)

DEBIAN_8 = GuestOS(string=u'DEBIAN_8')¶: Debian GNU/Linux 8

DEBIAN_8_64 = GuestOS(string=u'DEBIAN_8_64')¶: Debian GNU/Linux 8 (64 bit)

DEBIAN_9 = GuestOS(string=u'DEBIAN_9')¶: Debian GNU/Linux 9

DEBIAN_9_64 = GuestOS(string=u'DEBIAN_9_64')¶: Debian GNU/Linux 9 (64 bit)

DOS = GuestOS(string=u'DOS')¶: MS-DOS.

ECOMSTATION = GuestOS(string=u'ECOMSTATION')¶: eComStation 1.x

ECOMSTATION_2 = GuestOS(string=u'ECOMSTATION_2')¶: eComStation 2.0

FEDORA = GuestOS(string=u'FEDORA')¶: Fedora Linux

FEDORA_64 = GuestOS(string=u'FEDORA_64')¶: Fedora Linux (64 bit)

FREEBSD = GuestOS(string=u'FREEBSD')¶: FreeBSD

FREEBSD_64 = GuestOS(string=u'FREEBSD_64')¶: FreeBSD x64

GENERIC_LINUX = GuestOS(string=u'GENERIC_LINUX')¶: Other Linux

MANDRAKE = GuestOS(string=u'MANDRAKE')¶: Mandrake Linux

MANDRIVA = GuestOS(string=u'MANDRIVA')¶: Mandriva Linux

MANDRIVA_64 = GuestOS(string=u'MANDRIVA_64')¶: Mandriva Linux (64 bit)

NETWARE_4 = GuestOS(string=u'NETWARE_4')¶: Novell NetWare 4

NETWARE_5 = GuestOS(string=u'NETWARE_5')¶: Novell NetWare 5.1

NETWARE_6 = GuestOS(string=u'NETWARE_6')¶: Novell NetWare 6.x

NLD_9 = GuestOS(string=u'NLD_9')¶: Novell Linux Desktop 9

OES = GuestOS(string=u'OES')¶: Open Enterprise Server

OPENSERVER_5 = GuestOS(string=u'OPENSERVER_5')¶: SCO OpenServer 5

OPENSERVER_6 = GuestOS(string=u'OPENSERVER_6')¶: SCO OpenServer 6

OPENSUSE = GuestOS(string=u'OPENSUSE')¶: OpenSUSE Linux

OPENSUSE_64 = GuestOS(string=u'OPENSUSE_64')¶: OpenSUSE Linux (64 bit)

ORACLE_LINUX = GuestOS(string=u'ORACLE_LINUX')¶: Oracle Linux 4/5

ORACLE_LINUX_6 = GuestOS(string=u'ORACLE_LINUX_6')¶: Oracle Linux 6

ORACLE_LINUX_64 = GuestOS(string=u'ORACLE_LINUX_64')¶: Oracle Linux 4/5 (64-bit)

ORACLE_LINUX_6_64 = GuestOS(string=u'ORACLE_LINUX_6_64')¶: Oracle Linux 6 (64-bit)

ORACLE_LINUX_7 = GuestOS(string=u'ORACLE_LINUX_7')¶: Oracle Linux 7

ORACLE_LINUX_7_64 = GuestOS(string=u'ORACLE_LINUX_7_64')¶: Oracle Linux 7 (64-bit)

OS2 = GuestOS(string=u'OS2')¶: OS/2

OTHER = GuestOS(string=u'OTHER')¶: Other Operating System

OTHER_24X_LINUX = GuestOS(string=u'OTHER_24X_LINUX')¶: Linux 2.4x Kernel

OTHER_24X_LINUX_64 = GuestOS(string=u'OTHER_24X_LINUX_64')¶: Linux 2.4x Kernel (64 bit) (experimental)

OTHER_26X_LINUX = GuestOS(string=u'OTHER_26X_LINUX')¶: Linux 2.6x Kernel

OTHER_26X_LINUX_64 = GuestOS(string=u'OTHER_26X_LINUX_64')¶: Linux 2.6x Kernel (64 bit) (experimental)

OTHER_3X_LINUX = GuestOS(string=u'OTHER_3X_LINUX')¶: Linux 3.x Kernel

OTHER_3X_LINUX_64 = GuestOS(string=u'OTHER_3X_LINUX_64')¶: Linux 3.x Kernel (64 bit)

OTHER_64 = GuestOS(string=u'OTHER_64')¶: Other Operating System (64 bit) (experimental)

OTHER_LINUX = GuestOS(string=u'OTHER_LINUX')¶: Linux 2.2x Kernel

OTHER_LINUX_64 = GuestOS(string=u'OTHER_LINUX_64')¶: Linux (64 bit) (experimental)

REDHAT = GuestOS(string=u'REDHAT')¶: Red Hat Linux 2.1

RHEL_2 = GuestOS(string=u'RHEL_2')¶: Red Hat Enterprise Linux 2

RHEL_3 = GuestOS(string=u'RHEL_3')¶: Red Hat Enterprise Linux 3

RHEL_3_64 = GuestOS(string=u'RHEL_3_64')¶: Red Hat Enterprise Linux 3 (64 bit)

RHEL_4 = GuestOS(string=u'RHEL_4')¶: Red Hat Enterprise Linux 4

RHEL_4_64 = GuestOS(string=u'RHEL_4_64')¶: Red Hat Enterprise Linux 4 (64 bit)

RHEL_5 = GuestOS(string=u'RHEL_5')¶: Red Hat Enterprise Linux 5

RHEL_5_64 = GuestOS(string=u'RHEL_5_64')¶: Red Hat Enterprise Linux 5 (64 bit) (experimental)

RHEL_6 = GuestOS(string=u'RHEL_6')¶: Red Hat Enterprise Linux 6

RHEL_6_64 = GuestOS(string=u'RHEL_6_64')¶: Red Hat Enterprise Linux 6 (64 bit)

RHEL_7 = GuestOS(string=u'RHEL_7')¶: Red Hat Enterprise Linux 7

RHEL_7_64 = GuestOS(string=u'RHEL_7_64')¶: Red Hat Enterprise Linux 7 (64 bit)

SJDS = GuestOS(string=u'SJDS')¶: Sun Java Desktop System

SLES = GuestOS(string=u'SLES')¶: Suse Linux Enterprise Server 9

SLES_10 = GuestOS(string=u'SLES_10')¶: Suse linux Enterprise Server 10

SLES_10_64 = GuestOS(string=u'SLES_10_64')¶: Suse Linux Enterprise Server 10 (64 bit) (experimental)

SLES_11 = GuestOS(string=u'SLES_11')¶: Suse linux Enterprise Server 11

SLES_11_64 = GuestOS(string=u'SLES_11_64')¶: Suse Linux Enterprise Server 11 (64 bit)

SLES_12 = GuestOS(string=u'SLES_12')¶: Suse linux Enterprise Server 12

SLES_12_64 = GuestOS(string=u'SLES_12_64')¶: Suse Linux Enterprise Server 12 (64 bit)

SLES_64 = GuestOS(string=u'SLES_64')¶: Suse Linux Enterprise Server 9 (64 bit)

SOLARIS_10 = GuestOS(string=u'SOLARIS_10')¶: Solaris 10 (32 bit) (experimental)

SOLARIS_10_64 = GuestOS(string=u'SOLARIS_10_64')¶: Solaris 10 (64 bit) (experimental)

SOLARIS_11_64 = GuestOS(string=u'SOLARIS_11_64')¶: Solaris 11 (64 bit)

SOLARIS_6 = GuestOS(string=u'SOLARIS_6')¶: Solaris 6

SOLARIS_7 = GuestOS(string=u'SOLARIS_7')¶: Solaris 7

SOLARIS_8 = GuestOS(string=u'SOLARIS_8')¶: Solaris 8

SOLARIS_9 = GuestOS(string=u'SOLARIS_9')¶: Solaris 9

SUSE = GuestOS(string=u'SUSE')¶: Suse Linux

SUSE_64 = GuestOS(string=u'SUSE_64')¶: Suse Linux (64 bit)

TURBO_LINUX = GuestOS(string=u'TURBO_LINUX')¶: Turbolinux

TURBO_LINUX_64 = GuestOS(string=u'TURBO_LINUX_64')¶: Turbolinux (64 bit)

UBUNTU = GuestOS(string=u'UBUNTU')¶: Ubuntu Linux

UBUNTU_64 = GuestOS(string=u'UBUNTU_64')¶: Ubuntu Linux (64 bit)

UNIXWARE_7 = GuestOS(string=u'UNIXWARE_7')¶: SCO UnixWare 7

VMKERNEL = GuestOS(string=u'VMKERNEL')¶: VMware ESX 4

VMKERNEL_5 = GuestOS(string=u'VMKERNEL_5')¶: VMware ESX 5

VMKERNEL_6 = GuestOS(string=u'VMKERNEL_6')¶: VMware ESX 6

VMKERNEL_65 = GuestOS(string=u'VMKERNEL_65')¶: VMware ESX 6.5

VMWARE_PHOTON_64 = GuestOS(string=u'VMWARE_PHOTON_64')¶: VMware Photon (64 bit)

WINDOWS_7 = GuestOS(string=u'WINDOWS_7')¶: Windows 7

WINDOWS_7_64 = GuestOS(string=u'WINDOWS_7_64')¶: Windows 7 (64 bit)

WINDOWS_7_SERVER_64 = GuestOS(string=u'WINDOWS_7_SERVER_64')¶: Windows Server 2008 R2 (64 bit)

WINDOWS_8 = GuestOS(string=u'WINDOWS_8')¶: Windows 8

WINDOWS_8_64 = GuestOS(string=u'WINDOWS_8_64')¶: Windows 8 (64 bit)

WINDOWS_8_SERVER_64 = GuestOS(string=u'WINDOWS_8_SERVER_64')¶: Windows 8 Server (64 bit)

WINDOWS_9 = GuestOS(string=u'WINDOWS_9')¶: Windows 10

WINDOWS_9_64 = GuestOS(string=u'WINDOWS_9_64')¶: Windows 10 (64 bit)

WINDOWS_9_SERVER_64 = GuestOS(string=u'WINDOWS_9_SERVER_64')¶: Windows 10 Server (64 bit)

WINDOWS_HYPERV = GuestOS(string=u'WINDOWS_HYPERV')¶: Windows Hyper-V

WIN_2000_ADV_SERV = GuestOS(string=u'WIN_2000_ADV_SERV')¶: Windows 2000 Advanced Server

WIN_2000_PRO = GuestOS(string=u'WIN_2000_PRO')¶: Windows 2000 Professional

WIN_2000_SERV = GuestOS(string=u'WIN_2000_SERV')¶: Windows 2000 Server

WIN_31 = GuestOS(string=u'WIN_31')¶: Windows 3.1

WIN_95 = GuestOS(string=u'WIN_95')¶: Windows 95

WIN_98 = GuestOS(string=u'WIN_98')¶: Windows 98

WIN_LONGHORN = GuestOS(string=u'WIN_LONGHORN')¶: Windows Longhorn (experimental)

WIN_LONGHORN_64 = GuestOS(string=u'WIN_LONGHORN_64')¶: Windows Longhorn (64 bit) (experimental)

WIN_ME = GuestOS(string=u'WIN_ME')¶: Windows Millennium Edition

WIN_NET_BUSINESS = GuestOS(string=u'WIN_NET_BUSINESS')¶: Windows Small Business Server 2003

WIN_NET_DATACENTER = GuestOS(string=u'WIN_NET_DATACENTER')¶: Windows Server 2003, Datacenter Edition

WIN_NET_DATACENTER_64 = GuestOS(string=u'WIN_NET_DATACENTER_64')¶: Windows Server 2003, Datacenter Edition (64 bit) (experimental)

WIN_NET_ENTERPRISE = GuestOS(string=u'WIN_NET_ENTERPRISE')¶: Windows Server 2003, Enterprise Edition

WIN_NET_ENTERPRISE_64 = GuestOS(string=u'WIN_NET_ENTERPRISE_64')¶: Windows Server 2003, Enterprise Edition (64 bit)

WIN_NET_STANDARD = GuestOS(string=u'WIN_NET_STANDARD')¶: Windows Server 2003, Standard Edition

WIN_NET_STANDARD_64 = GuestOS(string=u'WIN_NET_STANDARD_64')¶: Windows Server 2003, Standard Edition (64 bit)

WIN_NET_WEB = GuestOS(string=u'WIN_NET_WEB')¶: Windows Server 2003, Web Edition

WIN_NT = GuestOS(string=u'WIN_NT')¶: Windows NT 4

WIN_VISTA = GuestOS(string=u'WIN_VISTA')¶: Windows Vista

WIN_VISTA_64 = GuestOS(string=u'WIN_VISTA_64')¶: Windows Vista (64 bit)

WIN_XP_HOME = GuestOS(string=u'WIN_XP_HOME')¶: Windows XP Home Edition

WIN_XP_PRO = GuestOS(string=u'WIN_XP_PRO')¶: Windows XP Professional

WIN_XP_PRO_64 = GuestOS(string=u'WIN_XP_PRO_64')¶: Windows XP Professional Edition (64 bit)

class com.vmware.vcenter.vm_client.Hardware(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

The Hardware class provides methods for configuring the virtual hardware of a virtual machine.

Parameters:	config (`vmware.vapi.bindings.stub.StubConfiguration`) – Configuration to be used for creating the stub.

class Info(version=None, upgrade_policy=None, upgrade_version=None, upgrade_status=None, upgrade_error=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The Hardware.Info class contains information related to the virtual hardware of a virtual machine.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters:

version (Hardware.Version) – Virtual hardware version.
upgrade_policy (Hardware.UpgradePolicy) – Scheduled upgrade policy.
upgrade_version (Hardware.Version) – Target hardware version to be used on the next scheduled virtual hardware upgrade. This attribute is optional and it is only relevant when the value of upgradePolicy is one of Hardware.UpgradePolicy.AFTER_CLEAN_SHUTDOWN or Hardware.UpgradePolicy.ALWAYS.
upgrade_status (Hardware.UpgradeStatus) – Scheduled upgrade status.
upgrade_error (Exception) – Reason for the scheduled upgrade failure. This attribute is optional and it is only relevant when the value of upgradeStatus is Hardware.UpgradeStatus.FAILED.

class Hardware.UpdateSpec(upgrade_policy=None, upgrade_version=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The Hardware.UpdateSpec class describes the updates to virtual hardware settings of a virtual machine.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters:

upgrade_policy (Hardware.UpgradePolicy or None) –
Scheduled upgrade policy.

If set to Hardware.UpgradePolicy.NEVER, the Hardware.Info.upgrade_version attribute will be reset to None. If None, the value is unchanged.
upgrade_version (Hardware.Version or None) –
Target hardware version to be used on the next scheduled virtual hardware upgrade.

If specified, this attribute must represent a newer virtual hardware version than the current virtual hardware version reported in Hardware.Info.version. If Hardware.UpdateSpec.upgrade_policy is set to Hardware.UpgradePolicy.NEVER, this attribute must be None. Otherwise, if this attribute is None, default to the most recent virtual hardware version supported by the server.

class Hardware.UpgradePolicy(string)¶

Bases: vmware.vapi.bindings.enum.Enum

The Hardware.UpgradePolicy class defines the valid virtual hardware upgrade policies for a virtual machine.

Note

This class represents an enumerated type in the interface language definition. The class contains class attributes which represent the values in the current version of the enumerated type. Newer versions of the enumerated type may contain new values. To use new values of the enumerated type in communication with a server that supports the newer version of the API, you instantiate this class. See enumerated type description page.

Parameters:	string (`str`) – String value for the `UpgradePolicy` instance.

AFTER_CLEAN_SHUTDOWN = UpgradePolicy(string=u'AFTER_CLEAN_SHUTDOWN')¶: Run scheduled upgrade when the virtual machine is powered on after a clean shutdown of the guest operating system.

ALWAYS = UpgradePolicy(string=u'ALWAYS')¶: Run scheduled upgrade when the virtual machine is powered on.

NEVER = UpgradePolicy(string=u'NEVER')¶: Do not upgrade the virtual machine when it is powered on.

class Hardware.UpgradeStatus(string)¶

Bases: vmware.vapi.bindings.enum.Enum

The Hardware.UpgradeStatus class defines the valid virtual hardware upgrade statuses for a virtual machine.

Note

This class represents an enumerated type in the interface language definition. The class contains class attributes which represent the values in the current version of the enumerated type. Newer versions of the enumerated type may contain new values. To use new values of the enumerated type in communication with a server that supports the newer version of the API, you instantiate this class. See enumerated type description page.

Parameters:	string (`str`) – String value for the `UpgradeStatus` instance.

FAILED = UpgradeStatus(string=u'FAILED')¶: The most recent scheduled upgrade was not successful.

NONE = UpgradeStatus(string=u'NONE')¶: No scheduled upgrade has been attempted.

PENDING = UpgradeStatus(string=u'PENDING')¶: Upgrade is scheduled but has not yet been run.

SUCCESS = UpgradeStatus(string=u'SUCCESS')¶: The most recent scheduled upgrade was successful.

class Hardware.Version(string)¶

Bases: vmware.vapi.bindings.enum.Enum

The Hardware.Version class defines the valid virtual hardware versions for a virtual machine.

Note

This class represents an enumerated type in the interface language definition. The class contains class attributes which represent the values in the current version of the enumerated type. Newer versions of the enumerated type may contain new values. To use new values of the enumerated type in communication with a server that supports the newer version of the API, you instantiate this class. See enumerated type description page.

Parameters:	string (`str`) – String value for the `Version` instance.

VMX_03 = Version(string=u'VMX_03')¶: Hardware version 3.

VMX_04 = Version(string=u'VMX_04')¶: Hardware version 4.

VMX_06 = Version(string=u'VMX_06')¶: Hardware version 6.

VMX_07 = Version(string=u'VMX_07')¶: Hardware version 7.

VMX_08 = Version(string=u'VMX_08')¶: Hardware version 8.

VMX_09 = Version(string=u'VMX_09')¶: Hardware version 9.

VMX_10 = Version(string=u'VMX_10')¶: Hardware version 10.

VMX_11 = Version(string=u'VMX_11')¶: Hardware version 11.

VMX_12 = Version(string=u'VMX_12')¶: Hardware version 12.

VMX_13 = Version(string=u'VMX_13')¶: Hardware version 13.

Hardware.get(vm)¶

Returns the virtual hardware settings of a virtual machine.

Parameters:	vm (`str`) – Virtual machine identifier. The parameter must be an identifier for the resource type: `VirtualMachine`.
Return type:	`Hardware.Info`
Returns:	Virtual hardware settings of the virtual machine.
Raise:	`com.vmware.vapi.std.errors_client.Error` if the system reports an error while responding to the request.
Raise:	`com.vmware.vapi.std.errors_client.NotFound` if the virtual machine is not found.
Raise:	`com.vmware.vapi.std.errors_client.ResourceInaccessible` if the virtual machine’s configuration state cannot be accessed.
Raise:	`com.vmware.vapi.std.errors_client.ServiceUnavailable` if the system is unable to communicate with a service to complete the request.
Raise:	`com.vmware.vapi.std.errors_client.Unauthenticated` if the user can not be authenticated.
Raise:	`com.vmware.vapi.std.errors_client.Unauthorized` if the user doesn’t have the required privileges.

Hardware.update(vm, spec)¶

Updates the virtual hardware settings of a virtual machine.

Parameters:	vm (`str`) – Virtual machine identifier. The parameter must be an identifier for the resource type: `VirtualMachine`. spec (`Hardware.UpdateSpec`) – Specification for updating the virtual hardware settings of the virtual machine.
Raise:	`com.vmware.vapi.std.errors_client.Error` if the system reports an error while responding to the request.
Raise:	`com.vmware.vapi.std.errors_client.NotFound` if the virtual machine is not found.
Raise:	`com.vmware.vapi.std.errors_client.AlreadyInDesiredState` if the virtual machine is already configured for the desired hardware version.
Raise:	`com.vmware.vapi.std.errors_client.InvalidArgument` if the requested virtual hardware version is not newer than the current version.
Raise:	`com.vmware.vapi.std.errors_client.Unsupported` if the requested virtual hardware version is not supported by the server.
Raise:	`com.vmware.vapi.std.errors_client.ResourceBusy` if the virtual machine is busy performing another operation.
Raise:	`com.vmware.vapi.std.errors_client.ResourceInaccessible` if the virtual machine’s configuration state cannot be accessed.
Raise:	`com.vmware.vapi.std.errors_client.ServiceUnavailable` if the system is unable to communicate with a service to complete the request.
Raise:	`com.vmware.vapi.std.errors_client.Unauthenticated` if the user can not be authenticated.
Raise:	`com.vmware.vapi.std.errors_client.Unauthorized` if the user doesn’t have the required privileges.

Hardware.upgrade(vm, version=None)¶

Upgrades the virtual machine to a newer virtual hardware version.

Parameters:	vm (`str`) – Virtual machine identifier. The parameter must be an identifier for the resource type: `VirtualMachine`. version (`Hardware.Version` or `None`) – New virtual machine version. If None, defaults to the most recent virtual hardware version supported by the server.
Raise:	`com.vmware.vapi.std.errors_client.Error` if the system reports an error while responding to the request.
Raise:	`com.vmware.vapi.std.errors_client.NotFound` if the virtual machine is not found.
Raise:	`com.vmware.vapi.std.errors_client.NotAllowedInCurrentState` if the virtual machine is not powered off.
Raise:	`com.vmware.vapi.std.errors_client.AlreadyInDesiredState` if the virtual machine is already configured for the desired hardware version.
Raise:	`com.vmware.vapi.std.errors_client.InvalidArgument` if `version` is older than the current virtual hardware version.
Raise:	`com.vmware.vapi.std.errors_client.Unsupported` if `version` is not supported by the server.
Raise:	`com.vmware.vapi.std.errors_client.ResourceBusy` if the virtual machine is busy performing another operation.
Raise:	`com.vmware.vapi.std.errors_client.ResourceInaccessible` if the virtual machine’s configuration state cannot be accessed.
Raise:	`com.vmware.vapi.std.errors_client.ServiceUnavailable` if the system is unable to communicate with a service to complete the request.
Raise:	`com.vmware.vapi.std.errors_client.Unauthenticated` if the user can not be authenticated.
Raise:	`com.vmware.vapi.std.errors_client.Unauthorized` if the user doesn’t have the required privileges.

class com.vmware.vcenter.vm_client.Power(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

The Power class provides methods for managing the power state of a virtual machine.

Parameters:	config (`vmware.vapi.bindings.stub.StubConfiguration`) – Configuration to be used for creating the stub.

class Info(state=None, clean_power_off=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The Power.Info class contains information about the power state of a virtual machine.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters:	state (`Power.State`) – Power state of the virtual machine. clean_power_off (`bool`) – Flag indicating whether the virtual machine was powered off cleanly. This attribute may be used to detect that the virtual machine crashed unexpectedly and should be restarted. This attribute is optional and it is only relevant when the value of `state` is `Power.State.POWERED_OFF`.

class Power.State(string)¶

Bases: vmware.vapi.bindings.enum.Enum

The Power.State class defines the valid power states for a virtual machine.

Note

This class represents an enumerated type in the interface language definition. The class contains class attributes which represent the values in the current version of the enumerated type. Newer versions of the enumerated type may contain new values. To use new values of the enumerated type in communication with a server that supports the newer version of the API, you instantiate this class. See enumerated type description page.

Parameters:	string (`str`) – String value for the `State` instance.

POWERED_OFF = State(string=u'POWERED_OFF')¶: The virtual machine is powered off.

POWERED_ON = State(string=u'POWERED_ON')¶: The virtual machine is powered on.

SUSPENDED = State(string=u'SUSPENDED')¶: The virtual machine is suspended.

Power.get(vm)¶

Returns the power state information of a virtual machine.

Parameters:	vm (`str`) – Virtual machine identifier. The parameter must be an identifier for the resource type: `VirtualMachine`.
Return type:	`Power.Info`
Returns:	Power state information for the specified virtual machine.
Raise:	`com.vmware.vapi.std.errors_client.Error` if the system reports an error while responding to the request.
Raise:	`com.vmware.vapi.std.errors_client.NotFound` if the virtual machine is not found.
Raise:	`com.vmware.vapi.std.errors_client.ResourceInaccessible` if the virtual machine’s configuration or execution state cannot be accessed.
Raise:	`com.vmware.vapi.std.errors_client.ServiceUnavailable` if the system is unable to communicate with a service to complete the request.
Raise:	`com.vmware.vapi.std.errors_client.Unauthenticated` if the user can not be authenticated.
Raise:	`com.vmware.vapi.std.errors_client.Unauthorized` if the user doesn’t have the required privileges.

Power.reset(vm)¶

Resets a powered-on virtual machine.

Parameters:	vm (`str`) – Virtual machine identifier. The parameter must be an identifier for the resource type: `VirtualMachine`.
Raise:	`com.vmware.vapi.std.errors_client.Error` if the system reports an error while responding to the request.
Raise:	`com.vmware.vapi.std.errors_client.NotFound` if the virtual machine is not found.
Raise:	`com.vmware.vapi.std.errors_client.NotAllowedInCurrentState` if the virtual machine is powered off or suspended.
Raise:	`com.vmware.vapi.std.errors_client.ResourceBusy` if the virtual machine is performing another operation
Raise:	`com.vmware.vapi.std.errors_client.ServiceUnavailable` if the system is unable to communicate with a service to complete the request.
Raise:	`com.vmware.vapi.std.errors_client.Unauthenticated` if the user can not be authenticated.
Raise:	`com.vmware.vapi.std.errors_client.Unauthorized` if the user doesn’t have the required privileges.

Power.start(vm)¶

Powers on a powered-off or suspended virtual machine.

Parameters:	vm (`str`) – Virtual machine identifier. The parameter must be an identifier for the resource type: `VirtualMachine`.
Raise:	`com.vmware.vapi.std.errors_client.Error` if the system reports an error while responding to the request.
Raise:	`com.vmware.vapi.std.errors_client.NotFound` if the virtual machine is not found.
Raise:	`com.vmware.vapi.std.errors_client.AlreadyInDesiredState` if the virtual machine is already powered on.
Raise:	`com.vmware.vapi.std.errors_client.Unsupported` if the virtual machine does not support being powered on (e.g. marked as a template, serving as a fault-tolerance secondary virtual machine).
Raise:	`com.vmware.vapi.std.errors_client.UnableToAllocateResource` if resources cannot be allocated for the virtual machine (e.g. physical resource allocation policy cannot be satisfied, insufficient licenses are available to run the virtual machine).
Raise:	`com.vmware.vapi.std.errors_client.ResourceInaccessible` if resources required by the virtual machine are not accessible (e.g. virtual machine configuration files or virtual disks are on inaccessible storage, no hosts are available to run the virtual machine).
Raise:	`com.vmware.vapi.std.errors_client.ResourceInUse` if resources required by the virtual machine are in use (e.g. virtual machine configuration files or virtual disks are locked, host containing the virtual machine is an HA failover host).
Raise:	`com.vmware.vapi.std.errors_client.ResourceBusy` if the virtual machine is performing another operation.
Raise:	`com.vmware.vapi.std.errors_client.ServiceUnavailable` if the system is unable to communicate with a service to complete the request.
Raise:	`com.vmware.vapi.std.errors_client.Unauthenticated` if the user can not be authenticated.
Raise:	`com.vmware.vapi.std.errors_client.Unauthorized` if the user doesn’t have the required privileges.

Power.stop(vm)¶

Powers off a powered-on or suspended virtual machine.

Parameters:	vm (`str`) – Virtual machine identifier. The parameter must be an identifier for the resource type: `VirtualMachine`.
Raise:	`com.vmware.vapi.std.errors_client.Error` if the system reports an error while responding to the request.
Raise:	`com.vmware.vapi.std.errors_client.NotFound` if the virtual machine is not found.
Raise:	`com.vmware.vapi.std.errors_client.AlreadyInDesiredState` if the virtual machine is already powered off.
Raise:	`com.vmware.vapi.std.errors_client.ResourceBusy` if the virtual machine is performing another operation.
Raise:	`com.vmware.vapi.std.errors_client.ServiceUnavailable` if the system is unable to communicate with a service to complete the request.
Raise:	`com.vmware.vapi.std.errors_client.Unauthenticated` if the user can not be authenticated.
Raise:	`com.vmware.vapi.std.errors_client.Unauthorized` if the user doesn’t have the required privileges.

Power.suspend(vm)¶

Suspends a powered-on virtual machine.

Parameters:	vm (`str`) – Virtual machine identifier. The parameter must be an identifier for the resource type: `VirtualMachine`.
Raise:	`com.vmware.vapi.std.errors_client.Error` if the system reports an error while responding to the request.
Raise:	`com.vmware.vapi.std.errors_client.NotFound` if the virtual machine is not found.
Raise:	`com.vmware.vapi.std.errors_client.AlreadyInDesiredState` if the virtual machine is already suspended.
Raise:	`com.vmware.vapi.std.errors_client.NotAllowedInCurrentState` if the virtual machine is powered off.
Raise:	`com.vmware.vapi.std.errors_client.ResourceBusy` if the virtual machine is performing another operation.
Raise:	`com.vmware.vapi.std.errors_client.ServiceUnavailable` if the system is unable to communicate with a service to complete the request.
Raise:	`com.vmware.vapi.std.errors_client.Unauthenticated` if the user can not be authenticated.
Raise:	`com.vmware.vapi.std.errors_client.Unauthorized` if the user doesn’t have the required privileges.

com.vmware.vcenter package¶

Subpackages¶

Submodules¶

com.vmware.vcenter.hvc_client module¶

com.vmware.vcenter.inventory_client module¶

com.vmware.vcenter.iso_client module¶

com.vmware.vcenter.ovf_client module¶

com.vmware.vcenter.vm_client module¶

Module contents¶

Table Of Contents

Previous topic

Next topic

This Page

Navigation

com.vmware.vcenter package¶

Subpackages¶

Submodules¶

com.vmware.vcenter.hvc_client module¶

com.vmware.vcenter.inventory_client module¶

com.vmware.vcenter.iso_client module¶

com.vmware.vcenter.ovf_client module¶

com.vmware.vcenter.vm_client module¶

Module contents¶

Table Of Contents

Previous topic

Next topic

This Page

Quick search

Navigation