Api Documentation Data Structures
{
"bind_password": "string",
"bind_user": "string",
"force_ldaps": "boolean",
"ldap_admin_user": "string",
"ldap_certificates": [
"string"
],
"ldap_group_desc_attribute": "string",
"ldap_group_filter": "string",
"ldap_group_id_attribute": "string",
"ldap_group_member_attribute": "string",
"ldap_group_name_attribute": "string",
"ldap_group_objectclass": "string",
"ldap_group_tree_dn": "string",
"ldap_search_scope": "string",
"ldap_url": "string",
"ldap_use_start_tls": "boolean",
"ldap_user_enabled_attribute": "string",
"ldap_user_filter": "string",
"ldap_user_id_attribute": "string",
"ldap_user_mail_attribute": "string",
"ldap_user_name_attribute": "string",
"ldap_user_objectclass": "string",
"ldap_user_pass_attribute": "string",
"ldap_user_tree_dn": "string"
}
attributes
bind_password
bind_user
force_ldaps
ldap_admin_user
ldap_certificates
ldap_group_desc_attribute
ldap_group_filter
ldap_group_id_attribute
ldap_group_member_attribute
ldap_group_name_attribute
ldap_group_objectclass
ldap_group_tree_dn
ldap_search_scope
ldap_url
ldap_use_start_tls
ldap_user_enabled_attribute
ldap_user_filter
ldap_user_id_attribute
ldap_user_mail_attribute
ldap_user_name_attribute
ldap_user_objectclass
ldap_user_pass_attribute
ldap_user_tree_dn
{
"name": "string"
}
attributes
name
{
"buildNumber": "string",
"instanceNum": "integer",
"name": "string",
"nodeGroups": [
{
"cpuNum": "integer",
"instanceNum": "integer",
"instances": [
{
"action": "string",
"actionFailed": "boolean",
"cpuNumber": "integer",
"errMessage": "string",
"hostName": "string",
"memory": "integer",
"moId": "string",
"name": "string",
"rack": "string",
"roles": [
"string"
],
"status": "string",
"targetSystemDs": "string",
"version": "string",
"volumes": [
"string"
]
}
],
"memCapacityMB": "integer",
"name": "string",
"networking": {
"allIpBlocks": [
{
"beginIp": "string",
"endIp": "string"
}
],
"assignedIpBlocks": [
{
"beginIp": "string",
"endIp": "string"
}
],
"dhcp": "boolean",
"dns1": "string",
"dns2": "string",
"freeIpBlocks": [
{
"beginIp": "string",
"endIp": "string"
}
],
"gateway": "string",
"ipAllocEntries": [
{
"clusterId": "integer",
"clusterName": "string",
"ipAddress": "string",
"nodeGroupId": "integer",
"nodeGroupName": "string",
"nodeId": "integer",
"nodeName": "string"
}
],
"name": "string",
"netmask": "string",
"portGroup": "string"
},
"roles": [
"string"
],
"services": [
"string"
],
"storage": {
"allocType": "string",
"controllerType": "string",
"diskstoreNamePattern": [
"string"
],
"dsNames": [
"string"
],
"dsNames4Data": [
"string"
],
"dsNames4System": [
"string"
],
"imagestoreNamePattern": [
"string"
],
"sizeGB": "integer",
"splitPolicy": "string",
"type": "string"
},
"swapRatio": "number"
}
],
"resourcePools": [
{
"nodes": [
{
"action": "string",
"actionFailed": "boolean",
"cpuNumber": "integer",
"errMessage": "string",
"hostName": "string",
"memory": "integer",
"moId": "string",
"name": "string",
"rack": "string",
"roles": [
"string"
],
"status": "string",
"targetSystemDs": "string",
"version": "string",
"volumes": [
"string"
]
}
],
"rpName": "string",
"rpVsphereName": "string",
"totalCPUInMHz": "integer",
"totalRAMInMB": "integer",
"usedCPUInMHz": "integer",
"usedRAMInMB": "integer",
"vcCluster": "string"
}
],
"status": "string",
"version": "string"
}
attributes
buildNumber
instanceNum
name
status
version
{
"deployment_type": "string",
"management_cluster": {
"moid": "string",
"name": "string"
},
"name": "string",
"network_mapping": {
"data_network": "string",
"external_network": "string",
"management_network": "string",
"metadata_network": "string"
},
"networkings": [
{
"dns1": "string",
"dns2": "string",
"gateway": "string",
"ip_blocks": [
{
"begin_ip": "string",
"end_ip": "string"
}
],
"name": "string",
"netmask": "string",
"portgroup_moref": "string",
"portgroup_name": "string"
}
],
"openstack_info": {
"availability_zones": [
{
"name": "string"
}
],
"compute": {
"compute_clusters": [
{
"availability_zone_name": "string",
"cluster_moid": "string",
"cluster_name": "string",
"datastore_regex": "string",
"esxi_netmask": "string",
"vcenter_ip": "string"
}
]
},
"identity": {
"ad_domains": [
{
"bind_password": "string",
"bind_user": "string",
"force_ldaps": "boolean",
"ldap_admin_user": "string",
"ldap_certificates": [
"string"
],
"ldap_group_desc_attribute": "string",
"ldap_group_filter": "string",
"ldap_group_id_attribute": "string",
"ldap_group_member_attribute": "string",
"ldap_group_name_attribute": "string",
"ldap_group_objectclass": "string",
"ldap_group_tree_dn": "string",
"ldap_search_scope": "string",
"ldap_url": "string",
"ldap_use_start_tls": "boolean",
"ldap_user_enabled_attribute": "string",
"ldap_user_filter": "string",
"ldap_user_id_attribute": "string",
"ldap_user_mail_attribute": "string",
"ldap_user_name_attribute": "string",
"ldap_user_objectclass": "string",
"ldap_user_pass_attribute": "string",
"ldap_user_tree_dn": "string"
}
],
"admin_project_name": "string",
"sql_domain": {
"admin_password": "string",
"admin_user": "string"
},
"token_expiration_time": "string"
},
"image": {
"datastores": [
{
"datastores": "string",
"vcenter_ip": "string"
}
],
"glance_folder": "string"
},
"network": {
"neutron_backend": "string",
"nsxv": {
"nsxv_dvs_moref": "string",
"nsxv_dvs_name": "string",
"nsxv_edge_cluster_moref": "string",
"nsxv_edge_cluster_name": "string",
"nsxv_edge_ha": "string",
"nsxv_exclusive_router_appliance_size": "string",
"nsxv_external_network_name": "string",
"nsxv_manager": "string",
"nsxv_password": "string",
"nsxv_username": "string",
"nsxv_vdn_scope_moref": "string"
},
"nsxv3": {
"nsxv3_api_managers": "string",
"nsxv3_api_password": "string",
"nsxv3_api_username": "string",
"nsxv3_default_overlay_tz": "string",
"nsxv3_default_tier0_router": "string",
"nsxv3_default_vlan_tz": "string",
"nsxv3_edge_cluster_name": "string",
"nsxv3_edge_cluster_uuid": "string",
"nsxv3_md_shared_password": "string",
"nsxv3_native_dhcp_profile": "string",
"nsxv3_native_dhcp_profile_oms_create": "string",
"nsxv3_native_md_proxy": "string",
"nsxv3_native_md_proxy_oms_create": "string"
}
},
"region_name": "string",
"syslog": {
"port": "string",
"protocol": "string",
"server": "string",
"tag": "string"
},
"vcenter_insecure": "string",
"volumn": {
"cinder_folder": "string"
}
},
"public_access": {
"public_hostname": "string",
"public_vip": "string"
},
"root_ca_certificates": [
"string"
],
"vcenters": [
{
"hostname": "string",
"password": "string",
"username": "string"
}
],
"version": "string"
}
attributes
deployment_type
name
root_ca_certificates
version
{
"availability_zone_name": "string",
"cluster_moid": "string",
"cluster_name": "string",
"datastore_regex": "string",
"esxi_netmask": "string",
"vcenter_ip": "string"
}
attributes
availability_zone_name
cluster_moid
cluster_name
datastore_regex
esxi_netmask
vcenter_ip
{
"datastores": "string",
"vcenter_ip": "string"
}
datastores
vcenter_ip
{
"ad_domains": [
{
"bind_password": "string",
"bind_user": "string",
"force_ldaps": "boolean",
"ldap_admin_user": "string",
"ldap_certificates": [
"string"
],
"ldap_group_desc_attribute": "string",
"ldap_group_filter": "string",
"ldap_group_id_attribute": "string",
"ldap_group_member_attribute": "string",
"ldap_group_name_attribute": "string",
"ldap_group_objectclass": "string",
"ldap_group_tree_dn": "string",
"ldap_search_scope": "string",
"ldap_url": "string",
"ldap_use_start_tls": "boolean",
"ldap_user_enabled_attribute": "string",
"ldap_user_filter": "string",
"ldap_user_id_attribute": "string",
"ldap_user_mail_attribute": "string",
"ldap_user_name_attribute": "string",
"ldap_user_objectclass": "string",
"ldap_user_pass_attribute": "string",
"ldap_user_tree_dn": "string"
}
],
"admin_project_name": "string",
"sql_domain": {
"admin_password": "string",
"admin_user": "string"
},
"token_expiration_time": "string"
}
{
"datastores": [
{
"datastores": "string",
"vcenter_ip": "string"
}
],
"glance_folder": "string"
}
glance_folder
{
"clusterId": "integer",
"clusterName": "string",
"ipAddress": "string",
"nodeGroupId": "integer",
"nodeGroupName": "string",
"nodeId": "integer",
"nodeName": "string"
}
clusterId
clusterName
ipAddress
nodeGroupId
nodeGroupName
nodeId
nodeName
{
"beginIp": "string",
"endIp": "string"
}
beginIp
endIp
{
"begin_ip": "string",
"end_ip": "string"
}
begin_ip
end_ip
{
"ipAddress": "string",
"networkName": "string",
"portGroupName": "string",
"trafficType": "string"
}
ipAddress
networkName
portGroupName
trafficType
{
"dns1": "string",
"dns2": "string",
"gateway": "string",
"ip_blocks": [
{
"begin_ip": "string",
"end_ip": "string"
}
],
"name": "string",
"netmask": "string",
"portgroup_moref": "string",
"portgroup_name": "string"
}
dns1
dns2
gateway
name
netmask
portgroup_moref
portgroup_name
{
"data_network": "string",
"external_network": "string",
"management_network": "string",
"metadata_network": "string"
}
data_network
external_network
management_network
metadata_network
{
"allIpBlocks": [
{
"beginIp": "string",
"endIp": "string"
}
],
"assignedIpBlocks": [
{
"beginIp": "string",
"endIp": "string"
}
],
"dhcp": "boolean",
"dns1": "string",
"dns2": "string",
"freeIpBlocks": [
{
"beginIp": "string",
"endIp": "string"
}
],
"gateway": "string",
"ipAllocEntries": [
{
"clusterId": "integer",
"clusterName": "string",
"ipAddress": "string",
"nodeGroupId": "integer",
"nodeGroupName": "string",
"nodeId": "integer",
"nodeName": "string"
}
],
"name": "string",
"netmask": "string",
"portGroup": "string"
}
dhcp
dns1
dns2
gateway
name
netmask
portGroup
{
"nsxv3_api_managers": "string",
"nsxv3_api_password": "string",
"nsxv3_api_username": "string",
"nsxv3_default_overlay_tz": "string",
"nsxv3_default_tier0_router": "string",
"nsxv3_default_vlan_tz": "string",
"nsxv3_edge_cluster_name": "string",
"nsxv3_edge_cluster_uuid": "string",
"nsxv3_md_shared_password": "string",
"nsxv3_native_dhcp_profile": "string",
"nsxv3_native_dhcp_profile_oms_create": "string",
"nsxv3_native_md_proxy": "string",
"nsxv3_native_md_proxy_oms_create": "string"
}
nsxv3_api_managers
nsxv3_api_password
nsxv3_api_username
nsxv3_default_overlay_tz
nsxv3_default_tier0_router
nsxv3_default_vlan_tz
nsxv3_edge_cluster_name
nsxv3_edge_cluster_uuid
nsxv3_md_shared_password
nsxv3_native_dhcp_profile
nsxv3_native_dhcp_profile_oms_create
nsxv3_native_md_proxy
nsxv3_native_md_proxy_oms_create
{
"nsxv_dvs_moref": "string",
"nsxv_dvs_name": "string",
"nsxv_edge_cluster_moref": "string",
"nsxv_edge_cluster_name": "string",
"nsxv_edge_ha": "string",
"nsxv_exclusive_router_appliance_size": "string",
"nsxv_external_network_name": "string",
"nsxv_manager": "string",
"nsxv_password": "string",
"nsxv_username": "string",
"nsxv_vdn_scope_moref": "string"
}
nsxv_dvs_moref
nsxv_dvs_name
nsxv_edge_cluster_moref
nsxv_edge_cluster_name
nsxv_edge_ha
nsxv_exclusive_router_appliance_size
nsxv_external_network_name
nsxv_manager
nsxv_password
nsxv_username
nsxv_vdn_scope_moref
{
"cpuNum": "integer",
"instanceNum": "integer",
"instances": [
{
"action": "string",
"actionFailed": "boolean",
"cpuNumber": "integer",
"errMessage": "string",
"hostName": "string",
"memory": "integer",
"moId": "string",
"name": "string",
"rack": "string",
"roles": [
"string"
],
"status": "string",
"targetSystemDs": "string",
"version": "string",
"volumes": [
"string"
]
}
],
"memCapacityMB": "integer",
"name": "string",
"networking": {
"allIpBlocks": [
{
"beginIp": "string",
"endIp": "string"
}
],
"assignedIpBlocks": [
{
"beginIp": "string",
"endIp": "string"
}
],
"dhcp": "boolean",
"dns1": "string",
"dns2": "string",
"freeIpBlocks": [
{
"beginIp": "string",
"endIp": "string"
}
],
"gateway": "string",
"ipAllocEntries": [
{
"clusterId": "integer",
"clusterName": "string",
"ipAddress": "string",
"nodeGroupId": "integer",
"nodeGroupName": "string",
"nodeId": "integer",
"nodeName": "string"
}
],
"name": "string",
"netmask": "string",
"portGroup": "string"
},
"roles": [
"string"
],
"services": [
"string"
],
"storage": {
"allocType": "string",
"controllerType": "string",
"diskstoreNamePattern": [
"string"
],
"dsNames": [
"string"
],
"dsNames4Data": [
"string"
],
"dsNames4System": [
"string"
],
"imagestoreNamePattern": [
"string"
],
"sizeGB": "integer",
"splitPolicy": "string",
"type": "string"
},
"swapRatio": "number"
}
attributes
cpuNum
instanceNum
memCapacityMB
name
roles
services
swapRatio
{
"action": "string",
"actionFailed": "boolean",
"cpuNumber": "integer",
"errMessage": "string",
"hostName": "string",
"memory": "integer",
"moId": "string",
"name": "string",
"rack": "string",
"roles": [
"string"
],
"status": "string",
"targetSystemDs": "string",
"version": "string",
"volumes": [
"string"
]
}
action
actionFailed
attributes
cpuNumber
errMessage
hostName
ipConfigs
memory
moId
name
rack
roles
status
targetSystemDs
version
volumes
{
"cpuNumber": "integer",
"errorMessage": "string",
"ip": "string",
"memory": "integer",
"nodeName": "string",
"status": "string",
"succeed": "boolean"
}
cpuNumber
errorMessage
ip
memory
nodeName
status
succeed
{
"compute_clusters": [
{
"availability_zone_name": "string",
"cluster_moid": "string",
"cluster_name": "string",
"datastore_regex": "string",
"esxi_netmask": "string",
"vcenter_ip": "string"
}
]
}
attributes
{
"availability_zones": [
{
"name": "string"
}
],
"compute": {
"compute_clusters": [
{
"availability_zone_name": "string",
"cluster_moid": "string",
"cluster_name": "string",
"datastore_regex": "string",
"esxi_netmask": "string",
"vcenter_ip": "string"
}
]
},
"identity": {
"ad_domains": [
{
"bind_password": "string",
"bind_user": "string",
"force_ldaps": "boolean",
"ldap_admin_user": "string",
"ldap_certificates": [
"string"
],
"ldap_group_desc_attribute": "string",
"ldap_group_filter": "string",
"ldap_group_id_attribute": "string",
"ldap_group_member_attribute": "string",
"ldap_group_name_attribute": "string",
"ldap_group_objectclass": "string",
"ldap_group_tree_dn": "string",
"ldap_search_scope": "string",
"ldap_url": "string",
"ldap_use_start_tls": "boolean",
"ldap_user_enabled_attribute": "string",
"ldap_user_filter": "string",
"ldap_user_id_attribute": "string",
"ldap_user_mail_attribute": "string",
"ldap_user_name_attribute": "string",
"ldap_user_objectclass": "string",
"ldap_user_pass_attribute": "string",
"ldap_user_tree_dn": "string"
}
],
"admin_project_name": "string",
"sql_domain": {
"admin_password": "string",
"admin_user": "string"
},
"token_expiration_time": "string"
},
"image": {
"datastores": [
{
"datastores": "string",
"vcenter_ip": "string"
}
],
"glance_folder": "string"
},
"network": {
"neutron_backend": "string",
"nsxv": {
"nsxv_dvs_moref": "string",
"nsxv_dvs_name": "string",
"nsxv_edge_cluster_moref": "string",
"nsxv_edge_cluster_name": "string",
"nsxv_edge_ha": "string",
"nsxv_exclusive_router_appliance_size": "string",
"nsxv_external_network_name": "string",
"nsxv_manager": "string",
"nsxv_password": "string",
"nsxv_username": "string",
"nsxv_vdn_scope_moref": "string"
},
"nsxv3": {
"nsxv3_api_managers": "string",
"nsxv3_api_password": "string",
"nsxv3_api_username": "string",
"nsxv3_default_overlay_tz": "string",
"nsxv3_default_tier0_router": "string",
"nsxv3_default_vlan_tz": "string",
"nsxv3_edge_cluster_name": "string",
"nsxv3_edge_cluster_uuid": "string",
"nsxv3_md_shared_password": "string",
"nsxv3_native_dhcp_profile": "string",
"nsxv3_native_dhcp_profile_oms_create": "string",
"nsxv3_native_md_proxy": "string",
"nsxv3_native_md_proxy_oms_create": "string"
}
},
"region_name": "string",
"syslog": {
"port": "string",
"protocol": "string",
"server": "string",
"tag": "string"
},
"vcenter_insecure": "string",
"volumn": {
"cinder_folder": "string"
}
}
attributes
region_name
vcenter_insecure
{
"neutron_backend": "string",
"nsxv": {
"nsxv_dvs_moref": "string",
"nsxv_dvs_name": "string",
"nsxv_edge_cluster_moref": "string",
"nsxv_edge_cluster_name": "string",
"nsxv_edge_ha": "string",
"nsxv_exclusive_router_appliance_size": "string",
"nsxv_external_network_name": "string",
"nsxv_manager": "string",
"nsxv_password": "string",
"nsxv_username": "string",
"nsxv_vdn_scope_moref": "string"
},
"nsxv3": {
"nsxv3_api_managers": "string",
"nsxv3_api_password": "string",
"nsxv3_api_username": "string",
"nsxv3_default_overlay_tz": "string",
"nsxv3_default_tier0_router": "string",
"nsxv3_default_vlan_tz": "string",
"nsxv3_edge_cluster_name": "string",
"nsxv3_edge_cluster_uuid": "string",
"nsxv3_md_shared_password": "string",
"nsxv3_native_dhcp_profile": "string",
"nsxv3_native_dhcp_profile_oms_create": "string",
"nsxv3_native_md_proxy": "string",
"nsxv3_native_md_proxy_oms_create": "string"
}
}
attributes
neutron_backend
{
"public_hostname": "string",
"public_vip": "string"
}
public_hostname
public_vip
{
"public_vip": "string"
}
public_vip
{
"nodes": [
{
"action": "string",
"actionFailed": "boolean",
"cpuNumber": "integer",
"errMessage": "string",
"hostName": "string",
"memory": "integer",
"moId": "string",
"name": "string",
"rack": "string",
"roles": [
"string"
],
"status": "string",
"targetSystemDs": "string",
"version": "string",
"volumes": [
"string"
]
}
],
"rpName": "string",
"rpVsphereName": "string",
"totalCPUInMHz": "integer",
"totalRAMInMB": "integer",
"usedCPUInMHz": "integer",
"usedRAMInMB": "integer",
"vcCluster": "string"
}
rpName
rpVsphereName
totalCPUInMHz
totalRAMInMB
usedCPUInMHz
usedRAMInMB
vcCluster
{
"admin_password": "string",
"admin_user": "string"
}
admin_password
admin_user
attributes
{
"allocType": "string",
"controllerType": "string",
"diskstoreNamePattern": [
"string"
],
"dsNames": [
"string"
],
"dsNames4Data": [
"string"
],
"dsNames4System": [
"string"
],
"imagestoreNamePattern": [
"string"
],
"sizeGB": "integer",
"splitPolicy": "string",
"type": "string"
}
allocType
controllerType
diskstoreNamePattern
dsNames
dsNames4Data
dsNames4System
imagestoreNamePattern
sizeGB
splitPolicy
type
{
"clusterName": "string",
"collectRecentLogsOnly": "boolean",
"services": [
"string"
]
}
clusterName
collectRecentLogsOnly
services
{
"port": "string",
"protocol": "string",
"server": "string",
"tag": "string"
}
port
protocol
server
tag
{
"task_id": "integer",
"task_url": "string"
}
task_id
task_url
{
"errorKey": "string",
"errorMessage": "string",
"errorParam": "string",
"failNodes": [
{
"cpuNumber": "integer",
"errorMessage": "string",
"ip": "string",
"memory": "integer",
"nodeName": "string",
"status": "string",
"succeed": "boolean"
}
],
"id": "integer",
"progress": "number",
"progressMessage": "string",
"status": "string",
"succeedNodes": [
{
"cpuNumber": "integer",
"errorMessage": "string",
"ip": "string",
"memory": "integer",
"nodeName": "string",
"status": "string",
"succeed": "boolean"
}
],
"target": "string",
"type": "string",
"workDir": "string"
}
errorKey
errorMessage
errorParam
id
progress
progressMessage
status
target
type
workDir
{
"moid": "string",
"name": "string"
}
moid
name
{
"hostname": "string",
"management": "boolean",
"password": "string",
"port": "integer",
"thumbprint": "string",
"username": "string",
"uuid": "string"
}
hostname
management
password
port
thumbprint
username
uuid
{
"hostname": "string",
"password": "string",
"username": "string"
}
attributes
hostname
password
username
{
"cinder_folder": "string"
}
attributes
cinder_folder