The API allows you to list, view, edit and create hypervisor managers.
Returns list of hypervisor managers filtered by specified query parameters.
name | type | description | constraints |
---|---|---|---|
backup-to-be-restored | query | ||
direction | query | ||
filter | query | ||
nameLike | query | ||
orderBy | query | ||
page | query | ||
size | query | ||
snapshotable | query | boolean | |
type | query | "AWS" or "AZURE" or "FUSIONCOMPUTE" or "GCP" or "HC3" or "HYPERV" or "KUBERNETES" or "NUTANIX" or "OPENNEBULA" or "OPENSHIFT" or "OPENSTACK" or "ORACLE" or "RHEV" or "RHV" or "VCENTER" or "VIRTUOZZO" |
media type | data type | description |
---|---|---|
application/json | array of HypervisorManagerListRecord (JSON) | list of hypervisor managers filtered by specified query parameters |
GET /hypervisor-managers
Content-Type: */*
Accept: application/json
...
HTTP/1.1 200 OK
Content-Type: application/json
[ {
"url" : "...",
"sshPort" : 12345,
"user" : "...",
"nodeConfig" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"hvCount" : 12345,
"vmCount" : 12345,
"storageType" : "CEPH",
"region" : "...",
"endpointInterfaceType" : "PUBLIC",
"useToken" : true,
"lastInventorySyncDate" : 12345,
"lastSuccessfulInventorySyncDate" : 12345,
"possibleActions" : [ "READ", "HV_READ" ],
"version" : "...",
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"type" : {
"name" : "ENUM_NAME",
"description" : "Enum description"
}
} ]
Create hypervisor manager.
media type | data type | description |
---|---|---|
application/json | HypervisorManagerRequest (JSON) | specify details for new hypervisor manager |
media type | data type | description |
---|---|---|
application/json | HypervisorManagerDetails (JSON) | details of newly created hypervisor manager |
POST /hypervisor-managers
Content-Type: application/json
Accept: application/json
{
"password" : "...",
"secretKey" : "...",
"authenticationDomains" : [ {
"name" : "...",
"password" : "...",
"domainId" : "...",
"user" : "...",
"defaultProjectName" : "...",
"usedForAuthentication" : true
}, {
"name" : "...",
"password" : "...",
"domainId" : "...",
"user" : "...",
"defaultProjectName" : "...",
"usedForAuthentication" : true
} ],
"type" : {
"name" : "ENUM_NAME",
"description" : "Enum description"
},
"url" : "...",
"sshPort" : 12345,
"nodeConfig" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"user" : "...",
"accessKey" : "...",
"sshKeyPath" : "...",
"vmExportImportMode" : "DISK_IMAGE_TRANSFER",
"baseImageCreationConfig" : {
"windowsImageRequired" : "TRUE",
"linuxImageRequired" : "INHERIT"
},
"account" : "...",
"vmwareSettings" : {
"vmwareTagCategory" : "..."
},
"rhvSettings" : {
"rhvSnapshotCloneTimeout" : 12345,
"rhvSnapshotCreationTimeout" : 12345,
"rhvVmExportTimeout" : 12345,
"rhvDiskUnlockTimeout" : 12345,
"rhvMultiDatacenterExport" : true,
"rhvSnapshotRemovalTimeout" : 12345,
"rhvDcToSdMappings" : [ {
"dataCenter" : "...",
"storageDomain" : "..."
}, {
"dataCenter" : "...",
"storageDomain" : "..."
} ]
},
"awsSettings" : {
"awsSnapshotCreationTimeout" : 12345,
"awsImageCreationTimeout" : 12345,
"awsVolumeActionsTimeout" : 12345,
"awsInstanceCreationTimeout" : 12345
},
"ovmSettings" : {
"ovmJobStatusPollingInterval" : 12345,
"ovmPoolToRepoMappings" : [ {
"pool" : "...",
"repositoryId" : "..."
}, {
"pool" : "...",
"repositoryId" : "..."
} ],
"ovmExportCloneTypeOverride" : "THIN_CLONE"
},
"openStackSettings" : {
"openstackDownloadImageFromGlance" : true,
"openstackScopeVmsToDomain" : true
},
"nutanixSettings" : {
"nutanixSnapshotRemovalTimeout" : 12345,
"maxNutanixSnapshotCreatingTimeout" : 12345,
"nutanixDiskOperationTimeout" : 12345
},
"oadpSettings" : {
"oadpProjectName" : "...",
"oadpStorageClassName" : "..."
},
"hvmHypervSettings" : {
"hypervExportChunksNumber" : 12345,
"hypevisorManagerHypervType" : "..."
},
"hvmAzureSettings" : {
"azureClientId" : "...",
"azureClientSecret" : "...",
"azureSubscriptionId" : "...",
"azureTenantId" : "..."
},
"gcpSettings" : {
"gcpOrganizationId" : "..."
},
"projects" : [ {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
}, {
"guid" : "...",
"name" : "..."
} ],
"useNetcat" : true,
"storageType" : "DEFAULT",
"endpointInterfaceType" : "INTERNAL",
"region" : "...",
"useToken" : true,
"trustAllCerts" : true,
"updateTrustAllCertsForManagedHypervisors" : true
}
HTTP/1.1 201 Created
Content-Type: application/json
{
"url" : "...",
"sshPort" : 12345,
"nodeConfig" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"user" : "...",
"sshKeyPath" : "...",
"hvCount" : 12345,
"vmCount" : 12345,
"vmExportImportMode" : "DISK_ATTACHMENT_CHANGED_BLOCK_TRACKING",
"baseImageCreationConfig" : {
"windowsImageRequired" : "TRUE",
"linuxImageRequired" : "TRUE"
},
"account" : "...",
"useNetcat" : true,
"storageType" : "DEFAULT",
"region" : "...",
"endpointInterfaceType" : "INTERNAL",
"ovmSettings" : {
"ovmJobStatusPollingInterval" : 12345,
"ovmPoolToRepoMappings" : [ {
"pool" : "...",
"repositoryId" : "..."
}, {
"pool" : "...",
"repositoryId" : "..."
} ],
"ovmExportCloneTypeOverride" : "THIN_CLONE"
},
"rhvSettings" : {
"rhvSnapshotCloneTimeout" : 12345,
"rhvSnapshotCreationTimeout" : 12345,
"rhvVmExportTimeout" : 12345,
"rhvDiskUnlockTimeout" : 12345,
"rhvMultiDatacenterExport" : true,
"rhvSnapshotRemovalTimeout" : 12345,
"rhvDcToSdMappings" : [ {
"dataCenter" : "...",
"storageDomain" : "..."
}, {
"dataCenter" : "...",
"storageDomain" : "..."
} ]
},
"awsSettings" : {
"awsSnapshotCreationTimeout" : 12345,
"awsImageCreationTimeout" : 12345,
"awsVolumeActionsTimeout" : 12345,
"awsInstanceCreationTimeout" : 12345
},
"vmwareSettings" : {
"vmwareTagCategory" : "..."
},
"openStackSettings" : {
"openstackDownloadImageFromGlance" : true,
"openstackScopeVmsToDomain" : true
},
"nutanixSettings" : {
"nutanixSnapshotRemovalTimeout" : 12345,
"maxNutanixSnapshotCreatingTimeout" : 12345,
"nutanixDiskOperationTimeout" : 12345
},
"oadpSettings" : {
"oadpProjectName" : "...",
"oadpStorageClassName" : "..."
},
"hvmHypervSettings" : {
"hypervExportChunksNumber" : 12345,
"hypevisorManagerHypervType" : "..."
},
"hvmAzureSettings" : {
"azureClientId" : "...",
"azureClientSecret" : "...",
"azureSubscriptionId" : "...",
"azureTenantId" : "..."
},
"gcpSettings" : {
"gcpOrganizationId" : "..."
},
"useToken" : true,
"lastInventorySyncDate" : 12345,
"lastSuccessfulInventorySyncDate" : 12345,
"possibleActions" : [ "WRITE", "WRITE" ],
"version" : "...",
"trustAllCerts" : true,
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"type" : {
"name" : "ENUM_NAME",
"description" : "Enum description"
}
}
Change node for specified list of hypervisor managers.
media type | data type | description |
---|---|---|
application/json | HypervisorManagerBatchUpdate (JSON) | specify node and guids of hypervisor managers |
media type | data type | description |
---|---|---|
application/json | BatchResponse (JSON) | list of successful and unsuccessful updates of node |
PUT /hypervisor-managers
Content-Type: application/json
Accept: application/json
{
"hvManagers" : [ {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
}, {
"guid" : "...",
"name" : "..."
} ],
"nodeConfig" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
}
}
HTTP/1.1 204 No Content
Content-Type: application/json
{
"successful" : [ {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
}, {
"guid" : "...",
"name" : "..."
} ],
"unsuccessful" : [ {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
}, {
"guid" : "...",
"name" : "..."
} ]
}
Returns detailed list of hypervisor managers.
media type | data type | description |
---|---|---|
application/json | array of HypervisorManagerDetails (JSON) | detailed list of hypervisor managers |
GET /hypervisor-managers/detailed
Content-Type: */*
Accept: application/json
...
HTTP/1.1 200 OK
Content-Type: application/json
[ {
"url" : "...",
"sshPort" : 12345,
"nodeConfig" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"user" : "...",
"sshKeyPath" : "...",
"hvCount" : 12345,
"vmCount" : 12345,
"vmExportImportMode" : "DISK_ATTACHMENT_CHANGED_BLOCK_TRACKING",
"baseImageCreationConfig" : {
"windowsImageRequired" : "FALSE",
"linuxImageRequired" : "FALSE"
},
"account" : "...",
"useNetcat" : true,
"storageType" : "CEPH",
"region" : "...",
"endpointInterfaceType" : "ADMIN",
"ovmSettings" : {
"ovmJobStatusPollingInterval" : 12345,
"ovmPoolToRepoMappings" : [ {
"pool" : "...",
"repositoryId" : "..."
}, {
"pool" : "...",
"repositoryId" : "..."
} ],
"ovmExportCloneTypeOverride" : "SPARSE_COPY"
},
"rhvSettings" : {
"rhvSnapshotCloneTimeout" : 12345,
"rhvSnapshotCreationTimeout" : 12345,
"rhvVmExportTimeout" : 12345,
"rhvDiskUnlockTimeout" : 12345,
"rhvMultiDatacenterExport" : true,
"rhvSnapshotRemovalTimeout" : 12345,
"rhvDcToSdMappings" : [ {
"dataCenter" : "...",
"storageDomain" : "..."
}, {
"dataCenter" : "...",
"storageDomain" : "..."
} ]
},
"awsSettings" : {
"awsSnapshotCreationTimeout" : 12345,
"awsImageCreationTimeout" : 12345,
"awsVolumeActionsTimeout" : 12345,
"awsInstanceCreationTimeout" : 12345
},
"vmwareSettings" : {
"vmwareTagCategory" : "..."
},
"openStackSettings" : {
"openstackDownloadImageFromGlance" : true,
"openstackScopeVmsToDomain" : true
},
"nutanixSettings" : {
"nutanixSnapshotRemovalTimeout" : 12345,
"maxNutanixSnapshotCreatingTimeout" : 12345,
"nutanixDiskOperationTimeout" : 12345
},
"oadpSettings" : {
"oadpProjectName" : "...",
"oadpStorageClassName" : "..."
},
"hvmHypervSettings" : {
"hypervExportChunksNumber" : 12345,
"hypevisorManagerHypervType" : "..."
},
"hvmAzureSettings" : {
"azureClientId" : "...",
"azureClientSecret" : "...",
"azureSubscriptionId" : "...",
"azureTenantId" : "..."
},
"gcpSettings" : {
"gcpOrganizationId" : "..."
},
"useToken" : true,
"lastInventorySyncDate" : 12345,
"lastSuccessfulInventorySyncDate" : 12345,
"possibleActions" : [ "INVENTORY_SYNC", "HV_READ" ],
"version" : "...",
"trustAllCerts" : true,
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"type" : {
"name" : "ENUM_NAME",
"description" : "Enum description"
}
} ]
Returns list of hypervisor managers for a restore operation filtered by specified query parameters.
name | type | description | constraints |
---|---|---|---|
backup-to-be-restored | query | ||
direction | query | ||
filter | query | ||
nameLike | query | ||
orderBy | query | ||
page | query | ||
size | query | ||
snapshotable | query | boolean | |
type | query | "AWS" or "AZURE" or "FUSIONCOMPUTE" or "GCP" or "HC3" or "HYPERV" or "KUBERNETES" or "NUTANIX" or "OPENNEBULA" or "OPENSHIFT" or "OPENSTACK" or "ORACLE" or "RHEV" or "RHV" or "VCENTER" or "VIRTUOZZO" |
media type | data type | description |
---|---|---|
application/json | array of HypervisorManagerForRestoreListRecord (JSON) | list of hypervisor manager name and guids filtered by specified query parameters |
GET /hypervisor-managers/for-restore
Content-Type: */*
Accept: application/json
...
HTTP/1.1 200 OK
Content-Type: application/json
[ {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"url" : "https://some.host:8181/api",
"type" : {
"name" : "ENUM_NAME",
"description" : "Enum description"
}
} ]
Change password for specified list of hypervisor managers.
media type | data type | description |
---|---|---|
application/json | SingleAttributeBatchUpdate (JSON) | specify new password and guids of hypervisor managers |
media type | data type | description |
---|---|---|
application/json | BatchResponse (JSON) | list of successful and unsuccessful updates of password |
PUT /hypervisor-managers/password
Content-Type: application/json
Accept: application/json
{
"value" : "...",
"entities" : [ {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
}, {
"guid" : "...",
"name" : "..."
} ]
}
HTTP/1.1 204 No Content
Content-Type: application/json
{
"successful" : [ {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
}, {
"guid" : "...",
"name" : "..."
} ],
"unsuccessful" : [ {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
}, {
"guid" : "...",
"name" : "..."
} ]
}
Returns list of hypervisor managers for a rbac context
media type | data type | description |
---|---|---|
application/json | array of RbacContextListRecord (JSON) | list of hypervisor manager rbac context wrappers |
GET /hypervisor-managers/rbac-contexts
Content-Type: */*
Accept: application/json
...
HTTP/1.1 200 OK
Content-Type: application/json
[ {
"nameAndGuid" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"uuid" : "...",
"type" : "STORAGE_PROVIDER",
"checked" : true,
"lastLevel" : true,
"present" : true,
"entityType" : "...",
"childrenQueryType" : "..."
} ]
Change user for specified list of hypervisor managers.
media type | data type | description |
---|---|---|
application/json | SingleAttributeBatchUpdate (JSON) | specify new user and guids of hypervisor managers |
media type | data type | description |
---|---|---|
application/json | BatchResponse (JSON) | list of successful and unsuccessful updates of user |
PUT /hypervisor-managers/user
Content-Type: application/json
Accept: application/json
{
"value" : "...",
"entities" : [ {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
}, {
"guid" : "...",
"name" : "..."
} ]
}
HTTP/1.1 204 No Content
Content-Type: application/json
{
"successful" : [ {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
}, {
"guid" : "...",
"name" : "..."
} ],
"unsuccessful" : [ {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
}, {
"guid" : "...",
"name" : "..."
} ]
}
Remove hypervisor manager.
name | type | description |
---|---|---|
guid | path | specify local unique identifier for hypervisor manager (use by vProtect) |
DELETE /hypervisor-managers/{guid}
Content-Type: */*
...
HTTP/1.1 204 No Content
Get a single hypervisor manager.
name | type | description |
---|---|---|
guid | path | specify local unique identifier for hypervisor manager (use by vProtect) |
media type | data type | description |
---|---|---|
application/json | HypervisorManagerDetails (JSON) | hypervisor manager details |
GET /hypervisor-managers/{guid}
Content-Type: */*
Accept: application/json
...
HTTP/1.1 200 OK
Content-Type: application/json
{
"url" : "...",
"sshPort" : 12345,
"nodeConfig" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"user" : "...",
"sshKeyPath" : "...",
"hvCount" : 12345,
"vmCount" : 12345,
"vmExportImportMode" : "CHANGED_BLOCK_TRACKING",
"baseImageCreationConfig" : {
"windowsImageRequired" : "FALSE",
"linuxImageRequired" : "FALSE"
},
"account" : "...",
"useNetcat" : true,
"storageType" : "DEFAULT",
"region" : "...",
"endpointInterfaceType" : "INTERNAL",
"ovmSettings" : {
"ovmJobStatusPollingInterval" : 12345,
"ovmPoolToRepoMappings" : [ {
"pool" : "...",
"repositoryId" : "..."
}, {
"pool" : "...",
"repositoryId" : "..."
} ],
"ovmExportCloneTypeOverride" : "NON_SPARSE_COPY"
},
"rhvSettings" : {
"rhvSnapshotCloneTimeout" : 12345,
"rhvSnapshotCreationTimeout" : 12345,
"rhvVmExportTimeout" : 12345,
"rhvDiskUnlockTimeout" : 12345,
"rhvMultiDatacenterExport" : true,
"rhvSnapshotRemovalTimeout" : 12345,
"rhvDcToSdMappings" : [ {
"dataCenter" : "...",
"storageDomain" : "..."
}, {
"dataCenter" : "...",
"storageDomain" : "..."
} ]
},
"awsSettings" : {
"awsSnapshotCreationTimeout" : 12345,
"awsImageCreationTimeout" : 12345,
"awsVolumeActionsTimeout" : 12345,
"awsInstanceCreationTimeout" : 12345
},
"vmwareSettings" : {
"vmwareTagCategory" : "..."
},
"openStackSettings" : {
"openstackDownloadImageFromGlance" : true,
"openstackScopeVmsToDomain" : true
},
"nutanixSettings" : {
"nutanixSnapshotRemovalTimeout" : 12345,
"maxNutanixSnapshotCreatingTimeout" : 12345,
"nutanixDiskOperationTimeout" : 12345
},
"oadpSettings" : {
"oadpProjectName" : "...",
"oadpStorageClassName" : "..."
},
"hvmHypervSettings" : {
"hypervExportChunksNumber" : 12345,
"hypevisorManagerHypervType" : "..."
},
"hvmAzureSettings" : {
"azureClientId" : "...",
"azureClientSecret" : "...",
"azureSubscriptionId" : "...",
"azureTenantId" : "..."
},
"gcpSettings" : {
"gcpOrganizationId" : "..."
},
"useToken" : true,
"lastInventorySyncDate" : 12345,
"lastSuccessfulInventorySyncDate" : 12345,
"possibleActions" : [ "READ", "WRITE" ],
"version" : "...",
"trustAllCerts" : true,
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"type" : {
"name" : "ENUM_NAME",
"description" : "Enum description"
}
}
Change hypervisor manager details.
name | type | description |
---|---|---|
guid | path | specify local unique identifier for hypervisor manager (use by vProtect) |
media type | data type | description |
---|---|---|
application/json | HypervisorManagerUpdate (JSON) | specify hypervisor manager details to update |
media type | data type | description |
---|---|---|
application/json | HypervisorManagerDetails (JSON) | updated details of hypervisor manager |
PUT /hypervisor-managers/{guid}
Content-Type: application/json
Accept: application/json
{
"url" : "...",
"sshPort" : 12345,
"nodeConfig" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"user" : "...",
"accessKey" : "...",
"sshKeyPath" : "...",
"vmExportImportMode" : "SSH_TRANSFER",
"baseImageCreationConfig" : {
"windowsImageRequired" : "TRUE",
"linuxImageRequired" : "FALSE"
},
"account" : "...",
"vmwareSettings" : {
"vmwareTagCategory" : "..."
},
"rhvSettings" : {
"rhvSnapshotCloneTimeout" : 12345,
"rhvSnapshotCreationTimeout" : 12345,
"rhvVmExportTimeout" : 12345,
"rhvDiskUnlockTimeout" : 12345,
"rhvMultiDatacenterExport" : true,
"rhvSnapshotRemovalTimeout" : 12345,
"rhvDcToSdMappings" : [ {
"dataCenter" : "...",
"storageDomain" : "..."
}, {
"dataCenter" : "...",
"storageDomain" : "..."
} ]
},
"awsSettings" : {
"awsSnapshotCreationTimeout" : 12345,
"awsImageCreationTimeout" : 12345,
"awsVolumeActionsTimeout" : 12345,
"awsInstanceCreationTimeout" : 12345
},
"ovmSettings" : {
"ovmJobStatusPollingInterval" : 12345,
"ovmPoolToRepoMappings" : [ {
"pool" : "...",
"repositoryId" : "..."
}, {
"pool" : "...",
"repositoryId" : "..."
} ],
"ovmExportCloneTypeOverride" : "THIN_CLONE"
},
"openStackSettings" : {
"openstackDownloadImageFromGlance" : true,
"openstackScopeVmsToDomain" : true
},
"nutanixSettings" : {
"nutanixSnapshotRemovalTimeout" : 12345,
"maxNutanixSnapshotCreatingTimeout" : 12345,
"nutanixDiskOperationTimeout" : 12345
},
"oadpSettings" : {
"oadpProjectName" : "...",
"oadpStorageClassName" : "..."
},
"hvmHypervSettings" : {
"hypervExportChunksNumber" : 12345,
"hypevisorManagerHypervType" : "..."
},
"hvmAzureSettings" : {
"azureClientId" : "...",
"azureClientSecret" : "...",
"azureSubscriptionId" : "...",
"azureTenantId" : "..."
},
"gcpSettings" : {
"gcpOrganizationId" : "..."
},
"projects" : [ {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
}, {
"guid" : "...",
"name" : "..."
} ],
"useNetcat" : true,
"storageType" : "CEPH",
"endpointInterfaceType" : "ADMIN",
"region" : "...",
"useToken" : true,
"trustAllCerts" : true,
"updateTrustAllCertsForManagedHypervisors" : true
}
HTTP/1.1 204 No Content
Content-Type: application/json
{
"url" : "...",
"sshPort" : 12345,
"nodeConfig" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"user" : "...",
"sshKeyPath" : "...",
"hvCount" : 12345,
"vmCount" : 12345,
"vmExportImportMode" : "SSH_TRANSFER",
"baseImageCreationConfig" : {
"windowsImageRequired" : "INHERIT",
"linuxImageRequired" : "FALSE"
},
"account" : "...",
"useNetcat" : true,
"storageType" : "DEFAULT",
"region" : "...",
"endpointInterfaceType" : "ADMIN",
"ovmSettings" : {
"ovmJobStatusPollingInterval" : 12345,
"ovmPoolToRepoMappings" : [ {
"pool" : "...",
"repositoryId" : "..."
}, {
"pool" : "...",
"repositoryId" : "..."
} ],
"ovmExportCloneTypeOverride" : "SPARSE_COPY"
},
"rhvSettings" : {
"rhvSnapshotCloneTimeout" : 12345,
"rhvSnapshotCreationTimeout" : 12345,
"rhvVmExportTimeout" : 12345,
"rhvDiskUnlockTimeout" : 12345,
"rhvMultiDatacenterExport" : true,
"rhvSnapshotRemovalTimeout" : 12345,
"rhvDcToSdMappings" : [ {
"dataCenter" : "...",
"storageDomain" : "..."
}, {
"dataCenter" : "...",
"storageDomain" : "..."
} ]
},
"awsSettings" : {
"awsSnapshotCreationTimeout" : 12345,
"awsImageCreationTimeout" : 12345,
"awsVolumeActionsTimeout" : 12345,
"awsInstanceCreationTimeout" : 12345
},
"vmwareSettings" : {
"vmwareTagCategory" : "..."
},
"openStackSettings" : {
"openstackDownloadImageFromGlance" : true,
"openstackScopeVmsToDomain" : true
},
"nutanixSettings" : {
"nutanixSnapshotRemovalTimeout" : 12345,
"maxNutanixSnapshotCreatingTimeout" : 12345,
"nutanixDiskOperationTimeout" : 12345
},
"oadpSettings" : {
"oadpProjectName" : "...",
"oadpStorageClassName" : "..."
},
"hvmHypervSettings" : {
"hypervExportChunksNumber" : 12345,
"hypevisorManagerHypervType" : "..."
},
"hvmAzureSettings" : {
"azureClientId" : "...",
"azureClientSecret" : "...",
"azureSubscriptionId" : "...",
"azureTenantId" : "..."
},
"gcpSettings" : {
"gcpOrganizationId" : "..."
},
"useToken" : true,
"lastInventorySyncDate" : 12345,
"lastSuccessfulInventorySyncDate" : 12345,
"possibleActions" : [ "HV_READ", "INVENTORY_SYNC" ],
"version" : "...",
"trustAllCerts" : true,
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"type" : {
"name" : "ENUM_NAME",
"description" : "Enum description"
}
}
Returns access key from hypervisor manager.
name | type | description |
---|---|---|
guid | path | specify local unique identifier for hypervisor manager (use by vProtect) |
media type | data type | description |
---|---|---|
application/json | string (JSON) | access key from hypervisor manager |
GET /hypervisor-managers/{guid}/access-key
Content-Type: application/json
Accept: application/json
...
HTTP/1.1 200 OK
Content-Type: application/json
...
Change access key for specified hypervisor manager.
name | type | description |
---|---|---|
guid | path | specify local unique identifier for hypervisor manager (use by vProtect) |
media type | data type | description |
---|---|---|
application/json | StringDTO (JSON) | specify new access key |
PUT /hypervisor-managers/{guid}/access-key
Content-Type: application/json
{
"value" : "..."
}
HTTP/1.1 204 No Content
Change certificate settings for hypervisor manager
name | type | description |
---|---|---|
guid | path | specify local unique identifier for hypervisor manager (use by vProtect) |
media type | data type | description |
---|---|---|
application/json | HypervisorManagerCertificateSettingsUpdate (JSON) | specify hypervisor manager certificate settings to update |
media type | data type | description |
---|---|---|
application/json | HypervisorManagerDetails (JSON) | updated details of hypervisor manager |
PUT /hypervisor-managers/{guid}/certificates
Content-Type: application/json
Accept: application/json
{
"trustAllCerts" : true,
"updateTrustAllCertsForManagedHypervisors" : true
}
HTTP/1.1 204 No Content
Content-Type: application/json
{
"url" : "...",
"sshPort" : 12345,
"nodeConfig" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"user" : "...",
"sshKeyPath" : "...",
"hvCount" : 12345,
"vmCount" : 12345,
"vmExportImportMode" : "VM_IMAGE_PLUS_INCREMENTAL_DISKS",
"baseImageCreationConfig" : {
"windowsImageRequired" : "TRUE",
"linuxImageRequired" : "INHERIT"
},
"account" : "...",
"useNetcat" : true,
"storageType" : "CEPH",
"region" : "...",
"endpointInterfaceType" : "ADMIN",
"ovmSettings" : {
"ovmJobStatusPollingInterval" : 12345,
"ovmPoolToRepoMappings" : [ {
"pool" : "...",
"repositoryId" : "..."
}, {
"pool" : "...",
"repositoryId" : "..."
} ],
"ovmExportCloneTypeOverride" : "SPARSE_COPY"
},
"rhvSettings" : {
"rhvSnapshotCloneTimeout" : 12345,
"rhvSnapshotCreationTimeout" : 12345,
"rhvVmExportTimeout" : 12345,
"rhvDiskUnlockTimeout" : 12345,
"rhvMultiDatacenterExport" : true,
"rhvSnapshotRemovalTimeout" : 12345,
"rhvDcToSdMappings" : [ {
"dataCenter" : "...",
"storageDomain" : "..."
}, {
"dataCenter" : "...",
"storageDomain" : "..."
} ]
},
"awsSettings" : {
"awsSnapshotCreationTimeout" : 12345,
"awsImageCreationTimeout" : 12345,
"awsVolumeActionsTimeout" : 12345,
"awsInstanceCreationTimeout" : 12345
},
"vmwareSettings" : {
"vmwareTagCategory" : "..."
},
"openStackSettings" : {
"openstackDownloadImageFromGlance" : true,
"openstackScopeVmsToDomain" : true
},
"nutanixSettings" : {
"nutanixSnapshotRemovalTimeout" : 12345,
"maxNutanixSnapshotCreatingTimeout" : 12345,
"nutanixDiskOperationTimeout" : 12345
},
"oadpSettings" : {
"oadpProjectName" : "...",
"oadpStorageClassName" : "..."
},
"hvmHypervSettings" : {
"hypervExportChunksNumber" : 12345,
"hypevisorManagerHypervType" : "..."
},
"hvmAzureSettings" : {
"azureClientId" : "...",
"azureClientSecret" : "...",
"azureSubscriptionId" : "...",
"azureTenantId" : "..."
},
"gcpSettings" : {
"gcpOrganizationId" : "..."
},
"useToken" : true,
"lastInventorySyncDate" : 12345,
"lastSuccessfulInventorySyncDate" : 12345,
"possibleActions" : [ "READ", "HVM_READ" ],
"version" : "...",
"trustAllCerts" : true,
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"type" : {
"name" : "ENUM_NAME",
"description" : "Enum description"
}
}
Change password for specified hypervisor manager.
name | type | description |
---|---|---|
guid | path | specify local unique identifier for hypervisor manager (use by vProtect) |
media type | data type | description |
---|---|---|
application/json | StringDTO (JSON) | specify new password |
PUT /hypervisor-managers/{guid}/password
Content-Type: application/json
{
"value" : "..."
}
HTTP/1.1 204 No Content
Change secret key for specified hypervisor manager.
name | type | description |
---|---|---|
guid | path | specify local unique identifier for hypervisor manager (use by vProtect) |
media type | data type | description |
---|---|---|
application/json | StringDTO (JSON) | specify new secret key |
PUT /hypervisor-managers/{guid}/secret-key
Content-Type: application/json
{
"value" : "..."
}
HTTP/1.1 204 No Content
Returns architecture statistics from hypervisor manager.
name | type | description | constraints |
---|---|---|---|
guid | path | specify local unique identifier for hypervisor manager (use by vProtect) | |
compute-zone | query | ||
from | query | long | |
to | query | long |
media type | data type | description |
---|---|---|
application/json | VirtualProviderStatisticsDetails (JSON) | architecture statistics from hypervisor manager |
GET /hypervisor-managers/{guid}/statistics
Content-Type: */*
Accept: application/json
...
HTTP/1.1 200 OK
Content-Type: application/json
{
"hypervisorCount" : 12345,
"hypervisorClusterCount" : 12345,
"hypervisorStorageCount" : 12345,
"virtualMachineCount" : 12345,
"networkCount" : 12345,
"projectCount" : 12345,
"accessKeyCount" : 12345,
"vmFlavorCount" : 12345,
"backupCount" : 12345,
"backupHistoryCount" : 12345,
"restoreJobCount" : 12345,
"quotaCount" : 12345,
"certificatesCount" : 12345,
"authDomainCount" : 12345
}
name | type | description |
---|---|---|
guid | path |
media type | data type | description |
---|---|---|
application/json | string (JSON) |
GET /hypervisor-managers/azure/{guid}/client-secret
Content-Type: */*
Accept: application/json
...
HTTP/1.1 200 OK
Content-Type: application/json
...
name | type | description |
---|---|---|
guid | path |
media type | data type |
---|---|
application/json | StringDTO (JSON) |
PUT /hypervisor-managers/azure/{guid}/client-secret
Content-Type: application/json
{
"value" : "..."
}
HTTP/1.1 204 No Content