Documentation Powered by ReDoc

HyperV Service (3.1.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

Authentication

bearerAuth

Security Scheme Type HTTP
HTTP Authorization Scheme bearer
Bearer format "JWT"

HyperV

getSCVMMServer

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

Authorizations:
bearerAuth
query Parameters
host_name
string

IP or host name of the SCVMM server

Responses

Response samples

Content type
application/json
[
  • {
    }
]

registerSCVMMServer

Register SCVMM server with the Hyper-V service

Authorizations:
bearerAuth
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

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

Response samples

Content type
application/json
{
  • "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.

Authorizations:
bearerAuth
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

Response samples

Content type
application/json
{
  • "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.

Authorizations:
bearerAuth
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

Request samples

Content type
application/json
{
  • "host_name": "string",
  • "username": "string",
  • "password": "string"
}

Response samples

Content type
application/json
{
  • "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

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

updateServiceSetting

Authorizations:
bearerAuth
Request Body schema: application/json

Update service settings.

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

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "message": "string",
  • "code": 100
}

Trouble Shooting

Get Execution List

Get the list of all the previous executions

Authorizations:
bearerAuth
query Parameters
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)

Responses

Response samples

Content type
application/json
{
  • "items": [
    ]
}