Get Backup Repository List
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
{
"action": "BackupManagement",
"method": "getBackupRepositories",
"tid": "1",
"type": "rpc",
"message": null,
"where": null,
"cause": null,
"data": {
"children": [
{
"id": 2,
"state": "OK",
"status": "NONE",
"changeStatus": "NONE",
"type": "LOCAL",
"name": "Onboard repository",
"isAccessible": true,
"licensed": true,
"transporterLockedExclusive": true,
"location": "LOCAL",
"transporterLockedReasons": [null],
"description": "This is the built-in backup repository of NAKIVO Backup & Replication. It is located on the same machine where the main part of the product resides.",
"size": 13128503296,
"free": 10393382912,
"allocated": 0,
"consumed": 0,
"attached": true,
"consistent": true,
"path": "/opt/nakivo/repository",
"transporterId": 1,
"transporterName": "Onboard transporter",
"transporterCaps": {
"WINDOWS_GUESTS_RECOVERY_SUPPORT": true,
"CIFS_SHARE_SUPPORT": true,
"LINUX_GUESTS_RECOVERY_SUPPORT": true,
"VMWARE_VSPHERE_SUPPORT": true,
"REPOSITORY_MANAGEMENT_SUPPORT": true,
"AWS_EC2_SUPPORT ": false,
"NUTANIX_SUPPORT ": false,
"FLASH_VM_BOOT_SUPPORT ": true,
"NFS_SHARE_SUPPORT": true,
"MS_HYPERV_SUPPORT": false,
"REPOSITORY_ENCRYPTION_SUPPORT": true
},
"username": null,
"password": null,
"storageSize": null,
"chunkSize": null,
"autoSize": null,
"volumeType": null,
"backupCount": 0,
"hvTypeBackupCount": {},
"hvTypeBackupHasRootDiskCount": {},
"compression": "FAST",
"compressionRatio": 0,
"deduplication": true,
"deduplicationRatio": 0,
"selfHeal": true,
"encryption": false,
"encryptionPassword": null,
"lockedShared": false,
"lockedExclusive": false,
"lockReasons": [],
"preventModification": false,
"wasEdited": false,
"wasDiscoveredOnce": true,
"wasImported": false,
"wasCreated": false,
"useSelfHealSchedule": false,
"selfHealSchedule": null,
"selfHealOverrideJobs": false,
"useVerificationSchedule": false,
"verificationSchedule": null,
"verificationOverrideJobs": false,
"useConsolidationSchedule": false,
"consolidationSchedule": null,
"consolidationOverrideJobs": false,
"useDetachSchedule": false,
"detachSchedule": null,
"attachSchedule": null,
"deleteAndRecreateOnAttach": false,
"progress": 0,
"operationStart": null,
"operationStartRelative": 0,
"alertErrorCode": null,
"alertTitle": null,
"alertDescription": null
},
{
"id": 3,
"state": "OK",
"status": "NONE",
"changeStatus": "NONE",
"type": "SHARE",
"name": "Repo",
"isAccessible": true,
"licensed": true,
"transporterLockedExclusive": true,
"location": "LOCAL",
"transporterLockedReasons": [null],
"description": "",
"size": 8999835533312,
"free": 2891503828992,
"allocated": 331554388515,
"consumed": 321726173238,
"attached": true,
"consistent": true,
"path": "\\\\server\\share",
"transporterId": 1,
"transporterName": "Onboard transporter",
"transporterCaps": {
"WINDOWS_GUESTS_RECOVERY_SUPPORT": true,
"CIFS_SHARE_SUPPORT": true,
"LINUX_GUESTS_RECOVERY_SUPPORT": true,
"VMWARE_VSPHERE_SUPPORT": true,
"NUTANIX_SUPPORT": true
"REPOSITORY_MANAGEMENT_SUPPORT ": true,
"AWS_EC2_SUPPORT": false,
"FLASH_VM_BOOT_SUPPORT": true,
"NFS_SHARE_SUPPORT": true,
"MS_HYPERV_SUPPORT": false,
"REPOSITORY_ENCRYPTION_SUPPORT": true
},
"username": "DOMAIN\\username",
"password": "$FAKE_PASSWORD$",
"storageSize": 500,
"chunkSize": 500,
"autoSize": true,
"volumeType": "sc1",
"backupCount": 18,
"hvTypeBackupCount": {
"VMWARE": 11,
"HYPERV": 7
},
"hvTypeBackupHasRootDiskCount": {},
"compression": "FAST",
"compressionRatio": 5900,
"deduplication": true,
"deduplicationRatio": 1100,
"selfHeal": true,
"encryption": false,
"encryptionPassword": null,
"lockedShared": false,
"lockedExclusive": false,
"lockReasons": [],
"preventModification": false,
"wasEdited": false,
"wasDiscoveredOnce": true,
"wasImported": false,
"wasCreated": false,
"useSelfHealSchedule": false,
"selfHealSchedule": null,
"selfHealOverrideJobs": false,
"useVerificationSchedule": false,
"verificationSchedule": null,
"verificationOverrideJobs": false,
"useConsolidationSchedule": false,
"consolidationSchedule": null,
"consolidationOverrideJobs": false,
"useDetachSchedule": false,
"detachSchedule": null,
"attachSchedule": null,
"deleteAndRecreateOnAttach": false,
"progress": 0,
"operationStart": null,
"operationStartRelative": 0,
"alertErrorCode": null,
"alertTitle": null,
"alertDescription": null
}
],
"totalCount": 2
}
}
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. See the schedules data table below. Example schedule data: |
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) |
schedules
Field | Type | Description | Possible values or format |
---|---|---|---|
enabled
|
boolean | If a schedule enabled, then true , false otherwise |
|
|
string | The type of backup schedule |
|
position
|
int | Priority of the schedule |
|
startTime
|
string | Start time | hh:mm:ss AM/PM
|
endTime
|
string | End time. null if not set |
|
timezone
|
string | Time zone |
|
on
|
int | A decimal representation of a bit mask for a day of a week. The lowest bit is Monday, the 7th is Sunday. For example, if you need to run a job on weekdays, the bitmask will be 00011111 which is 31 in decimal |
1-127
|
everyType
|
string |
If |
|
every
|
int |
The number of delay units between job runs. For example, "Run job every 30 minutes" |
|
monthlyEveryType
|
string | If type is MONTHLY_YEARLY , selects the number of weekday in a month or a day number |
|
dayOfMonth
|
int | If monthlyEveryType is DAY , selects the day number in a month |
|
dayOfWeek
|
int | If monthlyEveryType is either from LAST , selects the number of a weekday |
|
month
|
int | If type is MONTHLY_YEARLY , the number of the month when a job must be run |
|
triggerItem
|
string | VID of the job that triggers current |
|
triggerRunType
|
string | Selects either to run the job immediately after the previous or within a delay. If DELAYED is selected, the delay is defined by the everyType and every fields |
|
triggerEvents
|
array | Trigger job conditions |
|
nextRun
|
string | Time and date of the next job run | YYYY-MM-DDTHH:MM:SS.SSSZ
|
|
string |
The date that schedule is effective from. It can be |
|
|
string |
Name of the triggered item |
|
|
string |
Name of the triggered item type |
|
|
int |
Set by the server. The specified timezone offset with regard to the server's time |
|
|
long |
Relative time in ms when the job will run next time |
|
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 |