HypervServers

The /HypervServers resource collection represents all Microsoft Hyper-V servers added to the management server infrastructure.

Get Hyper-V Hierarchy Tree

The HTTP GET request to the /hypervServers/servers endpoint retrieves a hierarchical tree of Hyper-V servers grouped by VMM and cluster.

SecurityuserAuth

Responses

200

401

Unauthorized

500

Internal Server Error

get/api/v1/hypervServers/servers

Request samples

curl
Python
JavaScript
C#
Go

Response samples

application/json

[{"id": "00000000-0000-0000-0000-000000000000",
"name": "scom-server.corp.local",
"type": "Root",
"isNodeMonitored": true,
"sockets": 8,
"monitored": 2,
"total": 3,
"children": [{"id": "HypervVmm\\u0001vmm-server.corp.local",
"name": "vmm-server.corp.local",
"type": "Vmm",
"isNodeMonitored": true,
"sockets": 8,
"monitored": 2,
"total": 3,
"children": [{"id": "vmm-server.corp.local\\u0001HV-Cluster01",
"name": "HV-Cluster01",
"type": "Cluster",
"isNodeMonitored": true,
"sockets": 8,
"monitored": 2,
"total": 3,
"children": [{"id": "hyperv-host01.corp.local",
"name": "hyperv-host01.corp.local",
"type": "Host",
"isNodeMonitored": true,
"sockets": 4,
"monitored": null,
"total": null,
"children": null,
"isHostOnThisVes": true,
"isScomConnected": null,
"monitoringStatus": "Success",
"connectionStatusIndicator": null
},
{"id": "hyperv-host02.corp.local",
"name": "hyperv-host02.corp.local",
"type": "Host",
"isNodeMonitored": true,
"sockets": 4,
"monitored": null,
"total": null,
"children": null,
"isHostOnThisVes": true,
"isScomConnected": null,
"monitoringStatus": "Success",
"connectionStatusIndicator": null
},
{"id": "hyperv-host03.corp.local",
"name": "hyperv-host03.corp.local",
"type": "Host",
"isNodeMonitored": false,
"sockets": 0,
"monitored": null,
"total": null,
"children": null,
"isHostOnThisVes": false,
"isScomConnected": null,
"monitoringStatus": "Info",
"connectionStatusIndicator": null
}
],
"isHostOnThisVes": null,
"isScomConnected": null,
"monitoringStatus": "Info",
"connectionStatusIndicator": null
}
],
"isHostOnThisVes": null,
"isScomConnected": null,
"monitoringStatus": "Info",
"connectionStatusIndicator": null
}
],
"isHostOnThisVes": null,
"isScomConnected": true,
"monitoringStatus": "Info",
"connectionStatusIndicator": "Success"
}
]

Add Hyper-V Hosts to Monitoring

The HTTP POST request to the /hypervServers/servers/addToMonitoring endpoint Hyper-V hosts to monitoring. Use the id values from the /hypervServers/servers endpoint response.

SecurityuserAuth

Request

Request Body schema: application/json

ids

required

Array of strings or null

List of Hyper-V server FQDNs.

Responses

204

No Content

401

Unauthorized

500

Internal Server Error

post/api/v1/hypervServers/servers/addToMonitoring

Request samples

application/json

{"ids": ["hyperv-host01.corp.local",
"hyperv-host02.corp.local"
]
}

Response samples

application/json

{"message": "string"
}

Remove Hyper-V Hosts from Monitoring

The HTTP POST request to the /hypervServers/servers/removeFromMonitoring endpoint removes Hyper-V hosts from monitoring. Use the id values from the /hypervServers/servers endpoint response.

SecurityuserAuth

Request

Request Body schema: application/json

ids

required

Array of strings or null

List of Hyper-V server FQDNs.

Responses

204

No Content

401

Unauthorized

500

Internal Server Error

post/api/v1/hypervServers/servers/removeFromMonitoring

Request samples

application/json

{"ids": ["hyperv-host01.corp.local",
"hyperv-host02.corp.local"
]
}

Response samples

application/json

{"message": "string"
}