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

Show optional properties

{
    "connection": {
        "psc_uri": "https://psc01.acme.com:443"
    },
    "credentials": {
        "admin_user": "string",
        "admin_password": "string"
    }
}
{
    "site_name": "string",
    "admin_email": "string",
    "host_name": "string",
    "extension_key": "com.vmware.vcHms",
    "connection": {
        "psc_uri": "https://psc01.acme.com:443",
        "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",
    "services_configuration": [
        {
            "name": "srm-service",
            "state": "UNCONFIGURED"
        }
    ],
    "overall_configuration_state": "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. Filled when the server is returning this data object.

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.

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

object
credentials
Required

Contains credentials information.

string
organization
Optional

Organization name. Filled when the server is returning this data object.

string
description
Optional

DEPRECATED in 9.0.3.0 - Do not use! Plugin description.

integer As int64 As int64
clock_tolerance_seconds
Optional

DEPRECATED in 9.0.3.0 - Do not use! 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
local_server_uuid
Optional

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

array of object
services_configuration
Optional

List of service configurations. Read only.

string
overall_configuration_state
Optional

Service configuration states:

  • UNCONFIGURED - No configuration has been done for the service
  • CONFIGURED - All configurations have been done for the service
  • IMPORTED - Service has been migrated, and can be configured
  • RECONFIGURE_REQUIRED - Service needs to be reconfigured
Possible values are : UNCONFIGURED, CONFIGURED, IMPORTED, RECONFIGURE_REQUIRED,
Authentication
This operation uses the following authentication methods.
Responses
202

Configure the appliance task.

Returns Task of type(s) application/json
"Task Object"
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,
object
error
Optional

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

object
result
Optional

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

integer As int32 As int32
progress
Optional
Constraints: minimum: 0 maximum: 100

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 cannot understand the request due to invalid syntax or invalid request body content

Returns ResponseError of type(s) application/json
"ResponseError Object"
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
"ResponseError Object"
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
"ResponseError Object"
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.


Code Samples
COPY
                    curl -X PUT -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"connection:"object","credentials:"object"}' https://{api_host}/appliance/configuration-manager/configuration