VMware Live Recovery Appliance Configuration REST API Operations Index
All available VMware Live Recovery Appliance Configuration REST API Operations
Get information about the virtual appliance.
Restart the virtual appliance.
Shut down the virtual appliance.
Get information about the virtual appliance's disks.
Update the appliance password.
A list of all configured syslog servers.
Update configured syslog servers.
Send test message to all syslog servers.
Information about the current time settings.
Update the current time settings.
Information about supported time zones.
Returns information about the current session, if any.
Logs in and returns the session ID. Include 'x-dr-session' header with the value of the returned session ID in subsequent requests.
Logs out if the session is authenticated.
Generate a new key and certificate signing request (CSR) and return it for signing.
Get the installed certificate authorities (CA) certificates used to validate other server's certificates.
Add certificate authorities (CA) certificates.
Delete certificate authorities (CA) certificates.
Get the appliance certificate info.
DEPRECATED - use POST /appliance/certificates/server/actions/update. Update the appliance certificate.
Check if the appliance can establish a successful SSL connection with the specified endpoint.
Update the appliance certificate. Returns a task to monitor the operation progress.
Check whether the service can be registered to a given VC without a conflict.
DEPRECATED: Use /configuration-manager/actions/check-existing-registrations instead. Check whether the given extension key is already registered in SSO, lookup service, and as VC extension.
List all vCenter Servers in the VMware Platform Services Controller (PSC).
If there is no explicit and valid vcInstanceId in the connection spec, no vCenter Server validation will be done. Only the infra node will be validated.
Error Not Found is returned if the appliance is not configured.
Update the appliance configuration.
Remove current configuration.
Check if the reconfigure operation is required after the upgrade.
Filters local services that support migration and lists available source appliances from which these services can be migrated from.
Migrate external appliance data into this appliance.
Validates connection to the remote appliance. If successful the result task will finish successfully without any ''result''.
Current appliance network settings.
Get the DNS settings.
Update the DNS settings.
Get all network interface settings.
Get network interface settings.
Update network interface settings. Changing the appliance IP address disconnects the current REST API connection.
Get information about all services.
Get information about a specific service.
Restart the service.
Start the service.
Stop the service.
Get all storage replication adapters available on the server.
Create a new storage replication adapter by uploading an installation archive to the server.
Delete a given storage replication adapter. Stop and then delete the containers instantiated from the given image. Afterwards, deletes the image itself. After deletion it is not possible to recover any VMs which are on storage arrays controlled by this adapter.
Any currently running operations affecting storage arrays controlled by the storage replication adapter will be interrupted. This includes but is not limited to, Recover, Test, Cleanup, and Reprotect.
Configuration from the given storage replication adapter is copied over to a specified storage replication adapter.
Any currently running operations affecting storage arrays controlled by the storage replication adapter will be interrupted. This includes but is not limited to, Recover, Test, Cleanup, and Reprotect.
This operation overwrites the configuration of the target storage replication adapter and all its customizations will be lost.
Download configuration archive for a given storage replication adapter from the server.
Reload a given storage replication adapter. Stop and then delete the containers which were instantiated from the given image. Call this operation when storage replication adapter Docker image is stuck and new ones are created. Before calling this operation be advised by a KB article or a VMware representative.
Any currently running operations affecting storage arrays controlled by the storage replication adapter will be interrupted. This includes but is not limited to, Recover, Test, Cleanup, and Reprotect.
Reset configuration of a given storage replication adapter to its default settings. All customizations will be lost.
Any currently running operations affecting storage arrays controlled by the storage replication adapter will be interrupted. This includes but is not limited to, Recover, Test, Cleanup, and Reprotect.
Upload configuration archive for a given storage replication adapter to the server.
Get all support bundles available on the server.
Retrieves the log bundles list.
The list will have the key identifiers of the log bundles created in the current config session and still available on the appliance.
Generate support bundle.
Instructs the server to generate a system log bundle.
A log bundle includes log files and other configuration information that can be used to investigate failures.
Download support bundle info from the server.
Downloads the log bundle which matches the key identifier from the log bundle list and is still available on the appliance.
Delete the existing support bundle on the server.
Instructs the server that this log bundle is no longer needed by the client that generated it.
The server can then safely delete the file.
Retrieve all configuration-related tasks.
Retrieve the task information.
Get all available updates in the repository.
Get information about the current Updates Repository.
Change the current Updates Repository.
Get information about the current rollback snapshot if any.
Delete existing rollback snapshot if any.
Apply rollback snapshot if existent. Applying the rollback snapshot might restart the appliance.
Install the update.