Vcenter Serivce for GoApp (2.3.0)

Download OpenAPI specification:Download

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

This is the spec that defines the APIs provided by the vcenter service from GoApp

VCenter

getVcenter

Get only specified VCenter details. The VCenter can be identified by IP Address/HostName

query Parameters

host_name

string

IP/Host Name of the Vcenter

Responses

registerVcenter

Register Vcenter with the VCenter service

Request Body schema: application/json

Register a new VCenter.

host_name required	string
username required	string
password required	string
tenant_name required	string

Responses

Request samples

Payload

Content type

application/json


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

deleteVcenter

Delete the specified VCenter from the inventory.

query Parameters

host_name required	string IP/Host Name of the Vcenter to be deleted.
cleanup_tenants	boolean Flag to indicate whether the tenant and EPGs should be deleted on vCenter Deletion

Responses

getVcenterDetails

Get only specified VCenter details. The VCenter can be identified by IP Address/HostName

query Parameters

host_name

string

IP/Host Name of the Vcenter

Responses

updateVCenter

Update the specified Vcenter details in the inventory.

path Parameters

host_name

required

string

IP Address/Host Name of the VCenter to be updated.

Request Body schema: application/json

Update vcenter if credentials changes 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"
}

getESXiDetails

Get only specified ESXi server details. The ESXi can be identified by IP Address/HostName

query Parameters

server_ip

string

IP/Host Name of the ESXI server

Responses

getTenantDetails

Get only specified vCenter server's Tenant details. The vCenter server is identified by IP Address/HostName

query Parameters

host_name

string

IP/Host Name of the vCenter server

Responses

Events

getVcenterEvents

Get only specified VCenter events. The VCenter can be identified by IP Address/HostName

query Parameters

host_name required	string IP/Host Name of the Vcenter
page_number	integer Default: 1 Page number of the events, since we support pagination
limit	integer Default: 20 Limit the number of events to be fetched, since we support pagination

Responses

Links

getPhysicalLinks

Get the Physical NIC to Switch links for the specified Vcenter or Host

query Parameters

host_name	string IP/Host Name of the Vcenter
server_ip	string IP of the ESXi server

Responses

getVirtualLinks

Get the Virtual NIC to Port Group connections for the specified Host

query Parameters

server_ip

required

string

IP of the ESXi server

Responses

Pnics

getUnconnectedPNICs

Get the Physical NIC which are not connected to SLX devices

query Parameters

host_name	string IP/Host Name of the Vcenter
server_ip	string IP of the ESXi server

Responses

Debug

setDebug

Set Debug Level for modules.

query Parameters

debug_level

string

Set debug level. If empty reset to default level (ERROR).

Responses

Service Setting

updateServiceSetting

Request Body schema: application/json

Update Service Settings.

key required	string Enum: "Poll Frequency" "Dead Link Clearing Time"
value required	string

Responses

Request samples

Payload

Content type

application/json


{"value": "value",
"key": "key"
}

getServiceSettings

Get the settings for the vCenter service