com.vmware.esx.settings.defaults.hosts package

Subpackages

Submodules

com.vmware.esx.settings.defaults.hosts.policies_client module

The com.vmware.esx.settings.defaults.hosts.policies_client module provides classes to manage the default policies that affect management of desired state configuration and software for ESXi hosts. Copyright (c) 2019-2023 VMware, Inc. All rights reserved. – VMware Confidential

class com.vmware.esx.settings.defaults.hosts.policies_client.Apply(config)

Bases: VapiInterface

The Apply class provides methods to configure the policies that will impact how the software and configuration specification documents are applied to ESXi hosts. This class was added in vSphere API 8.0.0.1.

Parameters:

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

class ConfiguredPolicySpec(failure_action=None, pre_remediation_power_action=None, enable_quick_boot=None)

Bases: VapiStruct

The Apply.ConfiguredPolicySpec class contains attributes that describe the policies configured to be used when the software and configuration specification documents are applied to ESXi hosts. This class was added in vSphere API 8.0.0.1.

Tip

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

Parameters:

  • failure_action (Apply.FailureAction or None) – What action is to be taken if entering maintenance mode fails on an ESXi host. This attribute was added in vSphere API 8.0.0.1. If None, configured value would be unset.

  • pre_remediation_power_action (Apply.ConfiguredPolicySpec.PreRemediationPowerAction or None) – Specifies what should be done to the power state of the VM before entering maintenance mode. This attribute was added in vSphere API 8.0.0.1. If None, configured value would be unset.

  • enable_quick_boot (bool or None) – Enable Quick Boot during remediation of the host. This attribute was added in vSphere API 8.0.0.1. If None, configured value would be unset.

class PreRemediationPowerAction(string)

Bases: Enum

The Apply.ConfiguredPolicySpec.PreRemediationPowerAction class defines the possible actions to be taken, before entering maintenance mode. This enumeration was added in vSphere API 8.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 PreRemediationPowerAction instance.

DO_NOT_CHANGE_VMS_POWER_STATE = PreRemediationPowerAction(string='DO_NOT_CHANGE_VMS_POWER_STATE')

Do not change the VM power state. This class attribute was added in vSphere API 8.0.0.1.

POWER_OFF_VMS = PreRemediationPowerAction(string='POWER_OFF_VMS')

Power off VMs before entering maintenance mode. This class attribute was added in vSphere API 8.0.0.1.

SUSPEND_VMS = PreRemediationPowerAction(string='SUSPEND_VMS')

Suspend VMs before entering maintenance mode. This class attribute was added in vSphere API 8.0.0.1.

SUSPEND_VMS_TO_MEMORY = PreRemediationPowerAction(string='SUSPEND_VMS_TO_MEMORY')

Suspend VMs to Memory before entering maintenance mode. This class attribute was added in vSphere API 8.0.0.1.

class FailureAction(action=None, retry_delay=None, retry_count=None)

Bases: VapiStruct

The Apply.FailureAction class contains attributes that describe the actions to be taken when entering maintenance mode fails on an ESXi host. This class was added in vSphere API 8.0.0.1.

Tip

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

Parameters:

  • action (Apply.FailureAction.Action) – What action (FAIL, RETRY) is to be taken if entering maintenance mode fails on an ESXi host. This attribute was added in vSphere API 8.0.0.1.

  • retry_delay (long) – Time to wait to retry the failed operation in seconds. This attribute was added in vSphere API 8.0.0.1. This attribute is optional and it is only relevant when the value of action is Apply.FailureAction.Action.RETRY.

  • retry_count (long) – Number of times to retry the failed operation. This attribute was added in vSphere API 8.0.0.1. This attribute is optional and it is only relevant when the value of action is Apply.FailureAction.Action.RETRY.

class Action(string)

Bases: Enum

The Apply.FailureAction.Action class defines the actions to be taken when entering maintenance mode fails on an ESXi host. This enumeration was added in vSphere API 8.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 Action instance.

FAIL = Action(string='FAIL')

Fail the apply method. This class attribute was added in vSphere API 8.0.0.1.

RETRY = Action(string='RETRY')

Retry the task Apply.FailureAction.retry_count number of times on the failed host after Apply.FailureAction.retry_delay. This class attribute was added in vSphere API 8.0.0.1.

get()

Returns the configured policy that has been set. This method was added in vSphere API 8.0.0.1.

Return type:

Apply.ConfiguredPolicySpec

Returns:

The configured policies that impact the apply method

Raise:

com.vmware.vapi.std.errors_client.Error If there is an 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.

Raise:

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

  • Method execution requires VcIntegrity.lifecycleSettings.Read.

set(spec)

This API will set the configured policy. This method was added in vSphere API 8.0.0.1.

Parameters:

spec (Apply.ConfiguredPolicySpec) – The policy specification.

Raise:

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

Raise:

com.vmware.vapi.std.errors_client.InvalidArgument If invalid value is provided.

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.

Raise:

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

  • Method execution requires VcIntegrity.lifecycleSettings.Write.

class com.vmware.esx.settings.defaults.hosts.policies_client.StubFactory(stub_config)

Bases: StubFactoryBase

Initialize StubFactoryBase

Parameters:

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