appliance vcenter settings v1 config: apply-task
Apply the specified profile as the desired state. The result of this operation can be queried by calling the cis/tasks/{task-id} where the task-id is the response of this operation. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
Request:
HTTP request
POST https://{server}/api/appliance/vcenter/settings/v1/config/{version}/
?action=apply
&vmw-task=true
?action=apply
&vmw-task=true
{
"message" : "string",
"version" : "obj-103"
}
"message" : "string",
"version" : "obj-103"
}
Path Parameters
| Name | Type | Description |
|---|---|---|
| Required | ||
| version | string | version of the profile. |
Body Parameters:
| Name | Type | Description |
|---|---|---|
| bold = required | ||
| - | apply_spec | The spec to be used to apply the profile. |
| -.message | string | Message to include with the apply. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. |
| -.version | string | Version of the profile. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. 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. |
Response:
HTTP Status Code: 202
Response Body Structure:
"obj-103"
Headers:
NoneType:
| Name | Type | Description |
|---|---|---|
| bold = required | ||
| - | string | apply result of the profile. |
Errors:
| HTTP Status Code | Type | Description |
|---|---|---|
| 500 | error | If there is unknown internal error. The accompanying error message will give more details about the failure. |
| 404 | not_found | If there is no profile associated with profprofileileId |
| 400 | not_allowed_in_current_state | If there is another operation in progress. |
| 400 | invalid_argument | If validation of the profile fails. The value of the data field of vapi.std.errors.error will be a structure that contains all the fields defined in appliance.vcenter.settings.v1.config.apply_result. |
| 503 | service_unavailable | If the service is not available. |
| 401 | unauthenticated | If the caller is not authenticated. |