VcenterSettingsV1ScanResult
The ScanResult structure contains fields to describe the scan result of a appliance. Warning: This structure 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.
Properties
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 structure as a parameter, the key in the field map must be an identifier for the resource type: com.vmware.appliance.vcenter.settings.v1.config.component. When operations return a value of this structure as a result, the key in the field map will be an identifier for the resource type: com.vmware.appliance.vcenter.settings.v1.config.component.
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 structure as a parameter, the field must contain identifiers for the resource type: com.vmware.appliance.vcenter.settings.v1.config.component. When operations return a value of this structure as a result, the field will contain identifiers for the resource type: com.vmware.appliance.vcenter.settings.v1.config.component.
Time when the operation 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 unset, the endTime will be empty.
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 structure as a parameter, the field must contain identifiers for the resource type: com.vmware.appliance.vcenter.settings.v1.config.component. When operations return a value of this structure as a result, the field will contain identifiers for the resource type: com.vmware.appliance.vcenter.settings.v1.config.component.
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.
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 structure as a parameter, the field must be an identifier for the resource type: com.vmware.appliance.vcenter.settings.v1.config.profile. When operations return a value of this structure as a result, the field will be an identifier for the resource type: com.vmware.appliance.vcenter.settings.v1.config.profile.
Time when the operation 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.
The ScanResult.ComplianceStatus structure 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.
COMPLIANT : Target configuration is same as the current configuration?. Warning: This constant 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 : Target configuration is not same as the current configuration. Warning: This constant 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 : Scan check failed due to unknown error or check hasn’t happened yet and the results are not available. Warning: This constant 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.
Possible values are: COMPLIANT , NON_COMPLIANT , UNAVAILABLE
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 structure as a parameter, the field must contain identifiers for the resource type: com.vmware.appliance.vcenter.settings.v1.config.component. When operations return a value of this structure as a result, the field will contain identifiers for the resource type: com.vmware.appliance.vcenter.settings.v1.config.component.
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 structure as a parameter, the field must be an identifier for the resource type: com.vmware.appliance.vcenter.settings.v1.config.version. When operations return a value of this structure as a result, the field will be an identifier for the resource type: com.vmware.appliance.vcenter.settings.v1.config.version.
JSON Example
{
"compliance_result": {
"key": {
"diff_results": {
"key": {
"category": "string",
"description": "string",
"path": "string"
}
}
}
},
"compliant": [
"string"
],
"non_compliant": [
"string"
],
"notifications": {},
"profile": "string",
"start_time": "string",
"status": "COMPLIANT",
"unavailable": [
"string"
],
"version": "string"
}
