HyperV Service (2.5.5)

Download OpenAPI specification:Download

Extreme Networks: support@extremenetworks.com URL: http://www.extremenetworks.com License: Apache license

API specification provided by the hyperv service from EFA

HyperV

getSCVMMServer

Get HyperV server details from specified SCVMM server. The SCVMM server can be identified by IP Address or HostName

query Parameters

host_name

string

IP/Host Name of the SCVMM Server

Responses

Response samples

200
401
404
500
default

Content type

application/json

[{"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
}
]
}
]

registerSCVMMServer

Register SCVMM server with the HyperV service

Request Body schema: application/json

Register a new SCVMM Server.

host_name required	string
username required	string
password required	string
tenant required	string

Responses

Request samples

Payload

Content type

application/json

{"host_name": "string",
"username": "string",
"password": "string",
"tenant": "string"
}

Response samples

200
401
409
500
default

Content type

application/json

{"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
}
]
}

deleteSCVMMServer

Delete the specified SCVMM server from the inventory.

query Parameters

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

Responses

Response samples

200
401
404
500
default

Content type

application/json

{"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
}
]
}

updateSCVMMServer

Update the specified SCVMM server details in the inventory.

path Parameters

host_name

required

string

IP Address/Host Name of the SCVMM server to be updated.

Request Body schema: application/json

Update SCVMM server. If credentials change provide new username and password

host_name required	string
username	string
password	string

Responses

Request samples

Payload

Content type

application/json

{"host_name": "string",
"username": "string",
"password": "string"
}

Response samples

200
401
404
500
default

Content type

application/json

{"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
}
]
}

Links

getPhysicalLinks

Get the Physical NIC to Switch links for the specified SCVMM or Hyper-V server

query Parameters

host_name	string IP/Host Name of the SCVMM Server
hyperv_host	string Host Name of the Hyper-V Server

Responses

Response samples

200
401
404
500
default

Content type

application/json

[{"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
}
]

getVirtualLinks

Get the Virtual NIC to Logical Network links for the specified Hyper-V server

query Parameters

hyperv_host

string

Host Name of the Hyper-V Server

Responses

Response samples

200
401
404
500
default

Content type

application/json

[{"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"
}
]

Service Setting

getServiceSettings

Get the settings for the HyperV service

Responses

Response samples

200
500
default

Content type

application/json

[{"key": "Poll Frequency",
"value": "string",
"example": { }
}
]

updateServiceSetting

Request Body schema: application/json

Update Service Settings.

key required	string Value: "Poll Frequency"
value required	string
example	object

Responses

Request samples

Payload

Content type

application/json

{"key": "Poll Frequency",
"value": "string",
"example": { }
}

Response samples

400
500
default

Content type

application/json

{"message": "string",
"code": 100
}