Documentation Powered by ReDoc

Vcenter Serivce for GoApp (2.2.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

200

OK

401

Authorization information is missing or invalid.

404

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

500

Unexpected error.

default

Unexpected error

get/vcenter
http://govcenter-service:8086/v1/vmware/vcenter

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

200

OK

401

Authorization information is missing or invalid.

409

A Vcenter with the specified IP/Host Name already exists.

412

Tenant with the specified name doesnt exist.

500

Unexpected error.

default

Unexpected error

post/vcenter
http://govcenter-service:8086/v1/vmware/vcenter

Request samples

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

200

OK

401

Authorization information is missing or invalid.

404

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

500

Unexpected error.

default

Unexpected error

delete/vcenter
http://govcenter-service:8086/v1/vmware/vcenter

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

200

OK

401

Authorization information is missing or invalid.

404

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

500

Unexpected error.

default

Unexpected error

get/vcenter/details
http://govcenter-service:8086/v1/vmware/vcenter/details

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

200

OK

401

Authorization information is missing or invalid.

404

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

500

Unexpected error.

default

Unexpected error

put/vcenter/{host_name}
http://govcenter-service:8086/v1/vmware/vcenter/{host_name}

Request samples

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

200

OK

401

Authorization information is missing or invalid.

404

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

500

Unexpected error.

default

Unexpected error

get/vcenter/host/details
http://govcenter-service:8086/v1/vmware/vcenter/host/details

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

200

OK

401

Authorization information is missing or invalid.

404

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

500

Unexpected error.

default

Unexpected error

get/vcenter/tenant
http://govcenter-service:8086/v1/vmware/vcenter/tenant

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

200

OK

404

A Vcenter or Server with the specified IP/Host Name was not found.

500

Unexpected error.

default

Unexpected error

get/events
http://govcenter-service:8086/v1/vmware/events

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

200

OK

401

Authorization information is missing or invalid.

404

A Vcenter or Server with the specified IP/Host Name was not found.

500

Unexpected error.

default

Unexpected error

get/pnics/disconnected
http://govcenter-service:8086/v1/vmware/pnics/disconnected

Debug

setDebug

Set Debug Level for modules.

query Parameters
debug_level
string

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

Responses

200

OK

401

Authorization information is missing or invalid.

500

Unexpected error.

default

Unexpected error

post/debug
http://govcenter-service:8086/v1/vmware/debug

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

200

OK

400

Incorrect values specified for Service setting

500

Unexpected error.

default

Unexpected error

put/settings
http://govcenter-service:8086/v1/vmware/settings

Request samples

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

getServiceSettings

Get the settings for the vCenter service

Responses

200

OK

500

Unexpected error.

default

Unexpected error

get/settings
http://govcenter-service:8086/v1/vmware/settings