Page tree

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

curl
curl --request POST \
	--url https://<Director_IP_address>:4443/c/router \
	--header "content-type: application/json" \
	--cookie @cookies.txt \
	--data "{
		"action": "BackupManagement",
		"method": "getBackupRepository",
		"data": [3],
		"type": "rpc",
		"tid": 1}"

Request Fields

Field
Type
Value(s)
actionstring

BackupManagement 

methodstring

getBackupRepository

dataarray of intBackup repository
typestringrpc
tidinteger1

Response Sample

 {
  "action": "BackupManagement",
  "method": "getBackupRepository",
  "tid": "1",
  "type": "rpc",
  "message": null,
  "where": null,
  "cause": null,
  "data": {
    "id": 3,
    "state": "OK",
    "status": "NONE",
    "changeStatus": "NONE",
    "type": "SHARE",
    "name": "Repo",
    "description": "",
    "size": 8999835533312,
    "free": 2891538235392,
    "allocated": 331554388515,
    "consumed": 321726173238,
    "attached": true,
    "consistent": true,
    "path": "\\\\server\\sharename",
    "transporterId": 1,
    "transporterName": "Onboard transporter",
    "transporterCaps": {
            "VMWARE_VSPHERE_PRE55_SUPPORT": true,
            "NUTANIX_SUPPORT": true,
            "AWS_EC2_SUPPORT": true,
            "REPOSITORY_ENCRYPTION_SUPPORT": false,
            "CIFS_SHARE_SUPPORT": true,
            "LINUX_GUESTS_RECOVERY_SUPPORT": false,
            "MS_HYPERV_SUPPORT": true,
            "FLASH_VM_BOOT_SUPPORT": true,
            "WINDOWS_GUESTS_RECOVERY_SUPPORT": true,
            "NFS_SHARE_SUPPORT": false,
            "VMWARE_VSPHERE_SUPPORT": true,
            "REPOSITORY_MANAGEMENT_SUPPORT": true
    },
    "username": "DOMAIN\\user",
    "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
  }
}

Response Fields

Field
Value
Description
messagestringMessage if the request failed
wherestringReference to the method where a problem occurred
causestringCause of failure
dataarrayBackup repository info. See below

Data

Field
Value
Description
idintBackup repository ID
statestringBackup repository state
statusstringThe status of the current operation on the backup repository. NONE if no operations are currently running
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
namestringDisplay name
descriptionstringDescription (if present)
sizelongTotal size of the 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
pathstringPath to the backup repository
transporterIdintAssigned 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
storageSizeintAWS-specific: the size of allocated storage
chunkSizeintAWS-specific: the size of the download chunk
autoSizebooleanAWS-specific: true if the storage size is automatically adjusted
volumeTypestringAWS-specific: the type of storage volume
backupCountintThe 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 the 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 backup repository at the same time
lockReasonsarrayLock reasons
preventModificationboolean
If true, prevents manual modification of the item.
wasEditedbooleanChecks if the backup repository was edited
wasDiscoveredOncebooleanChecked if the backup repository was discovered once
wasImportedbooleanChecks if the backup repository was imported
wasCreatedbooleantrue if changeStatus is CREATE_PENDING
useSelfHealSchedulebooleanChecks if the self-healing schedule is enabled
selfHealScheduleJsonSelf-healing schedule. See below
selfHealOverrideJobsbooleantrue if the self-healing can override current jobs
useVerficationSchedulebooleanChecks if the verification schedule is enabled
verificationScheduleJsonVerification schedule. See below
verificationOverrideJobsbooleantrue if the verification can override current jobs
useConsolidationSchedulebooleanChecks if the space reclaim schedule is enabled
consolidationScheduleJsonSpace reclaim schedule. See below
consolidationOverrideJobsbooleantrue if the space reclaim can override current jobs
useDetachSchedulebooleanChecks if the self-healing schedule is enabled
detachScheduleJsonDetach schedule. See below
attachScheduleJsonAttach schedule. See below
deleteAndRecreateOnAttachboolean
true if the backup repository should be recreated during the scheduled detach-attach process
progressintThe progress of the current operation
operationStartstringThe timestamp of the beginning of the current operation
operationStartRelativeintRelative timestamp (e.g. time since start) of the beginning of the current operation
alertErrorCodeintThe 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

FieldValueDescription
windowsGuestsRecoverySupportbooleanChecks if the Transporter supports Windows guest OS recovery
cifsShareSupportbooleanChecks if the Transporter supports CIFS shares
linuxGuestsRecoverySupportbooleanChecks if the Transporter supports Linux guest OS recovery
vmwarevSphereSupportbooleanChecks if the Transporter supports VMware vSphere
nutanixSupportbooleanChecks if the Transporter supports Nutanix AHV
repositoryManagementSupportbooleanChecks if the Transporter supports backup repository management
awsEc2SupportbooleanChecks if the Transporter supports AWS EC2 instances
flashVmBootSupportbooleanChecks if the Transporter supports Flash VM boot
nfsShareSupportbooleanChecks if the Transporter supports CIFS shares
msHypervSupportbooleanChecks if the Transporter supports Microsoft Hyper-V
repositoryEncryptionSupportbooleanChecks if the Transporter supports encryption of backup repository
Schedules

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

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

type

stringThe type of backup schedule.

DAILY

MONTHLY_YEARLY

PERIODICALLY

TRIGGER

startTimestringStart time.hh:mm:ss AM/PM
endTimestringEnd time. null if not set
timezonestringTime zone
onintA 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
everyTypestring

If type is PERIODICALLY or TRIGGER, defines the delay unit between jobs.

For example, "Run job every 30 minutes"

DAY (for PERIODICALLYonly)

MINUTE

HOUR

everyint

The number of delay units between job runs.

For example, "Run job every 30 minutes"


monthlyEveryTypestringIf type is MONTHLY_YEARLY , selects the number of weekday in a month or a day number

FIRST

SECOND

THIRD

FOURTH

LAST

DAY

dayOfMonthintIf monthlyEveryType is DAY, selects the day number in a month
dayOfWeekintIf monthlyEveryType is either from LAST, selects the number of a weekday
monthintif type is MONTHLY_YEARLY, the number of the month when a job must be run
triggerItemstringVID of the job that triggers current.
triggerRunTypestringSelects 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

triggerEventsarrayTrigger job conditions

RUN_SUCCESS

RUN_FAILURE

RUN_STOP

nextRunstringTime and date of the next job runYYYY-MM-DDTHH:MM:SS.SSSZ




  • No labels