Page tree

Gets the list of backup repositories.

Endpoint

https://<Director_IP_address>:4443/c/router

Tenant Endpoint

For tenants of the multi-tenant product the endpoint must be:
https://<Director_IP_address>:4443/t/<tenant_UUID>/c/router

Request Example

curl
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)
actionstring

BackupManagement

methodstring

getBackupRepositories

dataJsonFilter parameters. See the filter table below
typestringrpc
tidint1

filter

Field

Value

Description

start

int

A start ID of the backup repository to be returned

count

int

Number of backup repositories to be returned

sort

string

Backup repository parameter to be sorted with

sortAsc

boolean

true if the order is ascending

criteria

array

Filter criteria. See the rows below

type

string

Type of criterion

name

string

Name of criterion.  NAME means the backup repository name

type

string

Type of the criterion. EQ means the equality relational operator

value

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
messagestringMessage if the request failed
wherestringReference to the method where a problem occurred
causestringCause of failure
dataJsonRepositories info

Data.children

Single repository info.

Field
Value
Description
idlongBackup repository ID
statestringBackup repository state
statusstringThe 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
changeStatusstring

NONE
CREATE_PENDING New item, discovery is needed
CHANGE_PENDING Some attributes have changed, discovery is needed
IMPORT_PENDING Import item
RECREATE_PENDING The item was destroyed and needs to be re-created

typestringBackup repository type. Possible values: FOREVER_INCREMENTAL, INCREMENTAL_WITH_FULL_BACKUPS
namestringDisplay name

isAccessible

boolean

true if the backup repository is accessible

licensed

boolean

true if the backup repository is licensed

transporterLockedExclusive

boolean

true if the transporter is exclusively locked

advancedMountOptions

string

Advanced options of mounting the backup repository when the location field is either of the following: NFS_SHARE, CIFS_SHARE. This field is optional

location

string

Backup repository location type. Possible values: CIFS_SHARE, LOCAL, NFS_SHARE, AMAZON_EBS

transporterLockedReasons

array

Reason(s) for locking the transporter

descriptionstringDescription (if present)
sizelongTotal size of backup repository in bytes
freelongFree space in bytes
allocatedlong
Size of backup repository file(s) on the filesystem
consumedlong
Actual size of user data in the backup repository files
attachedbooleanChecks if the backup repository is attached
consistentbooleanChecks if the backup repository is consistent
pathstring

A path to the backup repository

transporterIdlongAssigned transporter ID
transporterNamestringAssigned transporter name
transporterCapsJsonAssigned transporter capabilities. See below.
usernamestringUsername to access the fileshare where the backup repository is located
passwordstringPassword to access the fileshare where the backup repository is located
storageSizelongAWS-specific: the size of allocated storage
chunkSizelongAWS-specific: the size of the download chunk
autoSizebooleanAWS-specific: true if the storage size is automatically adjusted
volumeTypestringAWS-specific: the type of the storage volume.
backupCountlongThe total number of backups
hvTypeBackupCountJsonNumber of backups by platform type
hvTypeBackupHasRootDiskCountJsonAWS-specific: backup count which savepoints have a Root volume
compressionstringCompression type
compressionRatiointCompression ratio
deduplicationbooleanChecks if the deduplication is enabled
deduplicationRatiointDeduplication ratio
selfHealbooleanChecks if self-healing of the backup repository is enabled
encryptionbooleanChecks if encryption is enabled for the backup repository
encryptionPasswordstringEncryption password
lockedSharedbooleantrue if multiple read operations cannot run on the same backup repository at the same time
lockedExclusivebooleantrue if multiple updates cannot be made to the repository at the same time
lockReasonsarrayLock reasons
preventModificationboolean
If true, prevents manual modification of the item
wasEditedbooleanChecks if the backup repository was edited
wasDiscoveredOncebooleanChecks if the backup repository was discovered once
importIsPendingbooleantrue if changeStatus is IMPORT_PENDING
createIsPendingbooleantrue if changeStatus is CREATE_PENDING or RECREATE_PENDING
useSelfHealSchedulebooleanChecks if the self-healing schedule is enabled
selfHealScheduleJsonSelf-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"
selfHealOverrideJobsbooleantrue if the self-healing can override current jobs
useVerificationSchedulebooleanChecks if the verification schedule is enabled
verificationScheduleJsonVerification schedule. See selfHealSchedule above for an example of schedule data
verificationOverrideJobsbooleantrue if the verification can override current jobs
useConsolidationSchedulebooleanChecks if the space reclaim schedule is enabled
consolidationScheduleJsonSpace reclaim schedule. See selfHealSchedule above for an example of schedule data
consolidationOverrideJobsbooleantrue if the space reclaim can override current jobs
useDetachSchedulebooleanChecks if the detaching schedule is enabled
detachScheduleJsonDetaching schedule. See selfHealSchedule above for an example of schedule data
attachScheduleJsonAttaching schedule. See selfHealSchedule above for an example of schedule data
deleteAndRecreateOnAttachboolean
true if the backup repository should be recreated during scheduled detach-attach process
progressintThe progress of the current operation
operationStartstringThe timestamp of the beginning of the current operation
operationStartRelativelongRelative timestamp (e.g. time since start) of the beginning of the current operation
alertErrorCodelongThe error code of the alert (if any)

alertTitle

stringThe title of the alert (if any)
alertDescriptionstringThe description of the alert (if any)
transporterCaps

Transporter capabilities

Field
Value
Description

WINDOWS_GUESTS_RECOVERY_SUPPORT

boolean

Checks if the transporter supports Windows guest OS recovery

CIFS_SHARE_SUPPORT

boolean

Checks if the transporter supports CIFS shares

LINUX_GUESTS_RECOVERY_SUPPORT

boolean

Checks if the transporter supports Linux guest OS recovery

VMWARE_VSPHERE_SUPPORT

boolean

Checks if the transporter supports VMware vSphere

NUTANIX_SUPPORT

boolean

Checks if the transporter supports Nutanix AHV

REPOSITORY_MANAGEMENT_SUPPORT

boolean

Checks if the transporter supports backup repository management

AWS_EC2_SUPPORT

boolean

Checks if the transporter supports AWS EC2 instances

FLASH_VM_BOOT_SUPPORT

boolean

Checks if the transporter supports Flash VM boot

NFS_SHARE_SUPPORT

boolean

Checks if the transporter supports  shares

MS_HYPERV_SUPPORT

boolean

Checks if the transporter supports Microsoft Hyper-V

REPOSITORY_ENCRYPTION_SUPPORT

boolean

Checks if the transporter supports backup repository encryption

VMWARE_VSPHERE_PRE55_SUPPORT

boolean

Checks if the transporter supports VMware vSphere versions earlier than 5.5


  • No labels