com.vmware.appliance package¶

Subpackages¶

Submodules¶

com.vmware.appliance.access_client module¶

The com.vmware.appliance.access_client module provides classes for managing access to the appliance. The module is available starting in vSphere 6.5.

class com.vmware.appliance.access_client.Consolecli(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

Consolecli class provides methods Get/Set enabled state of CLI.

get()¶

Get enabled state of the console-based controlled CLI (TTY1).

Return type:	`bool`
Returns:	Console-based controlled CLI is enabled.
Raise:	`com.vmware.vapi.std.errors_client.Error` Generic error

set(enabled)¶

Set enabled state of the console-based controlled CLI (TTY1).

Parameters:	enabled (`bool`) – Console-based controlled CLI is enabled.
Raise:	`com.vmware.vapi.std.errors_client.Error` Generic error

class com.vmware.appliance.access_client.Dcui(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

Dcui class provides methods Get/Set enabled state of DCUI.

get()¶

Get enabled state of Direct Console User Interface (DCUI TTY2).

Return type:	`bool`
Returns:	DCUI is enabled.
Raise:	`com.vmware.vapi.std.errors_client.Error` Generic error

set(enabled)¶

Set enabled state of Direct Console User Interface (DCUI TTY2).

Parameters:	enabled (`bool`) – DCUI is enabled.
Raise:	`com.vmware.vapi.std.errors_client.Error` Generic error

class com.vmware.appliance.access_client.Shell(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

Shell class provides methods Get/Set enabled state of BASH.

class ShellConfig(enabled=None, timeout=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Shell.ShellConfig class Structure that defines shell configuration.

Tip

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

get()¶

Get enabled state of BASH, that is, access to BASH from within the controlled CLI.

Return type:	`Shell.ShellConfig`
Returns:	Current shell configuration.
Raise:	`com.vmware.vapi.std.errors_client.Error` Generic error

set(config)¶

Set enabled state of BASH, that is, access to BASH from within the controlled CLI.

Parameters:	config (`Shell.ShellConfig`) – Shell configuration
Raise:	`com.vmware.vapi.std.errors_client.Error` Generic error

class com.vmware.appliance.access_client.Ssh(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

Ssh class provides methods Get/Set enabled state of SSH-based controlled CLI.

get()¶

Get enabled state of the SSH-based controlled CLI.

Return type:	`bool`
Returns:	SSH-based controlled CLI is enabled.
Raise:	`com.vmware.vapi.std.errors_client.Error` Generic error

set(enabled)¶

Set enabled state of the SSH-based controlled CLI.

Parameters:	enabled (`bool`) – SSH-based controlled CLI is enabled.
Raise:	`com.vmware.vapi.std.errors_client.Error` Generic error

class com.vmware.appliance.access_client.StubFactory(stub_config)¶: Bases: vmware.vapi.bindings.stub.StubFactoryBase

com.vmware.appliance.health_client module¶

The com.vmware.appliance.health_client module provides classes for reporting the health of the various subsystems of the the appliance. The module is available starting in vSphere 6.5.

class com.vmware.appliance.health_client.Applmgmt(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

Applmgmt class provides methods Get health status of applmgmt services.

get()¶

Get health status of applmgmt services.

Return type:	`str`
Returns:	health status
Raise:	`com.vmware.vapi.std.errors_client.Error` Generic error

class com.vmware.appliance.health_client.Databasestorage(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

Databasestorage class provides methods Get database storage health.

class HealthLevel(string)¶

Bases: vmware.vapi.bindings.enum.Enum

Databasestorage.HealthLevel class Defines service health levels.

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.

gray = HealthLevel(string='gray')¶: No health data is available for this service.

green = HealthLevel(string='green')¶: The service is healthy.

orange = HealthLevel(string='orange')¶: The service health is degraded. The service might have serious problems.

red = HealthLevel(string='red')¶: The service is unavaiable, not functioning properly, or will stop functioning soon.

yellow = HealthLevel(string='yellow')¶: The service is healthy but experiencing some problems.

get()¶

Get database storage health.

Return type:	`Databasestorage.HealthLevel`
Returns:	Database storage health
Raise:	`com.vmware.vapi.std.errors_client.Error` Generic error

class com.vmware.appliance.health_client.Load(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

Load class provides methods Get load health.

class HealthLevel(string)¶

Bases: vmware.vapi.bindings.enum.Enum

Load.HealthLevel class Defines health levels.

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.

gray = HealthLevel(string='gray')¶: No health data is available for this service.

green = HealthLevel(string='green')¶: Service is healthy.

orange = HealthLevel(string='orange')¶: The service health is degraded. The service might have serious problems.

red = HealthLevel(string='red')¶: The service is unavaiable, not functioning properly, or will stop functioning soon.

yellow = HealthLevel(string='yellow')¶: The service is healthy state, but experiencing some levels of problems.

get()¶

Get load health.

Return type:	`Load.HealthLevel`
Returns:	Load health.
Raise:	`com.vmware.vapi.std.errors_client.Error` Generic error

class com.vmware.appliance.health_client.Mem(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

Mem class provides methods Get memory health.

class HealthLevel(string)¶

Bases: vmware.vapi.bindings.enum.Enum

Mem.HealthLevel class Defines health levels.

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.

gray = HealthLevel(string='gray')¶: No health data is available for this service.

green = HealthLevel(string='green')¶: Service is healthy.

orange = HealthLevel(string='orange')¶: The service health is degraded. The service might have serious problems

red = HealthLevel(string='red')¶: The service is unavaiable, not functioning properly, or will stop functioning soon.

yellow = HealthLevel(string='yellow')¶: The service is healthy state, but experiencing some levels of problems.

get()¶

Get memory health.

Return type:	`Mem.HealthLevel`
Returns:	Memory health.
Raise:	`com.vmware.vapi.std.errors_client.Error` Generic error

class com.vmware.appliance.health_client.Softwarepackages(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

Softwarepackages class provides methods Get information on available software updates available in remote VUM repository.

class HealthLevel(string)¶

Bases: vmware.vapi.bindings.enum.Enum

Softwarepackages.HealthLevel class Defines health levels.

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.

gray = HealthLevel(string='gray')¶: No health data is available for this service.

green = HealthLevel(string='green')¶: Service is healthy.

orange = HealthLevel(string='orange')¶: The service health is degraded. The service might have serious problems.

red = HealthLevel(string='red')¶: The service is unavaiable, not functioning properly, or will stop functioning soon.

yellow = HealthLevel(string='yellow')¶: The service is healthy state, but experiencing some levels of problems.

get()¶

Get information on available software updates available in the remote vSphere Update Manager repository. Red indicates that security updates are available. Orange indicates that non-security updates are available. Green indicates that there are no updates available. Gray indicates that there was an error retreiving information on software updates.

Return type:	`Softwarepackages.HealthLevel`
Returns:	software updates available.
Raise:	`com.vmware.vapi.std.errors_client.Error` Generic error

class com.vmware.appliance.health_client.Storage(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

Storage class provides methods Get storage health.

class HealthLevel(string)¶

Bases: vmware.vapi.bindings.enum.Enum

Storage.HealthLevel class Defines health levels.

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.

gray = HealthLevel(string='gray')¶: No health data is available for this service.

green = HealthLevel(string='green')¶: Service is healthy.

orange = HealthLevel(string='orange')¶: The service health is degraded. The service might have serious problems.

red = HealthLevel(string='red')¶: The service is unavaiable, not functioning properly, or will stop functioning soon.

yellow = HealthLevel(string='yellow')¶: The service is healthy state, but experiencing some levels of problems.

get()¶

Get storage health.

Return type:	`Storage.HealthLevel`
Returns:	Storage health.
Raise:	`com.vmware.vapi.std.errors_client.Error` Generic error

class com.vmware.appliance.health_client.StubFactory(stub_config)¶: Bases: vmware.vapi.bindings.stub.StubFactoryBase

class com.vmware.appliance.health_client.Swap(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

Swap class provides methods Get swap health.

class HealthLevel(string)¶

Bases: vmware.vapi.bindings.enum.Enum

Swap.HealthLevel class Defines health levels.

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.

gray = HealthLevel(string='gray')¶: No health data is available for this service.

green = HealthLevel(string='green')¶: Service is healthy.

orange = HealthLevel(string='orange')¶: The service health is degraded. The service might have serious problems.

red = HealthLevel(string='red')¶: The service is unavaiable, not functioning properly, or will stop functioning soon.

yellow = HealthLevel(string='yellow')¶: The service is healthy state, but experiencing some levels of problems.

get()¶

Get swap health.

Return type:	`Swap.HealthLevel`
Returns:	Swap health
Raise:	`com.vmware.vapi.std.errors_client.Error` Generic error

class com.vmware.appliance.health_client.System(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

System class provides methods Get overall health of the system.

class HealthLevel(string)¶

Bases: vmware.vapi.bindings.enum.Enum

System.HealthLevel class Defines health levels.

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.

gray = HealthLevel(string='gray')¶: No health data is available for this service.

green = HealthLevel(string='green')¶: Service is healthy.

orange = HealthLevel(string='orange')¶: The service health is degraded. The service might have serious problems.

red = HealthLevel(string='red')¶: The service is unavaiable, not functioning properly, or will stop functioning soon.

yellow = HealthLevel(string='yellow')¶: The service is healthy state, but experiencing some levels of problems.

get()¶

Get overall health of system.

Return type:	`System.HealthLevel`
Returns:	System health
Raise:	`com.vmware.vapi.std.errors_client.Error` Generic error

lastcheck()¶

Get last check timestamp of the health of the system.

Return type:	`datetime.datetime`
Returns:	System health last check timestamp
Raise:	`com.vmware.vapi.std.errors_client.Error` Generic error

com.vmware.appliance.local_accounts_client module¶

class com.vmware.appliance.local_accounts_client.Policy(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

The Policy class provides methods to manage local user accounts. This class was added in vSphere API 6.7

class Info(max_days=None, min_days=None, warn_days=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The Policy.Info class defines the global password policy. This class was added in vSphere API 6.7

Tip

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

get()¶

Get the global password policy. This method was added in vSphere API 6.7

Return type:	`Policy.Info`
Returns:	Global password policy
Raise:	`com.vmware.vapi.std.errors_client.Error` Generic error

set(policy)¶

Set the global password policy. This method was added in vSphere API 6.7

Parameters:	policy (`Policy.Info`) – Global password policy
Raise:	`com.vmware.vapi.std.errors_client.InvalidArgument` if passed policy values are < -1 or > 99999
Raise:	`com.vmware.vapi.std.errors_client.Error` Generic error

class com.vmware.appliance.local_accounts_client.StubFactory(stub_config)¶: Bases: vmware.vapi.bindings.stub.StubFactoryBase

com.vmware.appliance.localaccounts_client module¶

The com.vmware.appliancelocalaccounts module provides classes for managing local (OS) accounts in the appliance. The module is available starting in vSphere 6.5.

class com.vmware.appliance.localaccounts_client.StubFactory(stub_config)¶: Bases: vmware.vapi.bindings.stub.StubFactoryBase

com.vmware.appliance.logging_client module¶

The com.vmware.appliance.logging_client module provides classes for managing log forwarding in the appliance. The module is available starting in vSphere 6.5.

class com.vmware.appliance.logging_client.Forwarding(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

The Forwarding class provides methods to manage forwarding of log messages to remote logging servers. This class was added in vSphere API 6.7

class Config(hostname=None, port=None, protocol=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The Forwarding.Config class defines the configuration for log message forwarding to remote logging servers. This class was added in vSphere API 6.7

Tip

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

class ConnectionStatus(hostname=None, state=None, message=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Tip

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

class State(string)¶

Bases: vmware.vapi.bindings.enum.Enum

The Forwarding.ConnectionStatus.State class defines the state values that a remote logging server can be in. This enumeration was added in vSphere API 6.7

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.

DOWN = State(string='DOWN')¶: The remote logging server is not reachable. This class attribute was added in vSphere API 6.7

UNKNOWN = State(string='UNKNOWN')¶: The status of remote logging server is unknown. This class attribute was added in vSphere API 6.7

UP = State(string='UP')¶: The remote logging server is reachable. This class attribute was added in vSphere API 6.7

class Protocol(string)¶

Bases: vmware.vapi.bindings.enum.Enum

The Forwarding.Protocol class defines transport protocols for outbound log messages. This enumeration was added in vSphere API 6.7

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.

TCP = Protocol(string='TCP')¶: Log messages will be forwarded to the remote host using the TCP protocol. This class attribute was added in vSphere API 6.7

TLS = Protocol(string='TLS')¶: Log messages will be forwarded to the remote host by using the TLS protocol. This class attribute was added in vSphere API 6.7

UDP = Protocol(string='UDP')¶: Log messages will be forwarded to the remote host using the UDP protocol. This class attribute was added in vSphere API 6.7

get()¶

Returns the configuration for forwarding log messages to remote logging servers. This method was added in vSphere API 6.7

Return type:	`list` of `Forwarding.Config`
Returns:	Information about the configuration for forwarding log messages to remote logging servers.

set(cfg_list)¶

Sets the configuration for forwarding log messages to remote log servers. This method was added in vSphere API 6.7

Parameters:	cfg_list (`list` of `Forwarding.Config`) – The cfgList is a list of Config structure that contains the log message forwarding rules in terms of the host, port, protocol of the log message.
Raise:	`com.vmware.vapi.std.errors_client.InvalidArgument` if an invalid configuration is provided.
Raise:	`com.vmware.vapi.std.errors_client.UnableToAllocateResource` if the number of configurations exceeds the maximum number of supported configurations.
Raise:	`com.vmware.vapi.std.errors_client.Error` if there is any internal error during the execution of the operation.

test(send_test_message=None)¶

Validates the current log forwarding configuration by checking the liveness of the remote machine and optionally sending a test diagnostic log message from the appliance to all configured logging servers to allow manual end-to-end validation. The message that is sent is: “This is a diagnostic log test message from vCenter Server.”. This method was added in vSphere API 6.7

Parameters:	send_test_message (`bool` or `None`) – Flag specifying whether a default test message should be sent to the configured logging servers. If None, no test message will be sent to the configured remote logging servers.
Return type:	`list` of `Forwarding.ConnectionStatus`
Returns:	Information about the status of the connection to each of the remote logging servers.

class com.vmware.appliance.logging_client.StubFactory(stub_config)¶: Bases: vmware.vapi.bindings.stub.StubFactoryBase

com.vmware.appliance.monitoring_client module¶

The com.vmware.appliance.monitoring_client module provides classes for monitoring of the appliance. The module is available starting in vSphere 6.5.

class com.vmware.appliance.monitoring_client.StubFactory(stub_config)¶: Bases: vmware.vapi.bindings.stub.StubFactoryBase

com.vmware.appliance.networking_client module¶

The com.vmware.appliance.networking_client module provides classes for managing network configuration of the appliance. The module is available starting in vSphere 6.5.

class com.vmware.appliance.networking_client.Interfaces(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

Interfaces class provides methods Provides information about network interface.

class InterfaceInfo(name=None, status=None, mac=None, ipv4=None, ipv6=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Interfaces.InterfaceInfo class Structure that defines properties and status of a network interface.

Tip

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

class InterfaceStatus(string)¶

Bases: vmware.vapi.bindings.enum.Enum

Interfaces.InterfaceStatus class Defines interface status

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.

down = InterfaceStatus(string='down')¶: The interface is down.

up = InterfaceStatus(string='up')¶: The interface is up.

get(interface_name)¶

Get information about a particular network interface.

Parameters:	interface_name (`str`) – Network interface, for example, “nic0”. The parameter must be an identifier for the resource type: `com.vmware.appliance.networking.interfaces`.
Return type:	`Interfaces.InterfaceInfo`
Returns:	Network interface information.
Raise:	`com.vmware.vapi.std.errors_client.NotFound` if the specified interface is not found.
Raise:	`com.vmware.vapi.std.errors_client.Error` Generic error

list()¶

Get list of available network interfaces, including those that are not yet configured.

Return type:	`list` of `Interfaces.InterfaceInfo`
Returns:	List of InterfaceInfo structures.
Raise:	`com.vmware.vapi.std.errors_client.Error` Generic error

class com.vmware.appliance.networking_client.NoProxy(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

The NoProxy class provides methods to configure a connection that does not need a proxy. This class was added in vSphere API 6.7

get()¶

Returns servers for which no proxy configuration will be applied. This method was added in vSphere API 6.7

Return type:	`list` of `str`
Returns:	List of servers for which no proxy configuration will be applied.
Raise:	`com.vmware.vapi.std.errors_client.Error` Generic error.

set(servers)¶

Sets servers for which no proxy configuration should be applied. This operation sets environment variables. In order for this operation to take effect, a logout from appliance or a service restart is required. If IPv4 is enabled, “127.0.0.1” and “localhost” will always bypass the proxy (even if they are not explicitly configured). This method was added in vSphere API 6.7

Parameters:	servers (`list` of `str`) – List of strings representing servers to bypass proxy. A server can be a FQDN, IP address, FQDN:port or IP:port combinations.
Raise:	`com.vmware.vapi.std.errors_client.Error` Generic error.

class com.vmware.appliance.networking_client.Proxy(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

The Proxy class provides methods Proxy configuration. This class was added in vSphere API 6.7

class Config(server=None, port=None, username=None, password=None, enabled=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The Proxy.Config class defines proxy configuration. This class was added in vSphere API 6.7

Tip

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

class Protocol(string)¶

Bases: vmware.vapi.bindings.enum.Enum

Proxy.Protocol class defines the protocols for which proxying is supported. This enumeration was added in vSphere API 6.7

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.

FTP = Protocol(string='FTP')¶: Proxy configuration for ftp. This class attribute was added in vSphere API 6.7

HTTP = Protocol(string='HTTP')¶: Proxy configuration for http. This class attribute was added in vSphere API 6.7

HTTPS = Protocol(string='HTTPS')¶: Proxy configuration for https. This class attribute was added in vSphere API 6.7

class ServerStatus(string)¶

Bases: vmware.vapi.bindings.enum.Enum

Proxy.ServerStatus class defines the status of the server associated with the test run. This enumeration was added in vSphere API 6.7

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.

SERVER_REACHABLE = ServerStatus(string='SERVER_REACHABLE')¶: Server is reachable. This class attribute was added in vSphere API 6.7

SERVER_UNREACHABLE = ServerStatus(string='SERVER_UNREACHABLE')¶: Server is unreachable. This class attribute was added in vSphere API 6.7

class TestResult(status=None, message=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The Proxy.TestResult class contains information about the test operation done on a proxy server. This class was added in vSphere API 6.7

Tip

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

delete(protocol)¶

Deletes a proxy configuration for a specific protocol. This method was added in vSphere API 6.7

Parameters:	protocol (`str`) – ID whose proxy is to be deleted.
Raise:	`com.vmware.vapi.std.errors_client.Error` Generic error.

get(protocol)¶

Gets the proxy configuration for a specific protocol. This method was added in vSphere API 6.7

Parameters:	protocol (`str`) – The protocol whose proxy configuration is requested.
Return type:	`Proxy.Config`
Returns:	Proxy configuration for a specific protocol.
Raise:	`com.vmware.vapi.std.errors_client.Error` Generic error.

list()¶

Gets proxy configuration for all configured protocols. This method was added in vSphere API 6.7

Return type:	`dict` of `Proxy.Protocol` and `Proxy.Config`
Returns:	Proxy configuration for all configured protocols.
Raise:	`com.vmware.vapi.std.errors_client.Error` Generic error.

set(protocol, config)¶

Configures which proxy server to use for the specified protocol. This operation sets environment variables for using proxy. In order for this configuration to take effect a logout / service restart is required. This method was added in vSphere API 6.7

Parameters:	protocol (`str`) – The protocol for which proxy should be set. config (`Proxy.Config`) – Proxy configuration for the specific protocol.
Raise:	`com.vmware.vapi.std.errors_client.Error` Generic error.

test(host, protocol, config)¶

Tests a proxy configuration by testing the connection to the proxy server and test host. This method was added in vSphere API 6.7

Parameters:	host (`str`) – A hostname, IPv4 or Ipv6 address. protocol (`str`) – Protocol whose proxy is to be tested. config (`Proxy.Config`) – Proxy configuration to test.
Return type:	`Proxy.TestResult`
Returns:	Status of proxy settings.
Raise:	`com.vmware.vapi.std.errors_client.Error` Generic error.

class com.vmware.appliance.networking_client.StubFactory(stub_config)¶: Bases: vmware.vapi.bindings.stub.StubFactoryBase

com.vmware.appliance.ntp_client module¶

The com.vmware.appliance.ntp_client module provides classes for managing NTP settings of the appliance. The module is available starting in vSphere 6.5.

class com.vmware.appliance.ntp_client.StubFactory(stub_config)¶: Bases: vmware.vapi.bindings.stub.StubFactoryBase

com.vmware.appliance.recovery_client module¶

The com.vmware.appliance.recovery_client module provides classes for backin up and restoring vCenter Appliance configuration. The module is available starting in vSphere 6.7.

class com.vmware.appliance.recovery_client.Backup(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

Backup class provides methods Performs backup restore operations

class BackupRequest(parts=None, backup_password=None, location_type=None, location=None, location_user=None, location_password=None, comment=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Backup.BackupRequest class Structure representing requested backup piece

Tip

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

class LocalizableMessage(id=None, default_message=None, args=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Backup.LocalizableMessage class Structure representing message

Tip

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

class LocationType(string)¶

Bases: vmware.vapi.bindings.enum.Enum

Backup.LocationType class Defines type of all locations for backup/restore

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.

FTP = LocationType(string='FTP')¶: Destination is FTP server

FTPS = LocationType(string='FTPS')¶: Destination is FTPS server

HTTP = LocationType(string='HTTP')¶: Destination is HTTP server

HTTPS = LocationType(string='HTTPS')¶: Destination is HTTPS server

SCP = LocationType(string='SCP')¶: Destination is SSH server

class ReturnResult(status=None, messages=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Backup.ReturnResult class Structure representing precheck result

Tip

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

class ReturnStatus(string)¶

Bases: vmware.vapi.bindings.enum.Enum

Backup.ReturnStatus class Defines the state of precheck

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.

FAIL = ReturnStatus(string='FAIL')¶: Check failed

OK = ReturnStatus(string='OK')¶: Check passed

WARNING = ReturnStatus(string='WARNING')¶: Passed with warnings

validate(piece)¶

Check for backup errors without starting backup.

Parameters:	piece (`Backup.BackupRequest`) – BackupRequest Structure
Return type:	`Backup.ReturnResult`
Returns:	ReturnResult Structure
Raise:	`com.vmware.vapi.std.errors_client.FeatureInUse` A backup or restore is already in progress
Raise:	`com.vmware.vapi.std.errors_client.Error` Generic error

class com.vmware.appliance.recovery_client.Restore(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

Restore class provides methods Performs restore operations

class LocalizableMessage(id=None, default_message=None, args=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Restore.LocalizableMessage class Structure representing message

Tip

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

class LocationType(string)¶

Bases: vmware.vapi.bindings.enum.Enum

Restore.LocationType class Defines type of all locations for backup/restore

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.

FTP = LocationType(string='FTP')¶: Destination is FTP server

FTPS = LocationType(string='FTPS')¶: Destination is FTPS server

HTTP = LocationType(string='HTTP')¶: Destination is HTTP server

HTTPS = LocationType(string='HTTPS')¶: Destination is HTTPS server

SCP = LocationType(string='SCP')¶: Destination is SSH server

class Metadata(timestamp=None, parts=None, version=None, boxname=None, sso_login_required=None, comment=None, applicable=None, messages=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Restore.Metadata class Structure representing metadata

Tip

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

class RestoreRequest(backup_password=None, location_type=None, location=None, location_user=None, location_password=None, sso_admin_user_name=None, sso_admin_user_password=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Restore.RestoreRequest class Structure representing requested restore piece

Tip

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

validate(piece)¶

Get metadata before restore

Parameters:	piece (`Restore.RestoreRequest`) – RestoreRequest Structure
Return type:	`Restore.Metadata`
Returns:	Metadata Structure
Raise:	`com.vmware.vapi.std.errors_client.Error` Generic error

class com.vmware.appliance.recovery_client.StubFactory(stub_config)¶: Bases: vmware.vapi.bindings.stub.StubFactoryBase

com.vmware.appliance.shutdown_client module¶

The com.vmware.appliance.shutdown_client module provides classes to shutdown and reboot the appliance. The module is available starting in vSphere 6.5.

class com.vmware.appliance.shutdown_client.StubFactory(stub_config)¶: Bases: vmware.vapi.bindings.stub.StubFactoryBase

com.vmware.appliance.system_client module¶

The com.vmware.appliance.system_client module provides classes to query the appliance system information. The module is available starting in vSphere 6.5.

class com.vmware.appliance.system_client.Storage(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

Storage class provides methods Appliance storage configuration

class StorageChange(old_size=None, new_size=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The Storage.StorageChange class describes the changes in capasity of a storage partition. This class was added in vSphere API 6.7

Tip

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

class StorageMapping(disk=None, partition=None, description=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The Storage.StorageMapping class describes the mapping between VCSA partitions and the Hard disk numbers visible in the vSphere Web Client.

Tip

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

list()¶

Get disk to partition mapping.

Return type:	`list` of `Storage.StorageMapping`
Returns:	list of mapping items
Raise:	`com.vmware.vapi.std.errors_client.Error` Generic error

resize()¶

Resize all partitions to 100 percent of disk size.

Raise:	`com.vmware.vapi.std.errors_client.Error` Generic error

resize_ex()¶

Resize all partitions to 100 percent of disk size. This method was added in vSphere API 6.7

Return type:	`dict` of `str` and `Storage.StorageChange`
Returns:	List of the partitions with the size before and after resizing
Raise:	`com.vmware.vapi.std.errors_client.Error` Generic error

class com.vmware.appliance.system_client.StubFactory(stub_config)¶: Bases: vmware.vapi.bindings.stub.StubFactoryBase

class com.vmware.appliance.system_client.Time(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

Time class provides methods Gets system time.

class SystemTimeStruct(seconds_since_epoch=None, date=None, time=None, timezone=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Time.SystemTimeStruct class Structure representing the system time.

Tip

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

get()¶

Get system time.

Return type:	`Time.SystemTimeStruct`
Returns:	System time
Raise:	`com.vmware.vapi.std.errors_client.Error` Generic error

class com.vmware.appliance.system_client.Uptime(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

Uptime class provides methods Get the system uptime.

get()¶

Get the system uptime.

Return type:	`float`
Returns:	system uptime
Raise:	`com.vmware.vapi.std.errors_client.Error` Generic error

class com.vmware.appliance.system_client.Version(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

Version class provides methods Get the appliance version.

class VersionStruct(version=None, product=None, build=None, type=None, summary=None, releasedate=None, install_time=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Version.VersionStruct class Structure representing appliance version information.

Tip

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

get()¶

Get the version.

Return type:	`Version.VersionStruct`
Returns:	version information about the appliance
Raise:	`com.vmware.vapi.std.errors_client.Error` Generic error

com.vmware.appliance.tymesync_client module¶

The com.vmware.appliance.tymesync_client module provides classes for managing tyme synchronization settings of the appliance. The module is available starting in vSphere 6.5.

class com.vmware.appliance.tymesync_client.StubFactory(stub_config)¶: Bases: vmware.vapi.bindings.stub.StubFactoryBase

com.vmware.appliance.update_client module¶

The com.vmware.appliance.update_client module provides classes for updating the software in the appliance. The module is available starting in vSphere 6.5.

class com.vmware.appliance.update_client.CommonInfo(description=None, priority=None, severity=None, update_type=None, release_date=None, reboot_required=None, size=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The CommonInfo class defines common update information

Tip

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

class Category(string)¶

Bases: vmware.vapi.bindings.enum.Enum

The CommonInfo.Category class defines update type

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.

FIX = Category(string='FIX')¶: Fixes bugs/vulnerabilities, doesn’t change functionality

SECURITY = Category(string='SECURITY')¶: Fixes vulnerabilities, doesn’t change functionality

UPDATE = Category(string='UPDATE')¶: Changes product functionality

UPGRADE = Category(string='UPGRADE')¶: Introduces new features, significantly changes product functionality

class Priority(string)¶

Bases: vmware.vapi.bindings.enum.Enum

The CommonInfo.Priority class defines the update installation priority recommendations.

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.

HIGH = Priority(string='HIGH')¶: Install ASAP

LOW = Priority(string='LOW')¶: Install at your discretion

MEDIUM = Priority(string='MEDIUM')¶: Install at the earliest convenience

class Severity(string)¶

Bases: vmware.vapi.bindings.enum.Enum

The CommonInfo.Severity class defines the severity of the issues fixed in the update.

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.

CRITICAL = Severity(string='CRITICAL')¶: Vulnerabilities that can be exploited by an unauthenticated attacker from the Internet or those that break the guest/host Operating System isolation. The exploitation results in the complete compromise of confidentiality, integrity, and availability of user data and/or processing resources without user interaction. Exploitation could be leveraged to propagate an Internet worm or execute arbitrary code between Virtual Machines and/or the Host Operating System.

IMPORTANT = Severity(string='IMPORTANT')¶: Vulnerabilities that are not rated critical but whose exploitation results in the complete compromise of confidentiality and/or integrity of user data and/or processing resources through user assistance or by authenticated attackers. This rating also applies to those vulnerabilities which could lead to the complete compromise of availability when exploitation is by a remote unauthenticated attacker from the Internet or through a breach of virtual machine isolation.

LOW = Severity(string='LOW')¶: All other issues that have a security impact. Vulnerabilities where exploitation is believed to be extremely difficult, or where successful exploitation would have minimal impact

MODERATE = Severity(string='MODERATE')¶: Vulnerabilities where the ability to exploit is mitigated to a significant degree by configuration or difficulty of exploitation, but in certain deployment scenarios could still lead to the compromise of confidentiality, integrity, or availability of user data and/or processing resources.

class com.vmware.appliance.update_client.Pending(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

The Pending class provides methods to manipulate pending updates.

class Info(contents=None, services_will_be_stopped=None, eulas=None, staged=None, description=None, priority=None, severity=None, update_type=None, release_date=None, reboot_required=None, size=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The Pending.Info class contains the extended information about the update

Tip

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

class PrecheckResult(check_time=None, estimated_time_to_install=None, estimated_time_to_rollback=None, reboot_required=None, issues=None, questions=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The Pending.PrecheckResult class contains estimates of how long it will take install and rollback an update as well as a list of possible warnings and problems with installing the update.

Tip

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

class Question(data_item=None, text=None, description=None, type=None, allowed_values=None, regexp=None, default_answer=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The Pending.Question class describes a item of information that must be provided by the user in order to install the update.

Tip

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

class InputType(string)¶

Bases: vmware.vapi.bindings.enum.Enum

The Pending.Question.InputType class defines representation of field fields in GUI or CLI

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.

BOOLEAN = InputType(string='BOOLEAN')¶: Yes/No,On/Off,Checkbox answer

PASSWORD = InputType(string='PASSWORD')¶: Password (masked) answer

PLAIN_TEXT = InputType(string='PLAIN_TEXT')¶: plain text answer

class SourceType(string)¶

Bases: vmware.vapi.bindings.enum.Enum

The Pending.SourceType class defines the supported types of sources of updates.

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.

LAST_CHECK = SourceType(string='LAST_CHECK')¶: Do not perform a new check, return the previous result

LOCAL = SourceType(string='LOCAL')¶: Check the local sources, ISO devices, staged area

LOCAL_AND_ONLINE = SourceType(string='LOCAL_AND_ONLINE')¶: Check the local sources, ISO devices, staged area, then online repository as stated in update policy

get(version)¶

Gets update information

Parameters:	version (`str`) – Update version The parameter must be an identifier for the resource type: `com.vmware.appliance.update.pending`.
Return type:	`Pending.Info`
Returns:	Update
Raise:	`com.vmware.vapi.std.errors_client.Error` Generic error
Raise:	`com.vmware.vapi.std.errors_client.Unauthenticated` session is not authenticated
Raise:	`com.vmware.vapi.std.errors_client.Unauthorized` session is not authorized to perform this operation
Raise:	`com.vmware.vapi.std.errors_client.NotFound` the update is not found
Raise:	`com.vmware.vapi.std.errors_client.AlreadyInDesiredState` if the update of this version is already installed

install(version, user_data)¶

Starts operation of installing the appliance update. Will fail is the update is not staged

Parameters:	version (`str`) – Update version The parameter must be an identifier for the resource type: `com.vmware.appliance.update.pending`. user_data (`dict` of `str` and `str`) – map of user provided data with IDs The key in the parameter `dict` must be an identifier for the resource type: `com.vmware.applicance.update.pending.dataitem`.
Raise:	`com.vmware.vapi.std.errors_client.Error` Generic error
Raise:	`com.vmware.vapi.std.errors_client.Error` Generic error
Raise:	`com.vmware.vapi.std.errors_client.Unauthenticated` session is not authenticated
Raise:	`com.vmware.vapi.std.errors_client.Unauthorized` session is not authorized to perform this operation
Raise:	`com.vmware.vapi.std.errors_client.NotFound` if the update is not found
Raise:	`com.vmware.vapi.std.errors_client.AlreadyInDesiredState` if the update of this version is already installed
Raise:	`com.vmware.vapi.std.errors_client.NotAllowedInCurrentState` if appliance update state prevents running an update or not staged

list(source_type, url=None)¶

Checks if new updates are available.

Parameters:	source_type (`Pending.SourceType`) – type of the source url (`str` or `None`) – specific URL to check at If None then URL is taken from the policy settings
Return type:	`list` of `Summary`
Returns:	List of the update summaries
Raise:	`com.vmware.vapi.std.errors_client.Error` Generic error
Raise:	`com.vmware.vapi.std.errors_client.NotFound` source is not found
Raise:	`com.vmware.vapi.std.errors_client.Unauthenticated` session is not authenticated
Raise:	`com.vmware.vapi.std.errors_client.Unauthorized` session is not authorized to perform this operation

precheck(version)¶

Runs update precheck

Parameters:	version (`str`) – Update version The parameter must be an identifier for the resource type: `com.vmware.appliance.update.pending`.
Return type:	`Pending.PrecheckResult`
Returns:	PrecheckResult
Raise:	`com.vmware.vapi.std.errors_client.Error` Generic error
Raise:	`com.vmware.vapi.std.errors_client.Unauthenticated` session is not authenticated
Raise:	`com.vmware.vapi.std.errors_client.Unauthorized` session is not authorized to perform this operation
Raise:	`com.vmware.vapi.std.errors_client.NotFound` the update is not found
Raise:	`com.vmware.vapi.std.errors_client.AlreadyInDesiredState` if this version is already installed
Raise:	`com.vmware.vapi.std.errors_client.NotAllowedInCurrentState` if another operation is in progress

stage(version)¶

Starts staging the appliance update. The updates are searched for in the following order: staged, CDROM, URL

Parameters:	version (`str`) – Update version The parameter must be an identifier for the resource type: `com.vmware.appliance.update.pending`.
Raise:	`com.vmware.vapi.std.errors_client.Error` Generic error
Raise:	`com.vmware.vapi.std.errors_client.Unauthenticated` session is not authenticated
Raise:	`com.vmware.vapi.std.errors_client.Unauthorized` session is not authorized to perform this operation
Raise:	`com.vmware.vapi.std.errors_client.NotFound` the update is not found
Raise:	`com.vmware.vapi.std.errors_client.AlreadyInDesiredState` if the update of this version is already installed
Raise:	`com.vmware.vapi.std.errors_client.AlreadyExists` the update is already staged
Raise:	`com.vmware.vapi.std.errors_client.NotAllowedInCurrentState` if appliance update state prevents staging

stage_and_install(version, user_data)¶

Starts operation of installing the appliance update. Will stage update if not already staged The updates are searched for in the following order: staged, CDROM, URL

Parameters:	version (`str`) – Update version The parameter must be an identifier for the resource type: `com.vmware.appliance.update.pending`. user_data (`dict` of `str` and `str`) – map of user provided data with IDs The key in the parameter `dict` must be an identifier for the resource type: `com.vmware.applicance.update.pending.dataitem`.
Raise:	`com.vmware.vapi.std.errors_client.Error` Generic error
Raise:	`com.vmware.vapi.std.errors_client.Error` Generic error
Raise:	`com.vmware.vapi.std.errors_client.Unauthenticated` session is not authenticated
Raise:	`com.vmware.vapi.std.errors_client.Unauthorized` session is not authorized to perform this operation
Raise:	`com.vmware.vapi.std.errors_client.NotFound` if the update is not found
Raise:	`com.vmware.vapi.std.errors_client.AlreadyInDesiredState` if the update of this version is already installed
Raise:	`com.vmware.vapi.std.errors_client.NotAllowedInCurrentState` if appliance update state prevents running an update

validate(version, user_data)¶

Validates the user provided data before the update installation.

Parameters:	version (`str`) – Update version The parameter must be an identifier for the resource type: `com.vmware.appliance.update.pending`. user_data (`dict` of `str` and `str`) – map of user provided data with IDs The key in the parameter `dict` must be an identifier for the resource type: `com.vmware.applicance.update.pending.dataitem`.
Return type:	`com.vmware.appliance_client.Notifications`
Returns:	Issues struct with the issues found during the validation
Raise:	`com.vmware.vapi.std.errors_client.Error` Generic error
Raise:	`com.vmware.vapi.std.errors_client.Unauthenticated` session is not authenticated
Raise:	`com.vmware.vapi.std.errors_client.Unauthorized` session is not authorized to perform this operation
Raise:	`com.vmware.vapi.std.errors_client.NotFound` if the update is not found
Raise:	`com.vmware.vapi.std.errors_client.AlreadyInDesiredState` if the update of this version is already installed
Raise:	`com.vmware.vapi.std.errors_client.NotAllowedInCurrentState` if appliance update state prevents running an check

class com.vmware.appliance.update_client.Policy(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

The Policy class provides methods to set/get background check for the new updates.

class Config(custom_url=None, username=None, password=None, check_schedule=None, auto_stage=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The Policy.Config class defines automatic update checking and staging policy.

Tip

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

class DayOfWeek(string)¶

Bases: vmware.vapi.bindings.enum.Enum

The Policy.DayOfWeek class defines the set of days

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.

FRIDAY = DayOfWeek(string='FRIDAY')¶: Friday

MONDAY = DayOfWeek(string='MONDAY')¶: Monday

SATURDAY = DayOfWeek(string='SATURDAY')¶: Saturday

SUNDAY = DayOfWeek(string='SUNDAY')¶: Sunday

THURSDAY = DayOfWeek(string='THURSDAY')¶: Thursday

TUESDAY = DayOfWeek(string='TUESDAY')¶: Tuesday

WEDNESDAY = DayOfWeek(string='WEDNESDAY')¶: Wednesday

class Info(custom_url=None, default_url=None, username=None, check_schedule=None, auto_stage=None, auto_update=None, manual_control=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The Policy.Info class defines automatic update checking and staging policy.

Tip

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

class Time(day=None, hour=None, minute=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The Policy.Time class defines weekday and time the automatic check for new updates will be run

Tip

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

get()¶

Gets the automatic update checking and staging policy.

Return type:	`Policy.Info`
Returns:	Structure containing the policy for the appliance update.
Raise:	`com.vmware.vapi.std.errors_client.Error` Generic error
Raise:	`com.vmware.vapi.std.errors_client.Unauthenticated` session is not authenticated
Raise:	`com.vmware.vapi.std.errors_client.Unauthorized` session is not authorized to perform this operation

set(policy)¶

Sets the automatic update checking and staging policy.

Parameters:	policy (`Policy.Config`) – Info structure containing the policy for the appliance update.
Raise:	`com.vmware.vapi.std.errors_client.Error` Generic error
Raise:	`com.vmware.vapi.std.errors_client.Unauthenticated` session is not authenticated
Raise:	`com.vmware.vapi.std.errors_client.Unauthorized` session is not authorized to perform this operation

class com.vmware.appliance.update_client.ServiceInfo(service=None, description=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The ServiceInfo class describes a service to be stopped and started during the update installation.

Tip

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

class com.vmware.appliance.update_client.Staged(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

The Staged class provides methods to get the status of the staged update.

class Info(staging_complete=None, version=None, description=None, priority=None, severity=None, update_type=None, release_date=None, reboot_required=None, size=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The Staged.Info class contains information about the staged update

Tip

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

delete()¶

Deletes the staged update

Raise:	`com.vmware.vapi.std.errors_client.Error` Generic error
Raise:	`com.vmware.vapi.std.errors_client.Unauthenticated` session is not authenticated
Raise:	`com.vmware.vapi.std.errors_client.Unauthorized` session is not authorized to perform this operation

get()¶

Gets the current status of the staged update

Return type:	`Staged.Info`
Returns:	Info structure with information about staged update
Raise:	`com.vmware.vapi.std.errors_client.Error` Generic error
Raise:	`com.vmware.vapi.std.errors_client.Unauthenticated` session is not authenticated
Raise:	`com.vmware.vapi.std.errors_client.Unauthorized` session is not authorized to perform this operation
Raise:	`com.vmware.vapi.std.errors_client.NotAllowedInCurrentState` if nothing is staged

class com.vmware.appliance.update_client.StubFactory(stub_config)¶: Bases: vmware.vapi.bindings.stub.StubFactoryBase

class com.vmware.appliance.update_client.Summary(version=None, description=None, priority=None, severity=None, update_type=None, release_date=None, reboot_required=None, size=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The Summary class contains the essential information about the update

Tip

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

com.vmware.appliance.vmon_client module¶

The com.vmware.appliance.vmon_client module provides classes to manage a set of services that are part of the vCenter Server.

class com.vmware.appliance.vmon_client.Service(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

The Service class provides methods to manage a single/set of services that are managed by vMon.

class Health(string)¶

Bases: vmware.vapi.bindings.enum.Enum

The Service.Health class defines the possible values for health of a service.

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.

DEGRADED = Health(string='DEGRADED')¶: Service is in degraded state, it is not functional.

HEALTHY = Health(string='HEALTHY')¶: Service is in a healthy state and is fully functional.

HEALTHY_WITH_WARNINGS = Health(string='HEALTHY_WITH_WARNINGS')¶: Service is healthy with warnings.

class Info(name_key=None, description_key=None, startup_type=None, state=None, health=None, health_messages=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The Service.Info class contains information about a service.

Tip

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

class StartupType(string)¶

Bases: vmware.vapi.bindings.enum.Enum

The Service.StartupType class defines valid Startup Type for services managed by vMon.

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.

AUTOMATIC = StartupType(string='AUTOMATIC')¶: Service Startup type is Automatic, thus during starting all services or issuing explicit start on the service will start it.

DISABLED = StartupType(string='DISABLED')¶: Service Startup type is Disabled, thus it will not start unless the startup type changes to manual or automatic.

MANUAL = StartupType(string='MANUAL')¶: Service Startup type is Manual, thus issuing an explicit start on the service will start it.

class State(string)¶

Bases: vmware.vapi.bindings.enum.Enum

The Service.State class defines valid Run State for services.

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.

STARTED = State(string='STARTED')¶: Service Run State is Started, it is fully functional

STARTING = State(string='STARTING')¶: Service Run State is Starting, it is still not functional

STOPPED = State(string='STOPPED')¶: Service Run State is Stopped

STOPPING = State(string='STOPPING')¶: Service Run State is Stopping, it is not functional

class UpdateSpec(startup_type=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The Service.UpdateSpec class describes the changes to be made to the configuration of the service.

Tip

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

get(service)¶

Returns the state of a service.

Parameters:	service (`str`) – identifier of the service whose state is being queried. The parameter must be an identifier for the resource type: `com.vmware.appliance.vmon.Service`.
Return type:	`Service.Info`
Returns:	Service Info structure.
Raise:	`com.vmware.vapi.std.errors_client.NotFound` if the service associated with `service` does not exist.
Raise:	`com.vmware.vapi.std.errors_client.Error` if any other error occurs during the execution of the operation.

list_details()¶

Lists details of services managed by vMon.

Return type:	`dict` of `str` and `Service.Info`
Returns:	Map of service identifiers to service Info structures. The key in the return value `dict` will be an identifier for the resource type: `com.vmware.appliance.vmon.Service`.
Raise:	`com.vmware.vapi.std.errors_client.Error` if any error occurs during the execution of the operation.

restart(service)¶

Restarts a service

Parameters:	service (`str`) – identifier of the service to restart The parameter must be an identifier for the resource type: `com.vmware.appliance.vmon.Service`.
Raise:	`com.vmware.vapi.std.errors_client.NotFound` if the service associated with `service` does not exist.
Raise:	`com.vmware.vapi.std.errors_client.TimedOut` if any timeout occurs during the execution of the restart operation.
Raise:	`com.vmware.vapi.std.errors_client.NotAllowedInCurrentState` if the operation is denied in the current state of the service. If a stop or start operation is in progress, issuing a restart operation will lead to this error.
Raise:	`com.vmware.vapi.std.errors_client.NotAllowedInCurrentState` if a restart operation is issued on a service which has startup type `Service.StartupType.DISABLED`
Raise:	`com.vmware.vapi.std.errors_client.Error` if any other error occurs during the execution of the operation.

start(service)¶

Starts a service

Parameters:	service (`str`) – identifier of the service to start The parameter must be an identifier for the resource type: `com.vmware.appliance.vmon.Service`.
Raise:	`com.vmware.vapi.std.errors_client.NotFound` if the service associated with `service` does not exist.
Raise:	`com.vmware.vapi.std.errors_client.NotAllowedInCurrentState` if the operation is denied in the current state of the service. If a stop or restart operation is in progress, the start operation will not be allowed.
Raise:	`com.vmware.vapi.std.errors_client.NotAllowedInCurrentState` if start operation is issued on a service which has startup type `Service.StartupType.DISABLED`.
Raise:	`com.vmware.vapi.std.errors_client.TimedOut` if any timeout occurs during the execution of the start operation. Timeout occurs when the service takes longer than StartTimeout to start.
Raise:	`com.vmware.vapi.std.errors_client.Error` if any other error occurs during the execution of the operation.

stop(service)¶

Stops a service

Parameters:	service (`str`) – identifier of the service to stop The parameter must be an identifier for the resource type: `com.vmware.appliance.vmon.Service`.
Raise:	`com.vmware.vapi.std.errors_client.NotFound` if the service associated with `service` does not exist.
Raise:	`com.vmware.vapi.std.errors_client.Error` if any other error occurs during the execution of the operation.
Raise:	`com.vmware.vapi.std.errors_client.NotAllowedInCurrentState` if the operation is denied in the current state of the service. If a stop operation is in progress, issuing another stop operation will lead to this error.

update(service, spec)¶

Updates the properties of a service.

Parameters:	service (`str`) – identifier of the service whose properties are being updated. The parameter must be an identifier for the resource type: `com.vmware.appliance.vmon.Service`. spec (`Service.UpdateSpec`) – Service Update specification.
Raise:	`com.vmware.vapi.std.errors_client.NotFound` if the service associated with `service` does not exist.
Raise:	`com.vmware.vapi.std.errors_client.Error` if any other error occurs during the execution of the operation.
Raise:	`com.vmware.vapi.std.errors_client.NotAllowedInCurrentState` if the operation is denied in the current state of the service. If a start, stop or restart operation is in progress, update operation will fail with this error.
Raise:	`com.vmware.vapi.std.errors_client.NotAllowedInCurrentState` if a request to set the `Service.UpdateSpec.startup_type` attribute of `spec` to `Service.StartupType.DISABLED` comes in for a service that is not in `Service.State.STOPPED` state.

class com.vmware.appliance.vmon_client.StubFactory(stub_config)¶: Bases: vmware.vapi.bindings.stub.StubFactoryBase