Virtual Infrastructure

Adds virtual infrastructure to the inventory.

Base URL

        https://<consoleFQDN:port>/st/console/api/v1.0/virtual

Supported Requests

Hypervisors

Method URL Input Return
DELETE https://<consoleFQDN:port>/st/console/api/v1.0/virtual/hypervisors/{id of hypervisor} URL Parameters  
GET https://<consoleFQDN:port>/st/console/api/v1.0/virtual/hypervisors   Hypervisors[]
https://<consoleFQDN:port>/st/console/api/v1.0/virtual/hypervisors/{id of hypervisor}   Configuration information for the specified hypervisor.
https://<consoleFQDN:port>/st/console/api/v1.0/virtual/hypervisors/{id of hypervisor}/images/{id of image}   Configuration information for the specified virtual image.

https://<consoleFQDN:port>/st/console/api/v1.0/virtual/hypervisors/{id of hypervisor}/images

URL Parameters

VirtualImages[]
https://<consoleFQDN:port>/st/console/api/v1.0/virtual/hypervisors/{id of hypervisor}/images/usedby    
POST

https://<consoleFQDN:port>/st/console/api/v1.0/virtual

POST Request Body  
https://<consoleFQDN:port>/st/console/api/v1.0/virtual/hypervisors/{id}/refresh    
PATCH https://<consoleFQDN:port>/st/console/api/v1.0/virtual/hypervisors/{id} PATCH Request Body  

VCenters

Method URL Input Return
DELETE https://<consoleFQDN:port>/st/console/api/v1.0/virtual/vcenters/{id of vcenter} URL Parameters  
GET https://<consoleFQDN:port>/st/console/api/v1.0/virtual/vcenters   VCenterServers[]
https://<consoleFQDN:port>/st/console/api/v1.0/virtual/vcenters/{id of vcenter}   Configuration information for the specified vCenter Server.
https://<consoleFQDN:port>/st/console/api/v1.0/virtual/vcenters/{id of vcenter}/hypervisors   Hypervisors[]
https://<consoleFQDN:port>/st/console/api/v1.0/virtual/vcenters/{id of vcenter}/usedby    
POST https://<consoleFQDN:port>/st/console/api/v1.0/virtual/vcenters POST Request Body  
https://<consoleFQDN:port>/st/console/api/v1.0/virtual/vcenters/{id}/refresh    
PATCH https://<consoleFQDN:port>/st/console/api/v1.0/virtual/vcenters/{id} PATCH Request Body  

Input Models

Example with Sample Response

Find all VCenter servers

GET Request

https://<consoleFQDN:port>/st/console/api/v1.0/virtual/vcenters

Sample Response

{

"count": 1,

"value": [

{

"certificateThumbprint": "A22AD02F85CACAE70900F0F24158DA7F7CEC1556",

"credentialId": "daf645ca-a22f-4ffc-a186-32a620c8b67b",

"id": 1,

"links": {

"self": {

"href": "https://device-name.fakedomain.com:3121/st/console/api/v1.0/virtual/vcenters/1"

},

"hypervisors": {

"href": "https://device-name.fakedomain.com:3121/st/console/api/v1.0/virtual/vcenters/1/hypervisors"

},

"usedby": {

"href": "https:/device-name.fakedomain.com:3121/st/console/api/v1.0/virtual/vcenters/1/usedby"

}

},

"managedHypervisors": [

"https://device-name.fakedomain.com:3121/st/console/api/v1.0/virtual/hypervisors/1",

"https://device-name.fakedomain.com:3121/st/console/api/v1.0/virtual/hypervisors/2",

"https://device-name.fakedomain.com:3121/st/console/api/v1.0/virtual/hypervisors/3",

"https://device-name.fakedomain.com:3121/st/console/api/v1.0/virtual/hypervisors/4",

"https://device-name.fakedomain.com:3121/st/console/api/v1.0/virtual/hypervisors/5",

"https://device-name.fakedomain.com:3121/st/console/api/v1.0/virtual/hypervisors/6",

"https://device-name.fakedomain.com:3121/st/console/api/v1.0/virtual/hypervisors/7",

"https://device-name.fakedomain.com:3121/st/console/api/v1.0/virtual/hypervisors/8"

],

"name": "sample.fakedomain.com",

"port": 443

}

]

}

Other Request Examples

Output Models