CLI Command Reference

Listing SMS API Versions

hcloud SMS ListApiVersion

This API is used to list SMS API versions.

Go debug

Querying an SMS API Version

hcloud SMS ShowApiVersion

This API is used to query a specified API version of SMS.

Go debug

Listing Failed Source Servers

hcloud SMS ListErrorServers

This API is used to query the list of source servers that failed to be migrated and the reported error messages.

Go debug

Listing Source Servers

hcloud SMS ListServers

After the Agent installed on a source server is started, the Agent registers the source server information with SMS. This API is used to list registered source servers.

Go debug

Registering a Source Server with SMS

hcloud SMS RegisterServer

This API is automatically called by the Agent to report the basic information about a source server to SMS. After the source server is registered successfully, you can view the source server information on the SMS console.

Go debug

Batch Deleting Source Server Records

hcloud SMS DeleteServers

This API is used to delete source server records in batches. Once the information about a source server is deleted, you can add the information about the source server to the SMS console again only by restarting the migration Agent on the source server.

Go debug

Querying a Source Server

hcloud SMS ShowServer

After the migration Agent reports the source server information to SMS, SMS checks the migration feasibility. This API returns the basic information and check results of the source server.

Go debug

Modifying Source Server Information

hcloud SMS UpdateServerName

This API is used to modify the information of a source server in SMS to facilitate server management.

Go debug

Deleting a Source Server Record

hcloud SMS DeleteServer

This API is used to delete the record of a source server with a specified ID from the SMS console. Once the information about a source server is deleted, you can add the information about the source server to the SMS console again only by restarting the migration Agent on the source server.

Go debug

Updating Disk Information

hcloud SMS UpdateDiskInfo

This API is used to overwrite the original disk information of a server with the new disk information.

Go debug

Obtaining an Overview of Source Servers

hcloud SMS ShowOverview

Obtaining an Overview of Source Servers

Go debug

Updating the Migration Status of a Source Server

hcloud SMS UpdateCopyState

This API is used to update the migration status of a source server.

Go debug

Obtaining the Agent configuration information

hcloud SMS ShowConfig

After the Agent installed on a source server is started, it calls this API to obtain configuration information.

Go debug

Listing Migration Tasks

hcloud SMS ListTasks

After the target server is configured for a source server, SMS automatically creates a migration task. This API is used to list all your migration tasks.

Go debug

Creating a Migration Task

hcloud SMS CreateTask

This API is used to create a migration task for a source server.

Go debug

Batch Deleting Migration Tasks

hcloud SMS DeleteTasks

This API is used to delete multiple migration tasks in a batch.

Go debug

Querying a Migration Task with a Specified ID

hcloud SMS ShowTask

This API is used to query a migration task with a specified ID.

Go debug

Deleting a Migration Task

hcloud SMS DeleteTask

This API is used to delete a migration task with a specified ID.

Go debug

Updating a Migration Task

hcloud SMS UpdateTask

This API is used to update a migration task with a specified ID.

Go debug

Managing Migration Tasks

hcloud SMS UpdateTaskStatus

This API is used to manage migration tasks, including starting, suspending, and synchronizing tasks, uploading logs, and deleting snapshot resources.

Go debug

Reporting Migration Progress and Rate

hcloud SMS UpdateTaskSpeed

This API is called by the Agent installed on source servers during migration to report the migration progress and speed to SMS.

Go debug

Querying the Migration Rate Limiting Rules of a Migration Task

hcloud SMS ShowsSpeedLimits

This API is used to query the time segment-based migration rate limiting rules of a migration task.

Go debug

Setting Migration Rate Limiting Rules for a Migration Task

hcloud SMS UpdateSpeed

This API is used to set migration rate limiting rules for a migration task.

Go debug

Querying a Certificate Passphrase

hcloud SMS ShowPassphrase

This API is used to query the certificate passphrase of the secure transmission channel for a task.

Go debug

Uploading Migration Task Logs

hcloud SMS CollectLog

This API is used to upload the logs of a migration task.

Go debug

Obtaining Consistency Verification Results

hcloud SMS ShowConsistencyResult

This API is used to obtain the brief consistency verification results of a task.

Go debug

Uploading Consistency Verification Results

hcloud SMS UpdateConsistencyResult

This API is called by the Agent to upload the consistency verification results of a task.

Go debug

Obtaining Consistency Verification Results in Batches

hcloud SMS ExportConsistencyResults

This API is used to export consistency verification results in batches.

Go debug

Obtaining Commands from SMS

hcloud SMS ShowCommand

This API is called by the migration Agent on source servers to obtain commands from the SMS server.

Go debug

Reporting Command Execution Results to SMS

hcloud SMS UpdateCommandResult

This API is called by the Agent to send the execution result of a specified command to SMS.

Go debug

Querying the Template List

hcloud SMS ListTemplates

This API is used to list templates used for setting up target servers. You can use these templates for quick configuration.

Go debug

Creating a Template

hcloud SMS CreateTemplate

This API is used to create a template.

Go debug

Batch Deleting Templates

hcloud SMS DeleteTemplates

This API is used to delete templates with specified IDs in batches.

Go debug

Querying a Template

hcloud SMS ShowTemplate

This API is used to query information about an ECS template with a specified ID.

Go debug

Modifying a Template

hcloud SMS UpdateTemplate

This API is used to modify a template.

Go debug

Deleting a Template

hcloud SMS DeleteTemplate

This API is used to delete a template with a specified ID.

Go debug

Querying the Target Server Password in a Template

hcloud SMS ShowTargetPassword

This API is used to query the target server password configured in a template.

Go debug

Listing Migration Projects

hcloud SMS ListMigprojects

SMS enables you to use migration projects to manage source servers. This API is used to obtain the list of all migration projects under the current account.

Go debug

Creating a Migration Project

hcloud SMS CreateMigproject

This API is used to create a migration project.

Go debug

Querying Details About a Migration Project with a Specified ID

hcloud SMS ShowMigproject

This API is used to query details about a migration project with a specified ID.

Go debug

Modifying a Migration Project

hcloud SMS UpdateMigproject

This API is used to modify a migration project.

Go debug

Deleting a Migration Project

hcloud SMS DeleteMigproject

This API is used to delete a migration project with a specified ID.

Go debug

Changing the Default Migration Project

hcloud SMS UpdateDefaultMigproject

This API is used to change the default migration project. If you change the default migration project, the source server will be registered under the changed project.

Go debug

Obtaining an SSL Certificate and Private Key

hcloud SMS ShowCertKey

If the block-level migration method is used, the Agent installed on the source server communicates with the target server through an SSL socket. This API is used to download the certificate and private key (in PEM format) required for data migration.

Go debug

Updating Network Measurement Information

hcloud SMS UpdateNetworkCheckInfo

The API is called by the Agent to report network measurement information.

Go debug

Configuring Advanced Migration Options

hcloud SMS UploadSpecialConfigurationSetting

This API is used to configure advanced migration options for a task, for example, specifying the files or paths to be synchronized.

Go debug

Querying the Settings of Advanced Migration Options of a Task

hcloud SMS ShowConfigSetting

This API is used to query the settings of advanced migration options of a task.

Go debug

Signing the Privacy Agreement

hcloud SMS CreatePrivacyAgreements

This API is used to agree to the privacy agreement.

Go debug

Checking Whether a User Has Agreed to the Privacy Agreement

hcloud SMS ShowPrivacyAgreements

This API is used to query whether a user has signed the privacy agreement.

Go debug