appliance configuration desired state: commit-task
Commits the specified profile as the desired state document. 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/configuration/desiredstate/{profile}
?action=commit
&vmw-task=true
?action=commit
&vmw-task=true
{
"message" : "string"
}
"message" : "string"
}
Path Parameters
| Name | Type | Description |
|---|---|---|
| Required | ||
| profile | string | Identifier of the profile. |
Body Parameters:
| Name | Type | Description |
|---|---|---|
| bold = required | ||
| - | commit_spec | The spec to be used to create the commit. |
| -.message | string | Message to include with the commit. 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. Optional. If unset, message is set to empty string. |
Response:
HTTP Status Code: 202
Response Body Structure:
"obj-103"
Headers:
NoneType:
| Name | Type | Description |
|---|---|---|
| bold = required | ||
| - | string | profile info of the commit. |
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 version associated with profile |
| 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.configuration.validate_result. |
| 503 | service_unavailable | If the service is not available. |
| 401 | unauthenticated | If the caller is not authenticated. |