ClustersAggregateInfo
ClustersAggregateInfo
JSON Example
{
"cluster_status": {
"cluster_id": "string",
"groups": [
{
"group_id": "string",
"group_status": "string",
"group_type": "string",
"leaders": [
{
"leader_uuid": "string",
"lease_version": 0,
"service_name": "string"
}
],
"members": [
{
"member_fqdn": "string",
"member_ip": "string",
"member_ipv6": "string",
"member_status": "string",
"member_uuid": "string"
}
]
}
],
"overall_status": "string"
},
"controller_cluster": [
{
"display_name": "string",
"id": "string",
"node_interface_properties": [
{
"admin_status": "string",
"backing_nsx_managed": false,
"connected_switch": "string",
"connected_switch_type": "string",
"device": "string",
"dpu_alias": "string",
"dpu_backed": false,
"dpu_id": "string",
"driver": "string",
"ens_capable": false,
"ens_enabled": false,
"ens_interrupt_capable": false,
"ens_interrupt_enabled": false,
"host_managed": false,
"interface_alias": [
{
"broadcast_address": "string",
"ip6_address": [
"string"
],
"ip_address": "string",
"ip_configuration": "string",
"netmask": "string",
"physical_address": "string"
}
],
"interface_id": "string",
"interface_type": "string",
"interface_uuid": "string",
"key": "string",
"link_status": "string",
"lport_attachment_id": "string",
"mtu": 0,
"pci": "string",
"source": "string",
"speed": "number",
"state": "string"
}
],
"node_interface_statistics": [
{
"_links": [
{
"action": "string",
"href": "string",
"rel": "string"
}
],
"_schema": "string",
"_self": {},
"interface_id": "string",
"rx_bytes": 0,
"rx_drop_no_match": 0,
"rx_dropped": 0,
"rx_errors": 0,
"rx_frame": 0,
"rx_misses": 0,
"rx_nombufs": 0,
"rx_packets": 0,
"source": "string",
"tx_bytes": 0,
"tx_carrier": 0,
"tx_colls": 0,
"tx_dropped": 0,
"tx_drops": 0,
"tx_errors": 0,
"tx_packets": 0
}
],
"node_status": {
"control_cluster_status": {
"control_cluster_status": "string",
"mgmt_connection_status": {
"connectivity_status": "string"
}
},
"mgmt_cluster_status": {
"mgmt_cluster_status": "string"
},
"system_status": {
"cpu_cores": 0,
"cpu_sockets": 0,
"cpu_usage": {
"avg_cpu_core_usage_dpdk": "number",
"avg_cpu_core_usage_non_dpdk": "number",
"highest_cpu_core_usage_dpdk": "number",
"highest_cpu_core_usage_non_dpdk": "number"
},
"dfw_heap_memory_usage": [
{
"description": "string",
"name": "string",
"total_mb": 0,
"usage_pct": "number",
"used_mb": 0
}
],
"disk_space_total": 0,
"disk_space_used": 0,
"dpdk_cpu_cores": 0,
"dpus": [
{
"cpu_cores": 0,
"dpu_alias": "string",
"dpu_id": "string",
"load_average": [
"number"
],
"mem_cache": 0,
"mem_total": 0,
"mem_used": 0
}
],
"edge_mem_usage": {
"cache_usage": "number",
"datapath_mem_usage_details": {
"datapath_heap_usage": "number",
"datapath_mem_pools_usage": [
{
"description": "string",
"name": "string",
"usage": "number"
}
],
"highest_datapath_mem_pool_usage": "number",
"highest_datapath_mem_pool_usage_names": [
"string"
]
},
"datapath_total_usage": "number",
"swap_usage": "number",
"system_mem_usage": "number"
},
"file_systems": [
{
"file_system": "string",
"mount": "string",
"total": 0,
"type": "string",
"used": 0
}
],
"hostname": "string",
"load_average": [
"number"
],
"mem_cache": 0,
"mem_total": 0,
"mem_used": 0,
"non_dpdk_cpu_cores": 0,
"remote_logging_server_configured": false,
"source": "string",
"swap_total": 0,
"swap_used": 0,
"system_time": 0,
"uptime": 0
},
"version": "string"
},
"node_status_properties": [
{
"_links": [
{
"action": "string",
"href": "string",
"rel": "string"
}
],
"_schema": "string",
"_self": {},
"cpu_cores": 0,
"cpu_sockets": 0,
"cpu_usage": {
"avg_cpu_core_usage_dpdk": "number",
"avg_cpu_core_usage_non_dpdk": "number",
"highest_cpu_core_usage_dpdk": "number",
"highest_cpu_core_usage_non_dpdk": "number"
},
"dfw_heap_memory_usage": [
{
"description": "string",
"name": "string",
"total_mb": 0,
"usage_pct": "number",
"used_mb": 0
}
],
"disk_space_total": 0,
"disk_space_used": 0,
"dpdk_cpu_cores": 0,
"dpus": [
{
"cpu_cores": 0,
"dpu_alias": "string",
"dpu_id": "string",
"load_average": [
"number"
],
"mem_cache": 0,
"mem_total": 0,
"mem_used": 0
}
],
"edge_mem_usage": {
"cache_usage": "number",
"datapath_mem_usage_details": {
"datapath_heap_usage": "number",
"datapath_mem_pools_usage": [
{
"description": "string",
"name": "string",
"usage": "number"
}
],
"highest_datapath_mem_pool_usage": "number",
"highest_datapath_mem_pool_usage_names": [
"string"
]
},
"datapath_total_usage": "number",
"swap_usage": "number",
"system_mem_usage": "number"
},
"file_systems": [
{
"file_system": "string",
"mount": "string",
"total": 0,
"type": "string",
"used": 0
}
],
"hostname": "string",
"load_average": [
"number"
],
"mem_cache": 0,
"mem_total": 0,
"mem_used": 0,
"non_dpdk_cpu_cores": 0,
"remote_logging_server_configured": false,
"source": "string",
"swap_total": 0,
"swap_used": 0,
"system_time": 0,
"uptime": 0
}
],
"role_config": {
"control_cluster_listen_addr": {
"certificate": "string",
"certificate_sha256_thumbprint": "string",
"entities_hosted": [
{
"entity_type": "string",
"entity_uuid": "string"
}
],
"fqdn": "string",
"ip_address": "string",
"ipv6_address": "string",
"ipv6_fqdn": "string",
"port": 0,
"service_endpoint_uuid": "string"
},
"control_plane_listen_addr": {
"certificate": "string",
"certificate_sha256_thumbprint": "string",
"entities_hosted": [
{
"entity_type": "string",
"entity_uuid": "string"
}
],
"fqdn": "string",
"ip_address": "string",
"ipv6_address": "string",
"ipv6_fqdn": "string",
"port": 0,
"service_endpoint_uuid": "string"
},
"host_msg_client_info": {
"account_name": "string",
"certificate": "string",
"shared_secret": "string",
"software_version": "string"
},
"mpa_msg_client_info": {
"account_name": "string",
"certificate": "string",
"shared_secret": "string",
"software_version": "string"
}
}
}
],
"management_cluster": [
{
"display_name": "string",
"id": "string",
"node_interface_properties": [
{
"admin_status": "string",
"backing_nsx_managed": false,
"connected_switch": "string",
"connected_switch_type": "string",
"device": "string",
"dpu_alias": "string",
"dpu_backed": false,
"dpu_id": "string",
"driver": "string",
"ens_capable": false,
"ens_enabled": false,
"ens_interrupt_capable": false,
"ens_interrupt_enabled": false,
"host_managed": false,
"interface_alias": [
{
"broadcast_address": "string",
"ip6_address": [
"string"
],
"ip_address": "string",
"ip_configuration": "string",
"netmask": "string",
"physical_address": "string"
}
],
"interface_id": "string",
"interface_type": "string",
"interface_uuid": "string",
"key": "string",
"link_status": "string",
"lport_attachment_id": "string",
"mtu": 0,
"pci": "string",
"source": "string",
"speed": "number",
"state": "string"
}
],
"node_interface_statistics": [
{
"_links": [
{
"action": "string",
"href": "string",
"rel": "string"
}
],
"_schema": "string",
"_self": {},
"interface_id": "string",
"rx_bytes": 0,
"rx_drop_no_match": 0,
"rx_dropped": 0,
"rx_errors": 0,
"rx_frame": 0,
"rx_misses": 0,
"rx_nombufs": 0,
"rx_packets": 0,
"source": "string",
"tx_bytes": 0,
"tx_carrier": 0,
"tx_colls": 0,
"tx_dropped": 0,
"tx_drops": 0,
"tx_errors": 0,
"tx_packets": 0
}
],
"node_status": {
"control_cluster_status": {
"control_cluster_status": "string",
"mgmt_connection_status": {
"connectivity_status": "string"
}
},
"mgmt_cluster_status": {
"mgmt_cluster_status": "string"
},
"system_status": {
"cpu_cores": 0,
"cpu_sockets": 0,
"cpu_usage": {
"avg_cpu_core_usage_dpdk": "number",
"avg_cpu_core_usage_non_dpdk": "number",
"highest_cpu_core_usage_dpdk": "number",
"highest_cpu_core_usage_non_dpdk": "number"
},
"dfw_heap_memory_usage": [
{
"description": "string",
"name": "string",
"total_mb": 0,
"usage_pct": "number",
"used_mb": 0
}
],
"disk_space_total": 0,
"disk_space_used": 0,
"dpdk_cpu_cores": 0,
"dpus": [
{
"cpu_cores": 0,
"dpu_alias": "string",
"dpu_id": "string",
"load_average": [
"number"
],
"mem_cache": 0,
"mem_total": 0,
"mem_used": 0
}
],
"edge_mem_usage": {
"cache_usage": "number",
"datapath_mem_usage_details": {
"datapath_heap_usage": "number",
"datapath_mem_pools_usage": [
{
"description": "string",
"name": "string",
"usage": "number"
}
],
"highest_datapath_mem_pool_usage": "number",
"highest_datapath_mem_pool_usage_names": [
"string"
]
},
"datapath_total_usage": "number",
"swap_usage": "number",
"system_mem_usage": "number"
},
"file_systems": [
{
"file_system": "string",
"mount": "string",
"total": 0,
"type": "string",
"used": 0
}
],
"hostname": "string",
"load_average": [
"number"
],
"mem_cache": 0,
"mem_total": 0,
"mem_used": 0,
"non_dpdk_cpu_cores": 0,
"remote_logging_server_configured": false,
"source": "string",
"swap_total": 0,
"swap_used": 0,
"system_time": 0,
"uptime": 0
},
"version": "string"
},
"node_status_properties": [
{
"_links": [
{
"action": "string",
"href": "string",
"rel": "string"
}
],
"_schema": "string",
"_self": {},
"cpu_cores": 0,
"cpu_sockets": 0,
"cpu_usage": {
"avg_cpu_core_usage_dpdk": "number",
"avg_cpu_core_usage_non_dpdk": "number",
"highest_cpu_core_usage_dpdk": "number",
"highest_cpu_core_usage_non_dpdk": "number"
},
"dfw_heap_memory_usage": [
{
"description": "string",
"name": "string",
"total_mb": 0,
"usage_pct": "number",
"used_mb": 0
}
],
"disk_space_total": 0,
"disk_space_used": 0,
"dpdk_cpu_cores": 0,
"dpus": [
{
"cpu_cores": 0,
"dpu_alias": "string",
"dpu_id": "string",
"load_average": [
"number"
],
"mem_cache": 0,
"mem_total": 0,
"mem_used": 0
}
],
"edge_mem_usage": {
"cache_usage": "number",
"datapath_mem_usage_details": {
"datapath_heap_usage": "number",
"datapath_mem_pools_usage": [
{
"description": "string",
"name": "string",
"usage": "number"
}
],
"highest_datapath_mem_pool_usage": "number",
"highest_datapath_mem_pool_usage_names": [
"string"
]
},
"datapath_total_usage": "number",
"swap_usage": "number",
"system_mem_usage": "number"
},
"file_systems": [
{
"file_system": "string",
"mount": "string",
"total": 0,
"type": "string",
"used": 0
}
],
"hostname": "string",
"load_average": [
"number"
],
"mem_cache": 0,
"mem_total": 0,
"mem_used": 0,
"non_dpdk_cpu_cores": 0,
"remote_logging_server_configured": false,
"source": "string",
"swap_total": 0,
"swap_used": 0,
"system_time": 0,
"uptime": 0
}
],
"role_config": {
"api_listen_addr": {
"certificate": "string",
"certificate_sha256_thumbprint": "string",
"entities_hosted": [
{
"entity_type": "string",
"entity_uuid": "string"
}
],
"fqdn": "string",
"ip_address": "string",
"ipv6_address": "string",
"ipv6_fqdn": "string",
"port": 0,
"service_endpoint_uuid": "string"
},
"appliance_connection_info": {
"certificate": "string",
"certificate_sha256_thumbprint": "string",
"entities_hosted": [
{
"entity_type": "string",
"entity_uuid": "string"
}
],
"fqdn": "string",
"ip_address": "string",
"ipv6_address": "string",
"ipv6_fqdn": "string",
"port": 0,
"service_endpoint_uuid": "string"
},
"mgmt_cluster_listen_addr": {
"certificate": "string",
"certificate_sha256_thumbprint": "string",
"entities_hosted": [
{
"entity_type": "string",
"entity_uuid": "string"
}
],
"fqdn": "string",
"ip_address": "string",
"ipv6_address": "string",
"ipv6_fqdn": "string",
"port": 0,
"service_endpoint_uuid": "string"
},
"mgmt_plane_listen_addr": {
"certificate": "string",
"certificate_sha256_thumbprint": "string",
"entities_hosted": [
{
"entity_type": "string",
"entity_uuid": "string"
}
],
"fqdn": "string",
"ip_address": "string",
"ipv6_address": "string",
"ipv6_fqdn": "string",
"port": 0,
"service_endpoint_uuid": "string"
},
"mpa_msg_client_info": {
"account_name": "string",
"certificate": "string",
"shared_secret": "string",
"software_version": "string"
}
},
"transport_nodes_connected": 0
}
]
}
cluster_status
Optional
A list of the statuses of all the groups in the cluster.