Extreme Networks Logo
Documentation Powered by ReDoc

Extreme Fabric Automation - HyperV Service APIs (2.1.0)

Download OpenAPI specification:Download

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

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

200

OK

401

Authorization information is missing or invalid.

404

A SCVMM server with the specified IP/Host Name was not found.

500

Unexpected error.

default

Unexpected error

get /hyperv
http://gohyperv-service:8087/v1/microsoft/hyperv

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

200

OK

401

Authorization information is missing or invalid.

409

A SCVMM Server with the specified IP/Host Name already exists.

500

Unexpected error.

default

Unexpected error

post /hyperv
http://gohyperv-service:8087/v1/microsoft/hyperv

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "host_name": "string",
  • "username": "string",
  • "password": "string",
  • "tenant": "string"
}

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

200

OK

401

Authorization information is missing or invalid.

404

A SCVMM Server with the specified IP Address/Host Name was not found.

500

Unexpected error.

default

Unexpected error

delete /hyperv
http://gohyperv-service:8087/v1/microsoft/hyperv

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

200

OK

401

Authorization information is missing or invalid.

404

Couldnt connect to the SCVMM Server. Check the credentials and/or host name.

500

Unexpected error.

default

Unexpected error

put /hyperv/{host_name}
http://gohyperv-service:8087/v1/microsoft/hyperv/{host_name}

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "host_name": "string",
  • "username": "string",
  • "password": "string"
}

Service Setting

updateServiceSetting

Request Body schema: application/json

Update Service Settings.

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

Responses

200

OK

400

Incorrect values specified for Service setting

500

Unexpected error.

default

Unexpected error

put /settings
http://gohyperv-service:8087/v1/microsoft/settings

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "key": "Poll Frequency",
  • "value": "string",
  • "example": null
}

getServiceSettings

Get the settings for the HyperV service

Responses

200

OK

500

Unexpected error.

default

Unexpected error

get /settings
http://gohyperv-service:8087/v1/microsoft/settings