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 |
[- {
- "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
}
]
}
]
Register Vcenter with the VCenter service
Register a new VCenter.
host_name required | string |
username required | string |
password required | string |
tenant_name required | string |
{- "host_name": "string",
- "username": "string",
- "password": "string",
- "tenant_name": "string"
}
{- "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
}
]
}
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 |
{- "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
}
]
}
Get only specified VCenter details. The VCenter can be identified by IP Address/HostName
host_name | string IP/Host Name of the Vcenter |
{- "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"
}
]
}
]
}
]
}
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 |
{- "host_name": "string",
- "username": "string",
- "password": "string"
}