Vcenter Service (2.7.0)

Download OpenAPI specification:Download

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

Response samples

Content type
application/json
[
  • {
    }
]

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

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": [
    ],
  • "hosts": [
    ],
  • "virtualmachines": [
    ]
}

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

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": [
    ],
  • "hosts": [
    ],
  • "virtualmachines": [
    ]
}

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

Response samples

Content type
application/json
{
  • "host_name": "10.24.39.224",
  • "name": "SRA VCenter Server",
  • "id": 1,
  • "version": "Vcenter 6.5",
  • "datacenters": [
    ]
}

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

Content type
application/json
{
  • "host_name": "string",
  • "username": "string",
  • "password": "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": [
    ],
  • "hosts": [
    ],
  • "virtualmachines": [
    ]
}

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

Response samples

Content type
application/json
{
  • "name": "Host1",
  • "id": 1,
  • "num_cpu_cores": 12,
  • "memory": 34094989312,
  • "vms": [
    ],
  • "pnics": [
    ]
}

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

Response samples

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": [
    ]
}

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

Response samples

Content type
application/json
{
  • "host_name": "10.24.39.224",
  • "name": "SRA VCenter Server",
  • "id": 1,
  • "total_count": 100,
  • "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

Response samples

Content type
application/json
[
  • {
    }
]

Debug

setDebug

Set Debug Level for modules.

query Parameters
debug_level
string

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

Responses

Response samples

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

Service Setting

getServiceSettings

Get the settings for the vCenter service

Responses

Response samples

Content type
application/json
[
  • {
    }
]

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

Content type
application/json
{
  • "value": "value",
  • "key": "key"
}

Response samples

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