The API allows you to list, view, edit and create hypervisor clusters.
Returns list of hypervisor clusters filtered by specified query parameters.
name | type | description | constraints |
---|---|---|---|
compute-zone | query | boolean | |
dataCenter | query | ||
direction | query | ||
filter | query | ||
hypervisor | query | ||
hypervisor-manager | query | ||
nameLike | query | ||
orderBy | query | ||
page | query | ||
project-uuid | query | ||
size | query | ||
storage-provider | query | ||
uuid | query |
media type | data type | description |
---|---|---|
application/json | array of HypervisorClusterListRecord (JSON) | list of hypervisor clusters filtered by specified query parameters |
GET /hypervisor-clusters
Content-Type: */*
Accept: application/json
...
HTTP/1.1 200 OK
Content-Type: application/json
[ {
"guid" : "...",
"uuid" : "...",
"name" : "...",
"hvManager" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"hvManagerType" : "OPENSTACK",
"dataCenter" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"storageProvider" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"nodeConfig" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"projects" : [ {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
}, {
"guid" : "...",
"name" : "..."
} ],
"visibleForAllProjects" : true
} ]
Create hypervisor cluster.
media type | data type | description |
---|---|---|
application/json | HypervisorClusterRequest (JSON) | specify details for new hypervisor cluster |
media type | data type | description |
---|---|---|
application/json | HypervisorClusterListRecord (JSON) | details of newly created hypervisor cluster |
POST /hypervisor-clusters
Content-Type: application/json
Accept: application/json
{
"uuid" : "...",
"name" : "...",
"hvManager" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"dataCenter" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"storageProvider" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"nodeConfig" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"projects" : [ {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
}, {
"guid" : "...",
"name" : "..."
} ],
"visibleForAllProjects" : true
}
HTTP/1.1 201 Created
Content-Type: application/json
{
"guid" : "...",
"uuid" : "...",
"name" : "...",
"hvManager" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"hvManagerType" : "AZURE",
"dataCenter" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"storageProvider" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"nodeConfig" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"projects" : [ {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
}, {
"guid" : "...",
"name" : "..."
} ],
"visibleForAllProjects" : true
}
Returns list of clusters filtered by specified query parameters for restore operation
name | type | description | constraints |
---|---|---|---|
compute-zone | query | boolean | |
dataCenter | query | ||
direction | query | ||
filter | query | ||
hypervisor | query | ||
hypervisor-manager | query | ||
nameLike | query | ||
orderBy | query | ||
page | query | ||
project-uuid | query | ||
size | query | ||
storage-provider | query | ||
uuid | query |
media type | data type | description |
---|---|---|
application/json | array of HypervisorClusterListRecord (JSON) | list of cluster infos for restore filtered by specified query parameters |
GET /hypervisor-clusters/for-restore
Content-Type: */*
Accept: application/json
...
HTTP/1.1 200 OK
Content-Type: application/json
[ {
"guid" : "...",
"uuid" : "...",
"name" : "...",
"hvManager" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"hvManagerType" : "RHEV",
"dataCenter" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"storageProvider" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"nodeConfig" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"projects" : [ {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
}, {
"guid" : "...",
"name" : "..."
} ],
"visibleForAllProjects" : true
} ]
Change node for specified list of hypervisor clusters.
media type | data type | description |
---|---|---|
application/json | HypervisorClusterBatchUpdate (JSON) | specify node and guids of hypervisor clusters |
media type | data type | description |
---|---|---|
application/json | BatchResponse (JSON) | list of successful and unsuccessful updates of node |
PUT /hypervisor-clusters/node-config
Content-Type: application/json
Accept: application/json
{
"hvClusters" : [ {
"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 list of hypervisor clusters 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 hypervisor clusters filtered by specified query parameters |
GET /hypervisor-clusters/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" : "..."
} ]
Remove hypervisor cluster.
name | type | description |
---|---|---|
guid | path | specify local unique identifier for hypervisor cluster (use by vProtect) |
DELETE /hypervisor-clusters/{guid}
Content-Type: */*
...
HTTP/1.1 204 No Content
Get a single hypervisor cluster.
name | type | description |
---|---|---|
guid | path | specify local unique identifier for hypervisor cluster (use by vProtect) |
media type | data type | description |
---|---|---|
application/json | HypervisorClusterListRecord (JSON) | hypervisor cluster details |
GET /hypervisor-clusters/{guid}
Content-Type: */*
Accept: application/json
...
HTTP/1.1 200 OK
Content-Type: application/json
{
"guid" : "...",
"uuid" : "...",
"name" : "...",
"hvManager" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"hvManagerType" : "NUTANIX",
"dataCenter" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"storageProvider" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"nodeConfig" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"projects" : [ {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
}, {
"guid" : "...",
"name" : "..."
} ],
"visibleForAllProjects" : true
}
Change hypervisor cluster details.
name | type | description |
---|---|---|
guid | path | specify local unique identifier for hypervisor cluster (use by vProtect) |
media type | data type | description |
---|---|---|
application/json | HypervisorClusterUpdate (JSON) | specify hypervisor cluster details to update |
media type | data type | description |
---|---|---|
application/json | HypervisorClusterListRecord (JSON) | updated details of hypervisor cluster |
PUT /hypervisor-clusters/{guid}
Content-Type: application/json
Accept: application/json
{
"name" : "...",
"storageProvider" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"nodeConfig" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"projects" : [ {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
}, {
"guid" : "...",
"name" : "..."
} ],
"visibleForAllProjects" : true
}
HTTP/1.1 204 No Content
Content-Type: application/json
{
"guid" : "...",
"uuid" : "...",
"name" : "...",
"hvManager" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"hvManagerType" : "RHV",
"dataCenter" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"storageProvider" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"nodeConfig" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"projects" : [ {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
}, {
"guid" : "...",
"name" : "..."
} ],
"visibleForAllProjects" : true
}
Check if hypervisor cluster update will make some auto-assignment settings invalid
name | type | description |
---|---|---|
guid | path | specify local unique identifier for hypervisor cluster (use by vProtect) |
media type | data type | description |
---|---|---|
application/json | HypervisorClusterUpdate (JSON) | specify hypervisor cluster details to update |
media type | data type | description |
---|---|---|
application/json | array of PolicyProjectAndClusterScopeValidationResultListRecord (JSON) | validation results |
PUT /hypervisor-clusters/validation/{guid}
Content-Type: application/json
Accept: application/json
{
"name" : "...",
"storageProvider" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"nodeConfig" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"projects" : [ {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
}, {
"guid" : "...",
"name" : "..."
} ],
"visibleForAllProjects" : true
}
HTTP/1.1 204 No Content
Content-Type: application/json
[ {
"policy" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"projectsWithoutMatchingClusters" : [ {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
}, {
"guid" : "...",
"name" : "..."
} ],
"clustersWithoutMatchingProjects" : [ {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
}, {
"guid" : "...",
"name" : "..."
} ]
} ]