Download OpenAPI specification:Download
API specification provided by the hyperv service from EFA
Get HyperV server details from specified SCVMM server. The SCVMM server can be identified by IP Address or HostName
host_name | string IP/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 HyperV 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/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/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/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
}