Documentation Powered by ReDoc

HyperV Service (2.6.0)

Download OpenAPI specification:Download

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

API specification provided by the Hyper-V service from EFA

HyperV

getSCVMMServer

Get Hyper-V server details from a specified SCVMM server. The SCVMM server can be identified by IP address or host name.

query Parameters
host_name
string

IP or host name of the SCVMM server

Responses

200

OK

401

Authorization information is missing or invalid.

404

An SCVMM server with the specified IP or host name was not found.

500

Unexpected error

default

Unexpected error

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

Response samples

Content type
application/json
Copy
 Expand all Collapse all
[
  • {
    }
]

registerSCVMMServer

Register SCVMM server with the Hyper-V 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

An SCVMM server with the specified IP or host name already exists.

500

Unexpected error

default

Unexpected error

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

Request samples

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

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "host_name": "10.24.39.224",
  • "id": 1,
  • "discovery_status": "Discovered",
  • "version": "System Center 2012",
  • "vm_count": 1000,
  • "hosts":
    [
    ],
  • "virtualmachines":
    [
    ]
}

deleteSCVMMServer

Delete the specified SCVMM server from the inventory.

query Parameters
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

Responses

200

OK

401

Authorization information is missing or invalid.

404

An SCVMM server with the specified IP Address/host name was not found.

500

Unexpected error

default

Unexpected error

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

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "host_name": "10.24.39.224",
  • "id": 1,
  • "discovery_status": "Discovered",
  • "version": "System Center 2012",
  • "vm_count": 1000,
  • "hosts":
    [
    ],
  • "virtualmachines":
    [
    ]
}

updateSCVMMServer

Update the specified SCVMM server details in the inventory.

path Parameters
host_name
required
string

IP address or 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

Could not connect to the SCVMM server. Check the credentials and/or the host name.

500

Unexpected error

default

Unexpected error

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

Request samples

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

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "host_name": "10.24.39.224",
  • "id": 1,
  • "discovery_status": "Discovered",
  • "version": "System Center 2012",
  • "vm_count": 1000,
  • "hosts":
    [
    ],
  • "virtualmachines":
    [
    ]
}

Service Setting

getServiceSettings

Get the settings for the Hyper-V service

Responses

200

OK

500

Unexpected error

default

Unexpected error

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

Response samples

Content type
application/json
Copy
 Expand all Collapse all
[
  • {
    }
]

updateServiceSetting

Request Body schema: application/json

Update service settings.

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

Responses

200

OK

400

Incorrect values specified for service setting

500

Unexpected error

default

Unexpected error

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

Request samples

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

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "message": "string",
  • "code": 100
}