VcenterSettingsV1ConfigApplyResult

The Config.ApplyResult structure contains fields that describe the result of an apply operation. 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

string as date-time
end_time Optional

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.


array of string
failed Required

Set of failed 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 Required

Notifications providing additional information about the status 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.


string
profile Required

The identifier of the commit used to fetch the configuration state to be applied to all components within 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. 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.


array of string
skipped Required

Set of skipped 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.


string as date-time
start_time Required

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.


status Required

The Config.ApplyStatus enumerated type contains the possible different status codes that can be returned while trying to apply the configuration specification to the vcenter. 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.
SUCCESS : The operation completed successfully. 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.
SKIPPED : The operation was skipped. 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.
TIMED_OUT : The operation timed out. 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.
ERROR : The operation encountered an error. 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: SUCCESSSKIPPEDTIMED_OUTERROR


array of string
success Required

Set of successfully applied 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.


string
version Required

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

{
	"failed": [
		"string"
	],
	"notifications": {},
	"profile": "string",
	"skipped": [
		"string"
	],
	"start_time": "string",
	"status": "SUCCESS",
	"success": [
		"string"
	],
	"version": "string"
}

Feedback

Was this page helpful?