REST API - update

appliance configuration desired state: update

Updates the configuration of a currently configured profile. 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

PATCH https://{server}/api/appliance/configuration/desiredstate/{version}

{
    "pull_location" : "http://myurl.com",
    "components" : [
        "obj-103",
        "obj-103"
    ],
    "config_spec" : "string",
    "file_id" : "string",
    "encryption_key" : "secret string",
    "description" : "string",
    "source_type" : "PULL",
    "create_spec" : {
        "name" : "string",
        "description" : "string"
    }
}

Path Parameters

Name	Type	Description
Required
version	string	Identifier of the profile to be updated.

Body Parameters:

Name	Type	Description
bold = required
-	import_spec	Specification to update desired profile specification.
-.encryption_key	secret	Encryption Key to encrypt the configuration. 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 encryption will not be used for the profile.
-.description	string	Custom description provided by the user. 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 description will be empty.
-.components	string[]	Components to be imported. 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 or empty, all components will be imported.When clients pass a value of this structure as a parameter, the field must contain identifiers for the resource type: `com.vmware.appliance.configuration.component`. When operations return a value of this structure as a result, the field will contain identifiers for the resource type: `com.vmware.appliance.configuration.component`.
-.source_type	string	Type of the source to import the desired profile specification. 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. The `source_type` structure defines possible values of sources to import profile specification. Warning: This enumeration is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. Value is one of: PULL: Content is pulled from the URL location. The URL scheme of the value in {@link #pullLocation) can be http, https or file. Warning: This constant is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. PUSH: Content was previously uploaded using the file upload endpoint present on vCenter appliance. This endpoint is present at https://VCENTERFQDN:9087/ipm-fileupload URL. Warning: This constant is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. JSON_STRING: The string representing the content of the profile specification. Warning: This constant is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
-.pull_location	URI	Location of the profile specification file to be imported. 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. It is only relevant when source_type has value [PULL]. This field is optional and it is only relevant when the value of `source_type` is PULL.
-.file_id	string	File identifier returned by the file upload endpoint after file is uploaded. 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. It is only relevant when source_type has value [PUSH]. This field is optional and it is only relevant when the value of `source_type` is PUSH.
-.config_spec	string	The JSON string representing the desired config specification. 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. It is only relevant when source_type has value [JSON_STRING]. This field is optional and it is only relevant when the value of `source_type` is JSON_STRING.
-.create_spec	create_spec	Create Spec information used to create 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.
-.create_spec.description	string	Description 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. Optional. If unset, the description will be empty.
-.create_spec.name	string	Name 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.

Response:

HTTP Status Code: 204

Headers:

None

Type:

None

Errors:

HTTP Status Code	Type	Description
401	unauthenticated	if the caller is not authenticated.
400	invalid_argument	If given version is system defined.
404	not_found	If there is no version associated with parameter `version` in the system.
400	not_allowed_in_current_state	If there is another operation in progress.
500	error	If there is some unknown internal error. The accompanying error message will give more details about the failure.
503	service_unavailable	If the service is not available.