Storage Controller Resource

The API allows you to list, view and edit storage.

GET /storages

Returns list of storage filtered by specified query parameters.

Request Parameters
name type description constraints multivalued
backupStatus query "IS_PROTECTED" or "NOT_PROTECTED" or "NO_SCHEDULE" yes
direction query   no
filter query   no
nameLike query   no
nodeConfig query   no
orderBy query   no
page query   no
size query   no
snapshot-mgmt-policy query   no
storage-policy query   yes
storage-pool query   no
storage-provider query   no
storage-provider-type query "AFS" or "CEPH_RBD" or "DEFAULT" or "FILE_SYSTEM" or "NUTANIX_VG" yes
uuid query   no
Response Body
media type data type description
application/json array of StorageListRecord (JSON) list of storage filtered by specified query parameters

Example

Request
GET /storages
Content-Type: */*
Accept: application/json

                
...
                
              
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
[ {
  "name" : "...",
  "type" : "CLOUD",
  "uuid" : "...",
  "backupUpToDate" : true,
  "size" : 12345,
  "snapshotable" : true,
  "restorable" : true,
  "storageBackupPolicy" : {
    "rules" : [ {
      "guid" : "...",
      "name" : "...",
      "policy" : { },
      "schedules" : [ { }, { } ],
      "vmCount" : 12345,
      "schedulesCount" : 12345,
      "position" : 12345,
      "active" : true,
      "removable" : true,
      "daysToKeepRetentionLock" : 12345
    }, {
      "guid" : "...",
      "name" : "...",
      "policy" : { },
      "schedules" : [ { }, { } ],
      "vmCount" : 12345,
      "schedulesCount" : 12345,
      "position" : 12345,
      "active" : true,
      "removable" : true,
      "daysToKeepRetentionLock" : 12345
    } ],
    "name" : "...",
    "active" : true,
    "autoAssignSettings" : {
      "mode" : "ASSIGN_AND_REMOVE",
      "includeRegExps" : [ "...", "..." ],
      "excludeRegExps" : [ "...", "..." ],
      "storagePools" : [ { }, { } ]
    },
    "backupRetryCount" : 12345,
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "autoRemoveNonPresent" : true,
    "storages" : [ {
      "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
      "name" : "Entity name"
    }, {
      "guid" : "...",
      "name" : "..."
    } ],
    "averageBackupSize" : 12345,
    "priority" : 50,
    "failRemainingBackupTasksExportThreshold" : 12345.0,
    "failRemainingBackupTasksStoreThreshold" : 12345.0,
    "dailyReportEnabled" : true,
    "mailingList" : {
      "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
      "name" : "Entity name"
    },
    "disableCleanOldBackups" : true
  },
  "lastSuccessfulBackupSize" : 12345,
  "lastSuccessfulFullBackupSize" : 12345,
  "storageProvider" : {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  },
  "warningsPresent" : true,
  "storagePool" : {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  },
  "lastSuccessfulFullBackup" : {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  },
  "storageProviderType" : "CEPH_RBD",
  "lastSuccessfulIncBackup" : {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  },
  "present" : true,
  "path" : "...",
  "averageProgress" : 12345.0,
  "restoreStatus" : "...",
  "lastChainMarkedForDeletion" : true,
  "possibleActions" : [ "READ", "HVM_READ" ],
  "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
  "description" : "...",
  "rule" : {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  },
  "nodeConfig" : {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  },
  "lastBackup" : 1451649601000
} ]
                
              

POST /storages

Create a storage.

Request Body
media type data type description
application/json StorageRequest (JSON) specify details for new storage
Response Body
media type data type description
application/json StorageDetails (JSON) details of newly created storage

Example

Request
POST /storages
Content-Type: application/json
Accept: application/json

                
{
  "name" : "...",
  "uuid" : "...",
  "size" : 12345,
  "isSnapshotable" : true,
  "present" : true,
  "storageBackupPolicy" : {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  },
  "snapshotMgmtPolicy" : {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  },
  "storageProvider" : {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  },
  "storagePool" : {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  },
  "path" : "...",
  "description" : "..."
}
                
              
Response
HTTP/1.1 201 Created
Content-Type: application/json

                
{
  "sshHost" : "...",
  "sshPort" : 12345,
  "credential" : {
    "guid" : "...",
    "name" : "...",
    "user" : "...",
    "secretKey" : "...",
    "sshKey" : "...",
    "sshKeyPath" : "...",
    "powerShellTransportType" : "CREDSSP"
  },
  "sshKeyPath" : "...",
  "backupCount" : 12345,
  "rules" : [ {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  }, {
    "guid" : "...",
    "name" : "..."
  } ],
  "name" : "...",
  "type" : "CLOUD_USER",
  "backupUpToDate" : true,
  "restorable" : true,
  "lastSuccessfulBackupSize" : 12345,
  "lastSuccessfulFullBackupSize" : 12345,
  "warningsPresent" : true,
  "lastSuccessfulFullBackup" : {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  },
  "uuid" : "...",
  "size" : 12345,
  "lastSuccessfulIncBackup" : {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  },
  "snapshotable" : true,
  "storageProvider" : {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  },
  "averageProgress" : 12345.0,
  "lastChainMarkedForDeletion" : true,
  "storageBackupPolicy" : {
    "rules" : [ {
      "guid" : "...",
      "name" : "...",
      "policy" : { },
      "schedules" : [ { }, { } ],
      "vmCount" : 12345,
      "schedulesCount" : 12345,
      "position" : 12345,
      "active" : true,
      "removable" : true,
      "daysToKeepRetentionLock" : 12345
    }, {
      "guid" : "...",
      "name" : "...",
      "policy" : { },
      "schedules" : [ { }, { } ],
      "vmCount" : 12345,
      "schedulesCount" : 12345,
      "position" : 12345,
      "active" : true,
      "removable" : true,
      "daysToKeepRetentionLock" : 12345
    } ],
    "name" : "...",
    "active" : true,
    "autoAssignSettings" : {
      "mode" : "ASSIGN_AND_REMOVE",
      "includeRegExps" : [ "...", "..." ],
      "excludeRegExps" : [ "...", "..." ],
      "storagePools" : [ { }, { } ]
    },
    "backupRetryCount" : 12345,
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "autoRemoveNonPresent" : true,
    "storages" : [ {
      "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
      "name" : "Entity name"
    }, {
      "guid" : "...",
      "name" : "..."
    } ],
    "averageBackupSize" : 12345,
    "priority" : 50,
    "failRemainingBackupTasksExportThreshold" : 12345.0,
    "failRemainingBackupTasksStoreThreshold" : 12345.0,
    "dailyReportEnabled" : true,
    "mailingList" : {
      "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
      "name" : "Entity name"
    },
    "disableCleanOldBackups" : true
  },
  "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
  "snapshotMgmtPolicy" : {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  },
  "storagePool" : {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  },
  "storageProviderType" : "DEFAULT",
  "lastBackup" : 1451649601000,
  "present" : true,
  "path" : "...",
  "description" : "...",
  "possibleActions" : [ "HVM_READ", "INVENTORY_SYNC" ],
  "lastStoredSnapshotAssignments" : [ {
    "protectedEntitySnapshot" : {
      "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
      "name" : "Entity name"
    },
    "storage" : {
      "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
      "name" : "Entity name"
    },
    "backupRule" : {
      "guid" : "...",
      "name" : "...",
      "policy" : { },
      "schedules" : [ { }, { } ],
      "vmCount" : 12345,
      "schedulesCount" : 12345,
      "position" : 12345,
      "active" : true,
      "ruleBackupDestinations" : [ { }, { } ],
      "removable" : true,
      "daysToKeepRetentionLock" : 12345,
      "backupCount" : 12345,
      "markedForDeletion" : true
    }
  }, {
    "protectedEntitySnapshot" : {
      "guid" : "...",
      "name" : "..."
    },
    "storage" : {
      "guid" : "...",
      "name" : "..."
    },
    "backupRule" : {
      "guid" : "...",
      "name" : "...",
      "policy" : { },
      "schedules" : [ { }, { } ],
      "vmCount" : 12345,
      "schedulesCount" : 12345,
      "position" : 12345,
      "active" : true,
      "ruleBackupDestinations" : [ { }, { } ],
      "removable" : true,
      "daysToKeepRetentionLock" : 12345,
      "backupCount" : 12345,
      "markedForDeletion" : true
    }
  } ],
  "preCommand" : {
    "commandArgs" : [ "...", "..." ],
    "commandType" : "SSH",
    "executionStage" : "POST"
  },
  "postCommand" : {
    "commandArgs" : [ "...", "..." ],
    "commandType" : "SSH",
    "executionStage" : "PRE"
  },
  "preSnapCmdExecEnabled" : true,
  "postSnapCmdExecEnabled" : true,
  "preSnapIgnoredExitCodes" : "...",
  "postSnapIgnoredExitCodes" : "...",
  "preSnapStdErrorHandling" : "IGNORE_WITH_WARNING",
  "postSnapStdErrorHandling" : "IGNORE_WITH_WARNING",
  "preSnapCmdExecTimeout" : 12345,
  "postSnapCmdExecTimeout" : 12345,
  "nodeConfig" : {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  }
}
                
              

DELETE /storages/all-non-present

Remove all virtual machines that are not present and without any backup.

Example

Request
DELETE /storages/all-non-present
Content-Type: */*

                
...
                
              
Response
HTTP/1.1 204 No Content

              

POST /storages/assign-backup-policy

Assign storages to specified policy (or unassign if policy is null)

Request Body
media type data type description
application/json ProtectedEntityBackupPolicyAssignmentRequest (JSON) containing policy and storages info
Response Body
media type data type description
application/json array of StorageDetails (JSON) list of updated storages

Example

Request
POST /storages/assign-backup-policy
Content-Type: application/json
Accept: application/json

                
{
  "backupPolicy" : "...",
  "protectedEntities" : [ {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  }, {
    "guid" : "...",
    "name" : "..."
  } ]
}
                
              
Response
HTTP/1.1 201 Created
Content-Type: application/json

                
[ {
  "sshHost" : "...",
  "sshPort" : 12345,
  "credential" : {
    "guid" : "...",
    "name" : "...",
    "user" : "...",
    "secretKey" : "...",
    "sshKey" : "...",
    "sshKeyPath" : "...",
    "powerShellTransportType" : "CERTIFICATE"
  },
  "sshKeyPath" : "...",
  "backupCount" : 12345,
  "rules" : [ {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  }, {
    "guid" : "...",
    "name" : "..."
  } ],
  "name" : "...",
  "type" : "CLOUD_TEAMS",
  "backupUpToDate" : true,
  "restorable" : true,
  "lastSuccessfulBackupSize" : 12345,
  "lastSuccessfulFullBackupSize" : 12345,
  "warningsPresent" : true,
  "lastSuccessfulFullBackup" : {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  },
  "uuid" : "...",
  "size" : 12345,
  "lastSuccessfulIncBackup" : {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  },
  "snapshotable" : true,
  "storageProvider" : {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  },
  "averageProgress" : 12345.0,
  "lastChainMarkedForDeletion" : true,
  "storageBackupPolicy" : {
    "rules" : [ {
      "guid" : "...",
      "name" : "...",
      "policy" : { },
      "schedules" : [ { }, { } ],
      "vmCount" : 12345,
      "schedulesCount" : 12345,
      "position" : 12345,
      "active" : true,
      "removable" : true,
      "daysToKeepRetentionLock" : 12345
    }, {
      "guid" : "...",
      "name" : "...",
      "policy" : { },
      "schedules" : [ { }, { } ],
      "vmCount" : 12345,
      "schedulesCount" : 12345,
      "position" : 12345,
      "active" : true,
      "removable" : true,
      "daysToKeepRetentionLock" : 12345
    } ],
    "name" : "...",
    "active" : true,
    "autoAssignSettings" : {
      "mode" : "ASSIGN_AND_REMOVE",
      "includeRegExps" : [ "...", "..." ],
      "excludeRegExps" : [ "...", "..." ],
      "storagePools" : [ { }, { } ]
    },
    "backupRetryCount" : 12345,
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "autoRemoveNonPresent" : true,
    "storages" : [ {
      "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
      "name" : "Entity name"
    }, {
      "guid" : "...",
      "name" : "..."
    } ],
    "averageBackupSize" : 12345,
    "priority" : 50,
    "failRemainingBackupTasksExportThreshold" : 12345.0,
    "failRemainingBackupTasksStoreThreshold" : 12345.0,
    "dailyReportEnabled" : true,
    "mailingList" : {
      "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
      "name" : "Entity name"
    },
    "disableCleanOldBackups" : true
  },
  "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
  "snapshotMgmtPolicy" : {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  },
  "storagePool" : {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  },
  "storageProviderType" : "FILE_SYSTEM",
  "lastBackup" : 1451649601000,
  "present" : true,
  "path" : "...",
  "description" : "...",
  "possibleActions" : [ "READ", "READ" ],
  "lastStoredSnapshotAssignments" : [ {
    "protectedEntitySnapshot" : {
      "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
      "name" : "Entity name"
    },
    "storage" : {
      "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
      "name" : "Entity name"
    },
    "backupRule" : {
      "guid" : "...",
      "name" : "...",
      "policy" : { },
      "schedules" : [ { }, { } ],
      "vmCount" : 12345,
      "schedulesCount" : 12345,
      "position" : 12345,
      "active" : true,
      "ruleBackupDestinations" : [ { }, { } ],
      "removable" : true,
      "daysToKeepRetentionLock" : 12345,
      "backupCount" : 12345,
      "markedForDeletion" : true
    }
  }, {
    "protectedEntitySnapshot" : {
      "guid" : "...",
      "name" : "..."
    },
    "storage" : {
      "guid" : "...",
      "name" : "..."
    },
    "backupRule" : {
      "guid" : "...",
      "name" : "...",
      "policy" : { },
      "schedules" : [ { }, { } ],
      "vmCount" : 12345,
      "schedulesCount" : 12345,
      "position" : 12345,
      "active" : true,
      "ruleBackupDestinations" : [ { }, { } ],
      "removable" : true,
      "daysToKeepRetentionLock" : 12345,
      "backupCount" : 12345,
      "markedForDeletion" : true
    }
  } ],
  "preCommand" : {
    "commandArgs" : [ "...", "..." ],
    "commandType" : "SSH",
    "executionStage" : "PRE"
  },
  "postCommand" : {
    "commandArgs" : [ "...", "..." ],
    "commandType" : "POWERSHELL",
    "executionStage" : "PRE"
  },
  "preSnapCmdExecEnabled" : true,
  "postSnapCmdExecEnabled" : true,
  "preSnapIgnoredExitCodes" : "...",
  "postSnapIgnoredExitCodes" : "...",
  "preSnapStdErrorHandling" : "IGNORE_WITH_WARNING",
  "postSnapStdErrorHandling" : "IGNORE_WITHOUT_WARNING",
  "preSnapCmdExecTimeout" : 12345,
  "postSnapCmdExecTimeout" : 12345,
  "nodeConfig" : {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  }
} ]
                
              

GET /storages/backup-cleanup

Returns list of protected entities for backup cleanup.

Request Parameters
name type description
backup-destination query
Response Body
media type data type description
application/json array of StorageListRecord (JSON) list of protected entities for backup cleanup

Example

Request
GET /storages/backup-cleanup
Content-Type: */*
Accept: application/json

                
...
                
              
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
[ {
  "name" : "...",
  "type" : "OS",
  "uuid" : "...",
  "backupUpToDate" : true,
  "size" : 12345,
  "snapshotable" : true,
  "restorable" : true,
  "storageBackupPolicy" : {
    "rules" : [ {
      "guid" : "...",
      "name" : "...",
      "policy" : { },
      "schedules" : [ { }, { } ],
      "vmCount" : 12345,
      "schedulesCount" : 12345,
      "position" : 12345,
      "active" : true,
      "removable" : true,
      "daysToKeepRetentionLock" : 12345
    }, {
      "guid" : "...",
      "name" : "...",
      "policy" : { },
      "schedules" : [ { }, { } ],
      "vmCount" : 12345,
      "schedulesCount" : 12345,
      "position" : 12345,
      "active" : true,
      "removable" : true,
      "daysToKeepRetentionLock" : 12345
    } ],
    "name" : "...",
    "active" : true,
    "autoAssignSettings" : {
      "mode" : "DISABLED",
      "includeRegExps" : [ "...", "..." ],
      "excludeRegExps" : [ "...", "..." ],
      "storagePools" : [ { }, { } ]
    },
    "backupRetryCount" : 12345,
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "autoRemoveNonPresent" : true,
    "storages" : [ {
      "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
      "name" : "Entity name"
    }, {
      "guid" : "...",
      "name" : "..."
    } ],
    "averageBackupSize" : 12345,
    "priority" : 50,
    "failRemainingBackupTasksExportThreshold" : 12345.0,
    "failRemainingBackupTasksStoreThreshold" : 12345.0,
    "dailyReportEnabled" : true,
    "mailingList" : {
      "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
      "name" : "Entity name"
    },
    "disableCleanOldBackups" : true
  },
  "lastSuccessfulBackupSize" : 12345,
  "lastSuccessfulFullBackupSize" : 12345,
  "storageProvider" : {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  },
  "warningsPresent" : true,
  "storagePool" : {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  },
  "lastSuccessfulFullBackup" : {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  },
  "storageProviderType" : "NUTANIX_VG",
  "lastSuccessfulIncBackup" : {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  },
  "present" : true,
  "path" : "...",
  "averageProgress" : 12345.0,
  "restoreStatus" : "...",
  "lastChainMarkedForDeletion" : true,
  "possibleActions" : [ "INVENTORY_SYNC", "INVENTORY_SYNC" ],
  "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
  "description" : "...",
  "rule" : {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  },
  "nodeConfig" : {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  },
  "lastBackup" : 1451649601000
} ]
                
              

GET /storages/detailed

Returns detailed list of storage by specified query parameters.

Request Parameters
name type description constraints multivalued
backupStatus query "IS_PROTECTED" or "NOT_PROTECTED" or "NO_SCHEDULE" yes
direction query   no
filter query   no
nameLike query   no
nodeConfig query   no
orderBy query   no
page query   no
size query   no
snapshot-mgmt-policy query   no
storage-policy query   yes
storage-pool query   no
storage-provider query   no
storage-provider-type query "AFS" or "CEPH_RBD" or "DEFAULT" or "FILE_SYSTEM" or "NUTANIX_VG" yes
uuid query   no
Response Body
media type data type description
application/json array of StorageDetails (JSON) detailed list of storage filtered by specified query parameters

Example

Request
GET /storages/detailed
Content-Type: */*
Accept: application/json

                
...
                
              
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
[ {
  "sshHost" : "...",
  "sshPort" : 12345,
  "credential" : {
    "guid" : "...",
    "name" : "...",
    "user" : "...",
    "secretKey" : "...",
    "sshKey" : "...",
    "sshKeyPath" : "...",
    "powerShellTransportType" : "KERBEROS"
  },
  "sshKeyPath" : "...",
  "backupCount" : 12345,
  "rules" : [ {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  }, {
    "guid" : "...",
    "name" : "..."
  } ],
  "name" : "...",
  "type" : "CLOUD_USER",
  "backupUpToDate" : true,
  "restorable" : true,
  "lastSuccessfulBackupSize" : 12345,
  "lastSuccessfulFullBackupSize" : 12345,
  "warningsPresent" : true,
  "lastSuccessfulFullBackup" : {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  },
  "uuid" : "...",
  "size" : 12345,
  "lastSuccessfulIncBackup" : {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  },
  "snapshotable" : true,
  "storageProvider" : {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  },
  "averageProgress" : 12345.0,
  "lastChainMarkedForDeletion" : true,
  "storageBackupPolicy" : {
    "rules" : [ {
      "guid" : "...",
      "name" : "...",
      "policy" : { },
      "schedules" : [ { }, { } ],
      "vmCount" : 12345,
      "schedulesCount" : 12345,
      "position" : 12345,
      "active" : true,
      "removable" : true,
      "daysToKeepRetentionLock" : 12345
    }, {
      "guid" : "...",
      "name" : "...",
      "policy" : { },
      "schedules" : [ { }, { } ],
      "vmCount" : 12345,
      "schedulesCount" : 12345,
      "position" : 12345,
      "active" : true,
      "removable" : true,
      "daysToKeepRetentionLock" : 12345
    } ],
    "name" : "...",
    "active" : true,
    "autoAssignSettings" : {
      "mode" : "ASSIGN_AND_REMOVE",
      "includeRegExps" : [ "...", "..." ],
      "excludeRegExps" : [ "...", "..." ],
      "storagePools" : [ { }, { } ]
    },
    "backupRetryCount" : 12345,
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "autoRemoveNonPresent" : true,
    "storages" : [ {
      "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
      "name" : "Entity name"
    }, {
      "guid" : "...",
      "name" : "..."
    } ],
    "averageBackupSize" : 12345,
    "priority" : 50,
    "failRemainingBackupTasksExportThreshold" : 12345.0,
    "failRemainingBackupTasksStoreThreshold" : 12345.0,
    "dailyReportEnabled" : true,
    "mailingList" : {
      "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
      "name" : "Entity name"
    },
    "disableCleanOldBackups" : true
  },
  "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
  "snapshotMgmtPolicy" : {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  },
  "storagePool" : {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  },
  "storageProviderType" : "DEFAULT",
  "lastBackup" : 1451649601000,
  "present" : true,
  "path" : "...",
  "description" : "...",
  "possibleActions" : [ "HV_READ", "WRITE" ],
  "lastStoredSnapshotAssignments" : [ {
    "protectedEntitySnapshot" : {
      "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
      "name" : "Entity name"
    },
    "storage" : {
      "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
      "name" : "Entity name"
    },
    "backupRule" : {
      "guid" : "...",
      "name" : "...",
      "policy" : { },
      "schedules" : [ { }, { } ],
      "vmCount" : 12345,
      "schedulesCount" : 12345,
      "position" : 12345,
      "active" : true,
      "ruleBackupDestinations" : [ { }, { } ],
      "removable" : true,
      "daysToKeepRetentionLock" : 12345,
      "backupCount" : 12345,
      "markedForDeletion" : true
    }
  }, {
    "protectedEntitySnapshot" : {
      "guid" : "...",
      "name" : "..."
    },
    "storage" : {
      "guid" : "...",
      "name" : "..."
    },
    "backupRule" : {
      "guid" : "...",
      "name" : "...",
      "policy" : { },
      "schedules" : [ { }, { } ],
      "vmCount" : 12345,
      "schedulesCount" : 12345,
      "position" : 12345,
      "active" : true,
      "ruleBackupDestinations" : [ { }, { } ],
      "removable" : true,
      "daysToKeepRetentionLock" : 12345,
      "backupCount" : 12345,
      "markedForDeletion" : true
    }
  } ],
  "preCommand" : {
    "commandArgs" : [ "...", "..." ],
    "commandType" : "SSH",
    "executionStage" : "PRE"
  },
  "postCommand" : {
    "commandArgs" : [ "...", "..." ],
    "commandType" : "POWERSHELL",
    "executionStage" : "PRE"
  },
  "preSnapCmdExecEnabled" : true,
  "postSnapCmdExecEnabled" : true,
  "preSnapIgnoredExitCodes" : "...",
  "postSnapIgnoredExitCodes" : "...",
  "preSnapStdErrorHandling" : "DONT_IGNORE",
  "postSnapStdErrorHandling" : "IGNORE_WITH_WARNING",
  "preSnapCmdExecTimeout" : 12345,
  "postSnapCmdExecTimeout" : 12345,
  "nodeConfig" : {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  }
} ]
                
              

GET /storages/rbac-contexts

Returns list of storage filtered by specified query parameters.

Request Parameters
name type description constraints
app-cmd-exec-config query  
cloud-service-provider query  
cluster query  
data-center query  
direction query  
filter query  
hypervisor query  
hypervisor-manager query  
nameLike query  
orderBy query  
page query  
project query  
size query  
storage-pool query  
storage-provider query  
teams-group query boolean
Response Body
media type data type description
application/json array of RbacContextListRecord (JSON) list of storage filtered by specified query parameters

Example

Request
GET /storages/rbac-contexts
Content-Type: */*
Accept: application/json

                
...
                
              
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
[ {
  "nameAndGuid" : {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  },
  "uuid" : "...",
  "type" : "STORAGE",
  "checked" : true,
  "lastLevel" : true,
  "present" : true,
  "entityType" : "...",
  "childrenQueryType" : "..."
} ]
                
              

DELETE /storages/{guid}

Remove storage.

Request Parameters
name type description
guid path specify local unique identifier for storage (use by vProtect)

Example

Request
DELETE /storages/{guid}
Content-Type: */*

                
...
                
              
Response
HTTP/1.1 204 No Content

              

GET /storages/{guid}

Get a single storage details.

Request Parameters
name type description
guid path specify local unique identifier for storage (use by vProtect)
Response Body
media type data type description
application/json StorageDetails (JSON) a signle storage details

Example

Request
GET /storages/{guid}
Content-Type: */*
Accept: application/json

                
...
                
              
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "sshHost" : "...",
  "sshPort" : 12345,
  "credential" : {
    "guid" : "...",
    "name" : "...",
    "user" : "...",
    "secretKey" : "...",
    "sshKey" : "...",
    "sshKeyPath" : "...",
    "powerShellTransportType" : "CERTIFICATE"
  },
  "sshKeyPath" : "...",
  "backupCount" : 12345,
  "rules" : [ {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  }, {
    "guid" : "...",
    "name" : "..."
  } ],
  "name" : "...",
  "type" : "OS_AGENT",
  "backupUpToDate" : true,
  "restorable" : true,
  "lastSuccessfulBackupSize" : 12345,
  "lastSuccessfulFullBackupSize" : 12345,
  "warningsPresent" : true,
  "lastSuccessfulFullBackup" : {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  },
  "uuid" : "...",
  "size" : 12345,
  "lastSuccessfulIncBackup" : {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  },
  "snapshotable" : true,
  "storageProvider" : {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  },
  "averageProgress" : 12345.0,
  "lastChainMarkedForDeletion" : true,
  "storageBackupPolicy" : {
    "rules" : [ {
      "guid" : "...",
      "name" : "...",
      "policy" : { },
      "schedules" : [ { }, { } ],
      "vmCount" : 12345,
      "schedulesCount" : 12345,
      "position" : 12345,
      "active" : true,
      "removable" : true,
      "daysToKeepRetentionLock" : 12345
    }, {
      "guid" : "...",
      "name" : "...",
      "policy" : { },
      "schedules" : [ { }, { } ],
      "vmCount" : 12345,
      "schedulesCount" : 12345,
      "position" : 12345,
      "active" : true,
      "removable" : true,
      "daysToKeepRetentionLock" : 12345
    } ],
    "name" : "...",
    "active" : true,
    "autoAssignSettings" : {
      "mode" : "DISABLED",
      "includeRegExps" : [ "...", "..." ],
      "excludeRegExps" : [ "...", "..." ],
      "storagePools" : [ { }, { } ]
    },
    "backupRetryCount" : 12345,
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "autoRemoveNonPresent" : true,
    "storages" : [ {
      "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
      "name" : "Entity name"
    }, {
      "guid" : "...",
      "name" : "..."
    } ],
    "averageBackupSize" : 12345,
    "priority" : 50,
    "failRemainingBackupTasksExportThreshold" : 12345.0,
    "failRemainingBackupTasksStoreThreshold" : 12345.0,
    "dailyReportEnabled" : true,
    "mailingList" : {
      "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
      "name" : "Entity name"
    },
    "disableCleanOldBackups" : true
  },
  "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
  "snapshotMgmtPolicy" : {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  },
  "storagePool" : {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  },
  "storageProviderType" : "NUTANIX_VG",
  "lastBackup" : 1451649601000,
  "present" : true,
  "path" : "...",
  "description" : "...",
  "possibleActions" : [ "READ", "INVENTORY_SYNC" ],
  "lastStoredSnapshotAssignments" : [ {
    "protectedEntitySnapshot" : {
      "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
      "name" : "Entity name"
    },
    "storage" : {
      "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
      "name" : "Entity name"
    },
    "backupRule" : {
      "guid" : "...",
      "name" : "...",
      "policy" : { },
      "schedules" : [ { }, { } ],
      "vmCount" : 12345,
      "schedulesCount" : 12345,
      "position" : 12345,
      "active" : true,
      "ruleBackupDestinations" : [ { }, { } ],
      "removable" : true,
      "daysToKeepRetentionLock" : 12345,
      "backupCount" : 12345,
      "markedForDeletion" : true
    }
  }, {
    "protectedEntitySnapshot" : {
      "guid" : "...",
      "name" : "..."
    },
    "storage" : {
      "guid" : "...",
      "name" : "..."
    },
    "backupRule" : {
      "guid" : "...",
      "name" : "...",
      "policy" : { },
      "schedules" : [ { }, { } ],
      "vmCount" : 12345,
      "schedulesCount" : 12345,
      "position" : 12345,
      "active" : true,
      "ruleBackupDestinations" : [ { }, { } ],
      "removable" : true,
      "daysToKeepRetentionLock" : 12345,
      "backupCount" : 12345,
      "markedForDeletion" : true
    }
  } ],
  "preCommand" : {
    "commandArgs" : [ "...", "..." ],
    "commandType" : "SSH",
    "executionStage" : "POST"
  },
  "postCommand" : {
    "commandArgs" : [ "...", "..." ],
    "commandType" : "SSH",
    "executionStage" : "POST"
  },
  "preSnapCmdExecEnabled" : true,
  "postSnapCmdExecEnabled" : true,
  "preSnapIgnoredExitCodes" : "...",
  "postSnapIgnoredExitCodes" : "...",
  "preSnapStdErrorHandling" : "DONT_IGNORE",
  "postSnapStdErrorHandling" : "IGNORE_WITH_WARNING",
  "preSnapCmdExecTimeout" : 12345,
  "postSnapCmdExecTimeout" : 12345,
  "nodeConfig" : {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  }
}
                
              

PUT /storages/{guid}

Change storage details.

Request Parameters
name type description
guid path specify local unique identifier for storage (use by vProtect)
Request Body
media type data type description
application/json StorageUpdateRequest (JSON) specify storage details to update
Response Body
media type data type description
application/json StorageDetails (JSON) updated details of storage

Example

Request
PUT /storages/{guid}
Content-Type: application/json
Accept: application/json

                
{
  "name" : "...",
  "uuid" : "...",
  "storageProvider" : {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  },
  "storagePool" : {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  },
  "protectedEntitySnapshotAssignmentRequest" : {
    "protectedEntitySnapshot" : {
      "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
      "name" : "Entity name"
    },
    "backupRule" : {
      "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
      "name" : "Entity name"
    },
    "valid" : true
  },
  "present" : true,
  "path" : "...",
  "description" : "..."
}
                
              
Response
HTTP/1.1 204 No Content
Content-Type: application/json

                
{
  "sshHost" : "...",
  "sshPort" : 12345,
  "credential" : {
    "guid" : "...",
    "name" : "...",
    "user" : "...",
    "secretKey" : "...",
    "sshKey" : "...",
    "sshKeyPath" : "...",
    "powerShellTransportType" : "NTLM"
  },
  "sshKeyPath" : "...",
  "backupCount" : 12345,
  "rules" : [ {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  }, {
    "guid" : "...",
    "name" : "..."
  } ],
  "name" : "...",
  "type" : "CLOUD_SITE",
  "backupUpToDate" : true,
  "restorable" : true,
  "lastSuccessfulBackupSize" : 12345,
  "lastSuccessfulFullBackupSize" : 12345,
  "warningsPresent" : true,
  "lastSuccessfulFullBackup" : {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  },
  "uuid" : "...",
  "size" : 12345,
  "lastSuccessfulIncBackup" : {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  },
  "snapshotable" : true,
  "storageProvider" : {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  },
  "averageProgress" : 12345.0,
  "lastChainMarkedForDeletion" : true,
  "storageBackupPolicy" : {
    "rules" : [ {
      "guid" : "...",
      "name" : "...",
      "policy" : { },
      "schedules" : [ { }, { } ],
      "vmCount" : 12345,
      "schedulesCount" : 12345,
      "position" : 12345,
      "active" : true,
      "removable" : true,
      "daysToKeepRetentionLock" : 12345
    }, {
      "guid" : "...",
      "name" : "...",
      "policy" : { },
      "schedules" : [ { }, { } ],
      "vmCount" : 12345,
      "schedulesCount" : 12345,
      "position" : 12345,
      "active" : true,
      "removable" : true,
      "daysToKeepRetentionLock" : 12345
    } ],
    "name" : "...",
    "active" : true,
    "autoAssignSettings" : {
      "mode" : "ASSIGN_AND_REMOVE",
      "includeRegExps" : [ "...", "..." ],
      "excludeRegExps" : [ "...", "..." ],
      "storagePools" : [ { }, { } ]
    },
    "backupRetryCount" : 12345,
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "autoRemoveNonPresent" : true,
    "storages" : [ {
      "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
      "name" : "Entity name"
    }, {
      "guid" : "...",
      "name" : "..."
    } ],
    "averageBackupSize" : 12345,
    "priority" : 50,
    "failRemainingBackupTasksExportThreshold" : 12345.0,
    "failRemainingBackupTasksStoreThreshold" : 12345.0,
    "dailyReportEnabled" : true,
    "mailingList" : {
      "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
      "name" : "Entity name"
    },
    "disableCleanOldBackups" : true
  },
  "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
  "snapshotMgmtPolicy" : {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  },
  "storagePool" : {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  },
  "storageProviderType" : "DEFAULT",
  "lastBackup" : 1451649601000,
  "present" : true,
  "path" : "...",
  "description" : "...",
  "possibleActions" : [ "INVENTORY_SYNC", "INVENTORY_SYNC" ],
  "lastStoredSnapshotAssignments" : [ {
    "protectedEntitySnapshot" : {
      "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
      "name" : "Entity name"
    },
    "storage" : {
      "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
      "name" : "Entity name"
    },
    "backupRule" : {
      "guid" : "...",
      "name" : "...",
      "policy" : { },
      "schedules" : [ { }, { } ],
      "vmCount" : 12345,
      "schedulesCount" : 12345,
      "position" : 12345,
      "active" : true,
      "ruleBackupDestinations" : [ { }, { } ],
      "removable" : true,
      "daysToKeepRetentionLock" : 12345,
      "backupCount" : 12345,
      "markedForDeletion" : true
    }
  }, {
    "protectedEntitySnapshot" : {
      "guid" : "...",
      "name" : "..."
    },
    "storage" : {
      "guid" : "...",
      "name" : "..."
    },
    "backupRule" : {
      "guid" : "...",
      "name" : "...",
      "policy" : { },
      "schedules" : [ { }, { } ],
      "vmCount" : 12345,
      "schedulesCount" : 12345,
      "position" : 12345,
      "active" : true,
      "ruleBackupDestinations" : [ { }, { } ],
      "removable" : true,
      "daysToKeepRetentionLock" : 12345,
      "backupCount" : 12345,
      "markedForDeletion" : true
    }
  } ],
  "preCommand" : {
    "commandArgs" : [ "...", "..." ],
    "commandType" : "POWERSHELL",
    "executionStage" : "POST"
  },
  "postCommand" : {
    "commandArgs" : [ "...", "..." ],
    "commandType" : "POWERSHELL",
    "executionStage" : "PRE"
  },
  "preSnapCmdExecEnabled" : true,
  "postSnapCmdExecEnabled" : true,
  "preSnapIgnoredExitCodes" : "...",
  "postSnapIgnoredExitCodes" : "...",
  "preSnapStdErrorHandling" : "IGNORE_WITH_WARNING",
  "postSnapStdErrorHandling" : "IGNORE_WITHOUT_WARNING",
  "preSnapCmdExecTimeout" : 12345,
  "postSnapCmdExecTimeout" : 12345,
  "nodeConfig" : {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  }
}
                
              

PUT /storages/{guid}/settings

Change storage settings.

Request Parameters
name type description
guid path specify local unique identifier for storage (use by vProtect)
Request Body
media type data type description
application/json StorageSettingsUpdateRequest (JSON) specify storage details for update
Response Body
media type data type description
application/json StorageDetails (JSON) updated details for storage

Example

Request
PUT /storages/{guid}/settings
Content-Type: application/json
Accept: application/json

                
{
  "sshHost" : "...",
  "sshPort" : 12345,
  "credential" : {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  },
  "sshKeyPath" : "...",
  "preCommand" : {
    "commandArgs" : [ "...", "..." ],
    "commandType" : "SSH",
    "executionStage" : "POST"
  },
  "postCommand" : {
    "commandArgs" : [ "...", "..." ],
    "commandType" : "POWERSHELL",
    "executionStage" : "POST"
  },
  "preSnapCmdExecEnabled" : true,
  "postSnapCmdExecEnabled" : true,
  "preSnapStdErrorHandling" : "DONT_IGNORE",
  "postSnapStdErrorHandling" : "IGNORE_WITHOUT_WARNING",
  "preSnapCmdExecTimeout" : 12345,
  "postSnapCmdExecTimeout" : 12345,
  "preSnapIgnoredExitCodes" : "...",
  "postSnapIgnoredExitCodes" : "...",
  "storageBackupPolicy" : {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  },
  "snapshotMgmtPolicy" : {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  },
  "description" : "...",
  "path" : "...",
  "name" : "..."
}
                
              
Response
HTTP/1.1 204 No Content
Content-Type: application/json

                
{
  "sshHost" : "...",
  "sshPort" : 12345,
  "credential" : {
    "guid" : "...",
    "name" : "...",
    "user" : "...",
    "secretKey" : "...",
    "sshKey" : "...",
    "sshKeyPath" : "...",
    "powerShellTransportType" : "PLAINTEXT"
  },
  "sshKeyPath" : "...",
  "backupCount" : 12345,
  "rules" : [ {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  }, {
    "guid" : "...",
    "name" : "..."
  } ],
  "name" : "...",
  "type" : "CLOUD_GROUP",
  "backupUpToDate" : true,
  "restorable" : true,
  "lastSuccessfulBackupSize" : 12345,
  "lastSuccessfulFullBackupSize" : 12345,
  "warningsPresent" : true,
  "lastSuccessfulFullBackup" : {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  },
  "uuid" : "...",
  "size" : 12345,
  "lastSuccessfulIncBackup" : {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  },
  "snapshotable" : true,
  "storageProvider" : {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  },
  "averageProgress" : 12345.0,
  "lastChainMarkedForDeletion" : true,
  "storageBackupPolicy" : {
    "rules" : [ {
      "guid" : "...",
      "name" : "...",
      "policy" : { },
      "schedules" : [ { }, { } ],
      "vmCount" : 12345,
      "schedulesCount" : 12345,
      "position" : 12345,
      "active" : true,
      "removable" : true,
      "daysToKeepRetentionLock" : 12345
    }, {
      "guid" : "...",
      "name" : "...",
      "policy" : { },
      "schedules" : [ { }, { } ],
      "vmCount" : 12345,
      "schedulesCount" : 12345,
      "position" : 12345,
      "active" : true,
      "removable" : true,
      "daysToKeepRetentionLock" : 12345
    } ],
    "name" : "...",
    "active" : true,
    "autoAssignSettings" : {
      "mode" : "ASSIGN_ONLY",
      "includeRegExps" : [ "...", "..." ],
      "excludeRegExps" : [ "...", "..." ],
      "storagePools" : [ { }, { } ]
    },
    "backupRetryCount" : 12345,
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "autoRemoveNonPresent" : true,
    "storages" : [ {
      "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
      "name" : "Entity name"
    }, {
      "guid" : "...",
      "name" : "..."
    } ],
    "averageBackupSize" : 12345,
    "priority" : 50,
    "failRemainingBackupTasksExportThreshold" : 12345.0,
    "failRemainingBackupTasksStoreThreshold" : 12345.0,
    "dailyReportEnabled" : true,
    "mailingList" : {
      "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
      "name" : "Entity name"
    },
    "disableCleanOldBackups" : true
  },
  "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
  "snapshotMgmtPolicy" : {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  },
  "storagePool" : {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  },
  "storageProviderType" : "AFS",
  "lastBackup" : 1451649601000,
  "present" : true,
  "path" : "...",
  "description" : "...",
  "possibleActions" : [ "HVM_READ", "HV_READ" ],
  "lastStoredSnapshotAssignments" : [ {
    "protectedEntitySnapshot" : {
      "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
      "name" : "Entity name"
    },
    "storage" : {
      "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
      "name" : "Entity name"
    },
    "backupRule" : {
      "guid" : "...",
      "name" : "...",
      "policy" : { },
      "schedules" : [ { }, { } ],
      "vmCount" : 12345,
      "schedulesCount" : 12345,
      "position" : 12345,
      "active" : true,
      "ruleBackupDestinations" : [ { }, { } ],
      "removable" : true,
      "daysToKeepRetentionLock" : 12345,
      "backupCount" : 12345,
      "markedForDeletion" : true
    }
  }, {
    "protectedEntitySnapshot" : {
      "guid" : "...",
      "name" : "..."
    },
    "storage" : {
      "guid" : "...",
      "name" : "..."
    },
    "backupRule" : {
      "guid" : "...",
      "name" : "...",
      "policy" : { },
      "schedules" : [ { }, { } ],
      "vmCount" : 12345,
      "schedulesCount" : 12345,
      "position" : 12345,
      "active" : true,
      "ruleBackupDestinations" : [ { }, { } ],
      "removable" : true,
      "daysToKeepRetentionLock" : 12345,
      "backupCount" : 12345,
      "markedForDeletion" : true
    }
  } ],
  "preCommand" : {
    "commandArgs" : [ "...", "..." ],
    "commandType" : "SSH",
    "executionStage" : "PRE"
  },
  "postCommand" : {
    "commandArgs" : [ "...", "..." ],
    "commandType" : "SSH",
    "executionStage" : "PRE"
  },
  "preSnapCmdExecEnabled" : true,
  "postSnapCmdExecEnabled" : true,
  "preSnapIgnoredExitCodes" : "...",
  "postSnapIgnoredExitCodes" : "...",
  "preSnapStdErrorHandling" : "IGNORE_WITH_WARNING",
  "postSnapStdErrorHandling" : "IGNORE_WITH_WARNING",
  "preSnapCmdExecTimeout" : 12345,
  "postSnapCmdExecTimeout" : 12345,
  "nodeConfig" : {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  }
}