The API allows you to list, view, create and edit hypervisors.
Returns list of hypervisors filtered by specified query parameters.
name | type | description | constraints |
---|---|---|---|
backup-to-be-restored | query | ||
direction | query | ||
filter | query | ||
hypervisor-manager | query | ||
nameLike | query | ||
orderBy | query | ||
page | query | ||
size | query | ||
snapshotable | query | boolean | |
type | query | "CITRIX" or "ESXI" or "HYPERV" or "KUBERNETES" or "KVM" or "NUTANIX" or "OPENSHIFT" or "OVM" or "PROXMOX" or "XEN" |
media type | data type | description |
---|---|---|
application/json | array of HypervisorListRecord (JSON) | list of hypervisors filtered by specified query parameters |
GET /hypervisors
Content-Type: */*
Accept: application/json
...
HTTP/1.1 200 OK
Content-Type: application/json
[ {
"host" : "...",
"sshPort" : 12345,
"user" : "...",
"nodeConfig" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"cluster" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"dataCenter" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"vmCount" : 12345,
"storageType" : "CEPH",
"licenseCovered" : true,
"hvManager" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"storageProvider" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"lastInventorySyncDate" : 12345,
"lastSuccessfulInventorySyncDate" : 12345,
"possibleActions" : [ "WRITE", "HVM_READ" ],
"version" : "...",
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"type" : {
"name" : "ENUM_NAME",
"description" : "Enum description"
}
} ]
Create hypervisor.
media type | data type | description |
---|---|---|
application/json | HypervisorRequest (JSON) | specify details for new hypervisor |
media type | data type | description |
---|---|---|
application/json | HypervisorDetails (JSON) | details of newly created hypervisor |
POST /hypervisors
Content-Type: application/json
Accept: application/json
{
"password" : "...",
"hvManager" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"cluster" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"dataCenter" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"type" : {
"name" : "ENUM_NAME",
"description" : "Enum description"
},
"host" : "...",
"sshPort" : 12345,
"nodeConfig" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"sshKeyPath" : "...",
"user" : "...",
"vmExportImportMode" : "DISK_ATTACHMENT_CHANGED_BLOCK_TRACKING",
"transferNicAddress" : "...",
"dataCenterName" : "...",
"vmOwner" : "...",
"vmOwningGroup" : "...",
"storageProvider" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"storageType" : "DEFAULT",
"licenseCovered" : true,
"useNetcat" : true,
"libvirtSettings" : {
"libvirtSshTimeout" : 12345,
"libvirtSshKnownHostsPath" : "...",
"libvirtSshProgressRefreshRate" : 12345,
"libvirtLvmSnapshotSize" : "...",
"libvirtLvmSnapshotExtents" : "...",
"libvirtAlwaysExportFullIfVmTurnedOff" : true
},
"citrixSettings" : {
"citrixExportRefreshRate" : 12345,
"citrixEnableXvaCompression" : true,
"citrixSnapshotRemovalTimeout" : 12345
},
"proxmoxSettings" : {
"proxmoxBackupStorage" : "...",
"proxmoxCompressionType" : "GZIP",
"proxmoxNbdBufferReleaseMaxAttempts" : 12345,
"proxmoxNbdBufferReleaseTimeout" : 12345,
"proxmoxNbdBufferReleaseWaitPeriod" : 12345,
"proxmoxAvailableNbdWaitPeriod" : 12345,
"proxmoxConnectQcow2ToNbdWaitPeriod" : 12345
},
"hvHypervSettings" : {
"hypervExportChunksNumber" : 12345
},
"trustAllCerts" : true
}
HTTP/1.1 201 Created
Content-Type: application/json
{
"host" : "...",
"sshPort" : 12345,
"nodeConfig" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"user" : "...",
"sshKeyPath" : "...",
"vmCount" : 12345,
"hvManager" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"hvmType" : {
"name" : "ENUM_NAME",
"description" : "Enum description"
},
"vmExportImportMode" : "INHERIT",
"transferNicAddress" : "...",
"dataCenterName" : "...",
"cluster" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"vmOwner" : "...",
"vmOwningGroup" : "...",
"storageType" : "DEFAULT",
"storageProvider" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"licenseCovered" : true,
"useNetcat" : true,
"citrixSettings" : {
"citrixExportRefreshRate" : 12345,
"citrixEnableXvaCompression" : true,
"citrixSnapshotRemovalTimeout" : 12345
},
"libvirtSettings" : {
"libvirtSshTimeout" : 12345,
"libvirtSshKnownHostsPath" : "...",
"libvirtSshProgressRefreshRate" : 12345,
"libvirtLvmSnapshotSize" : "...",
"libvirtLvmSnapshotExtents" : "...",
"libvirtAlwaysExportFullIfVmTurnedOff" : true
},
"proxmoxSettings" : {
"proxmoxBackupStorage" : "...",
"proxmoxCompressionType" : "GZIP",
"proxmoxNbdBufferReleaseMaxAttempts" : 12345,
"proxmoxNbdBufferReleaseTimeout" : 12345,
"proxmoxNbdBufferReleaseWaitPeriod" : 12345,
"proxmoxAvailableNbdWaitPeriod" : 12345,
"proxmoxConnectQcow2ToNbdWaitPeriod" : 12345
},
"hvHypervSettings" : {
"hypervExportChunksNumber" : 12345,
"hypevisorManagerHypervType" : "..."
},
"lastInventorySyncDate" : 12345,
"lastSuccessfulInventorySyncDate" : 12345,
"possibleActions" : [ "WRITE", "HVM_READ" ],
"version" : "...",
"trustAllCerts" : true,
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"type" : {
"name" : "ENUM_NAME",
"description" : "Enum description"
}
}
Change node for specified list of hypervisors.
media type | data type | description |
---|---|---|
application/json | HypervisorBatchUpdate (JSON) | specify node and guids of hypervisors |
media type | data type | description |
---|---|---|
application/json | BatchResponse (JSON) | list of successful and unsuccessful updates of node |
PUT /hypervisors
Content-Type: application/json
Accept: application/json
{
"hypervisors" : [ {
"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 hypervisors filtered by specified query parameters.
name | type | description | constraints |
---|---|---|---|
backup-to-be-restored | query | ||
direction | query | ||
filter | query | ||
hypervisor-manager | query | ||
nameLike | query | ||
orderBy | query | ||
page | query | ||
size | query | ||
snapshotable | query | boolean | |
type | query | "CITRIX" or "ESXI" or "HYPERV" or "KUBERNETES" or "KVM" or "NUTANIX" or "OPENSHIFT" or "OVM" or "PROXMOX" or "XEN" |
media type | data type | description |
---|---|---|
application/json | array of HypervisorDetails (JSON) | detailed list of hypervisors filtered by specified query parameters |
GET /hypervisors/detailed
Content-Type: */*
Accept: application/json
...
HTTP/1.1 200 OK
Content-Type: application/json
[ {
"host" : "...",
"sshPort" : 12345,
"nodeConfig" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"user" : "...",
"sshKeyPath" : "...",
"vmCount" : 12345,
"hvManager" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"hvmType" : {
"name" : "ENUM_NAME",
"description" : "Enum description"
},
"vmExportImportMode" : "CHANGED_BLOCK_TRACKING",
"transferNicAddress" : "...",
"dataCenterName" : "...",
"cluster" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"vmOwner" : "...",
"vmOwningGroup" : "...",
"storageType" : "DEFAULT",
"storageProvider" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"licenseCovered" : true,
"useNetcat" : true,
"citrixSettings" : {
"citrixExportRefreshRate" : 12345,
"citrixEnableXvaCompression" : true,
"citrixSnapshotRemovalTimeout" : 12345
},
"libvirtSettings" : {
"libvirtSshTimeout" : 12345,
"libvirtSshKnownHostsPath" : "...",
"libvirtSshProgressRefreshRate" : 12345,
"libvirtLvmSnapshotSize" : "...",
"libvirtLvmSnapshotExtents" : "...",
"libvirtAlwaysExportFullIfVmTurnedOff" : true
},
"proxmoxSettings" : {
"proxmoxBackupStorage" : "...",
"proxmoxCompressionType" : "LZO",
"proxmoxNbdBufferReleaseMaxAttempts" : 12345,
"proxmoxNbdBufferReleaseTimeout" : 12345,
"proxmoxNbdBufferReleaseWaitPeriod" : 12345,
"proxmoxAvailableNbdWaitPeriod" : 12345,
"proxmoxConnectQcow2ToNbdWaitPeriod" : 12345
},
"hvHypervSettings" : {
"hypervExportChunksNumber" : 12345,
"hypevisorManagerHypervType" : "..."
},
"lastInventorySyncDate" : 12345,
"lastSuccessfulInventorySyncDate" : 12345,
"possibleActions" : [ "INVENTORY_SYNC", "INVENTORY_SYNC" ],
"version" : "...",
"trustAllCerts" : true,
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"type" : {
"name" : "ENUM_NAME",
"description" : "Enum description"
}
} ]
Returns list of hypervisors filtered by specified query parameters for restore operation
name | type | description | constraints |
---|---|---|---|
backup-to-be-restored | query | ||
direction | query | ||
filter | query | ||
hypervisor-manager | query | ||
nameLike | query | ||
orderBy | query | ||
page | query | ||
size | query | ||
snapshotable | query | boolean | |
type | query | "CITRIX" or "ESXI" or "HYPERV" or "KUBERNETES" or "KVM" or "NUTANIX" or "OPENSHIFT" or "OVM" or "PROXMOX" or "XEN" |
media type | data type | description |
---|---|---|
application/json | array of HypervisorForRestoreListRecord (JSON) | list of hypervisor infos for restore filtered by specified query parameters |
GET /hypervisors/for-restore
Content-Type: */*
Accept: application/json
...
HTTP/1.1 200 OK
Content-Type: application/json
[ {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"host" : "https://some.host:8181/api",
"type" : {
"name" : "ENUM_NAME",
"description" : "Enum description"
}
} ]
Change license coverage for specified list of hypervisors.
media type | data type | description |
---|---|---|
application/json | SingleAttributeBatchUpdate (JSON) | specify license coverage and guids of hypervisors |
media type | data type | description |
---|---|---|
application/json | BatchResponse (JSON) | list of successful and unsuccessful updates of license coverage |
PUT /hypervisors/licensed
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" : "..."
} ]
}
Change password for specified list of hypervisors.
media type | data type | description |
---|---|---|
application/json | SingleAttributeBatchUpdate (JSON) | specify new password and guids of hypervisors |
media type | data type | description |
---|---|---|
application/json | BatchResponse (JSON) | list of successful and unsuccessful updates of password |
PUT /hypervisors/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 hypervisors filtered by specified query 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 |
media type | data type | description |
---|---|---|
application/json | array of RbacContextListRecord (JSON) | list of hypervisors filtered by specified query parameters |
GET /hypervisors/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" : "DATA_CENTER",
"checked" : true,
"lastLevel" : true,
"present" : true,
"entityType" : "...",
"childrenQueryType" : "..."
} ]
Change ssh key path for specified list of hypervisors.
media type | data type | description |
---|---|---|
application/json | SingleAttributeBatchUpdate (JSON) | specify new ssh key path and guids of hypervisors |
media type | data type | description |
---|---|---|
application/json | BatchResponse (JSON) | list of successful and unsuccessful updates of ssh key path |
PUT /hypervisors/ssh-key-path
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" : "..."
} ]
}
Change user for specified list of hypervisors.
media type | data type | description |
---|---|---|
application/json | SingleAttributeBatchUpdate (JSON) | specify new user and guids of hypervisors |
media type | data type | description |
---|---|---|
application/json | BatchResponse (JSON) | list of successful and unsuccessful updates of user |
PUT /hypervisors/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.
name | type | description |
---|---|---|
guid | path | specify local unique identifier for hypervisor (use by vProtect) |
DELETE /hypervisors/{guid}
Content-Type: */*
...
HTTP/1.1 204 No Content
Get a single hypervisor.
name | type | description |
---|---|---|
guid | path | specify local unique identifier for hypervisor (use by vProtect) |
media type | data type | description |
---|---|---|
application/json | HypervisorDetails (JSON) | hypervisor details |
GET /hypervisors/{guid}
Content-Type: */*
Accept: application/json
...
HTTP/1.1 200 OK
Content-Type: application/json
{
"host" : "...",
"sshPort" : 12345,
"nodeConfig" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"user" : "...",
"sshKeyPath" : "...",
"vmCount" : 12345,
"hvManager" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"hvmType" : {
"name" : "ENUM_NAME",
"description" : "Enum description"
},
"vmExportImportMode" : "EXPORT_STORAGE_REPO",
"transferNicAddress" : "...",
"dataCenterName" : "...",
"cluster" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"vmOwner" : "...",
"vmOwningGroup" : "...",
"storageType" : "CEPH",
"storageProvider" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"licenseCovered" : true,
"useNetcat" : true,
"citrixSettings" : {
"citrixExportRefreshRate" : 12345,
"citrixEnableXvaCompression" : true,
"citrixSnapshotRemovalTimeout" : 12345
},
"libvirtSettings" : {
"libvirtSshTimeout" : 12345,
"libvirtSshKnownHostsPath" : "...",
"libvirtSshProgressRefreshRate" : 12345,
"libvirtLvmSnapshotSize" : "...",
"libvirtLvmSnapshotExtents" : "...",
"libvirtAlwaysExportFullIfVmTurnedOff" : true
},
"proxmoxSettings" : {
"proxmoxBackupStorage" : "...",
"proxmoxCompressionType" : "GZIP",
"proxmoxNbdBufferReleaseMaxAttempts" : 12345,
"proxmoxNbdBufferReleaseTimeout" : 12345,
"proxmoxNbdBufferReleaseWaitPeriod" : 12345,
"proxmoxAvailableNbdWaitPeriod" : 12345,
"proxmoxConnectQcow2ToNbdWaitPeriod" : 12345
},
"hvHypervSettings" : {
"hypervExportChunksNumber" : 12345,
"hypevisorManagerHypervType" : "..."
},
"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"
}
}
Change hypervisor details.
name | type | description |
---|---|---|
guid | path | specify local unique identifier for hypervisor (use by vProtect) |
media type | data type | description |
---|---|---|
application/json | HypervisorUpdate (JSON) | specify hypervisor details to update |
media type | data type | description |
---|---|---|
application/json | HypervisorDetails (JSON) | updated details of hypervisor |
PUT /hypervisors/{guid}
Content-Type: application/json
Accept: application/json
{
"host" : "...",
"sshPort" : 12345,
"nodeConfig" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"sshKeyPath" : "...",
"user" : "...",
"vmExportImportMode" : "DISK_ATTACHMENT_CHANGED_BLOCK_TRACKING",
"transferNicAddress" : "...",
"dataCenterName" : "...",
"cluster" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"vmOwner" : "...",
"vmOwningGroup" : "...",
"storageProvider" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"storageType" : "CEPH",
"licenseCovered" : true,
"useNetcat" : true,
"libvirtSettings" : {
"libvirtSshTimeout" : 12345,
"libvirtSshKnownHostsPath" : "...",
"libvirtSshProgressRefreshRate" : 12345,
"libvirtLvmSnapshotSize" : "...",
"libvirtLvmSnapshotExtents" : "...",
"libvirtAlwaysExportFullIfVmTurnedOff" : true
},
"citrixSettings" : {
"citrixExportRefreshRate" : 12345,
"citrixEnableXvaCompression" : true,
"citrixSnapshotRemovalTimeout" : 12345
},
"proxmoxSettings" : {
"proxmoxBackupStorage" : "...",
"proxmoxCompressionType" : "GZIP",
"proxmoxNbdBufferReleaseMaxAttempts" : 12345,
"proxmoxNbdBufferReleaseTimeout" : 12345,
"proxmoxNbdBufferReleaseWaitPeriod" : 12345,
"proxmoxAvailableNbdWaitPeriod" : 12345,
"proxmoxConnectQcow2ToNbdWaitPeriod" : 12345
},
"hvHypervSettings" : {
"hypervExportChunksNumber" : 12345
},
"trustAllCerts" : true
}
HTTP/1.1 204 No Content
Content-Type: application/json
{
"host" : "...",
"sshPort" : 12345,
"nodeConfig" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"user" : "...",
"sshKeyPath" : "...",
"vmCount" : 12345,
"hvManager" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"hvmType" : {
"name" : "ENUM_NAME",
"description" : "Enum description"
},
"vmExportImportMode" : "DISK_IMAGE_TRANSFER",
"transferNicAddress" : "...",
"dataCenterName" : "...",
"cluster" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"vmOwner" : "...",
"vmOwningGroup" : "...",
"storageType" : "DEFAULT",
"storageProvider" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"licenseCovered" : true,
"useNetcat" : true,
"citrixSettings" : {
"citrixExportRefreshRate" : 12345,
"citrixEnableXvaCompression" : true,
"citrixSnapshotRemovalTimeout" : 12345
},
"libvirtSettings" : {
"libvirtSshTimeout" : 12345,
"libvirtSshKnownHostsPath" : "...",
"libvirtSshProgressRefreshRate" : 12345,
"libvirtLvmSnapshotSize" : "...",
"libvirtLvmSnapshotExtents" : "...",
"libvirtAlwaysExportFullIfVmTurnedOff" : true
},
"proxmoxSettings" : {
"proxmoxBackupStorage" : "...",
"proxmoxCompressionType" : "DISABLED",
"proxmoxNbdBufferReleaseMaxAttempts" : 12345,
"proxmoxNbdBufferReleaseTimeout" : 12345,
"proxmoxNbdBufferReleaseWaitPeriod" : 12345,
"proxmoxAvailableNbdWaitPeriod" : 12345,
"proxmoxConnectQcow2ToNbdWaitPeriod" : 12345
},
"hvHypervSettings" : {
"hypervExportChunksNumber" : 12345,
"hypevisorManagerHypervType" : "..."
},
"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 certificate settings.
name | type | description |
---|---|---|
guid | path | specify local unique identifier for hypervisor (use by vProtect) |
media type | data type | description |
---|---|---|
application/json | HypervisorCertificateSettingsUpdate (JSON) | specify hypervisor certificate settings to update |
media type | data type | description |
---|---|---|
application/json | HypervisorDetails (JSON) | updated details of hypervisor |
PUT /hypervisors/{guid}/certificates
Content-Type: application/json
Accept: application/json
{
"trustAllCerts" : true
}
HTTP/1.1 204 No Content
Content-Type: application/json
{
"host" : "...",
"sshPort" : 12345,
"nodeConfig" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"user" : "...",
"sshKeyPath" : "...",
"vmCount" : 12345,
"hvManager" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"hvmType" : {
"name" : "ENUM_NAME",
"description" : "Enum description"
},
"vmExportImportMode" : "DISK_IMAGE_TRANSFER",
"transferNicAddress" : "...",
"dataCenterName" : "...",
"cluster" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"vmOwner" : "...",
"vmOwningGroup" : "...",
"storageType" : "CEPH",
"storageProvider" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"licenseCovered" : true,
"useNetcat" : true,
"citrixSettings" : {
"citrixExportRefreshRate" : 12345,
"citrixEnableXvaCompression" : true,
"citrixSnapshotRemovalTimeout" : 12345
},
"libvirtSettings" : {
"libvirtSshTimeout" : 12345,
"libvirtSshKnownHostsPath" : "...",
"libvirtSshProgressRefreshRate" : 12345,
"libvirtLvmSnapshotSize" : "...",
"libvirtLvmSnapshotExtents" : "...",
"libvirtAlwaysExportFullIfVmTurnedOff" : true
},
"proxmoxSettings" : {
"proxmoxBackupStorage" : "...",
"proxmoxCompressionType" : "LZO",
"proxmoxNbdBufferReleaseMaxAttempts" : 12345,
"proxmoxNbdBufferReleaseTimeout" : 12345,
"proxmoxNbdBufferReleaseWaitPeriod" : 12345,
"proxmoxAvailableNbdWaitPeriod" : 12345,
"proxmoxConnectQcow2ToNbdWaitPeriod" : 12345
},
"hvHypervSettings" : {
"hypervExportChunksNumber" : 12345,
"hypevisorManagerHypervType" : "..."
},
"lastInventorySyncDate" : 12345,
"lastSuccessfulInventorySyncDate" : 12345,
"possibleActions" : [ "HVM_READ", "HV_READ" ],
"version" : "...",
"trustAllCerts" : true,
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"type" : {
"name" : "ENUM_NAME",
"description" : "Enum description"
}
}
Change password for specified hypervisor.
name | type | description |
---|---|---|
guid | path | specify local unique identifier for hypervisor (use by vProtect) |
media type | data type | description |
---|---|---|
application/json | StringDTO (JSON) | specify new password to update |
PUT /hypervisors/{guid}/password
Content-Type: application/json
{
"value" : "..."
}
HTTP/1.1 204 No Content
Returns architecture statistics from hypervisor.
name | type | description | constraints |
---|---|---|---|
guid | path | specify local unique identifier for hypervisor (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 |
GET /hypervisors/{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
}