Download OpenAPI specification:Download
This is the spec that defines the APIs provided by the vcenter service from GoApp
Get only specified VCenter details. The VCenter can be identified by IP Address/HostName
host_name | string IP/Host Name of the Vcenter |
OK
Authorization information is missing or invalid.
A Vcenter with the specified IP/Host Name was not found.
Unexpected error.
Unexpected error
Register Vcenter with the VCenter service
Register a new VCenter.
host_name required | string |
username required | string |
password required | string |
tenant_name required | string |
OK
Authorization information is missing or invalid.
A Vcenter with the specified IP/Host Name already exists.
Tenant with the specified name doesnt exist.
Unexpected error.
Unexpected error
{- "host_name": "string",
- "username": "string",
- "password": "string",
- "tenant_name": "string"
}
Delete the specified VCenter from the inventory.
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 |
OK
Authorization information is missing or invalid.
A Vcenter with the specified IP Address/Host Name was not found.
Unexpected error.
Unexpected error
Get only specified VCenter details. The VCenter can be identified by IP Address/HostName
host_name | string IP/Host Name of the Vcenter |
OK
Authorization information is missing or invalid.
A Vcenter with the specified IP/Host Name was not found.
Unexpected error.
Unexpected error
Update the specified Vcenter details in the inventory.
host_name required | string IP Address/Host Name of the VCenter to be updated. |
Update vcenter if credentials changes provide new username and password
host_name required | string |
username | string |
password | string |
OK
Authorization information is missing or invalid.
Couldnt connect to the VCenter. Check the credentials and/or host name.
Unexpected error.
Unexpected error
{- "host_name": "string",
- "username": "string",
- "password": "string"
}
Get only specified ESXi server details. The ESXi can be identified by IP Address/HostName
server_ip | string IP/Host Name of the ESXI server |
OK
Authorization information is missing or invalid.
A Vcenter with the specified IP/Host Name was not found.
Unexpected error.
Unexpected error
Get only specified vCenter server's Tenant details. The vCenter server is identified by IP Address/HostName
host_name | string IP/Host Name of the vCenter server |
OK
Authorization information is missing or invalid.
A Vcenter with the specified IP/Host Name was not found.
Unexpected error.
Unexpected error
Get only specified VCenter events. The VCenter can be identified by IP Address/HostName
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 |
OK
A Vcenter or Server with the specified IP/Host Name was not found.
Unexpected error.
Unexpected error
Get the Physical NIC to Switch links for the specified Vcenter or Host
host_name | string IP/Host Name of the Vcenter |
server_ip | string IP of the ESXi server |
OK
Authorization information is missing or invalid.
A Vcenter or Server with the specified IP/Host Name was not found.
Unexpected error.
Unexpected error
Get the Virtual NIC to Port Group connections for the specified Host
server_ip required | string IP of the ESXi server |
OK
Authorization information is missing or invalid.
A Server with the specified IP/Host Name was not found.
Unexpected error.
Unexpected error
Get the Physical NIC which are not connected to SLX devices
host_name | string IP/Host Name of the Vcenter |
server_ip | string IP of the ESXi server |
OK
Authorization information is missing or invalid.
A Vcenter or Server with the specified IP/Host Name was not found.
Unexpected error.
Unexpected error
Set Debug Level for modules.
debug_level | string Set debug level. If empty reset to default level (ERROR). |
OK
Authorization information is missing or invalid.
Unexpected error.
Unexpected error
Update Service Settings.
key required | string Enum: "Poll Frequency" "Dead Link Clearing Time" |
value required | string |
OK
Incorrect values specified for Service setting
Unexpected error.
Unexpected error
{- "value": "value",
- "key": "key"
}