ConfigurationInfo

ConfigurationInfo
ConfigurationInfo

Information about the current appliance configuration.

JSON Example
{
    "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.

ConnectionSpecData
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
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 ServiceConfigurationData
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,
Used By
Parameter To