com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster package

Submodules

com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.drs_client module

The com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.drs_client module provides classes to manage the vCenter Server Inventory Cluster DRS settings.

class com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.drs_client.AdditionalOptions(advanced_options=None, scalable_shares=None)

Bases: VapiStruct

The AdditionalOptions class contains attributes describing the HA specific configurations of a cluster. It contains cluster-wide configurations for vSphereHA.

Tip

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

Parameters:
class com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.drs_client.AffinityRule(status=None, enabled=None, in_compliance=None, name=None, mandatory=None, user_created=None, vms=None)

Bases: VapiStruct

The AffinityRule class defines a set of virtual machines that DRS will attempt to run on the same host.

Tip

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

Parameters:

  • status (Status or None) – Flag to indicate whether or not the rule is currently satisfied.

  • enabled (bool or None) – Flag to indicate whether or not the rule is enabled. Set this property when user configures the rule. The default value is false (disabled). If there is a rule conflict, the Server can override the setting to disable a rule. If None or empty, the value is skipped.

  • in_compliance (bool or None) – Flag to indicate if the rule is in compliance. If None or empty, the value is skipped.

  • name (str or None) – Name of the rule.

  • mandatory (bool or None) – Flag to indicate whether compliance with this rule is mandatory or optional. The default value is false (optional). If None or empty, the value is skipped.

  • user_created (bool or None) – Flag to indicate whether the rule is created by the user or the system. If None or empty, the value is skipped.

  • vms (list of str or None) – List of virtual machines.

class com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.drs_client.Automation(automation_level=None, migration_threshold=None, proactive_drs_enabled=None, virtual_machine_automation=None)

Bases: VapiStruct

The Automation class contains attributes describing the HA specific configurations of a cluster. It contains cluster-wide configurations for vSphereHA.

Tip

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

Parameters:

  • automation_level (DrsBehaviorInfo or None) – Specifies the cluster-wide default DRS behavior for virtual machines. You can override the default behavior for a virtual machine. If None or empty, the value is skipped.

  • migration_threshold (long or None) – Threshold for generated recommendations. DRS generates only those recommendations that are above the specified vmotionRate. Ratings vary from 1 to 5. If None or empty, the value is skipped.

  • proactive_drs_enabled (bool or None) – Flag indicating whether or not the ProactiveDRS is enabled. If None or empty, the value is skipped.

  • virtual_machine_automation (bool or None) – Flag that dictates whether DRS Behavior overrides for individual VMs.

class com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.drs_client.DependencyRule(status=None, enabled=None, in_compliance=None, name=None, mandatory=None, user_created=None, vm_group=None, depends_on_vm_group=None)

Bases: VapiStruct

The DependencyRule class defines VM-to-VM dependencies.

A VM-VM Dependency rule identifies the following groups.

  • A virtual machine group - DependencyRule.vm_group

  • A “depends on” virtual machine group - DependencyRule.depends_on_vm_group.

The VMs in DependencyRule.vm_group depends on the list of VMs specified in DependencyRule.depends_on_vm_group.

Tip

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

Parameters:

  • status (Status or None) – Flag to indicate whether or not the rule is currently satisfied.

  • enabled (bool or None) – Flag to indicate whether or not the rule is enabled. Set this property when user configures the rule. The default value is false (disabled). If there is a rule conflict, the Server can override the setting to disable a rule. If None or empty, the value is skipped.

  • in_compliance (bool or None) – Flag to indicate if the rule is in compliance. If None or empty, the value is skipped.

  • name (str or None) – Name of the rule.

  • mandatory (bool or None) – Flag to indicate whether compliance with this rule is mandatory or optional. The default value is false (optional). If None or empty, the value is skipped.

  • user_created (bool or None) – Flag to indicate whether the rule is created by the user or the system. If None or empty, the value is skipped.

  • vm_group (str or None) – Virtual group name. The virtual group may contain one or more virtual machines.

  • depends_on_vm_group (str or None) – Depdendency virtual group name. The virtual group may contain one or more virtual machines.

class com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.drs_client.DpmBehaviorInfo(string)

Bases: Enum

The DpmBehaviorInfo class defines the automation level for DPM service on a cluster.

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

AUTOMATED = DpmBehaviorInfo(string='AUTOMATED')

Specifies that VirtualCenter should generate recommendations for host power operations, and should execute the recommendations automatically.

MANUAL = DpmBehaviorInfo(string='MANUAL')

Specifies that VirtualCenter should generate recommendations for host power operations, but should not execute the recommendations automatically.

class com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.drs_client.DrsBehaviorInfo(string)

Bases: Enum

The DrsBehaviorInfo class defines the automation levels that can be set on a DRS cluster.

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

FULLY_AUTOMATED = DrsBehaviorInfo(string='FULLY_AUTOMATED')

Specifies that VirtualCenter should automate both the migration of virtual machines and their placement with a host at power on.

MANUAL = DrsBehaviorInfo(string='MANUAL')

Specifies that VirtualCenter should generate recommendations for virtual machine migration and for placement with a host, but should not implement the recommendations automatically.

PARTIALLY_AUTOMATED = DrsBehaviorInfo(string='PARTIALLY_AUTOMATED')

Specifies that VirtualCenter should generate recommendations for virtual machine migration and for placement with a host, but should automatically implement only the placement at power on.

class com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.drs_client.DrsConfig(enabled=None, automation=None, additional_options=None, power_management=None)

Bases: VapiStruct

The DrsConfig class contains attributes describing the HA specific configurations of a cluster. It contains cluster-wide configurations for DAS.

Tip

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

Parameters:

  • enabled (bool or None) – Flag indicating whether or not DRS service is enabled. If None or empty, the value is skipped.

  • automation (Automation or None) – vSphere HA configuration for Automation Level, Migration Threshold Predictive DRS and VM Automation.

  • additional_options (AdditionalOptions or None) – vSphere HA configuration for VM Distribution, CPU Over commit Scalable Shares.

  • power_management (PowerManagement or None) – vSphere HA configuration for DPM, AutomationLevel, DPM Threshold.

class com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.drs_client.DrsVmOverrides(name=None, behavior=None)

Bases: VapiStruct

The DrsVmOverrides class contains the fields describing DRS behavior override for individual virtual machines in the cluster.

Tip

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

Parameters:

  • name (str or None) – Reference to the virtual machine.

  • behavior (DrsBehaviorInfo or None) – Specifies the particular DRS behavior for this virtual machine. If None or empty, the value is skipped.

class com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.drs_client.Group(vm_groups=None, host_groups=None)

Bases: VapiStruct

The Group class describes the properties of virtual machine and host groups.

Tip

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

Parameters:

  • vm_groups (list of GroupDetails or None) – List of VM Group details. If None or empty, the value is skipped.

  • host_groups (list of GroupDetails or None) – List of HOST Group details. If None or empty, the value is skipped.

class com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.drs_client.GroupDetails(name=None, entities=None, user_created=None)

Bases: VapiStruct

Tip

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

Parameters:

  • name (str or None) – Unique name of the group.

  • entities (list of str or None) – List of VMs or Hosts belonging to the group. If None or empty, the value is skipped.

  • user_created (bool or None) – Flag to indicate whether the group is created by the user or the system. If None or empty, the value is skipped.

class com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.drs_client.PowerManagement(dpm_enabled=None, automation_level=None, dpm_threshold=None)

Bases: VapiStruct

The PowerManagement class contains the fields describing DPM specific configurations of a cluster.

Tip

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

Parameters:

  • dpm_enabled (bool or None) – Flag indicating whether or not the service is enabled. This service can not be enabled, unless DRS is enabled as well. If None or empty, the value is skipped.

  • automation_level (DpmBehaviorInfo or None) – Specifies the default VMware DPM behavior for hosts. This default behavior can be overridden on a per host. If None or empty, the value is skipped.

  • dpm_threshold (com.vmware.appliance.vcenter.settings.v1.config.components.inventory.common_client.OptionValue or None) – DPM Advanced options. If None or empty, the value is skipped.

class com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.drs_client.ProactiveHAConfig(enabled=None, automation_level=None, remediation=None, providers=None)

Bases: VapiStruct

The ProactiveHAConfig class defines the Configuration of the vSphere InfraUpdateHA service on a cluster.

Tip

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

Parameters:

  • enabled (bool or None) – Flag indicating whether or not the service is enabled. InfraUpdateHA will not be active, unless DRS is enabled as well. If None or empty, the value is skipped.

  • automation_level (ProactiveHAConfig.BehaviorType or None) – Configured behavior. Values are of type InfraUpdateHaConfig.BehaviorType. If None or empty, the value is skipped.

  • remediation (ProactiveHAConfig.RemediationType or None) – Configured remediation for moderately degraded hosts. Values are of type InfraUpdateHaConfig.RemediationType. If None or empty, the value is skipped.

  • providers (list of str or None) – The list of health update providers configured for this cluster. Providers are identified by their id. If the provider list is empty, InfraUpdateHA will not be active. If None or empty, the value is skipped.

class BehaviorType(string)

Bases: Enum

The ProactiveHAConfig.BehaviorType class defines the behavior for executing the proposed DRS recommendations.

Note

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

Parameters:

string (str) – String value for the BehaviorType instance.

AUTOMATED = BehaviorType(string='AUTOMATED')

With this behavior configured, the proposed DRS recommendations are executed immediately.

MANUAL = BehaviorType(string='MANUAL')

With this behavior configured, the proposed DRS recommendations require manual approval before they are executed.

class RemediationType(string)

Bases: Enum

The ProactiveHAConfig.RemediationType class defines the types of remediation behaviours that can be configured.

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

MAINTENANCE_MODE = RemediationType(string='MAINTENANCE_MODE')

With this behavior configured, a degraded host will be recommended to be placed in Maintenance Mode.

QUARANTINE_MODE = RemediationType(string='QUARANTINE_MODE')

With this behavior configured, a degraded host will be recommended to be placed in Quarantine Mode.

class com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.drs_client.Rule(vm_affinity_rules=None, vm_anti_affinity_rules=None, dependency_rule=None, vm_host_rule=None)

Bases: VapiStruct

The Rule class describes affinity and anti-affinity DRS rules that affect the placement of virtual machines in a cluster.

Tip

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

Parameters:

  • vm_affinity_rules (list of AffinityRule or None) – Cluster-wide VM affinity rules.If this is set then AntiAffinityRule, DependencyRule, VmHostRule can not be set. If None or empty, the value is skipped.

  • vm_anti_affinity_rules (list of AffinityRule or None) – Cluster-wide VM anti affinity rules.If this is set then AntiAffinityRule, DependencyRule, VmHostRule can not be set. If None or empty, the value is skipped.

  • dependency_rule (list of DependencyRule or None) – Cluster-wide VM-to-VM dependency rules.If this is set then AffinityRule, AntiAffinityRule, VmHostRule can not be set. If None or empty, the value is skipped.

  • vm_host_rule (list of VmHostRule or None) – Cluster-wide VM-to-Host affinity rules.If this is set then AffinityRule, AntiAffinityRule, DependencyRule can not be set. If None or empty, the value is skipped.

class com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.drs_client.ScaleSharesBehavior(string)

Bases: Enum

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

DISABLED = ScaleSharesBehavior(string='DISABLED')

Do not scale shares

SCALE_CPU_AND_MEMORY_SHARES = ScaleSharesBehavior(string='SCALE_CPU_AND_MEMORY_SHARES')

Scale both CPU and memory shares

class com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.drs_client.Status(string)

Bases: Enum

The Status enumeration defines a general “health” value for a managed entity.

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.

GRAY = Status(string='GRAY')

The status is unknown.

GREEN = Status(string='GREEN')

The entity is OK.

RED = Status(string='RED')

The entity definitely has a problem.

YELLOW = Status(string='YELLOW')

The entity might have a problem.

class com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.drs_client.StubFactory(stub_config)

Bases: StubFactoryBase

Initialize StubFactoryBase

Parameters:

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

class com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.drs_client.VmHostRule(status=None, enabled=None, in_compliance=None, name=None, mandatory=None, user_created=None, vm_group_name=None, affine_host_group_name=None, anti_affine_host_group_name=None)

Bases: VapiStruct

The VmHostRule class defines virtual machines and host groups that determine virtual machine placement. The virtual machines and hosts referenced by a VM-Host rule must be in the same cluster.

A VM-Host rule identifies the following groups.

  • A virtual machine group (vim.cluster.VmGroup).

  • Two host groups - an affine host group and an anti-affine host group (vim.cluster.HostGroup). At least one of the groups must contain one or more hosts.

Tip

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

Parameters:

  • status (Status or None) – Flag to indicate whether or not the rule is currently satisfied.

  • enabled (bool or None) – Flag to indicate whether or not the rule is enabled. Set this property when user configures the rule. The default value is false (disabled). If there is a rule conflict, the Server can override the setting to disable a rule. If None or empty, the value is skipped.

  • in_compliance (bool or None) – Flag to indicate if the rule is in compliance. If None or empty, the value is skipped.

  • name (str or None) – Name of the rule.

  • mandatory (bool or None) – Flag to indicate whether compliance with this rule is mandatory or optional. The default value is false (optional). If None or empty, the value is skipped.

  • user_created (bool or None) – Flag to indicate whether the rule is created by the user or the system. If None or empty, the value is skipped.

  • vm_group_name (str or None) – Virtual group name. If None or empty, the value is skipped.

  • affine_host_group_name (str or None) – Name of the affine host group. The affine host group identifies hosts on which VmHotRule#vmGroupName virtual machines can be powered-on. If None or empty, the value is skipped.

  • anti_affine_host_group_name (str or None) – Name of the anti-affine host group. The anti-affine host group identifies hosts on which VmHotRule#vmGroupName virtual machines should not be powered-on. If None or empty, the value is skipped.

com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.ha_client module

The com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.ha_client module provides classes to manage the vCenter Server Inventory Cluster HA settings.

class com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.ha_client.AdmissionControl(host_failures_cluster_tolerates=None, policy_type=None, host_fail_over_slot_policy=None, cluster_resource_percentage=None, dedicated_failover_hosts=None, performance_degradation_vm_tolerate=None)

Bases: VapiStruct

The FailuresAndResponses class contains attributes describing the Failures and responses specific configurations of a cluster. It contains cluster-wide configurations for vsphere HA.

Tip

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

Parameters:

  • host_failures_cluster_tolerates (long or None) – Number of host failures that should be tolerated, still guaranteeing sufficient resources to restart virtual machines on available hosts. If not set, we assume 1.

  • policy_type (str or None) –

  • host_fail_over_slot_policy (FixedSizeSlotPolicy or None) – This policy allows setting a fixed slot size

  • cluster_resource_percentage (ClusterResourcePercentage or None) –

  • dedicated_failover_hosts (list of str or None) – List of hosts dedicated for failover.

  • performance_degradation_vm_tolerate (long or None) – Percentage of resource reduction that a cluster of VMs can tolerate in case of a failover.

class com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.ha_client.ClusterResourcePercentage(cpu=None, memory=None)

Bases: VapiStruct

This class defines CPU, Memory resource percentages.

Tip

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

Parameters:

  • cpu (long) – Reserved failover CPU capacity

  • memory (long) – Reserved failover Memory capacity

class com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.ha_client.FailuresAndResponses(host_monitoring=None, default_vm_restart_priority=None, restart_priority_condition_timeout=None, additional_delay=None, host_isolation_response=None, datastore_with_pdl_failure_response=None, apd_failure_response=None, response_recovery=None, response_delay=None, vm_monitoring=None, vm_tools_monitoring_settings=None)

Bases: VapiStruct

The FailuresAndResponses class contains attributes describing the Failures and responses specific configurations of a cluster. It contains cluster-wide configurations for vsphere HA.

Tip

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

Parameters:

  • host_monitoring (FailuresAndResponses.ServiceState or None) –

  • default_vm_restart_priority (FailuresAndResponses.RestartPriority or None) –

    Restart priority for a virtual machine.

    If not specified at either the cluster level or the virtual machine level, this will default to medium. If None or empty, the value is skipped.

  • restart_priority_condition_timeout (long or None) – This setting is used to specify a maximum time the lower priority VMs should wait for the higher priority VMs to be ready. If the higher priority Vms are not ready by this time, then the lower priority VMs are restarted irrespective of the VM ready state. This timeout can be used to prevent the failover of lower priority VMs to be stuck infinitely. Timeout specified in seconds. To use cluster setting for a VM override, set to -1 in per-VM. setting. If None or empty, the value is skipped.

  • additional_delay (long or None) – After condition has been met, a mandatory delay before starting the next VM restart priority.

  • host_isolation_response (FailuresAndResponses.IsolationResponse or None) –

    Indicates whether or not the virtual machine should be powered off if a host determines that it is isolated from the rest of the compute resource.

    If not specified at either the cluster level or the virtual machine level, this will default to powerOff. If None or empty, the value is skipped.

  • datastore_with_pdl_failure_response (FailuresAndResponses.StorageVmReaction) – VM storage protection setting for storage failures categorized as Permenant Device Loss (PDL). PDL indicates storage device failure or LUN removal. In case of PDL, the failed datastore or device is unlikely to recover. The details of PDL are

  • apd_failure_response (FailuresAndResponses.StorageVmReaction) – VM storage protection setting for storage failures categorized as All Paths Down (APD). APD is a condition where a storage has become inaccessible for unknown reasons. It only indicates loss of connectivity and does not indicate storage device failure or LUN removal (Permanent Device Loss or PDL)

  • response_recovery (FailuresAndResponses.VmReactionOnAPDCleared or None) –

    Action taken by VM Component Protection service for a powered on VM when APD condition clears after APD timeout.

    This property is meaningful only when vSphere HA is turned on. Valid values are specified by FailuresAndResponses.VmReactionOnAPDCleared. The default value is VmReactionOnAPDCleared#none for cluster setting and VmReactionOnAPDCleared#useClusterDefault for per-VM setting.

  • response_delay (long or None) – The time interval after an APD timeout has been declared and before VM Component Protection service will terminate the VM. The default value is 180 seconds if not specified. To use cluster setting for a VM override, set to -1 in per-VM setting.

  • vm_monitoring (FailuresAndResponses.VmMonitoringState or None) –

  • vm_tools_monitoring_settings (VmToolsMonitoringSettings or None) –

class IsolationResponse(string)

Bases: Enum

The enum defines values that indicate whether or not the virtual machine should be powered off if a host determines that it is isolated from the rest of the cluster.

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

CLUSTER_ISOLATION_RESPONSE = IsolationResponse(string='CLUSTER_ISOLATION_RESPONSE')

Use the default isolation response defined for the cluster that contains this virtual machine.

NONE = IsolationResponse(string='NONE')

Do not power off the virtual machine in the event of a host network isolation.

POWER_OFF = IsolationResponse(string='POWER_OFF')

Power off the virtual machine in the event of a host network isolation.

SHUTDOWN = IsolationResponse(string='SHUTDOWN')

Shut down the virtual machine guest operating system in the event of a host network isolation. If the guest operating system fails to shutdown within five minutes, HA will initiate a forced power off.

When you use the shutdown isolation response, failover can take longer (compared to the response) because the virtual machine cannot fail over until it is shutdown.

class RestartPriority(string)

Bases: Enum

The enum defines virtual machine restart priority values to resolve resource contention. The priority determines the preference that HA gives to a virtual machine if sufficient capacity is not available to power on all failed virtual machines. For example, high priority virtual machines on a host get preference over low priority virtual machines.

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

CLUSTER_RESTART_PRIORITY = RestartPriority(string='CLUSTER_RESTART_PRIORITY')

Virtual machines with this priority use the default restart priority defined for the cluster that contains this virtual machine.

DISABLED = RestartPriority(string='DISABLED')

vSphere HA is disabled for this virtual machine.

HIGH = RestartPriority(string='HIGH')

Virtual machines with this priority have a higher chance of powering on after a failure if there is insufficient capacity on hosts to meet all virtual machine needs.

HIGHEST = RestartPriority(string='HIGHEST')

Virtual machines with this priority have the highest chance of powering on after a failure if there is insufficient capacity on hosts to meet all virtual machine needs.

LOW = RestartPriority(string='LOW')

Virtual machines with this priority have a lower chance of powering on after a failure if there is insufficient capacity on hosts to meet all virtual machine needs.

LOWEST = RestartPriority(string='LOWEST')

Virtual machines with this priority have the lowest chance of powering on after a failure if there is insufficient capacity on hosts to meet all virtual machine needs.

MEDIUM = RestartPriority(string='MEDIUM')

Virtual machines with this priority have an intermediate chance of powering on after a failure if there is insufficient capacity on hosts to meet all virtual machine needs.

class ServiceState(string)

Bases: Enum

Possible states of an HA service. All services support the disabled and enabled states.

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

DISABLED = ServiceState(string='DISABLED')

HA service is disabled.

ENABLED = ServiceState(string='ENABLED')

HA service is enabled.

class StorageVmReaction(string)

Bases: Enum

The VM policy settings that determine the response to storage failures.

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

CLUSTER_DEFAULT = StorageVmReaction(string='CLUSTER_DEFAULT')

VM will use the cluster default setting. This option is only meaningful for per-VM settings.

DISABLED = StorageVmReaction(string='DISABLED')

VM Component Protection service will not monitor or react to the component failure. This setting does not affect other vSphere HA services such as Host Monitoring or VM Health Monitoring.

RESTART_AGGRESSIVE = StorageVmReaction(string='RESTART_AGGRESSIVE')

VM Component Protection service protects VMs aggressively. With this setting, the service will terminate an affected VM even if it can’t determine that capacity exists to restart the VM.

RESTART_CONSERVATIVE = StorageVmReaction(string='RESTART_CONSERVATIVE')

VM Component Protection service protects VMs conservatively. With this setting, when the service can’t determine that capacity is available to restart a VM, it will favor keeping the VM running.

WARNING = StorageVmReaction(string='WARNING')

VM Component Protection service will monitor component failures but will not restart an affected VM. Rather it will notify users about the component failures. This setting does not affect other vSphere HA services such as Host Monitoring or VM Health Monitoring.

class VmMonitoringState(string)

Bases: Enum

The enum defines values that indicate the state of Virtual Machine Health Monitoring. Health Monitoring uses the vmTools (guest) and application agent heartbeat modules. You can configure HA to respond to heartbeat failures of either one or both modules. You can also disable the HA response to heartbeat failures.

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

VM_AND_APP_MONITORING = VmMonitoringState(string='VM_AND_APP_MONITORING')

HA response to both guest and application heartbeat failure is enabled.

VM_MONITORING_DISABLED = VmMonitoringState(string='VM_MONITORING_DISABLED')

Virtual machine health monitoring is disabled. In this state, HA response to guest and application heartbeat failures are disabled.

VM_MONITORING_ONLY = VmMonitoringState(string='VM_MONITORING_ONLY')

HA response to guest heartbeat failure is enabled.

class VmReactionOnAPDCleared(string)

Bases: Enum

If an APD condition clears after an APD timeout condition has been declared and before VM Component Protection service terminated the VM, the guestOS and application may no longer be operational.

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

NONE = VmReactionOnAPDCleared(string='NONE')

VM Component Protection service will not react after APD condition is cleared.

RESET = VmReactionOnAPDCleared(string='RESET')

VM Component Protection service will reset the VM after APD condition is cleared. Note this only applies if the subject VM is still powered on.

USE_CLUSTER_DEFAULT = VmReactionOnAPDCleared(string='USE_CLUSTER_DEFAULT')

VM will use the cluster default setting. This option is only meaningful for per-VM settings.

class com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.ha_client.FixedSizeSlotPolicy(cpu=None, memory=None)

Bases: VapiStruct

This policy allows setting a fixed slot size

Tip

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

Parameters:

  • cpu (long) – The cpu component of the slot size (in MHz)

  • memory (long) – The memory component of the slot size (in megabytes)

class com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.ha_client.HaVmOverrides(name=None, vm_restart_priority=None, vm_additional_delay=None, vm_restart_priority_timeout=None, vm_isolation_response=None, vm_datastore_with_pdl_failure_response=None, vm_apd_failure_response=None, vm_apd_failover_delay=None, vm_apd_response_recovery=None, vm_monitoring=None)

Bases: VapiStruct

The VmOverrides data object contains the HA configuration settings for vm as a override from cluster. All fields are optional.

Tip

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

Parameters:

  • name (str) – Reference to the virtual machine.

  • vm_restart_priority (FailuresAndResponses.RestartPriority or None) – Restart priority for a virtual machine. If None or empty, the value is skipped.

  • vm_additional_delay (long or None) – After condition has been met, a mandatory delay before starting the next VM restart priority.

  • vm_restart_priority_timeout (long or None) – This setting is used to specify a maximum time the lower priority VMs should wait for the higher priority VMs to be ready. If the higher priority Vms are not ready by this time, then the lower priority VMs are restarted irrespective of the VM ready state. This timeout can be used to prevent the failover of lower priority VMs to be stuck infinitely. If None or empty, the value is skipped.

  • vm_isolation_response (FailuresAndResponses.IsolationResponse or None) –

    Indicates whether or not the virtual machine should be powered off if a host determines that it is isolated from the rest of the compute resource.

    If not specified at either the cluster level or the virtual machine level, this will default to powerOff. If None or empty, the value is skipped.

  • vm_datastore_with_pdl_failure_response (FailuresAndResponses.StorageVmReaction) – VM storage protection setting for storage failures categorized as Permenant Device Loss (PDL). PDL indicates storage device failure or LUN removal. In case of PDL, the failed datastore or device is unlikely to recover. The details of PDL are

  • vm_apd_failure_response (FailuresAndResponses.StorageVmReaction) – VM storage protection setting for storage failures categorized as All Paths Down (APD). APD is a condition where a storage has become inaccessible for unknown reasons. It only indicates loss of connectivity and does not indicate storage device failure or LUN removal (Permanent Device Loss or PDL)

  • vm_apd_failover_delay (long or None) – The time interval after an APD timeout has been declared and before VM Component Protection service will terminate the VM. The default value is 180 seconds if not specified. To use cluster setting for a VM override, set to -1 in per-VM setting.

  • vm_apd_response_recovery (FailuresAndResponses.VmReactionOnAPDCleared or None) – Action taken by VM Component Protection service for a powered on VM when APD condition clears after APD timeout. This property is meaningful only when vSphere HA is turned on. Valid values are

  • vm_monitoring (FailuresAndResponses.VmMonitoringState or None) – Virtual machine health monitoring is disabled. In this state, HA response to guest and application heartbeat failures are disabled.

class com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.ha_client.HeartBeatDataStores(heartbeat_datastore_policy=None, datastores=None)

Bases: VapiStruct

The HeartBeatDataStores class contains attributes describing the HeartBeatDataStores It contains cluster-wide configurations for vsphere HA.

Tip

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

Parameters:
class HBDatastoreCandidate(string)

Bases: Enum

The policy to determine the candidates from which vCenter Server can choose heartbeat datastores.

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

ALL_FEASIBLE_DS = HBDatastoreCandidate(string='ALL_FEASIBLE_DS')

vCenter Server chooses heartbeat datastores from all the feasible ones, i.e., the datastores that are accessible to more than one host in the cluster. The choice will be made without giving preference to those specified by the user (see #heartbeatDatastore).

ALL_FEASIBLE_DS_WITH_USER_PREFERENCE = HBDatastoreCandidate(string='ALL_FEASIBLE_DS_WITH_USER_PREFERENCE')

vCenter Server chooses heartbeat datastores from all the feasible ones while giving preference to those specified by the user (see #heartbeatDatastore). More specifically, the datastores not included in #heartbeatDatastore will be chosen if and only if the specified ones are not sufficient.

USER_SELECTED_DS = HBDatastoreCandidate(string='USER_SELECTED_DS')

vCenter Server chooses heartbeat datastores from the set specified by the user (see #heartbeatDatastore). More specifically, datastores not included in the set will not be chosen. Note that if #heartbeatDatastore is empty, datastore heartbeating will be disabled for HA.

class com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.ha_client.StubFactory(stub_config)

Bases: StubFactoryBase

Initialize StubFactoryBase

Parameters:

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

class com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.ha_client.VmToolsMonitoringSettings(enabled=None, cluster_settings=None, failure_interval=None, min_up_time=None, max_failures=None, max_failure_window=None)

Bases: VapiStruct

The vim.cluster.VmToolsMonitoringSettings data object contains virtual machine monitoring settings that are used by the Virtual Machine Health Monitoring Service. The Service checks the VMware Tools heartbeat of a virtual machine. If heartbeats have not been received within a specified time interval, the Service declares the virtual machine as failed and resets the virtual machine. All fields are optional. In case of a reconfiguration, fields left unset are not changed.

Tip

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

Parameters:

  • enabled (bool or None) –

    Flag indicating whether or not the Virtual Machine Health Monitoring service is enabled.

    The Server does not use this property.

  • cluster_settings (bool or None) –

    Flag indicating whether to use the cluster settings or the per VM settings.

    The default value is true.

  • failure_interval (long or None) –

    If no heartbeat has been received for at least the specified number of seconds, the virtual machine is declared as failed.

    The default value is 30.

  • min_up_time (long or None) –

    The number of seconds for the virtual machine’s heartbeats to stabilize after the virtual machine has been powered on. This time should include the guest operating system boot-up time. The virtual machine monitoring will begin only after this period.

    The default value is 120.

  • max_failures (long or None) –

    Maximum number of failures and automated resets allowed during the time that VmToolsMonitoringSettings.max_failure_window specifies. If VmToolsMonitoringSettings.max_failure_window is -1 (no window), this represents the absolute number of failures after which automated response is stopped.

    If a virtual machine exceeds this threshold, in-depth problem analysis is usually needed.

    The default value is 3.

  • max_failure_window (long or None) –

    The number of seconds for the window during which up to VmToolsMonitoringSettings.max_failures resets can occur before automated responses stop.

    If set to -1, no failure window is specified.

    The default value is -1.

class com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.ha_client.VsphereHA(enabled=None, failures_and_responses=None, admission_control=None, heartbeat_datastores=None, advanced_options=None)

Bases: VapiStruct

The DasInfo class contains attributes describing the HA specific configurations of a cluster. It contains cluster-wide configurations for DAS.

Tip

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

Parameters:

com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.vsan_client module

class com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.vsan_client.HostDefaultInfo(checksum_enabled=None)

Bases: VapiStruct

Default VSAN service configuration to be used for hosts admitted to the cluster.

Tip

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

Parameters:

checksum_enabled (bool or None) – Whether the VSAN service is configured to enforce checksum protection. If omitted while enabling the VSAN service, this value will default to false. Change this value to false shall not affect any existing disk status. Changing this value to true shall do disk enforcement check that all VSAN disks are checksum enabled.````

class com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.vsan_client.StubFactory(stub_config)

Bases: StubFactoryBase

Initialize StubFactoryBase

Parameters:

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

class com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.vsan_client.VsanConfigInfo(enabled=None, default_config=None)

Bases: VapiStruct

The VsanConfigInfo data object contains configuration data for the VSAN service in a cluster. This data object is used both for specifying cluster-wide settings when updating the VSAN service, and as an output datatype when retrieving current cluster-wide VSAN service settings.

Tip

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

Parameters:

  • enabled (bool or None) – Whether the VSAN service is enabled for the cluster.

  • default_config (HostDefaultInfo or None) – Default VSAN settings to use for hosts admitted to the cluster when the VSAN service is enabled. If omitted, values will default as though the fields in the HostDefaultInfo have been omitted.