Registering a Source Server with SMS
Function
This API is automatically called by the Agent to report the basic information about the source server to SMS. After the source server is registered successfully, you can view the source server information on the SMS console.
Calling Method
For details, see Calling APIs.
URI
POST /v3/sources
Request
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
X-Auth-Token |
Yes |
String |
The user token. It can be obtained by calling the IAM API (value of X-Subject-Token in the response header). Minimum length: 1 character Maximum length: 16,384 characters |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
id |
No |
String |
The ID of the source server in the SMS database. Minimum length: 0 characters Maximum length: 255 characters |
ip |
Yes |
String |
The IP address of the source server. This parameter is mandatory for registering the source server with SMS and optional for updating the information about the source server. Minimum length: 0 characters Maximum length: 255 characters |
name |
Yes |
String |
The name of the source server displayed on the SMS console. Minimum length: 0 characters Maximum length: 255 characters |
hostname |
No |
String |
The hostname of the source server. This parameter is mandatory for registering the source server with SMS and optional for updating the information about the source server. Minimum length: 0 characters Maximum length: 255 characters |
os_type |
Yes |
String |
The OS type of the source server. This parameter is mandatory for registering the source server with SMS and optional for updating the information about the source server. Minimum length: 0 characters Maximum length: 255 characters The value can be:
|
os_version |
No |
String |
The OS version. This parameter is mandatory for registration and optional for update. Minimum length: 0 characters Maximum length: 255 characters |
virtualization_type |
No |
String |
The OS virtualization type. Minimum length: 0 characters Maximum length: 255 characters |
linux_block_check |
No |
String |
The Linux block-level check. Minimum length: 0 characters Maximum length: 255 characters |
firmware |
No |
String |
The boot mode. Minimum length: 0 characters Maximum length: 255 characters The value can be:
|
cpu_quantity |
No |
Integer |
The number of CPUs. Minimum value: 0 Maximum value: 65535 |
memory |
No |
Long |
The memory size (MB). Minimum value: 0 Maximum value: 9223372036854775807 |
disks |
No |
Array of ServerDisk objects |
The disk information of the source server. Array length: 0 to 65,535 characters |
btrfs_list |
No |
Array of BtrfsFileSystem objects |
The Btrfs information on the source server. This parameter is mandatory for Linux. If there are no Btrfs file systems on the source server, the value is an empty array []. Array length: 0 to 65,535 characters |
networks |
No |
Array of NetWork objects |
The NIC information of the source server. Array length: 0 to 65,535 characters |
domain_id |
No |
String |
The domain ID of a tenant. Minimum length: 0 characters Maximum length: 255 characters |
has_rsync |
No |
Boolean |
Specifies whether rsync is installed. This parameter is mandatory for Linux. |
paravirtualization |
No |
Boolean |
Specifies whether the source server is paravirtualized. This parameter is mandatory for Linux. |
raw_devices |
No |
String |
The list of raw devices. This parameter is mandatory for Linux. Minimum length: 0 characters Maximum length: 255 characters |
driver_files |
No |
Boolean |
Specifies whether any driver files are missing. This parameter is mandatory for Windows. |
system_services |
No |
Boolean |
Specifies whether there are abnormal services. This parameter is mandatory for Windows. |
account_rights |
No |
Boolean |
Specifies whether the account has the required permissions. This parameter is mandatory for Windows. |
boot_loader |
No |
String |
The system boot loader. This parameter is mandatory for Linux. The value can be:
|
system_dir |
No |
String |
The system directory. This parameter is mandatory for Windows. Minimum length: 0 characters Maximum length: 255 characters |
volume_groups |
No |
Array of VolumeGroups objects |
This parameter is mandatory for Linux. If there are no volume groups, the value is an empty array []. Array length: 0 to 65,535 characters |
agent_version |
Yes |
String |
The Agent version. Minimum length: 0 characters Maximum length: 255 characters |
kernel_version |
No |
String |
The Kernel version. Minimum length: 0 characters Maximum length: 255 characters |
migration_cycle |
No |
String |
The current migration stage of the source server. The value can be:
|
state |
No |
String |
The source server status. Minimum length: 0 characters Maximum length: 255 characters The value can be:
|
oem_system |
No |
Boolean |
Whether the OS is an OEM version (Windows). |
start_type |
No |
String |
The startup mode. The value can be MANUAL, MGC, or an empty string (""). The value can be:
|
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
name |
Yes |
String |
The disk name. Minimum length: 0 characters Maximum length: 255 characters |
partition_style |
No |
String |
The disk partition type. This parameter is mandatory for source server registration. The value can be:
|
device_use |
Yes |
String |
The disk function. The value can be:
|
size |
Yes |
Long |
The disk size, in bytes. Minimum value: 0 Maximum value: 9223372036854775807 |
used_size |
Yes |
Long |
The used disk space, in bytes. Minimum value: 0 Maximum value: 9223372036854775807 |
physical_volumes |
Yes |
Array of PhysicalVolume objects |
The physical partition information of the disk. Array length: 0 to 65,535 characters |
os_disk |
No |
Boolean |
Specifies whether the disk is the system disk. |
relation_name |
No |
String |
The name of the corresponding disk on the target server running Linux. Minimum length: 0 characters Maximum length: 255 characters |
inode_size |
No |
Integer |
The number of inodes. Minimum value: 0 Maximum value: 4294967296 |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
device_use |
No |
String |
The partition function. The value can be NORMAL, BOOT, or OS. Minimum length: 0 characters Maximum length: 255 characters |
file_system |
No |
String |
The file system type. Minimum length: 0 characters Maximum length: 255 characters |
index |
No |
Integer |
The serial number of the volume. Minimum value: 0 Maximum value: 2147483647 |
mount_point |
No |
String |
The mount point. Minimum length: 0 characters Maximum length: 255 characters |
name |
No |
String |
The volume name. In Windows, it indicates the drive letter, and in Linux, it indicates the device ID. Minimum length: 0 characters Maximum length: 255 characters |
size |
No |
Long |
The volume size. Minimum value: 0 Maximum value: 9223372036854775807 |
used_size |
No |
Long |
The used space. Minimum value: 0 Maximum value: 9223372036854775807 |
inode_size |
No |
Integer |
The number of inodes. Minimum value: 0 Maximum value: 4294967296 |
uuid |
No |
String |
The GUID of the volume, which can be obtained from the source server. Minimum length: 0 characters Maximum length: 255 characters |
size_per_cluster |
No |
Integer |
The size of each cluster. Minimum value: 0 Maximum value: 2147483647 |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
name |
Yes |
String |
The file system name. Minimum length: 0 characters Maximum length: 255 characters |
label |
Yes |
String |
The file system tag. If no tag exists, the value is an empty string. Minimum length: 0 characters Maximum length: 255 characters |
The UUID. |
Yes |
String |
The UUID of the file system. Minimum length: 0 characters Maximum length: 255 characters |
device |
Yes |
String |
The device name in the Btrfs. Minimum length: 0 characters Maximum length: 255 characters |
size |
Yes |
Long |
The space occupied by the file system. Minimum value: 0 Maximum value: 9223372036854775807 |
nodesize |
Yes |
Long |
The size of the Btrfs node. Minimum value: 0 Maximum value: 9223372036854775807 |
sectorsize |
Yes |
Integer |
The sector size. Minimum value: 0 Maximum value: 2147483647 |
data_profile |
Yes |
String |
The data profile (RAD). Minimum length: 0 characters Maximum length: 255 characters |
system_profile |
Yes |
String |
The file system profile (RAD). Minimum length: 0 characters Maximum length: 255 characters |
metadata_profile |
Yes |
String |
The metadata profile (RAD). Minimum length: 0 characters Maximum length: 255 characters |
global_reserve1 |
Yes |
String |
The Btrfs file system information. Minimum length: 0 characters Maximum length: 255 characters |
g_vol_used_size |
Yes |
Long |
The used space of the Btrfs volume. Minimum value: 0 Maximum value: 9223372036854775807 |
default_subvolid |
Yes |
String |
The ID of the default subvolume. Minimum length: 0 characters Maximum length: 255 characters |
default_subvol_name |
Yes |
String |
The name of the default subvolume. Minimum length: 0 characters Maximum length: 255 characters |
default_subvol_mountpath |
Yes |
String |
The mount path of the default subvolume or Btrfs file system. Minimum length: 0 characters Maximum length: 255 characters |
subvolume |
Yes |
Array of BtrfsSubvolume objects |
The subvolume information. Array length: 0 to 65,535 characters |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
The UUID. |
Yes |
String |
The UUID of the parent volume. Minimum length: 0 characters Maximum length: 255 characters |
is_snapshot |
Yes |
String |
Specifies whether the subvolume is a snapshot. Minimum length: 0 characters Maximum length: 255 characters |
subvol_id |
Yes |
String |
The subvolume ID. Minimum length: 0 characters Maximum length: 255 characters |
parent_id |
Yes |
String |
The parent volume ID. Minimum length: 0 characters Maximum length: 255 characters |
subvol_name |
Yes |
String |
The subvolume name. Minimum length: 0 characters Maximum length: 255 characters |
subvol_mount_path |
Yes |
String |
The mount path of the subvolume. Minimum length: 0 characters Maximum length: 255 characters |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
name |
Yes |
String |
The NIC name. Minimum length: 0 characters Maximum length: 255 characters |
ip |
Yes |
String |
The IP address bound to the NIC. Minimum length: 0 characters Maximum length: 255 characters |
netmask |
Yes |
String |
The subnet mask. Minimum length: 0 characters Maximum length: 255 characters |
gateway |
Yes |
String |
The gateway. Minimum length: 0 characters Maximum length: 255 characters |
mtu |
No |
Integer |
The NIC MTU. This parameter is mandatory for Linux. Minimum value: 0 Maximum value: 2147483647 |
mac |
Yes |
String |
The MAC address. Minimum length: 0 characters Maximum length: 255 characters |
id |
No |
String |
The database ID. Minimum length: 0 characters Maximum length: 255 characters |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
components |
No |
String |
The physical volume information. Minimum length: 0 characters Maximum length: 255 characters |
free_size |
No |
Long |
The available space. Minimum value: 0 Maximum value: 9223372036854775807 |
logical_volumes |
No |
Array of LogicalVolumes objects |
The logical volume information. Array length: 0 to 255 characters |
name |
No |
String |
The volume group name. Minimum length: 0 characters Maximum length: 255 characters |
size |
No |
Long |
The volume size. Minimum value: 0 Maximum value: 9223372036854775807 |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
block_count |
No |
Integer |
The number of blocks. Minimum value: 0 Maximum value: 4294967296 Default value: 0 |
block_size |
No |
Long |
The block size. Minimum value: 0 Maximum value: 1048576 Default value: 0 |
file_system |
Yes |
String |
The file system. Minimum length: 0 characters Maximum length: 255 characters |
inode_size |
Yes |
Integer |
The number of inodes. Minimum value: 0 Maximum value: 4294967296 |
device_use |
No |
String |
The partition function. The value can be NORMAL, BOOT, or OS. Minimum length: 0 characters Maximum length: 255 characters |
mount_point |
Yes |
String |
The mount point. Minimum length: 0 characters Maximum length: 256 characters |
name |
Yes |
String |
The volume group name. Minimum length: 0 characters Maximum length: 1,024 characters |
size |
Yes |
Long |
The volume size. Minimum value: 0 Maximum value: 9223372036854775807 |
used_size |
Yes |
Long |
The used space. Minimum value: 0 Maximum value: 9223372036854775807 |
free_size |
Yes |
Long |
The available space. Minimum value: 0 Maximum value: 9223372036854775807 |
Response
Status code: 200
Parameter |
Type |
Description |
---|---|---|
id |
String |
The source server ID. Minimum length: 0 characters Maximum length: 255 characters |
Example Request
This example reports information about a source server to SMS. The source server runs Linux SUSE12_64BIT_SP2, with the name of host-192-168-136-xxx, the IP address of 192.168.136.xxx, the BOOT system disk named /dev/vda, and the total size of the system disk of 42949672960 bytes. After the source server is reported, it will be displayed in the SMS server list.
POST https://{endpoint}/v3/sources { "os_type" : "LINUX", "name" : "host-192-168-136-xxx", "os_version" : "SUSE12_64BIT_SP2", "linux_block_check" : "{\"release_type\": \"SUSE\", \"release_version\": \"12.2\", \"kernel_simplification\": \"4.4.21\", \"architecture\": \"x86_64\", \"kernel_version\": \"4.4.21-69-default\"}", "kernel_version" : "4.4.21-69-default", "virtualization_type" : "HVM", "paravirtualization" : true, "firmware" : "BIOS", "has_rsync" : true, "boot_loader" : "GRUB", "disks" : [ { "name" : "/dev/vda", "device_use" : "BOOT", "size" : 42949672960, "partition_style" : "MBR", "used_size" : 42948624384, "physical_volumes" : [ { "name" : "/dev/vda1", "size" : 2153775104, "device_use" : "NORMAL", "used_size" : 2153775104, "inode_size" : 0, "file_system" : "swap", "mount_point" : "" }, { "name" : "/dev/vda2", "size" : 16862150656, "device_use" : "BTRFS", "used_size" : 16862150656, "inode_size" : 0, "file_system" : "btrfs", "mount_point" : "" }, { "name" : "/dev/vda3", "size" : 23932698624, "device_use" : "NORMAL", "used_size" : 33988608, "inode_size" : 0, "file_system" : "xfs", "mount_point" : "/home" } ] }, { "name" : "/dev/vdb", "device_use" : "NORMAL", "size" : 21474836480, "partition_style" : "MBR", "used_size" : 21473787904, "physical_volumes" : [ { "name" : "/dev/vdb1", "size" : 21473787904, "device_use" : "VOLUME_GROUP", "used_size" : 21473787904, "inode_size" : 0, "file_system" : "LVM2_member", "mount_point" : "" } ] }, { "name" : "/dev/vdc", "device_use" : "VOLUME_GROUP", "size" : 21474836480, "partition_style" : "MBR", "used_size" : 0, "physical_volumes" : [ ] } ], "volume_groups" : [ { "name" : "vg1", "size" : 42948624384, "components" : "/dev/vdb1;/dev/vdc", "logical_volumes" : [ { "name" : "/dev/mapper/vg1-lv1", "device_use" : "NORMAL", "size" : 10737418240, "free_size" : 10713837568, "used_size" : 23580672, "file_system" : "ext4", "mount_point" : "/mnt/lv1", "inode_size" : "256" } ] } ], "btrfs_list" : [ { "name" : "/dev/vda2", "label" : "none", "uuid" : "51bc2b06-d675-4429-bef5-fedb11fe47f4", "device" : "/dev/vda2", "size" : "3.30GiB", "nodesize" : "16384", "sectorsize" : "4096", "data_profile" : "single", "system_profile" : "single", "metadata_profile" : "single", "global_reserve1" : "single", "g_vol_used_size" : "3894038528", "default_subvolid" : "259", "default_subvol_name" : "@/.snapshots/1/snapshot", "default_subvol_mountpath" : "/", "subvolumn" : [ { "uuid" : "51bc2b06-d675-4429-bef5-fedb11fe47f4", "is_snapshot" : "false", "subvol_id" : "257", "parent_id" : "5", "subvol_name" : "@", "subvol_mount_path" : "null" }, { "uuid" : "51bc2b06-d675-4429-bef5-fedb11fe47f4", "is_snapshot" : "false", "subvol_id" : "258", "parent_id" : "257", "subvol_name" : "@/.snapshots", "subvol_mount_path" : "/.snapshots" }, { "uuid" : "51bc2b06-d675-4429-bef5-fedb11fe47f4", "is_snapshot" : "true", "subvol_id" : "259", "parent_id" : "258", "subvol_name" : "@/.snapshots/1/snapshot", "subvol_mount_path" : "/" }, { "uuid" : "51bc2b06-d675-4429-bef5-fedb11fe47f4", "is_snapshot" : "false", "subvol_id" : "260", "parent_id" : "257", "subvol_name" : "@/boot/grub2/i386-pc", "subvol_mount_path" : "/boot/grub2/i386-pc" }, { "uuid" : "51bc2b06-d675-4429-bef5-fedb11fe47f4", "is_snapshot" : "false", "subvol_id" : "261", "parent_id" : "257", "subvol_name" : "@/boot/grub2/x86_64-efi", "subvol_mount_path" : "/boot/grub2/x86_64-efi" }, { "uuid" : "51bc2b06-d675-4429-bef5-fedb11fe47f4", "is_snapshot" : "false", "subvol_id" : "262", "parent_id" : "257", "subvol_name" : "@/opt", "subvol_mount_path" : "/opt" }, { "uuid" : "51bc2b06-d675-4429-bef5-fedb11fe47f4", "is_snapshot" : "false", "subvol_id" : "263", "parent_id" : "257", "subvol_name" : "@/srv", "subvol_mount_path" : "/srv" }, { "uuid" : "51bc2b06-d675-4429-bef5-fedb11fe47f4", "is_snapshot" : "false", "subvol_id" : "264", "parent_id" : "257", "subvol_name" : "@/tmp", "subvol_mount_path" : "/tmp" }, { "uuid" : "51bc2b06-d675-4429-bef5-fedb11fe47f4", "is_snapshot" : "false", "subvol_id" : "265", "parent_id" : "257", "subvol_name" : "@/usr/local", "subvol_mount_path" : "/usr/local" }, { "uuid" : "51bc2b06-d675-4429-bef5-fedb11fe47f4", "is_snapshot" : "false", "subvol_id" : "266", "parent_id" : "257", "subvol_name" : "@/var/cache", "subvol_mount_path" : "/var/cache" }, { "uuid" : "51bc2b06-d675-4429-bef5-fedb11fe47f4", "is_snapshot" : "false", "subvol_id" : "267", "parent_id" : "257", "subvol_name" : "@/var/crash", "subvol_mount_path" : "/var/crash" }, { "uuid" : "51bc2b06-d675-4429-bef5-fedb11fe47f4", "is_snapshot" : "false", "subvol_id" : "268", "parent_id" : "257", "subvol_name" : "@/var/lib/libvirt/images", "subvol_mount_path" : "/var/lib/libvirt/images" }, { "uuid" : "51bc2b06-d675-4429-bef5-fedb11fe47f4", "is_snapshot" : "false", "subvol_id" : "269", "parent_id" : "257", "subvol_name" : "@/var/lib/machines", "subvol_mount_path" : "/var/lib/machines" }, { "uuid" : "51bc2b06-d675-4429-bef5-fedb11fe47f4", "is_snapshot" : "false", "subvol_id" : "270", "parent_id" : "257", "subvol_name" : "@/var/lib/mailman", "subvol_mount_path" : "/var/lib/mailman" }, { "uuid" : "51bc2b06-d675-4429-bef5-fedb11fe47f4", "is_snapshot" : "false", "subvol_id" : "271", "parent_id" : "257", "subvol_name" : "@/var/lib/mariadb", "subvol_mount_path" : "/var/lib/mariadb" }, { "uuid" : "51bc2b06-d675-4429-bef5-fedb11fe47f4", "is_snapshot" : "false", "subvol_id" : "272", "parent_id" : "257", "subvol_name" : "@/var/lib/mysql", "subvol_mount_path" : "/var/lib/mysql" }, { "uuid" : "51bc2b06-d675-4429-bef5-fedb11fe47f4", "is_snapshot" : "false", "subvol_id" : "273", "parent_id" : "257", "subvol_name" : "@/var/lib/named", "subvol_mount_path" : "/var/lib/named" }, { "uuid" : "51bc2b06-d675-4429-bef5-fedb11fe47f4", "is_snapshot" : "false", "subvol_id" : "274", "parent_id" : "257", "subvol_name" : "@/var/lib/pgsql", "subvol_mount_path" : "/var/lib/pgsql" }, { "uuid" : "51bc2b06-d675-4429-bef5-fedb11fe47f4", "is_snapshot" : "false", "subvol_id" : "275", "parent_id" : "257", "subvol_name" : "@/var/log", "subvol_mount_path" : "/var/log" }, { "uuid" : "51bc2b06-d675-4429-bef5-fedb11fe47f4", "is_snapshot" : "false", "subvol_id" : "276", "parent_id" : "257", "subvol_name" : "@/var/opt", "subvol_mount_path" : "/var/opt" }, { "uuid" : "51bc2b06-d675-4429-bef5-fedb11fe47f4", "is_snapshot" : "false", "subvol_id" : "277", "parent_id" : "257", "subvol_name" : "@/var/spool", "subvol_mount_path" : "/var/spool" }, { "uuid" : "51bc2b06-d675-4429-bef5-fedb11fe47f4", "is_snapshot" : "false", "subvol_id" : "278", "parent_id" : "257", "subvol_name" : "@/var/tmp", "subvol_mount_path" : "/var/tmp" }, { "uuid" : "51bc2b06-d675-4429-bef5-fedb11fe47f4", "is_snapshot" : "true", "subvol_id" : "282", "parent_id" : "258", "subvol_name" : "@/.snapshots/2/snapshot", "subvol_mount_path" : "null" } ] } ], "cpu_quantity" : 1, "memory" : 934752256, "networks" : [ { "name" : "eth0", "ip" : "192.168.136.xxx", "netmask" : "netmask", "gateway" : "gateway", "mac" : "1a9660eb8a3ffcf4df6d7865b52eb54f7b0cd194029e0eadd8e2c7f1267d80c0" } ], "ip" : "192.168.136.xxx", "agent_version" : "2.2.1" }
Example Response
Status code: 200
The source server has been registered with SMS.
{ "id" : "8abda8635e09d185015e09d188dd0001xx" }
Status Codes
Status Code |
Description |
---|---|
200 |
The source server has been registered with SMS. |
Error Codes
For details, see Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.