Replicator Change Root Password

Replicator Change Root Password

This request changes the root user password of the Replicator Appliance.

Request
URI
POST
https://{api_host}/config/replicators/root-password
COPY
Header Parameters
string
operationID
Optional

Operation ID for correlating logs across multiple services

string
Config-Secret
Optional

The current root password of the Replicator Appliance.

Config-Secret example 
mypassword
Request Body

Replicator Appliance connection settings.

ReplicatorConnectionSettings of type(s) application/json
Required 
{
    "apiUrl": "https://replicator1:8043",
    "apiThumbprint": "SHA-256:0D:80:21:91:C7:DC:94:BC:9D:E8:A7:04:0F:6B:F1:09:5C:AA:97:C8:4A:72:E5:CF:5E:8F:84:A7:B9:CC:8C:85",
    "rootPassword": "rootpasswordformyreplicator"
}
string
apiThumbprint
Optional

The certificate of the Replicator Service, used for trusting both outgoing and incoming connections.Guaranteed to be populated for 'fully' registered replicators.

string
apiUrl
Optional

The URL of the REST API of the Replicator Service.Guaranteed to be populated for 'fully' registered replicators.

string
rootPassword
Optional

The root user password of the Replicator Appliance.

Authentication
This operation uses the following authentication methods.
Responses
204

No Content

Operation doesn't return any data structure

401

The returned error codes include (but are not limited to): NotAuthenticated

Returns ApiError of type(s) application/vnd.vmware.h4-v4.7+json;charset=UTF-8 
{
    "args": [],
    "code": "Forbidden",
    "msg": "Permission denied.",
    "stacktrace": "com.vmware.h4.api.error.exceptions.PermissionDeniedException: Permission denied."
}
array of string
args
Optional

Positional arguments.

string
code
Optional

Specific error code.

string
msg
Optional

Detailed error message.

string
stacktrace
Optional

Exception stacktrace.


500

The returned error codes include (but are not limited to): GeneralServerFailure

Returns ApiError of type(s) application/vnd.vmware.h4-v4.7+json;charset=UTF-8 
{
    "args": [],
    "code": "Forbidden",
    "msg": "Permission denied.",
    "stacktrace": "com.vmware.h4.api.error.exceptions.PermissionDeniedException: Permission denied."
}
array of string
args
Optional

Positional arguments.

string
code
Optional

Specific error code.

string
msg
Optional

Detailed error message.

string
stacktrace
Optional

Exception stacktrace.


On This Page
Replicators Operations
POST
Add Local Replicator
POST
Add Replicator
GET
List Replicators
DELETE
Remove Replicator
POST
Repair Replicator
POST
Replicator Change Root Password
POST
Set Local Replicator Ls
POST
Set Replicator Ls