com.vmware.vcenter.namespace_management.software package

Submodules

com.vmware.vcenter.namespace_management.software.supervisors_client module

The com.vmware.vcenter.namespace_management.software.supervisors_client module provides classes for managing Supervisor upgrades.

class com.vmware.vcenter.namespace_management.software.supervisors_client.Prechecks(config)

Bases: VapiInterface

The Prechecks class provides methods to perform Supervisor upgrade pre-checks. This class was added in vSphere API 8.0.3.0.

Parameters:

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

class FilterSpec(target_version=None)

Bases: VapiStruct

The Prechecks.FilterSpec class contains request filter(s) for fetching the Supervisor upgrade pre-checks. This class was added in vSphere API 8.0.3.0.

Tip

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

Parameters:

target_version (str or None) – Supervisor upgrade version for which pre-check results should be queried. This attribute was added in vSphere API 8.0.3.0. If set, return the pre-check results only for the specified target version. If None, return the pre-check results for all the Supervisor upgrade versions against which pre-checks have already been executed.

class Info(precheck_results=None)

Bases: VapiStruct

The Prechecks.Info class contains detailed information about the Supervisor upgrade pre-check results for multiple Supervisor upgrade version(s). This class was added in vSphere API 8.0.3.0.

Tip

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

Parameters:

precheck_results (list of Prechecks.PrecheckResult or None) – Information about Supervisor upgrade pre-check results. This attribute was added in vSphere API 8.0.3.0. If None, the Supervisor upgrade pre-checks did not run or upgrade is not available.

class PrecheckResult(target_version=None, conditions=None)

Bases: VapiStruct

The Prechecks.PrecheckResult class contains the detailed information about Supervisor upgrade pre-checks against individual upgrade version. This class was added in vSphere API 8.0.3.0.

Tip

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

Parameters:

  • target_version (str) – Represents Supervisor upgrade version for which Prechecks.PrecheckResult.conditions belong to. This attribute was added in vSphere API 8.0.3.0.

  • conditions (list of com.vmware.vcenter.namespace_management_client.Clusters.Condition) – Supervisor upgrade pre-check results for Prechecks.PrecheckResult.target_version. This attribute was added in vSphere API 8.0.3.0.

class PrecheckSpec(target_version=None)

Bases: VapiStruct

The Prechecks.PrecheckSpec class contains the specification required to run Supervisor upgrade pre-checks. This class was added in vSphere API 8.0.3.0.

Tip

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

Parameters:

target_version (str) – The target version indicates the Supervisor upgrade version against which the Supervisor upgrade pre-checks should run, the value for this field should be provided from the list of com.vmware.vcenter.namespace_management.software_client.Clusters.Info.available_versions. This attribute was added in vSphere API 8.0.3.0.

get(supervisor, filter=None)

Returns information about Supervisor upgrade pre-checks. This method was added in vSphere API 8.0.3.0.

Parameters:

  • supervisor (str) – Identifier for the Supervisor. The parameter must be an identifier for the resource type: com.vmware.vcenter.namespace_management.supervisor.Supervisor.

  • filter (Prechecks.FilterSpec or None) – Includes specification to fetch pre-check results for specific Supervisor upgrade version. If set returns the pre-check results only for the specified target version. If None returns the pre-check results for all the versions against which pre-checks ran.

Return type:

Prechecks.Info

Returns:

Supervisor upgrade pre-check results.

Raise:

com.vmware.vapi.std.errors_client.NotFound if Supervisor could not be located or pre-check results not found for Prechecks.FilterSpec.target_version or pre-check results not found for any available upgrade version(s).

Raise:

com.vmware.vapi.std.errors_client.Error if the system reports an error while responding to the request.

Raise:

com.vmware.vapi.std.errors_client.Unauthenticated if the user can not be authenticated.

Raise:

com.vmware.vapi.std.errors_client.Unauthorized if the user does not have System.Read privilege.

run(supervisor, spec)

Run Supervisor upgrade pre-checks. This operation will initiate Supervisor upgrade pre-checks for a specific target version. This method was added in vSphere API 8.0.3.0.

Parameters:

  • supervisor (str) – Identifier for the supervisor on which upgraded pre-checks are run. The parameter must be an identifier for the resource type: com.vmware.vcenter.namespace_management.supervisor.Supervisor.

  • spec (Prechecks.PrecheckSpec) – Specification for running Supervisor upgrade pre-checks.

Raise:

com.vmware.vapi.std.errors_client.Error if the system reports an error while responding to the request.

Raise:

com.vmware.vapi.std.errors_client.Unsupported if upgrade is not available for the Supervisor.

Raise:

com.vmware.vapi.std.errors_client.NotAllowedInCurrentState if Supervisor upgrade is in progress.

Raise:

com.vmware.vapi.std.errors_client.NotFound if Supervisor could not be located.

Raise:

com.vmware.vapi.std.errors_client.Unauthenticated if the user can not be authenticated.

Raise:

com.vmware.vapi.std.errors_client.Unauthorized if the user does not have Namespaces.Upgrade privilege.

Raise:

com.vmware.vapi.std.errors_client.InvalidArgument if the contains invalid details.

class com.vmware.vcenter.namespace_management.software.supervisors_client.StubFactory(stub_config)

Bases: StubFactoryBase

Initialize StubFactoryBase

Parameters:

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