Update Configuration

Update Configuration

Update the appliance configuration.

Request
URI
PUT
https://{api_host}/appliance/configuration-manager/configuration
COPY
Request Body

The appliance configuration to be updated.

ConfigurationInfo of type(s) application/json
Optional
{
    "site_name": "string",
    "admin_email": "string",
    "host_name": "string",
    "extension_key": "com.vmware.vcHms",
    "connection": {
        "psc_uri": "string",
        "psc_thumbprint": "string",
        "vc_instance_id": "string",
        "vc_thumbprint": "string"
    },
    "credentials": {
        "admin_user": "string",
        "admin_password": "string"
    },
    "organization": "string",
    "description": "string",
    "clock_tolerance_seconds": 0,
    "local_server_uuid": "string"
}
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.

string
admin_email
Optional

Administrator email.

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
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.

connection
Required

connection

credentials
Required

credentials

string
organization
Optional

Organization name.

string
description
Optional

Plugin description.

integer As int64 As int64
clock_tolerance_seconds
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 As uuid As uuid
local_server_uuid
Optional

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

Authentication
This operation uses the following authentication methods.
Responses
202

Configure the appliance task.

Returns Task of type(s) application/json
{
    "id": "string",
    "description": "string",
    "type": "string",
    "status": "string",
    "error": {
        "message": "string",
        "details": "string"
    },
    "progress": 0,
    "start_time": 0,
    "complete_time": 0
}
string
id
Optional

ID of the task.

string
description
Optional

Description of the task.

string
type
Optional

Operation type of the task.

string
status
Required

Status of the task.

Possible values are : QUEUED, RUNNING, SUCCESS, ERROR, CANCELLED,
error
Optional

error

object
result
Optional

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

integer As int32 As int32
progress
Optional

The current progress of the task, in percentage number.

integer As int64 As int64
start_time
Optional

The start time of the task, in milliseconds.

integer As int64 As int64
complete_time
Optional

The complete time of the task, in milliseconds.


400

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

Returns ResponseError of type(s) application/json
{
    "error_code": "string",
    "message": "string",
    "op_id": "string"
}
string
error_code
Optional

The code of the error.

string
message
Optional

The message of the error.

string As uuid As uuid
op_id
Optional

The ID of the operation.


401

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

Operation doesn't return any data structure

403

Forbidden - not sufficient access rights to fulfill the request

Returns ResponseError of type(s) application/json
{
    "error_code": "string",
    "message": "string",
    "op_id": "string"
}
string
error_code
Optional

The code of the error.

string
message
Optional

The message of the error.

string As uuid As uuid
op_id
Optional

The ID of the operation.


500

Internal server error - unexpected condition prevents fulfilling the request

Returns ResponseError of type(s) application/json
{
    "error_code": "string",
    "message": "string",
    "op_id": "string"
}
string
error_code
Optional

The code of the error.

string
message
Optional

The message of the error.

string As uuid As uuid
op_id
Optional

The ID of the operation.