Gets the list of backup repositories.
Endpoint
https://<Director_IP_address>:4443/c/router
Request Example
curl --request POST \ --url https://<Director_IP_address>:4443/c/router \ --header "content-type: application/json" \ --cookie @cookies.txt \ --data "{ "action": "BackupManagement", "method": "getBackupRepositories", "data": [{"filter": { "start": 0, "count": 60, "sort": "NAME", "sortAsc": true, "criteria": [{ "type": "AND", "criteria": [{ "type": "EQ", "name": "NAME", "value": "aaaa"}] }] } }], "type": "rpc", "tid": 1}"
Request Fields
Field | Type | Value(s) |
---|---|---|
action | string |
|
method | string |
|
data | Json | Filter parameters. See the filter table below |
type | string | rpc |
tid | int | 1 |
filter
Field | Value | Description |
| int | A start ID of the backup repository to be returned |
| int | Number of backup repositories to be returned |
| string | Backup repository parameter to be sorted with |
| boolean |
|
| array | Filter criteria. See the rows below |
| string | Type of criterion |
| string | Name of criterion. |
| string | Type of the criterion. |
| string | Value of the criterion |
Response Sample
Response Fields
Field | Value | Description |
---|---|---|
message | string | Message if the request failed |
where | string | Reference to the method where a problem occurred |
cause | string | Cause of failure |
data | Json | Repositories info |
Data.children
Single repository info.
Field | Value | Description |
---|---|---|
id | long | Backup repository ID |
state | string | Backup repository state |
status | string | The status of the current operation on the backup repository. NONE if no operations are currently running. Possible values: NONE, UPDATING, SELF_HEALING, SPACE_RECLAIM, VERIFY_BACKUPS, STOPPING_SELF_HEALING, STOPPING_SPACE_RECLAIM, STOPPING_VERIFY_BACKUPS |
changeStatus | string |
|
type | string | Backup repository type. Possible values: FOREVER_INCREMENTAL, INCREMENTAL_WITH_FULL_BACKUPS |
name | string | Display name |
| boolean |
|
| boolean |
|
| boolean |
|
| string | Advanced options of mounting the backup repository when the location field is either of the following: |
| string | Backup repository location type. Possible values: |
| array | Reason(s) for locking the transporter |
description | string | Description (if present) |
size | long | Total size of backup repository in bytes |
free | long | Free space in bytes |
allocated | long | Size of backup repository file(s) on the filesystem |
consumed | long | Actual size of user data in the backup repository files |
attached | boolean | Checks if the backup repository is attached |
consistent | boolean | Checks if the backup repository is consistent |
path | string | A path to the backup repository |
transporterId | long | Assigned transporter ID |
transporterName | string | Assigned transporter name |
transporterCaps | Json | Assigned transporter capabilities. See below. |
username | string | Username to access the fileshare where the backup repository is located |
password | string | Password to access the fileshare where the backup repository is located |
storageSize | long | AWS-specific: the size of allocated storage |
chunkSize | long | AWS-specific: the size of the download chunk |
autoSize | boolean | AWS-specific: true if the storage size is automatically adjusted |
volumeType | string | AWS-specific: the type of the storage volume. |
backupCount | long | The total number of backups |
hvTypeBackupCount | Json | Number of backups by platform type |
hvTypeBackupHasRootDiskCount | Json | AWS-specific: backup count which savepoints have a Root volume |
compression | string | Compression type |
compressionRatio | int | Compression ratio |
deduplication | boolean | Checks if the deduplication is enabled |
deduplicationRatio | int | Deduplication ratio |
selfHeal | boolean | Checks if self-healing of the backup repository is enabled |
encryption | boolean | Checks if encryption is enabled for the backup repository |
encryptionPassword | string | Encryption password |
lockedShared | boolean | true if multiple read operations cannot run on the same backup repository at the same time |
lockedExclusive | boolean | true if multiple updates cannot be made to the repository at the same time |
lockReasons | array | Lock reasons |
preventModification | boolean | If true, prevents manual modification of the item |
wasEdited | boolean | Checks if the backup repository was edited |
wasDiscoveredOnce | boolean | Checks if the backup repository was discovered once |
importIsPending | boolean | true if changeStatus is IMPORT_PENDING |
createIsPending | boolean | true if changeStatus is CREATE_PENDING or RECREATE_PENDING |
useSelfHealSchedule | boolean | Checks if the self-healing schedule is enabled |
selfHealSchedule | Json | Self-healing schedule. Example schedule data: dayOfMonth: null dayOfWeek: null effectiveDate: null enabled: true endTime: null every: null everyType: null month: null monthlyEveryType: null nextRun: null nextRunRelative: 0 on: 127 position: null startTime: "11:00:00 AM" timezone: "Asia/Bangkok" timezoneOffsetMs: 25200000 triggerEvents: null triggerItem: null triggerItemName: null triggerItemTypeName: null triggerRunType: null type: "DAILY" |
selfHealOverrideJobs | boolean | true if the self-healing can override current jobs |
useVerificationSchedule | boolean | Checks if the verification schedule is enabled |
verificationSchedule | Json | Verification schedule. See selfHealSchedule above for an example of schedule data |
verificationOverrideJobs | boolean | true if the verification can override current jobs |
useConsolidationSchedule | boolean | Checks if the space reclaim schedule is enabled |
consolidationSchedule | Json | Space reclaim schedule. See selfHealSchedule above for an example of schedule data |
consolidationOverrideJobs | boolean | true if the space reclaim can override current jobs |
useDetachSchedule | boolean | Checks if the detaching schedule is enabled |
detachSchedule | Json | Detaching schedule. See selfHealSchedule above for an example of schedule data |
attachSchedule | Json | Attaching schedule. See selfHealSchedule above for an example of schedule data |
deleteAndRecreateOnAttach | boolean | true if the backup repository should be recreated during scheduled detach-attach process |
progress | int | The progress of the current operation |
operationStart | string | The timestamp of the beginning of the current operation |
operationStartRelative | long | Relative timestamp (e.g. time since start) of the beginning of the current operation |
alertErrorCode | long | The error code of the alert (if any) |
| string | The title of the alert (if any) |
alertDescription | string | The description of the alert (if any) |
transporterCaps
Transporter capabilities
Field | Value | Description |
---|---|---|
| boolean | Checks if the transporter supports Windows guest OS recovery |
| boolean | Checks if the transporter supports CIFS shares |
| boolean | Checks if the transporter supports Linux guest OS recovery |
| boolean | Checks if the transporter supports VMware vSphere |
| boolean | Checks if the transporter supports Nutanix AHV |
| boolean | Checks if the transporter supports backup repository management |
| boolean | Checks if the transporter supports AWS EC2 instances |
| boolean | Checks if the transporter supports Flash VM boot |
| boolean | Checks if the transporter supports shares |
| boolean | Checks if the transporter supports Microsoft Hyper-V |
| boolean | Checks if the transporter supports backup repository encryption |
| boolean | Checks if the transporter supports VMware vSphere versions earlier than 5.5 |