This is the multi-page printable view of this section. Click here to print.
Show Backup Agent
1 - 1.2
scpcli backup backup agent show
--backup_agent_id <value>
Description
Show the detail of Backup Agent.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| backup_agent_id required | string | Backup Agent ID | BACKUP_AGENT-abcd |
Responses
| Name | Description | Example |
|---|---|---|
| ip_address | Media Server IP | |
| name | Media Server name |
2 - 1.1
scpcli backup backup agent show
--backup_agent_id <value>
Description
Show the detail of Backup Agent.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.1 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| backup_agent_id required | string | Backup Agent ID | BACKUP_AGENT-abcd |
Responses
| Name | Description | Example |
|---|---|---|
| id | Backup Agent ID | BACKUP_AGENT-abcd |
| account_id | Account ID | fnsd89fus0f9ds09f90dshf9dshfds09 |
| backup_master_ip | Backup Master IP | 33.44.55.66 |
| backup_master_name | Backup Master name | backupmastertest |
| backup_policy_count | Backup policy count | 3 |
| connection_check_time | Backup Agent connection check time | 2024-11-11T09:13:48Z |
| connection_state | Backup Agent connection state | SUCCESS |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| install_file_path | Install file path | http://linux-agent |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | Backup Agent Name | agent_abcd12 |
| server_backup_agent_ip | Server’s Backup Agent IP | 11.22.33.44 |
| server_category | Backup server category | VIRTUAL_SERVER |
| server_gateway_ip | Server Gateway IP | 22.33.44.55 |
| server_name | Backup Agent target server name | server-001 |
| server_os_type | Server’s OS Type | WINDOWS |
| server_uuid | Backup Agent target server UUID | 89f5ef44-1021-4a5c-8e06-fbb289eac366 |
| state | Backup Agent state | AVAILABLE |
3 - 1.0
scpcli backup backup agent show
--backup_agent_id <value>
Description
Show the detail of Backup Agent.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20260331 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| backup_agent_id required | string | Backup Agent ID | BACKUP_AGENT-abcd |
Responses
| Name | Description | Example |
|---|---|---|
| id | Backup Agent ID | BACKUP_AGENT-abcd |
| account_id | Account ID | fnsd89fus0f9ds09f90dshf9dshfds09 |
| backup_master_ip | Backup Master IP | 33.44.55.66 |
| backup_master_name | Backup Master name | backupmastertest |
| backup_policy_count | Backup policy count | 3 |
| connection_check_time | Backup Agent connection check time | 2024-11-11T09:13:48Z |
| connection_state | Backup Agent connection state | SUCCESS |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| install_file_path | Install file path | http://linux-agent |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | Backup Agent Name | agent_abcd12 |
| server_backup_agent_ip | Server’s Backup Agent IP | 11.22.33.44 |
| server_category | Backup server category | VIRTUAL_SERVER |
| server_gateway_ip | Server Gateway IP | 22.33.44.55 |
| server_name | Backup Agent target server name | server-001 |
| server_os_type | Server’s OS Type | WINDOWS |
| server_uuid | Backup Agent target server UUID | 89f5ef44-1021-4a5c-8e06-fbb289eac366 |
| state | Backup Agent state | AVAILABLE |