[{"label":"Latest (2.0.0)","version":"latest"},{"version":"1.0.0"}]
vrms-appliance-config-api

Update Configuration

Description

Update the appliance configuration.

Request

Request

URL

URL


put
https://{api_host}//appliance/configuration-manager/configuration
Copy

Request Body

Request Body

ConfigurationInfo of mimetype application/json Optional

The appliance configuration to be updated.

{}
connection Required

Contains connection information for a service. If not set the connection parameters will be read from the current DR solution configuration if it exists.


credentials Required

Contains credentials information.


string
admin_email Changed Optional

Administrator email.


integer as int64
clock_tolerance_seconds Changed Optional

The allowed server clock tolerance in seconds. If not set, the default value of 3 seconds will be used. This parameter will be used only when validating the VC server where DR solution will be registered. Clock difference between the DR virtual appliance and vCenter Server should not exceed this value, otherwise validation (or configuration) will fail.


string
description Optional

Plugin description.


string
extension_key Optional

The solution extension key. For vSphere Replication “com.vmware.vcHms” must be used. If not set, the default extension key value of “com.vmware.vcDr” will be used.


string
host_name Optional

The appliance FQDN. Used when registering with the infrastructure and management nodes. If not set, the DNS name will be used.


string as uuid
local_server_uuid Optional

UUID of the local DR server. Filled when the server is returning this data object.


string
organization Optional

Organization name.


string
site_name Optional

The DR site name. If not set, the site name will be read from the current DR configuration if it exists.

Authentication

Authentication

This operation uses the following authentication methods.

Response

Response

Response Body

Response Body

202 Accepted

Returns Task of type application/json

Configure the appliance task.

{
	"complete_time": 0,
	"description": "string",
	"error": {
		"details": "string",
		"message": "string"
	},
	"id": "string",
	"progress": 0,
	"result": {},
	"start_time": 0,
	"status": "QUEUED",
	"type": "string"
}
string
status Required

Status of the task.

Possible values are: QUEUEDRUNNINGSUCCESSERRORCANCELLED


integer as int64
complete_time Changed Optional

The complete time of the task, in milliseconds.


error Optional

Detailed information about the error if the task status is ERROR.


string
id Optional

ID of the task.


integer as int32
progress Optional

The current progress of the task, in percentage number.


object
result Optional

Information about the task result if the task status is SUCCESS.


integer as int64
start_time Changed Optional

The start time of the task, in milliseconds.


string
description Optional

Description of the task.


string
type Optional

Operation type of the task.

Errors

Errors

ResponseError
400

Bad request - the server could not understand the request due to invalid syntax or invalid request body content


401

Unauthorized - the client must authenticate itself to get the requested response


ResponseError
403

Forbidden - not sufficient access rights to fulfill the request


ResponseError
500

Internal server error - unexpected condition prevents fulfilling the request

Code Samples

Code Samples

cURL Command

curl -X PUT -H "Content-Type: application/json" -d '{"extension_key":"com.vmware.vcHms"}' https://{api_host}/appliance/configuration-manager/configuration


[{"label":"Latest (2.0.0)","version":"latest"},{"version":"1.0.0"}]
vrms-appliance-config-api
Feedback

Was this page helpful?