Get Backup Repository Info

Gets backup repository info.

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

Request Fields

Field
Type
Value(s)
action string

BackupManagement 

method string

getBackupRepository

data array of int Backup repository
type string rpc
tid integer 1

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 array Backup repository info. See below

Data

Field
Value
Description
id int 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
changeStatus string

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

type string Backup repository type
name string Display name
description string Description (if present)
size long Total size of the 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 Path to the backup repository
transporterId int 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 int AWS-specific: the size of allocated storage
chunkSize int 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 storage volume
backupCount int 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 the 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 backup 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 Checked if the backup repository was discovered once
wasImported boolean Checks if the backup repository was imported
wasCreated boolean true if changeStatus is CREATE_PENDING
useSelfHealSchedule boolean Checks if the self-healing schedule is enabled
selfHealSchedule Json Self-healing schedule. See below
selfHealOverrideJobs boolean true if the self-healing can override current jobs
useVerficationSchedule boolean Checks if the verification schedule is enabled
verificationSchedule Json Verification schedule. See below
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 below
consolidationOverrideJobs boolean true if the space reclaim can override current jobs
useDetachSchedule boolean Checks if the self-healing schedule is enabled
detachSchedule Json Detach schedule. See below
attachSchedule Json Attach schedule. See below
deleteAndRecreateOnAttach boolean
true if the backup repository should be recreated during the scheduled detach-attach process
progress int The progress of the current operation
operationStart string The timestamp of the beginning of the current operation
operationStartRelative int Relative timestamp (e.g. time since start) of the beginning of the current operation
alertErrorCode int The error code of the alert (if any)

alertTitle

string The title of the alert (if any)
alertDescription string The description of the alert (if any)
transporterCaps

Transporter capabilities

Field Value Description
windowsGuestsRecoverySupport boolean Checks if the Transporter supports Windows guest OS recovery
cifsShareSupport boolean Checks if the Transporter supports CIFS shares
linuxGuestsRecoverySupport boolean Checks if the Transporter supports Linux guest OS recovery
vmwarevSphereSupport boolean Checks if the Transporter supports VMware vSphere
nutanixSupport boolean Checks if the Transporter supports Nutanix AHV
repositoryManagementSupport boolean Checks if the Transporter supports backup repository management
awsEc2Support boolean Checks if the Transporter supports AWS EC2 instances
flashVmBootSupport boolean Checks if the Transporter supports Flash VM boot
nfsShareSupport boolean Checks if the Transporter supports CIFS shares
msHypervSupport boolean Checks if the Transporter supports Microsoft Hyper-V
repositoryEncryptionSupport boolean Checks if the Transporter supports encryption of backup repository

Schedules

Applicable for selfHealSchedule, verificationSchedule, consolidationSchedule, detachSchedule, attachSchedule.

Field
Type
Description
Possible values or format
enabled boolean If a schedule enabled, then truefalse otherwise.

type

string The type of backup schedule.

DAILY

MONTHLY_YEARLY

PERIODICALLY

TRIGGER

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 type is PERIODICALLY or TRIGGER, defines the delay unit between jobs.

For example, "Run job every 30 minutes"

DAY (for PERIODICALLYonly)

MINUTE

HOUR

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

FIRST

SECOND

THIRD

FOURTH

LAST

DAY

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

IMMEDIATELY

DELAYED

triggerEvents array Trigger job conditions

RUN_SUCCESS

RUN_FAILURE

RUN_STOP

nextRun string Time and date of the next job run YYYY-MM-DDTHH:MM:SS.SSSZ