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.

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

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.

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

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.

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

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.

Parameters

enabled (bool) – Enabled can be set to true or false
timeout (long) – The timeout (in seconds) specifies how long you enable the Shell access. The maximum timeout is 86400 seconds(1 day).

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.

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

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

Initialize StubFactoryBase

Parameters: stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance

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.

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

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.Database(config)

Bases: vmware.vapi.bindings.stub.VapiInterface

The Database class provides methods to retrieve the health status of the vcdb. This class was added in vSphere API 7.0.0.1.

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

class Info(status=None, messages=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

The Database.Info class contains information about the health of the the database. This class was added in vSphere API 7.0.0.1.

Tip

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

Parameters

status (Database.Info.Status) – Database health status. This attribute was added in vSphere API 7.0.0.1.
messages (list of Database.Message) – Messages describing any issues with the database, along with their severity. This attribute was added in vSphere API 7.0.0.1.

class Status(string)

Bases: vmware.vapi.bindings.enum.Enum

The Database.Info.Status class describes the health of the database. This enumeration was added in vSphere API 7.0.0.1.

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 Status instance.

DEGRADED = Status(string='DEGRADED'): The database has issues but the impact on vCenter Server is low. This class attribute was added in vSphere API 7.0.0.1.

HEALTHY = Status(string='HEALTHY'): The database is healthy. This class attribute was added in vSphere API 7.0.0.1.

UNHEALTHY = Status(string='UNHEALTHY'): The database is corrupted and vCenter server functionality will be impacted. This class attribute was added in vSphere API 7.0.0.1.

class Message(severity=None, message=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

The Database.Message class contains a database health message along with its severity. This class was added in vSphere API 7.0.0.1.

Tip

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

Parameters

severity (Database.Message.Severity) – Severity of the message. This attribute was added in vSphere API 7.0.0.1.
message (com.vmware.vapi.std_client.LocalizableMessage) – Message describing the issue with the database. This attribute was added in vSphere API 7.0.0.1.

class Severity(string)

Bases: vmware.vapi.bindings.enum.Enum

The MessageSeverity class defines the levels of severity for a message. This enumeration was added in vSphere API 7.0.0.1.

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 Severity instance.

ERROR = Severity(string='ERROR'): Error message. This class attribute was added in vSphere API 7.0.0.1.

WARNING = Severity(string='WARNING'): Warning message. This class attribute was added in vSphere API 7.0.0.1.

get()

Returns the health status of the database. This method was added in vSphere API 7.0.0.1.

Return type: Database.Info
Returns: Health status of the database
Raise: com.vmware.vapi.std.errors_client.Error if issue in retrieving health of the database

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

Bases: vmware.vapi.bindings.stub.VapiInterface

Databasestorage class provides methods Get database storage health.

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

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.

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

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.

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

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.

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

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.

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

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.

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

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.

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

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.

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

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.

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

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.

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

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

Initialize StubFactoryBase

Parameters: stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance

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

Bases: vmware.vapi.bindings.stub.VapiInterface

Swap class provides methods Get swap health.

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

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.

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

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.

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

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.

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

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.infraprofile_client module

The com.vmware.appliance.infraprofile_client module provides classes to manage profile spec for the appliance

class com.vmware.appliance.infraprofile_client.Configs(config)

Bases: vmware.vapi.bindings.stub.VapiInterface

Configs class provides methods to manage desired configuration specification of an appliance.

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

class ImportProfileSpec(config_spec=None, profile_spec=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

The Configs.ImportProfileSpec class represents a spec information for import and validate.

Tip

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

Parameters

config_spec (str) – The JSON string representing the desired config specification.
profile_spec (Configs.ProfilesSpec or None) – The profile specification, if any only set if there is a profilespec avaliable for this import profilespec.

class ProfileInfo(name=None, info=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

The Configs.ProfileInfo class defines the information about profile.

Tip

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

Parameters

name (str) – Name of the profile which is also a profile identifier. When clients pass a value of this class as a parameter, the attribute must be an identifier for the resource type: com.vmware.infraprofile.profile. When methods return a value of this class as a return value, the attribute will be an identifier for the resource type: com.vmware.infraprofile.profile.
info (str) – Description of the profile.

class ProfilesSpec(encryption_key=None, description=None, profiles=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

The Configs.ProfilesSpec class represents a spec information for export operation.

Tip

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

Parameters

encryption_key (str or None) – Encryption Key to encrypt/decrypt profiles. If None encryption will not be used for the profile.
description (str or None) – Custom description provided by the user. If None description will be empty.
profiles (set of str or None) – Profiles to be exported/imported. When clients pass a value of this class as a parameter, the attribute must contain identifiers for the resource type: com.vmware.infraprofile.profile. When methods return a value of this class as a return value, the attribute will contain identifiers for the resource type: com.vmware.infraprofile.profile. If None or empty, all profiles will be returned.

class ValidationResult(status=None, notifications=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

The Configs.ValidationResult class contains attributes to describe result of validation of profile specification.

Tip

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

Parameters

status (Configs.ValidationStatus) – Status of the Profile spec.
notifications (Notifications or None) – Notifications to the user Only set if the notifications were reported by this particular validation.

class ValidationStatus(string)

Bases: vmware.vapi.bindings.enum.Enum

The Configs.ValidationStatus class defines possible values of status of profile spec.

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 ValidationStatus instance.

INVALID = ValidationStatus(string='INVALID'): Profile spec is invalid.

VALID = ValidationStatus(string='VALID'): Profile spec is valid.

export(spec=None)

Exports the desired profile specification.

Parameters: spec (Configs.ProfilesSpec or None) – information to export the profile.
Return type: str
Returns: Configuration specification JSON in string format.
Raise: com.vmware.vapi.std.errors_client.Error If there is unknown internal error. The accompanying error message will give more details about the failure.
Raise: com.vmware.vapi.std.errors_client.NotFound If there is no profile associated.
Raise: com.vmware.vapi.std.errors_client.ServiceUnavailable If the service is not available.
Raise: com.vmware.vapi.std.errors_client.Unauthenticated If the caller is not authenticated.

import_profile_task(spec)

Imports the desired profile specification.

Parameters

spec (Configs.ImportProfileSpec) – information to import the profile.

Return type

class: vmware.vapi.stdlib.client.task.Task

Returns

Task instance

Raise

com.vmware.vapi.std.errors_client.Error If there is unknown internal error. The accompanying error message will give more details about the failure.

Raise

com.vmware.vapi.std.errors_client.NotFound If there is no profile associated.

Raise

com.vmware.vapi.std.errors_client.ServiceUnavailable If the service is not available.

Raise

com.vmware.vapi.std.errors_client.NotAllowedInCurrentState If there is another operation in progress.

Raise

com.vmware.vapi.std.errors_client.Unauthenticated If the caller is not authenticated.

list()

List all the profiles which are registered.

Return type: list of Configs.ProfileInfo
Returns: List of profiles with description are registered.
Raise: com.vmware.vapi.std.errors_client.Error If there is unknown internal error. The accompanying error message will give more details about the failure.
Raise: com.vmware.vapi.std.errors_client.ServiceUnavailable If the service is not available.
Raise: com.vmware.vapi.std.errors_client.Unauthenticated If the caller is not authenticated.

validate_task(spec)

Validates the desired profile specification.

Parameters

spec (Configs.ImportProfileSpec) – information to validate the profile.

Return type

class: vmware.vapi.stdlib.client.task.Task

Returns

Task instance

Raise

com.vmware.vapi.std.errors_client.Error If there is unknown internal error. The accompanying error message will give more details about the failure.

Raise

com.vmware.vapi.std.errors_client.NotFound If there is no profile associated.

Raise

com.vmware.vapi.std.errors_client.ServiceUnavailable If the service is not available.

Raise

com.vmware.vapi.std.errors_client.Unauthenticated If the caller is not authenticated.

class com.vmware.appliance.infraprofile_client.Notification(notification=None, time=None, message=None, resolution=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

The Notification class contains attributes to describe any info/warning/error messages that Tasks can raise.

Tip

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

Parameters

notification (str) – The notification id. When clients pass a value of this class as a parameter, the attribute must be an identifier for the resource type: com.vmware.infraprofile.notification. When methods return a value of this class as a return value, the attribute will be an identifier for the resource type: com.vmware.infraprofile.notification.
time (datetime.datetime or None) – The time the notification was raised/found. Only set if the time information is available.
message (com.vmware.vapi.std_client.LocalizableMessage) – The notification message.
resolution (com.vmware.vapi.std_client.LocalizableMessage or None) – The resolution message, if any. Only set for warnings and errors.

class com.vmware.appliance.infraprofile_client.Notifications(info=None, warnings=None, errors=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

The Notifications class contains info/warning/error messages that can be reported be the task.

Tip

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

Parameters

info (list of Notification or None) – Info notification messages reported. Only set if an info was reported by the task.
warnings (list of Notification or None) – Warning notification messages reported. Only set if an warning was reported by the task.
errors (list of Notification or None) – Error notification messages reported. Only set if an error was reported by the task.

class com.vmware.appliance.infraprofile_client.StubFactory(stub_config)

Bases: vmware.vapi.bindings.stub.StubFactoryBase

Initialize StubFactoryBase

Parameters: stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance

class com.vmware.appliance.infraprofile_client.TaskInfo(progress=None, notifications=None, result=None, description=None, service=None, operation=None, parent=None, target=None, status=None, cancelable=None, error=None, start_time=None, end_time=None, user=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

The TaskInfo class contains information about a task.

Tip

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

Parameters

progress (com.vmware.cis.task_client.Progress) – Progress of the operation. This attribute is optional and it is only relevant when the value of status is one of com.vmware.cis.task_client.Status.RUNNING, com.vmware.cis.task_client.Status.BLOCKED, com.vmware.cis.task_client.Status.SUCCEEDED, or com.vmware.cis.task_client.Status.FAILED.
notifications (Notifications or None) – Notifications to the user Only set if the notifications were reported by this particular task.
result (DataValue or None) – Task result. This attribute will be None if the task has no result.
description (com.vmware.vapi.std_client.LocalizableMessage) – Description of the operation associated with the task.
service (str) – Identifier of the service containing the operation. When clients pass a value of this class as a parameter, the attribute must be an identifier for the resource type: com.vmware.vapi.service. When methods return a value of this class as a return value, the attribute will be an identifier for the resource type: com.vmware.vapi.service.
operation (str) – Identifier of the operation associated with the task. When clients pass a value of this class as a parameter, the attribute must be an identifier for the resource type: com.vmware.vapi.operation. When methods return a value of this class as a return value, the attribute will be an identifier for the resource type: com.vmware.vapi.operation.
parent (str or None) – Parent of the current task. When clients pass a value of this class as a parameter, the attribute must be an identifier for the resource type: com.vmware.cis.task. When methods return a value of this class as a return value, the attribute will be an identifier for the resource type: com.vmware.cis.task. This attribute will be None if the task has no parent.
target (com.vmware.vapi.std_client.DynamicID or None) – Identifier of the target created by the operation or an existing one the operation performed on. This attribute will be None if the operation has no target or multiple targets.
status (com.vmware.cis.task_client.Status) – Status of the operation associated with the task.
cancelable (bool) – Flag to indicate whether or not the operation can be cancelled. The value may change as the operation progresses.
error (Exception or None) – Description of the error if the operation status is “FAILED”. If None the description of why the operation failed will be included in the result of the operation (see com.vmware.cis.task_client.Info.result).
start_time (datetime.datetime) – Time when the operation is started. This attribute is optional and it is only relevant when the value of status is one of com.vmware.cis.task_client.Status.RUNNING, com.vmware.cis.task_client.Status.BLOCKED, com.vmware.cis.task_client.Status.SUCCEEDED, or com.vmware.cis.task_client.Status.FAILED.
end_time (datetime.datetime) – Time when the operation is completed. This attribute is optional and it is only relevant when the value of status is one of com.vmware.cis.task_client.Status.SUCCEEDED or com.vmware.cis.task_client.Status.FAILED.
user (str or None) – Name of the user who performed the operation. This attribute will be None if the operation is performed by the system.

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.

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

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.

Parameters

max_days (long or None) – Maximum number of days a password may be used. If the password is older than this, a password change will be forced. This attribute was added in vSphere API 6.7. If None then the restriction will be ignored.
min_days (long or None) – Minimum number of days allowed between password changes. Any password changes attempted sooner than this will be rejected. This attribute was added in vSphere API 6.7. If None then the restriction will be ignored.
warn_days (long or None) – Number of days warning given before a password expires. A zero means warning is given only upon the day of expiration. This attribute was added in vSphere API 6.7. If None then no warning will be provided.

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

Initialize StubFactoryBase

Parameters: stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance

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

Initialize StubFactoryBase

Parameters: stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance

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.

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

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.

Parameters

hostname (str) – FQDN or IP address of the logging server to which messages are forwarded. This attribute was added in vSphere API 6.7.
port (long) – The port on which the remote logging server is listening for forwarded log messages. This attribute was added in vSphere API 6.7.
protocol (Forwarding.Protocol) – Transport protocol used to forward log messages. This attribute was added in vSphere API 6.7.

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.

Parameters

hostname (str) – FQDN or IP address of the configured remote logging servers. This attribute was added in vSphere API 6.7.
state (Forwarding.ConnectionStatus.State) – State of the configured remote logging server. This attribute was added in vSphere API 6.7.
message (com.vmware.vapi.std_client.LocalizableMessage or None) – Message associated with the state of the configured remote logging server. This attribute was added in vSphere API 6.7. If None, there is no message to be shown.

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.

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

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.

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

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

Initialize StubFactoryBase

Parameters: stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance

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

Initialize StubFactoryBase

Parameters: stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance

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.

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

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.

Parameters

name (str) – Interface name, for example, “nic0”, “nic1”.
status (Interfaces.InterfaceStatus) – Interface status.
mac (str) – MAC address. For example 00:0C:29:94:BB:5A.
ipv4 (com.vmware.appliance.networking.interfaces_client.Ipv4.Info or None) – IPv4 Address information. This attribute was added in vSphere API 6.7. ipv4 This attribute will be None if IPv4 is not enabled.
ipv6 (com.vmware.appliance.networking.interfaces_client.Ipv6.Info or None) – IPv6 Address information. This attribute was added in vSphere API 6.7. ipv6 This attribute will be None if IPv6 is not enabled.

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.

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

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.

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

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.

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

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.

Parameters

server (str) – URL of the proxy server. This attribute was added in vSphere API 6.7.
port (long) – Port to connect to the proxy server. In a ‘get’ call, indicates the port connected to the proxy server. In a ‘set’ call, specifies the port to connect to the proxy server. A value of -1 indicates the default port. This attribute was added in vSphere API 6.7.
username (str or None) – Username for proxy server. This attribute was added in vSphere API 6.7. Only set if proxy requires username.
password (str or None) – Password for proxy server. This attribute was added in vSphere API 6.7. Only set if proxy requires password.
enabled (bool) – In the result of the #get and #list methods this attribute indicates whether proxying is enabled for a particular protocol. In the input to the test and set methods this attribute specifies whether proxying should be enabled for a particular protocol. This attribute was added in vSphere API 6.7.

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.

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

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.

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

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.

Parameters

status (Proxy.ServerStatus) – Status of the proxy server indicating whether the proxy server is reachable. This attribute was added in vSphere API 6.7.
message (com.vmware.vapi.std_client.LocalizableMessage) – Message associated with status. This attribute was added in vSphere API 6.7.

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

Initialize StubFactoryBase

Parameters: stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance

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

Initialize StubFactoryBase

Parameters: stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance

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

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

class BackupRequest(parts=None, backup_password=None, location_type=None, location=None, location_user=None, location_password=None, comment=None, fast_backup=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.

Parameters

parts (list of str) – a list of optional parts. Run backup parts APIs to get list of optional parts and description
backup_password (str or None) – a password for a backup piece The backupPassword must adhere to the following password requirements: At least 8 characters, cannot be more than 20 characters in length. At least 1 uppercase letter. At least 1 lowercase letter. At least 1 numeric digit. At least 1 special character (i.e. any character not in [0-9,a-z,A-Z]). Only visible ASCII characters (for example, no space). backupPassword If no password then the piece will not be encrypted
location_type (Backup.LocationType) – a type of location
location (str) – path or url
location_user (str or None) – username for location locationUser User name for this location if login is required.
location_password (str or None) – password for location locationPassword Password for the specified user if login is required at this location.
comment (str or None) – Custom comment comment an optional comment
fast_backup (bool or None) – Option to enable Postgres DB/ VCDB fast backup. If None backup will proceed at slow rate

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.

Parameters

id (str) – id in message bundle
default_message (str) – text in english
args (list of str) – nested data

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.

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

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

NFS = LocationType(string='NFS'): Destination is NFS server. This class attribute was added in vSphere API 6.7.2.

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

SFTP = LocationType(string='SFTP'): Destination is SFTP server

SMB = LocationType(string='SMB'): Destination is SMB server. This class attribute was added in vSphere API 6.7.2.

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.

Parameters

status (Backup.ReturnStatus) – Check status
messages (list of Backup.LocalizableMessage) – List of messages

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.

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

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

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

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.

Parameters

id (str) – id in message bundle
default_message (str) – text in english
args (list of str) – nested data

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.

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

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

NFS = LocationType(string='NFS'): Destination is NFS server. This class attribute was added in vSphere API 6.7.2.

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

SFTP = LocationType(string='SFTP'): Destination is SFTP server

SMB = LocationType(string='SMB'): Destination is SMB server. This class attribute was added in vSphere API 6.7.2.

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.

Parameters

timestamp (datetime.datetime) – Time when this backup was completed.
parts (list of str) – List of parts included in the backup.
version (str) – VCSA version
boxname (str) – Box name is PNID/ FQDN etc
sso_login_required (bool) – Is SSO login required for the vCenter server. This attribute was added in vSphere API 6.7. This attribute is optional because it was added in a newer version than its parent node.
comment (str) – Custom comment
applicable (bool) – Does the VCSA match the deployment type, network properties and version of backed up VC
messages (list of Restore.LocalizableMessage) – Any messages if the backup is not aplicable

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.

Parameters

backup_password (str or None) – a password for a backup piece backupPassword If no password then the piece will not be decrypted
location_type (Restore.LocationType) – a type of location
location (str) – path or url
location_user (str or None) – username for location locationUser User name for this location if login is required.
location_password (str or None) – password for location locationPassword Password for the specified user if login is required at this location.
sso_admin_user_name (str or None) – Administrators username for SSO. This attribute was added in vSphere API 6.7. If None SSO authentication will not be used. If the vCenter Server is a management node or an embedded node, authentication is required.
sso_admin_user_password (str or None) – The password for SSO admin user. This attribute was added in vSphere API 6.7. If None SSO authentication will not be used. If the vCenter Server is a management node or an embedded node, authentication is required.

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

Initialize StubFactoryBase

Parameters: stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance

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

Initialize StubFactoryBase

Parameters: stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance

com.vmware.appliance.support_bundle_client module

class com.vmware.appliance.support_bundle_client.Components(config)

Bases: vmware.vapi.bindings.stub.VapiInterface

The SupportBundleComponents class provides methods to get the supported support bundle components. This class was added in vSphere API 7.0.1.0.

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

get()

Get list of components/manifests included in the support bundle. Manifests for a component specifies the files for a particular component that all needs to be collected as part of support bundle. This method was added in vSphere API 7.0.1.0.

Return type: dict of str and list of str
Returns: A map of components with it’s group. The keys in the map are group names and values in the map are a list of components in the group.
Raise: com.vmware.vapi.std.errors_client.Error Generic error

class com.vmware.appliance.support_bundle_client.StubFactory(stub_config)

Bases: vmware.vapi.bindings.stub.StubFactoryBase

Initialize StubFactoryBase

Parameters: stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance

com.vmware.appliance.supportbundle_client module

The com.vmware.appliance.supportbundle_client module provides classes for setting and getting support bundle related operations.

class com.vmware.appliance.supportbundle_client.StubFactory(stub_config)

Bases: vmware.vapi.bindings.stub.StubFactoryBase

Initialize StubFactoryBase

Parameters: stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance

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

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

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.

Parameters

old_size (long) – Original size of the partition in MB. This attribute was added in vSphere API 6.7.
new_size (long) – Nedw size of the partition in MB. This attribute was added in vSphere API 6.7.

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.

Parameters

disk (str) – The disk number in the vSphere Web Client. When clients pass a value of this class as a parameter, the attribute must be an identifier for the resource type: com.vmware.appliance.system.storage. When methods return a value of this class as a return value, the attribute will be an identifier for the resource type: com.vmware.appliance.system.storage.
partition (str) – Storage partition name.
description (com.vmware.vapi.std_client.LocalizableMessage) – Description of partition. This attribute was added in vSphere API 6.7. This attribute is optional because it was added in a newer version than its parent node.

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

Initialize StubFactoryBase

Parameters: stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance

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

Bases: vmware.vapi.bindings.stub.VapiInterface

Time class provides methods Gets system time.

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

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.

Parameters

seconds_since_epoch (float) – seconds since the epoch
date (str) – date format: Thu 07-31-2014
time (str) – time format: 18:18:32
timezone (str) – timezone

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.

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

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.

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

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.

Parameters

version (str) – Appliance version.
product (str) – Appliance name.
build (str) – Appliance build number.
type (str) – Type of product. Same product can have different deployment options, which is represented by type.
summary (str) – Summary of patch (empty string, if the appliance has not been patched)
releasedate (str) – Release date of patch (empty string, if the appliance has not been patched)
install_time (str) – Display the date and time when this system was first installed. Value will not change on subsequent updates.

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.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. This class was added in vSphere API 6.7.

Tip

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

Parameters

description (com.vmware.vapi.std_client.LocalizableMessage) – Description of the update. The short information what this update is. E.g. “Update2 for vCenter Server Appliance 6.5”. This attribute was added in vSphere API 6.7.
priority (CommonInfo.Priority) – Update priority. This attribute was added in vSphere API 6.7.
severity (CommonInfo.Severity) – Update severity. This attribute was added in vSphere API 6.7.
update_type (CommonInfo.Category) – Update category. This attribute was added in vSphere API 6.7.
release_date (datetime.datetime) – Update release date. This attribute was added in vSphere API 6.7.
reboot_required (bool) – Flag indicating whether reboot is required after update. This attribute was added in vSphere API 6.7.
size (long) – Download Size of update in Megabytes. This attribute was added in vSphere API 6.7.

class Category(string)

Bases: vmware.vapi.bindings.enum.Enum

The CommonInfo.Category class defines update type. 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.

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

FIX = Category(string='FIX'): Fixes bugs/vulnerabilities, doesn’t change functionality. This class attribute was added in vSphere API 6.7.

SECURITY = Category(string='SECURITY'): Fixes vulnerabilities, doesn’t change functionality. This class attribute was added in vSphere API 6.7.

UPDATE = Category(string='UPDATE'): Changes product functionality. This class attribute was added in vSphere API 6.7.

UPGRADE = Category(string='UPGRADE'): Introduces new features, significantly changes product functionality. This class attribute was added in vSphere API 6.7.

class Priority(string)

Bases: vmware.vapi.bindings.enum.Enum

The CommonInfo.Priority class defines the update installation priority recommendations. 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.

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

HIGH = Priority(string='HIGH'): Install ASAP. This class attribute was added in vSphere API 6.7.

LOW = Priority(string='LOW'): Install at your discretion. This class attribute was added in vSphere API 6.7.

MEDIUM = Priority(string='MEDIUM'): Install at the earliest convenience. This class attribute was added in vSphere API 6.7.

class Severity(string)

Bases: vmware.vapi.bindings.enum.Enum

The CommonInfo.Severity class defines the severity of the issues fixed in the update. 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.

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

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. This class attribute was added in vSphere API 6.7.

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. This class attribute was added in vSphere API 6.7.

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. This class attribute was added in vSphere API 6.7.

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. This class attribute was added in vSphere API 6.7.

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

Bases: vmware.vapi.bindings.stub.VapiInterface

The Pending class provides methods to manipulate pending updates. This class was added in vSphere API 6.7.

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

class Info(name=None, contents=None, services_will_be_stopped=None, eulas=None, staged=None, knowledge_base=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. This class was added in vSphere API 6.7.

Tip

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

Parameters

name (str) – Name of the update. This attribute was added in vSphere API 6.7.
contents (list of com.vmware.vapi.std_client.LocalizableMessage) – List of the 1. issues addressed since previous/current version 2. new features/improvements. This attribute was added in vSphere API 6.7.
services_will_be_stopped (list of ServiceInfo) – List of the services that will be stopped and restarted during the update installation. This attribute was added in vSphere API 6.7.
eulas (list of com.vmware.vapi.std_client.LocalizableMessage) – List of EULAs. This list has multiple entries and can be dynamic based on what we are actually installing. This attribute was added in vSphere API 6.7.
staged (bool) – Is the update staged. This attribute was added in vSphere API 6.7.
knowledge_base (str) – URL for the knowledge base article describing this update. This attribute was added in vSphere API 6.7.
description (com.vmware.vapi.std_client.LocalizableMessage) – Description of the update. The short information what this update is. E.g. “Update2 for vCenter Server Appliance 6.5”. This attribute was added in vSphere API 6.7.
priority (CommonInfo.Priority) – Update priority. This attribute was added in vSphere API 6.7.
severity (CommonInfo.Severity) – Update severity. This attribute was added in vSphere API 6.7.
update_type (CommonInfo.Category) – Update category. This attribute was added in vSphere API 6.7.
release_date (datetime.datetime) – Update release date. This attribute was added in vSphere API 6.7.
reboot_required (bool) – Flag indicating whether reboot is required after update. This attribute was added in vSphere API 6.7.
size (long) – Download Size of update in Megabytes. This attribute was added in vSphere API 6.7.

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. This class was added in vSphere API 6.7.

Tip

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

Parameters

check_time (datetime.datetime) – Time when this precheck was run. This attribute was added in vSphere API 6.7.
estimated_time_to_install (long or None) – Rough estimate of time to install the update (minutes). This attribute was added in vSphere API 6.7. estimatedTimeToInstall If None N/A
estimated_time_to_rollback (long or None) – Rough estimate of time to rollback the update (minutes). This attribute was added in vSphere API 6.7. estimatedTimeToRollback If None N/A
reboot_required (bool) – Is reboot required to install the update. This attribute was added in vSphere API 6.7.
issues (com.vmware.appliance_client.Notifications or None) – Lists of the issues and warnings. This attribute was added in vSphere API 6.7. issues If None N/A
questions (list of Pending.Question) – List of questions that must be answered to install the update. This attribute was added in vSphere API 6.7.

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. This class was added in vSphere API 6.7.

Tip

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

Parameters

data_item (str) – ID of the data item. This attribute was added in vSphere API 6.7. When clients pass a value of this class as a parameter, the attribute must be an identifier for the resource type: com.vmware.applicance.update.pending.dataitem. When methods return a value of this class as a return value, the attribute will be an identifier for the resource type: com.vmware.applicance.update.pending.dataitem.
text (com.vmware.vapi.std_client.LocalizableMessage) – Label for the item to be used in GUI/CLI. This attribute was added in vSphere API 6.7.
description (com.vmware.vapi.std_client.LocalizableMessage) – Description of the item. This attribute was added in vSphere API 6.7.
type (Pending.Question.InputType) – How this field shoudl be represented in GUI or CLI. This attribute was added in vSphere API 6.7.
allowed_values (list of str or None) – List of allowed values. This attribute was added in vSphere API 6.7. allowedValues If None any value is valid.
regexp (str or None) – Regexp to validate the input. This attribute was added in vSphere API 6.7. regexp If None no validation will be performed.
default_answer (str or None) – Default answer. This attribute was added in vSphere API 6.7. defaultAnswer If None then there is no default answer, so an explicit answer must be provided

class InputType(string)

Bases: vmware.vapi.bindings.enum.Enum

The Pending.Question.InputType class defines representation of field fields in GUI or CLI. 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.

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

BOOLEAN = InputType(string='BOOLEAN'): Yes/No,On/Off,Checkbox answer. This class attribute was added in vSphere API 6.7.

PASSWORD = InputType(string='PASSWORD'): Password (masked) answer. This class attribute was added in vSphere API 6.7.

PLAIN_TEXT = InputType(string='PLAIN_TEXT'): plain text answer. This class attribute was added in vSphere API 6.7.

class SourceType(string)

Bases: vmware.vapi.bindings.enum.Enum

The Pending.SourceType class defines the supported types of sources of updates. 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.

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

LAST_CHECK = SourceType(string='LAST_CHECK'): Do not perform a new check, return the previous result. This class attribute was added in vSphere API 6.7.

LOCAL = SourceType(string='LOCAL'): Check the local sources, ISO devices, staged area. This class attribute was added in vSphere API 6.7.

LOCAL_AND_ONLINE = SourceType(string='LOCAL_AND_ONLINE'): Check the local sources, ISO devices, staged area, then online repository as stated in update policy. This class attribute was added in vSphere API 6.7.

get(version)

Gets update information. This method was added in vSphere API 6.7.

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. This method was added in vSphere API 6.7.

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, enable_list_major_upgrade_versions=None)

Checks if there are any eligible updates. This method was added in vSphere API 6.7.

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
enable_list_major_upgrade_versions (bool or None) – checks and lists if there are eligible major version upgrades available. Possible values are true and false when set to true it allows listing of across version upgrade When not specified lists only minor updates available

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. This method was added in vSphere API 6.7.

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. This method was added in vSphere API 6.7.

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. This method was added in vSphere API 6.7.

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. This method was added in vSphere API 6.7.

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. This class was added in vSphere API 6.7.

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

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

Bases: vmware.vapi.bindings.struct.VapiStruct

The Policy.Config class defines automatic update checking and staging policy. This class was added in vSphere API 6.7.

Tip

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

Parameters

custom_url (str or None) – Current appliance update repository URL. This attribute was added in vSphere API 6.7. If None then default URL is assumed
username (str or None) – Username for the update repository. This attribute was added in vSphere API 6.7. If None username will not be used to login
password (str or None) – Password for the update repository. This attribute was added in vSphere API 6.7. password If None password will not be used to login
check_schedule (list of Policy.Time) – Schedule when the automatic check will be run. This attribute was added in vSphere API 6.7.
auto_stage (bool) – Automatically stage the latest update if available. This attribute was added in vSphere API 6.7.
certificate_check (bool or None) –
Indicates whether certificates will be checked during patching.

Warning: Setting this attribute to false will result in an insecure connection to update repository which can potentially put the appliance security at risk.. This attribute was added in vSphere API 6.7. certificateCheck If None the certificate checks are enabled.

class DayOfWeek(string)

Bases: vmware.vapi.bindings.enum.Enum

The Policy.DayOfWeek class defines the set of days. 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.

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

FRIDAY = DayOfWeek(string='FRIDAY'): Friday. This class attribute was added in vSphere API 6.7.

MONDAY = DayOfWeek(string='MONDAY'): Monday. This class attribute was added in vSphere API 6.7.

SATURDAY = DayOfWeek(string='SATURDAY'): Saturday. This class attribute was added in vSphere API 6.7.

SUNDAY = DayOfWeek(string='SUNDAY'): Sunday. This class attribute was added in vSphere API 6.7.

THURSDAY = DayOfWeek(string='THURSDAY'): Thursday. This class attribute was added in vSphere API 6.7.

TUESDAY = DayOfWeek(string='TUESDAY'): Tuesday. This class attribute was added in vSphere API 6.7.

WEDNESDAY = DayOfWeek(string='WEDNESDAY'): Wednesday. This class attribute was added in vSphere API 6.7.

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

Bases: vmware.vapi.bindings.struct.VapiStruct

The Policy.Info class defines automatic update checking and staging policy. This class was added in vSphere API 6.7.

Tip

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

Parameters

custom_url (str or None) – Current appliance update custom repository URL. This attribute was added in vSphere API 6.7. If None update is checked at defaut URL.
default_url (str) – Current appliance update default repository URL. This attribute was added in vSphere API 6.7.
username (str or None) – Username for the update repository. This attribute was added in vSphere API 6.7. If None username will not be used to login
check_schedule (list of Policy.Time) – Schedule when the automatic check will be run. This attribute was added in vSphere API 6.7.
auto_stage (bool) – Automatically stage the latest update if available. This attribute was added in vSphere API 6.7.
auto_update (bool) – Is the appliance updated automatically. If set the appliance may ignore the check schedule or auto-stage settings. This attribute was added in vSphere API 6.7.
manual_control (bool) – Whether API client should allow the user to start update manually. This attribute was added in vSphere API 6.7.
certificate_check (bool) –
Indicates whether certificates will be checked during patching.

Warning: If this attribute is set to false, an insecure connection is made to the update repository which can potentially put the appliance security at risk.. This attribute was added in vSphere API 6.7.

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. This class was added in vSphere API 6.7.

Tip

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

Parameters

day (Policy.DayOfWeek) – weekday to check for updates. This attribute was added in vSphere API 6.7.
hour (long) – Hour: 0-24. This attribute was added in vSphere API 6.7.
minute (long) – Minute: 0-59. This attribute was added in vSphere API 6.7.

get()

Gets the automatic update checking and staging policy. This method was added in vSphere API 6.7.

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. This method was added in vSphere API 6.7.

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. This class was added in vSphere API 6.7.

Tip

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

Parameters

service (str) – Service ID. This attribute was added in vSphere API 6.7. When clients pass a value of this class as a parameter, the attribute must be an identifier for the resource type: com.vmware.appliance.service. When methods return a value of this class as a return value, the attribute will be an identifier for the resource type: com.vmware.appliance.service.
description (com.vmware.vapi.std_client.LocalizableMessage) – Service description. This attribute was added in vSphere API 6.7.

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. This class was added in vSphere API 6.7.

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

class Info(staging_complete=None, version=None, name=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. This class was added in vSphere API 6.7.

Tip

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

Parameters

staging_complete (bool) – Is staging complete. This attribute was added in vSphere API 6.7.
version (str) – Version in form of X.Y.Z.P. e.g. 6.5.1.5400. This attribute was added in vSphere API 6.7. When clients pass a value of this class as a parameter, the attribute must be an identifier for the resource type: com.vmware.appliance.update.pending. When methods return a value of this class as a return value, the attribute will be an identifier for the resource type: com.vmware.appliance.update.pending.
name (str) – Name of the update. This attribute was added in vSphere API 6.7.
description (com.vmware.vapi.std_client.LocalizableMessage) – Description of the update. The short information what this update is. E.g. “Update2 for vCenter Server Appliance 6.5”. This attribute was added in vSphere API 6.7.
priority (CommonInfo.Priority) – Update priority. This attribute was added in vSphere API 6.7.
severity (CommonInfo.Severity) – Update severity. This attribute was added in vSphere API 6.7.
update_type (CommonInfo.Category) – Update category. This attribute was added in vSphere API 6.7.
release_date (datetime.datetime) – Update release date. This attribute was added in vSphere API 6.7.
reboot_required (bool) – Flag indicating whether reboot is required after update. This attribute was added in vSphere API 6.7.
size (long) – Download Size of update in Megabytes. This attribute was added in vSphere API 6.7.

delete()

Deletes the staged update. This method was added in vSphere API 6.7.

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. This method was added in vSphere API 6.7.

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

Initialize StubFactoryBase

Parameters: stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance

class com.vmware.appliance.update_client.Summary(version=None, name=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. This class was added in vSphere API 6.7.

Tip

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

Parameters

version (str) – Version in form of X.Y.Z.P. e.g. 6.5.1.5400. This attribute was added in vSphere API 6.7. When clients pass a value of this class as a parameter, the attribute must be an identifier for the resource type: com.vmware.appliance.update.pending. When methods return a value of this class as a return value, the attribute will be an identifier for the resource type: com.vmware.appliance.update.pending.
name (str) – Name of the update. This attribute was added in vSphere API 6.7.
description (com.vmware.vapi.std_client.LocalizableMessage) – Description of the update. The short information what this update is. E.g. “Update2 for vCenter Server Appliance 6.5”. This attribute was added in vSphere API 6.7.
priority (CommonInfo.Priority) – Update priority. This attribute was added in vSphere API 6.7.
severity (CommonInfo.Severity) – Update severity. This attribute was added in vSphere API 6.7.
update_type (CommonInfo.Category) – Update category. This attribute was added in vSphere API 6.7.
release_date (datetime.datetime) – Update release date. This attribute was added in vSphere API 6.7.
reboot_required (bool) – Flag indicating whether reboot is required after update. This attribute was added in vSphere API 6.7.
size (long) – Download Size of update in Megabytes. This attribute was added in vSphere API 6.7.

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.

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

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.

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

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.

Parameters

name_key (str) – Service name key. Can be used to lookup resource bundle
description_key (str) – Service description key. Can be used to lookup resource bundle
startup_type (Service.StartupType) – Startup Type.
state (Service.State) – Running State.
health (Service.Health) – Health of service. This attribute is optional and it is only relevant when the value of state is Service.State.STARTED.
health_messages (list of com.vmware.vapi.std_client.LocalizableMessage) – Localizable messages associated with the health of the service This attribute is optional and it is only relevant when the value of state is Service.State.STARTED.

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.

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

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.

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

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.

Parameters: startup_type (Service.StartupType or None) – Startup Type If unspecified, leaves value unchanged.

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

Initialize StubFactoryBase

Parameters: stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance