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

Authentication

bearerAuth

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

VCenter

getVcenter

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

Authorizations:

bearerAuth

query Parameters

host_name

string

IP/Host Name of the Vcenter

Responses

Response samples

200
401
404
500
default

Content type

application/json

[{"host_name": "10.24.39.224",
"name": "SRA VCenter Server",
"id": 1,
"discovery_status": "Discovered",
"tenant_name": "vCenter_10.24.85.166_tenant",
"version": "Vcenter 6.5",
"datacenters": [{"name": "SRA Datacenter",
"id": 1
}
],
"hosts": [{"name": "Host1",
"id": 1
}
],
"virtualmachines": [{"name": "Host1",
"guest_full_name": "Host1",
"id": 1
}
]
}
]

registerVcenter

Register Vcenter with the VCenter service

Authorizations:

bearerAuth

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"
}

Response samples

Content type

application/json

{"host_name": "10.24.39.224",
"name": "SRA VCenter Server",
"id": 1,
"discovery_status": "Discovered",
"tenant_name": "vCenter_10.24.85.166_tenant",
"version": "Vcenter 6.5",
"datacenters": [{"name": "SRA Datacenter",
"id": 1
}
],
"hosts": [{"name": "Host1",
"id": 1
}
],
"virtualmachines": [{"name": "Host1",
"guest_full_name": "Host1",
"id": 1
}
]
}

deleteVcenter

Delete the specified VCenter from the inventory.

Authorizations:

bearerAuth

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

Response samples

200
401
404
500
default

Content type

application/json

{"host_name": "10.24.39.224",
"name": "SRA VCenter Server",
"id": 1,
"discovery_status": "Discovered",
"tenant_name": "vCenter_10.24.85.166_tenant",
"version": "Vcenter 6.5",
"datacenters": [{"name": "SRA Datacenter",
"id": 1
}
],
"hosts": [{"name": "Host1",
"id": 1
}
],
"virtualmachines": [{"name": "Host1",
"guest_full_name": "Host1",
"id": 1
}
]
}

getVcenterDetails

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

Authorizations:

bearerAuth

query Parameters

host_name

string

IP/Host Name of the Vcenter

Responses

Response samples

200
401
404
500
default

Content type

application/json

{"host_name": "10.24.39.224",
"name": "SRA VCenter Server",
"id": 1,
"version": "Vcenter 6.5",
"datacenters": [{"name": "SRA Datacenter",
"id": 1,
"hosts": [{"name": "Host1",
"id": 1,
"num_cpu_cores": 12,
"memory": 34094989312,
"vms": [{"name": "Host1",
"guest_full_name": "Host1",
"id": 1,
"num_cpu_cores": 12,
"memory": 1024,
"vnics": [{"name": "Network adapter 1",
"mac_address": "00:50:56:9c:2c:b5",
"id": 1,
"port_group": "VM Network",
"port_group_vlan": "200",
"port_group_type": "VGT",
"vswitch_name": "vSwitch0",
"is_distributed_portgroup": true
}
]
}
],
"pnics": [{"name": "vmnic0",
"mac_address": "00:50:56:9c:2c:b5",
"id": 1,
"actual_link_speed": 1024,
"configured_link_speed": 1024,
"driver": "ext0",
"ipv4_address": "1.1.1.2",
"ipv6_address": "string"
}
]
}
]
}
]
}

updateVCenter

Update the specified Vcenter details in the inventory.

Authorizations:

bearerAuth

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"
}

Response samples

200
401
404
500
default

Content type

application/json

{"host_name": "10.24.39.224",
"name": "SRA VCenter Server",
"id": 1,
"discovery_status": "Discovered",
"tenant_name": "vCenter_10.24.85.166_tenant",
"version": "Vcenter 6.5",
"datacenters": [{"name": "SRA Datacenter",
"id": 1
}
],
"hosts": [{"name": "Host1",
"id": 1
}
],
"virtualmachines": [{"name": "Host1",
"guest_full_name": "Host1",
"id": 1
}
]
}

getESXiDetails

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

Authorizations:

bearerAuth

query Parameters

server_ip

string

IP/Host Name of the ESXI server

Responses

Response samples

200
401
404
500
default

Content type

application/json

{"name": "Host1",
"id": 1,
"num_cpu_cores": 12,
"memory": 34094989312,
"vms": [{"name": "Host1",
"guest_full_name": "Host1",
"id": 1,
"num_cpu_cores": 12,
"memory": 1024,
"vnics": [{"name": "Network adapter 1",
"mac_address": "00:50:56:9c:2c:b5",
"id": 1,
"port_group": "VM Network",
"port_group_vlan": "200",
"port_group_type": "VGT",
"vswitch_name": "vSwitch0",
"is_distributed_portgroup": true
}
]
}
],
"pnics": [{"name": "vmnic0",
"mac_address": "00:50:56:9c:2c:b5",
"id": 1,
"actual_link_speed": 1024,
"configured_link_speed": 1024,
"driver": "ext0",
"ipv4_address": "1.1.1.2",
"ipv6_address": "string"
}
]
}

getTenantDetails

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

Authorizations:

bearerAuth

query Parameters

host_name

string

IP/Host Name of the vCenter server

Responses

Response samples

200
401
404
500
default

Content type

application/json

{"host_name": "10.24.39.224",
"name": "SRA VCenter Server",
"id": 1,
"tenant_name": "vCenter_10.24.85.166",
"interfaces": "10.20.246.25[eth 0/11],10.20.246.26[eth 0/11],10.20.246.18[eth 0/10],10.20.246.17[eth 0/10]",
"vlans": "20,100,200-320,400",
"status": "Created Successfully",
"reason": "Conflicting ports in other tenant",
"epgs": [{"id": 1,
"tenant_id": 1,
"vcenter_id": 1,
"epg_name": "vCenter_10.24.85.166_datacenter-2_Real-DV-Switch_VM network",
"interfaces": "10.20.246.25[eth 0/11],10.20.246.26[eth 0/11],10.20.246.18[eth 0/10],10.20.246.17[eth 0/10]",
"portchannels": "po10,po11",
"switchport_mode": "Trunk",
"vlans": "20,100,200-320,400",
"status": "Created Successfully",
"reason": "Conflicting ports in other tenant"
}
]
}

Events

getVcenterEvents

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

Authorizations:

bearerAuth

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

Response samples

200
404
500
default

Content type

application/json

{"host_name": "10.24.39.224",
"name": "SRA VCenter Server",
"id": 1,
"total_count": 100,
"events": [{"description": "Completed the relocation of the virtual machine",
"event_time": "2019-08-24T14:15:22Z",
"event_number": 10000,
"target": "VM-1",
"target_type": "Virtual Machine"
}
]
}

Links

getPhysicalLinks

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

Authorizations:

bearerAuth

query Parameters

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

Responses

Response samples

200
401
404
500
default

Content type

application/json

[{"pnic_name": "vmnic2",
"pnic_mac": "40:f2:e9:bb:58:b2",
"driver": "ntg3",
"esxi_host": "10.24.85.150",
"pnic_id": 1,
"interface_name": "0/10",
"interface_type": "ethernet",
"interface_identifier": "Ethernet 0/10",
"interface_id": 1,
"portchannel": 1,
"portchannelName": "po10",
"device_ip": "10.20.246.17",
"device_id": 1,
"link_speed": 1000,
"missing": false,
"missing_time": "2019-08-24T14:15:22Z"
}
]

getVirtualLinks

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

Authorizations:

bearerAuth

query Parameters

server_ip

required

string

IP of the ESXi server

Responses

Response samples

200
401
404
500
default

Content type

application/json

[{"vnic_name": "Network adapter 1",
"vnic_mac": "40:f2:e9:bb:58:b2",
"vm_name": "Oracle_VM",
"guest_full_name": "Ubuntu Linux (64-bit)",
"memory": 1024,
"num_cpus": 2,
"port_group_name": "DPortGroup",
"vlan": "100",
"vlan_type": "EST",
"vswitch_name": "Test-DV-Switch",
"switch_id": 1,
"is_distributed_switch": true,
"lldp_enabled": true,
"lldp_operation": "Both",
"mtu": 1900
}
]

Pnics

getUnconnectedPNICs

Get the Physical NIC which are not connected to SLX devices

Authorizations:

bearerAuth

query Parameters

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

Responses

Response samples

200
401
404
500
default

Content type

application/json

[{"name": "Host1",
"id": 1,
"datacenter_name": "SRA Datacenter",
"pnics": [{"name": "vmnic0",
"mac_address": "00:50:56:9c:2c:b5",
"id": 1,
"actual_link_speed": 1024,
"configured_link_speed": 1024,
"driver": "ext0",
"ipv4_address": "1.1.1.2",
"ipv6_address": "string"
}
]
}
]

Debug

setDebug

Set Debug Level for modules.

Authorizations:

bearerAuth

query Parameters

debug_level

string

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

Responses

Response samples

401
500
default

Content type

application/json

{"message": "string",
"code": 100
}

Service Setting

getServiceSettings

Get the settings for the vCenter service

Authorizations:

bearerAuth

Responses

Response samples

200
500
default

Content type

application/json

[{"value": "value",
"key": "key"
}
]

updateServiceSetting

Authorizations:

bearerAuth

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"
}

Response samples

400
500
default

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

200
401
500
default

Content type

application/json

{"items": [{"start_time": "2000-01-23T04:56:07.000Z",
"end_time": "2000-01-23T04:56:07.000Z",
"id": "id",
"command": "client add",
"status": "client add"
},
{"start_time": "2000-01-23T04:56:07.000Z",
"end_time": "2000-01-23T04:56:07.000Z",
"id": "id",
"command": "client add",
"status": "client add"
}
]
}