com.vmware.appliance.vcenter.settings package¶
Subpackages¶
Submodules¶
com.vmware.appliance.vcenter.settings.v1_client module¶
The com.vmware.appliance.vcenter.settings.v1_client
module provides classes
to manage the ConfigManagement.
-
class
com.vmware.appliance.vcenter.settings.v1_client.
ComplianceResult
(diff_results=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStruct
The
ComplianceResult
class defines the information about scan results. Warning: This class is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.Tip
The arguments are used to initialize data attributes with the same names.
- Parameters
diff_results (
dict
ofstr
andDiffResult
) – Map of property value differences between current software state and working profile. Warning: This attribute is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.
-
class
com.vmware.appliance.vcenter.settings.v1_client.
Config
(config)¶ Bases:
vmware.vapi.bindings.stub.VapiInterface
The
Config
class provides methods to manage desired configuration specification of vCenter.- Parameters
config (
vmware.vapi.bindings.stub.StubConfiguration
) – Configuration to be used for creating the stub.
-
class
CreateSpec
(name=None, description=None, desired_state=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStruct
The
Config.CreateSpec
class contains the specification required to create a profile in vCenter. the spec contains attributes that describe information about the profile. Warning: This class is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.Tip
The arguments are used to initialize data attributes with the same names.
- Parameters
name (
str
) – Name of the profile. Warning: This attribute is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.description (
str
orNone
) – Description of the profile. Warning: This attribute is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments. If None, the description will be empty.desired_state (
DesiredState
) – Defines the desired state. Warning: This attribute is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.
-
class
Info
(profile=None, version=None, name=None, creation_time=None, owner=None, description=None, desired_state=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStruct
The
Config.Info
class represents information about the config profile. the spec contains attributes that describe information about the profile. Warning: This class is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.Tip
The arguments are used to initialize data attributes with the same names.
- Parameters
profile (
str
) – The identifier of the profile. Warning: This attribute is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments. When clients pass a value of this class as a parameter, the attribute must be an identifier for the resource type:com.vmware.appliance.vcenter.settings.v1.config.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.appliance.vcenter.settings.v1.config.profile
.version (
str
) – Version of the profile. Warning: This attribute is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments. When clients pass a value of this class as a parameter, the attribute must be an identifier for the resource type:com.vmware.appliance.vcenter.settings.v1.config.version
. 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.vcenter.settings.v1.config.version
.name (
str
) – Name of the profile. Warning: This attribute is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.creation_time (
datetime.datetime
) – Creation time of the profile. Warning: This attribute is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.owner (
str
) – Owner of the profile, the one who created. Warning: This attribute is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.description (
str
orNone
) – Custom description provided by the user. Warning: This attribute is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments. If None description will be empty.desired_state (
DesiredState
) – The desired state. Warning: This attribute is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.
-
class
ScanSpec
(message=None, desired_state=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStruct
The
Config.ScanSpec
class contains the specification required for compliance check against the vCenter current config state. Warning: This class is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.Tip
The arguments are used to initialize data attributes with the same names.
- Parameters
message (
str
orNone
) – Message for the scan. This may act as an identification for the scan operation. Warning: This attribute is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments. If None, the message will be empty.desired_state (
DesiredState
) – Defines the desired state. Warning: This attribute is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.
-
create
(spec)¶ Creates a Profile. Warning: This method is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.
- Parameters
spec (
Config.CreateSpec
) – Specification of the profile to be created.- Return type
str
- Returns
ID of newly-created profile. The return value will be an identifier for the resource type:
com.vmware.appliance.vcenter.settings.v1.config.profile
.- Raise
com.vmware.vapi.std.errors_client.AlreadyExists
if a profile with the specified name already exists.- 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.InvalidArgument
if any of the specified parameters are invalid.- Raise
com.vmware.vapi.std.errors_client.ServiceUnavailable
if the system is unable to communicate with a service to complete the request.- Raise
com.vmware.vapi.std.errors_client.Unauthenticated
if the user can not be authenticated.
-
delete
()¶ Deletes a profile. Warning: This method is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.
- 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.NotAllowedInCurrentState
if any other operation running on the same profile.- Raise
com.vmware.vapi.std.errors_client.NotFound
if the profile is not found.- Raise
com.vmware.vapi.std.errors_client.ServiceUnavailable
if the system is unable to communicate service to complete the request.- Raise
com.vmware.vapi.std.errors_client.Unauthenticated
if the user can not be authenticated.
-
get
()¶ Returns information about a profile. Warning: This method is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.
- Return type
- Returns
Information about the specified profile.
- 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.InvalidArgument
If given version is different than the latest one.- Raise
com.vmware.vapi.std.errors_client.NotFound
If there is no profile or version associated withprofile
orversion
in the system.- Raise
com.vmware.vapi.std.errors_client.ServiceUnavailable
if the system is unable to communicate with a service to complete the request.- Raise
com.vmware.vapi.std.errors_client.Unauthenticated
if the user can not be authenticated.
-
scan_desired_state_task
(spec)¶ Scans all the components in the desired state against the applied profile. result of this operation can be queried by calling the api cis/tasks/{task-id} where the task-id is the response of this operation. Warning: This method is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.
- Parameters
spec (
Config.ScanSpec
) –- 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.ServiceUnavailable
If the service is not available.- Raise
com.vmware.vapi.std.errors_client.Unauthenticated
If the caller is not authenticated.
-
scan_task
(version)¶ Scans all the components in the profiles against the applied profile. result of this operation can be queried by calling the api cis/tasks/{task-id} where the task-id is the response of this operation. Warning: This method is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.
- Parameters
version (
str
) – version of the profile. The parameter must be an identifier for the resource type:com.vmware.appliance.vcenter.settings.v1.config.version
.- 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 withprofile
in the system.- 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.vcenter.settings.v1_client.
ConfigCurrent
(config)¶ Bases:
vmware.vapi.bindings.stub.VapiInterface
The
ConfigCurrent
class provides methods to get the current state of the vCenter. Warning: This class is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.- Parameters
config (
vmware.vapi.bindings.stub.StubConfiguration
) – Configuration to be used for creating the stub.
-
get
()¶ Returns the current state of the vCenter. Warning: This method is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.
- Return type
- Returns
- 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.
-
class
com.vmware.appliance.vcenter.settings.v1_client.
DesiredState
(appliance=None, authmgmt=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStruct
The
DesiredState
class defines the configuration about different components in vCenter. Warning: This class is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.Tip
The arguments are used to initialize data attributes with the same names.
- Parameters
appliance (
com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.ApplianceManagement
orNone
) – Appliance Management component desired spec. Warning: This attribute is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.authmgmt (
com.vmware.appliance.vcenter.settings.v1.config.components.authmanagement_client.AuthenticationManagement
orNone
) – Authentication Management component desired spec. Warning: This attribute is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.
-
class
com.vmware.appliance.vcenter.settings.v1_client.
DiffResult
(current_value=None, desired_value=None, category=None, path=None, description=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStruct
The
DiffResult
class defines the information about the feature configuration. Warning: This class is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.Tip
The arguments are used to initialize data attributes with the same names.
- Parameters
current_value (
DataValue
) – Current property value. Warning: This attribute is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.desired_value (
DataValue
) – Desired property value. Warning: This attribute is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.category (
str
) – Category of component configuration. Warning: This attribute is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.path (
str
) – Path of the component configuration. Warning: This attribute is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.description (
str
) – Description of the component configuration. Warning: This attribute is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.
-
class
com.vmware.appliance.vcenter.settings.v1_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. Warning: This class is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.Tip
The arguments are used to initialize data attributes with the same names.
- Parameters
notification (
str
) – The notification Identifier. Warning: This attribute is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments. When clients pass a value of this class as a parameter, the attribute must be an identifier for the resource type:com.vmware.appliance.vcenter.settings.v1.config.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.appliance.vcenter.settings.v1.config.notification
.time (
datetime.datetime
orNone
) – The time the notification was raised. Warning: This attribute is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments. Onlyset
if the time information is available.message (
com.vmware.vapi.std_client.LocalizableMessage
) – The notification message. Warning: This attribute is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.resolution (
com.vmware.vapi.std_client.LocalizableMessage
orNone
) – The resolution message, if any. Warning: This attribute is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments. Onlyset
for warnings and errors.
-
class
com.vmware.appliance.vcenter.settings.v1_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. Warning: This class is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.Tip
The arguments are used to initialize data attributes with the same names.
- Parameters
info (
list
ofNotification
orNone
) – Info notification messages reported. Warning: This attribute is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments. Onlyset
if an info was reported by the task.warnings (
list
ofNotification
orNone
) – Warning notification messages reported. Warning: This attribute is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments. Onlyset
if an warning was reported by the task.errors (
list
ofNotification
orNone
) – Error notification messages reported. Warning: This attribute is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments. Onlyset
if an error was reported by the task.
-
class
com.vmware.appliance.vcenter.settings.v1_client.
ScanResult
(status=None, notifications=None, start_time=None, end_time=None, profile=None, version=None, compliant=None, non_compliant=None, unavailable=None, compliance_result=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStruct
The
ScanResult
class contains attributes to describe the scan result of a appliance. Warning: This class is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.Tip
The arguments are used to initialize data attributes with the same names.
- Parameters
status (
ScanResult.ComplianceStatus
) – Aggregrated compliance state of the appliance. Warning: This attribute is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.notifications (
Notifications
) – Notifications returned by the scan operation. Warning: This attribute is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.start_time (
datetime.datetime
) – Time when the method started. Warning: This attribute is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.end_time (
datetime.datetime
orNone
) – Time when the method completed. Warning: This attribute is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments. If None, the endTime will be empty.profile (
str
) – Identifier of the apply on which the scan is run to generate this result. Warning: This attribute is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments. When clients pass a value of this class as a parameter, the attribute must be an identifier for the resource type:com.vmware.appliance.vcenter.settings.v1.config.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.appliance.vcenter.settings.v1.config.profile
.version (
str
) – The version of the profile. Warning: This attribute is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments. When clients pass a value of this class as a parameter, the attribute must be an identifier for the resource type:com.vmware.appliance.vcenter.settings.v1.config.version
. 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.vcenter.settings.v1.config.version
.compliant (
set
ofstr
) – Identifiers of compliant components. Warning: This attribute is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments. When clients pass a value of this class as a parameter, the attribute must contain identifiers for the resource type:com.vmware.appliance.vcenter.settings.v1.config.component
. When methods return a value of this class as a return value, the attribute will contain identifiers for the resource type:com.vmware.appliance.vcenter.settings.v1.config.component
.non_compliant (
set
ofstr
) – Identifiers of non-compliant components. Warning: This attribute is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments. When clients pass a value of this class as a parameter, the attribute must contain identifiers for the resource type:com.vmware.appliance.vcenter.settings.v1.config.component
. When methods return a value of this class as a return value, the attribute will contain identifiers for the resource type:com.vmware.appliance.vcenter.settings.v1.config.component
.unavailable (
set
ofstr
) – Identifiers of unavailable components. There will not be compliance details for these components. Warning: This attribute is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments. When clients pass a value of this class as a parameter, the attribute must contain identifiers for the resource type:com.vmware.appliance.vcenter.settings.v1.config.component
. When methods return a value of this class as a return value, the attribute will contain identifiers for the resource type:com.vmware.appliance.vcenter.settings.v1.config.component
.compliance_result (
dict
ofstr
andComplianceResult
) – Mapping of component identifier to the compliance result. Warning: This attribute is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments. When clients pass a value of this class as a parameter, the key in the attributedict
must be an identifier for the resource type:com.vmware.appliance.vcenter.settings.v1.config.component
. When methods return a value of this class as a return value, the key in the attributedict
will be an identifier for the resource type:com.vmware.appliance.vcenter.settings.v1.config.component
.
-
class
ComplianceStatus
(string)¶ Bases:
vmware.vapi.bindings.enum.Enum
The
ScanResult.ComplianceStatus
class contains the possible different status of compliance with respect to target version. Warning: This enumeration is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.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 theComplianceStatus
instance.
-
COMPLIANT
= ComplianceStatus(string='COMPLIANT')¶ Target configuration is same as the current configuration?. Warning: This class attribute is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.
-
NON_COMPLIANT
= ComplianceStatus(string='NON_COMPLIANT')¶ Target configuration is not same as the current configuration. Warning: This class attribute is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.
-
UNAVAILABLE
= ComplianceStatus(string='UNAVAILABLE')¶ Scan check failed due to unknown error or check hasn’t happened yet and the results are not available. Warning: This class attribute is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.
-
class
com.vmware.appliance.vcenter.settings.v1_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.vcenter.settings.v1_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. Warning: This class is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.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. Warning: This attribute is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments. This attribute is optional and it is only relevant when the value of#status
is one ofcom.vmware.cis.task_client.Status.RUNNING
,com.vmware.cis.task_client.Status.BLOCKED
,com.vmware.cis.task_client.Status.SUCCEEDED
, orcom.vmware.cis.task_client.Status.FAILED
.notifications (
Notifications
orNone
) – Notifications to the user. Warning: This attribute is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments. Onlyset
if the notifications were reported by this particular task.result (
DataValue
orNone
) – Task result. Warning: This attribute is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments. 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
orNone
) – 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
orNone
) – 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
orNone
) – 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 (seecom.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 ofstatus
is one ofcom.vmware.cis.task_client.Status.RUNNING
,com.vmware.cis.task_client.Status.BLOCKED
,com.vmware.cis.task_client.Status.SUCCEEDED
, orcom.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 ofstatus
is one ofcom.vmware.cis.task_client.Status.SUCCEEDED
orcom.vmware.cis.task_client.Status.FAILED
.user (
str
orNone
) – Name of the user who performed the operation. This attribute will be None if the operation is performed by the system.