Download OpenAPI specification:Download
API specification provided by the Hyper-V service from EFA
Get Hyper-V server details from a specified SCVMM server. The SCVMM server can be identified by IP address or host name.
| host_name | string IP or host name of the SCVMM server |
[- {
- "host_name": "10.24.39.224",
- "id": 1,
- "discovery_status": "Discovered",
- "version": "System Center 2012",
- "vm_count": 1000,
- "hosts": [
- {
- "name": "HyperV1",
- "id": 1
}
], - "virtualmachines": [
- {
- "name": "VM-1",
- "id": 1
}
]
}
]Register SCVMM server with the Hyper-V service
Register a new SCVMM server
| host_name required | string |
| username required | string |
| password required | string |
| tenant required | string |
{- "host_name": "string",
- "username": "string",
- "password": "string",
- "tenant": "string"
}{- "host_name": "10.24.39.224",
- "id": 1,
- "discovery_status": "Discovered",
- "version": "System Center 2012",
- "vm_count": 1000,
- "hosts": [
- {
- "name": "HyperV1",
- "id": 1
}
], - "virtualmachines": [
- {
- "name": "VM-1",
- "id": 1
}
]
}Delete the specified SCVMM server from the inventory.
| host_name required | string IP or host name of the SCVMM to be deleted. |
| cleanup_epgs | boolean Flag to indicate whether the EPGs should be deleted on SCVMM Deletion |
{- "host_name": "10.24.39.224",
- "id": 1,
- "discovery_status": "Discovered",
- "version": "System Center 2012",
- "vm_count": 1000,
- "hosts": [
- {
- "name": "HyperV1",
- "id": 1
}
], - "virtualmachines": [
- {
- "name": "VM-1",
- "id": 1
}
]
}Update the specified SCVMM server details in the inventory.
| host_name required | string IP address or host name of the SCVMM server to be updated. |
Update SCVMM server. If credentials change provide new username and password.
| host_name required | string |
| username | string |
| password | string |
{- "host_name": "string",
- "username": "string",
- "password": "string"
}{- "host_name": "10.24.39.224",
- "id": 1,
- "discovery_status": "Discovered",
- "version": "System Center 2012",
- "vm_count": 1000,
- "hosts": [
- {
- "name": "HyperV1",
- "id": 1
}
], - "virtualmachines": [
- {
- "name": "VM-1",
- "id": 1
}
]
}Get the physical NIC to switch links for the specified SCVMM or Hyper-V server
| host_name | string IP or host name of the SCVMM server |
| hyperv_host | string Host name of the Hyper-V server |
[- {
- "host_name": "10.24.39.224",
- "hyperv_host": "HyperV2",
- "pnic_name": "pnic2",
- "pnic_mac": "40:f2:e9:bb:58:b2",
- "vswitch_name": "vSwitch1",
- "pnic_id": 10,
- "interface_name": "0/10",
- "interface_type": "ethernet",
- "interface_identifier": "Ethernet 0/10",
- "interface_id": 1,
- "device_ip": "10.24.80.134",
- "device_id": 1,
- "link_speed": 1000
}
]Get the virtual NIC to logical network links for the specified Hyper-V server
| hyperv_host | string Host name of the Hyper-V server |
[- {
- "hyperv_host": "HyperV2",
- "vm_name": "10.24.80.134",
- "vnic_name": "vnic2",
- "vnic_mac": "40:f2:e9:bb:58:b2",
- "vnic_id": 10,
- "vswitch_name": "vSwitch1",
- "vmnetwork_name": "VMNetwork1",
- "logicalnetwork_name": "LogicalNetwork1"
}
]Update service settings.
| key required | string Value: "Poll Frequency" |
| value required | string |
| example | object |
{- "key": "Poll Frequency",
- "value": "string",
- "example": { }
}{- "message": "string",
- "code": 100
}Get the list of all the previous executions
| limit required | integer Default: 10 Limit the number of executions that will be sent in the response. Default is 10 |
| status | string Default: "all" Filter the executions based on the status(failed/succeeded/all) |
{- "items": [
- {
- "id": "4aeeb752-318c-4e09-8b52-ae8a47b777e2",
- "url": "/v1/microsoft/hyperv",
- "status": "Completed(4.78873ms)",
- "start_time": "2022-06-28T14:06:37Z",
- "end_time": "2022-06-28T14:06:37Z"
}, - {
- "id": "4aeeb752-318c-4e09-8b52-ae8a47b777e2",
- "url": "/v1/microsoft/hyperv",
- "status": "Completed(4.594434ms)",
- "start_time": "2022-06-28T14:06:40Z",
- "end_time": "2022-06-28T14:06:40Z"
}
]
}