clusterDCSummary - Crosswork Network Controller 7.2 APIs

{"type":"model","meta":{"id":"/apps/pubhub/media/crosswork-network-controller-7-2/76fd4bb9d069fd2530d7a02f0b3a4ca00eccfd35/aec5c4a2-bcff-3f98-bfdb-2d20859244c1","info":{"title":"Crosswork ClusterManager API","description":"ClusterManager provides API methods for managing Crosswork cluster. This includes getting cluster and node summary, getting cluster and node health information. It also provides APIs to collect showtech, rebalance cluster and set or get login banner.","version":"7.2.0","contact":{"name":"Crosswork Team, Cisco","email":"support@cisco.com"},"license":{"name":"Cisco Software License Agreement","url":"https://www.cisco.com/public/sw-license-agreement.html"}},"security":[{"bearerAuth":[]}],"x-parser-conf":{"overview":{"markdownPath":"reference/INFRA/CLUSTER/cluster-overview.md"}},"openapi":"3.0.1","servers":[{"url":"https://{cw_ip}:30603/crosswork/platform/v2","description":"Generated server url"}],"securitySchemes":{"api_key":{"description":"security definitions details","type":"apiKey","name":"Authorization","in":"header"},"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"JWT Authorization header using the Bearer scheme. Example: \"Authorization: Bearer {token}\""}}},"spec":{"description":"Summary of a Data Center in the Crosswork Cluster","type":"object","properties":{"node_summary":{"description":"Array of node summaries in the data center","type":"array","items":{"description":"Summary of Crosswork Node","type":"object","properties":{"node_name":{"description":"Name of the node","type":"string"},"node_id":{"description":"Identifier of the node","type":"string"},"node_health":{"description":"Health State of the Cluster Component","type":"string","enum":["Healthy","Degraded","Down","NA","Unknown"],"default":"Healthy","$$ref":"#/components/schemas/clusterHealthState"},"node_type":{"description":"Type of the node","type":"string"},"vm_name":{"description":"Name of the VM","type":"string"},"node_resource":{"description":"Resource Health Summary","type":"object","properties":{"cpu_summary":{"description":"Summary of Crosswork Resources","type":"object","properties":{"current_usage":{"description":"Current resource usage in percent","type":"string"},"used":{"description":"Amount of resource used","type":"string"},"total":{"description":"Total amount of resource available","type":"string"},"thresholds":{"description":"Usage Thresholds in percent for CPU, Memory or Disk\nLow : 0 - \u003c medium_range_start\nMedium : medium_range_start - \u003c high_range_start\nHigh : high_range_start - 100","type":"object","properties":{"medium_range_start":{"description":"Medium range start threshold in percent","type":"integer","format":"int32"},"high_range_start":{"description":"High range start threshold in percent","type":"integer","format":"int32"}},"title":"Usage Thresholds in percent for CPU, Memory or Disk\nLow : 0 - \u003c medium_range_start\nMedium : medium_range_start - \u003c high_range_start\nHigh : high_range_start - 100","$$ref":"#/components/schemas/clusterResourceThreshold"}},"title":"Summary of Crosswork Resources","$$ref":"#/components/schemas/clusterResourceSummary"},"memory_summary":{"description":"Summary of Crosswork Resources","type":"object","properties":{"current_usage":{"description":"Current resource usage in percent","type":"string"},"used":{"description":"Amount of resource used","type":"string"},"total":{"description":"Total amount of resource available","type":"string"},"thresholds":{"description":"Usage Thresholds in percent for CPU, Memory or Disk\nLow : 0 - \u003c medium_range_start\nMedium : medium_range_start - \u003c high_range_start\nHigh : high_range_start - 100","type":"object","properties":{"medium_range_start":{"description":"Medium range start threshold in percent","type":"integer","format":"int32"},"high_range_start":{"description":"High range start threshold in percent","type":"integer","format":"int32"}},"title":"Usage Thresholds in percent for CPU, Memory or Disk\nLow : 0 - \u003c medium_range_start\nMedium : medium_range_start - \u003c high_range_start\nHigh : high_range_start - 100","$$ref":"#/components/schemas/clusterResourceThreshold"}},"title":"Summary of Crosswork Resources","$$ref":"#/components/schemas/clusterResourceSummary"},"disk_summary":{"description":"Summary of Crosswork Resources","type":"object","properties":{"current_usage":{"description":"Current resource usage in percent","type":"string"},"used":{"description":"Amount of resource used","type":"string"},"total":{"description":"Total amount of resource available","type":"string"},"thresholds":{"description":"Usage Thresholds in percent for CPU, Memory or Disk\nLow : 0 - \u003c medium_range_start\nMedium : medium_range_start - \u003c high_range_start\nHigh : high_range_start - 100","type":"object","properties":{"medium_range_start":{"description":"Medium range start threshold in percent","type":"integer","format":"int32"},"high_range_start":{"description":"High range start threshold in percent","type":"integer","format":"int32"}},"title":"Usage Thresholds in percent for CPU, Memory or Disk\nLow : 0 - \u003c medium_range_start\nMedium : medium_range_start - \u003c high_range_start\nHigh : high_range_start - 100","$$ref":"#/components/schemas/clusterResourceThreshold"}},"title":"Summary of Crosswork Resources","$$ref":"#/components/schemas/clusterResourceSummary"},"node_cpu_summary":{"description":"Summary of Crosswork Resources","type":"object","properties":{"current_usage":{"description":"Current resource usage in percent","type":"string"},"used":{"description":"Amount of resource used","type":"string"},"total":{"description":"Total amount of resource available","type":"string"},"thresholds":{"description":"Usage Thresholds in percent for CPU, Memory or Disk\nLow : 0 - \u003c medium_range_start\nMedium : medium_range_start - \u003c high_range_start\nHigh : high_range_start - 100","type":"object","properties":{"medium_range_start":{"description":"Medium range start threshold in percent","type":"integer","format":"int32"},"high_range_start":{"description":"High range start threshold in percent","type":"integer","format":"int32"}},"title":"Usage Thresholds in percent for CPU, Memory or Disk\nLow : 0 - \u003c medium_range_start\nMedium : medium_range_start - \u003c high_range_start\nHigh : high_range_start - 100","$$ref":"#/components/schemas/clusterResourceThreshold"}},"title":"Summary of Crosswork Resources","$$ref":"#/components/schemas/clusterResourceSummary"},"node_mem_summary":{"description":"Summary of Crosswork Resources","type":"object","properties":{"current_usage":{"description":"Current resource usage in percent","type":"string"},"used":{"description":"Amount of resource used","type":"string"},"total":{"description":"Total amount of resource available","type":"string"},"thresholds":{"description":"Usage Thresholds in percent for CPU, Memory or Disk\nLow : 0 - \u003c medium_range_start\nMedium : medium_range_start - \u003c high_range_start\nHigh : high_range_start - 100","type":"object","properties":{"medium_range_start":{"description":"Medium range start threshold in percent","type":"integer","format":"int32"},"high_range_start":{"description":"High range start threshold in percent","type":"integer","format":"int32"}},"title":"Usage Thresholds in percent for CPU, Memory or Disk\nLow : 0 - \u003c medium_range_start\nMedium : medium_range_start - \u003c high_range_start\nHigh : high_range_start - 100","$$ref":"#/components/schemas/clusterResourceThreshold"}},"title":"Summary of Crosswork Resources","$$ref":"#/components/schemas/clusterResourceSummary"},"last_updated_time":{"description":"Last updated time of the resource summary","type":"string"}},"example":{"cpu_summary":{"current_usage":"38 %","used":"4.58 cores","total":"12.00 cores","thresholds":{"medium_range_start":60,"high_range_start":90}},"memory_summary":{"current_usage":"24 %","used":"23.07 GB","total":"94.29 GB","thresholds":{"medium_range_start":60,"high_range_start":90}},"disk_summary":{"current_usage":"5 %","used":"47.44 GB","total":"0.00 GB","thresholds":{"medium_range_start":60,"high_range_start":90}},"node_cpu_summary":{"current_usage":"49 %","used":"5.41 cores","total":"11.00 cores","thresholds":{"medium_range_start":98,"high_range_start":99}},"node_mem_summary":{"current_usage":"22 %","used":"21660434432.00 B","total":"97547956224.00 B","thresholds":{"medium_range_start":98,"high_range_start":99}},"last_updated_time":"Wednesday, 05-Mar-25 15:10:25 UTC"},"$$ref":"#/components/schemas/clusterResource"},"actions":{"description":"Actions that can be performed on the node","type":"object","additionalProperties":{"type":"boolean"}},"vm_state":{"description":"State of the VM","type":"string"},"vm_id":{"description":"Identifier of the VM","type":"string"},"availability":{"description":"High-Availability status of the node","type":"string"},"recommendation_available":{"description":"Indicates if a recommendation is available for the node","type":"boolean"},"vm_os_version":{"description":"Operating system version of the VM","type":"string"}},"example":{"node_name":"192-168-133-165-hybrid.cw.cisco","node_id":"192.168.133.165","node_health":"Healthy","node_type":"HYBRID","vm_name":"svm1-az1","node_resource":{"cpu_summary":{"current_usage":"39 %","used":"4.71 cores","total":"12.00 cores","thresholds":{"medium_range_start":60,"high_range_start":90}},"memory_summary":{"current_usage":"24 %","used":"23.05 GB","total":"94.29 GB","thresholds":{"medium_range_start":60,"high_range_start":90}},"disk_summary":{"current_usage":"5 %","used":"47.43 GB","total":"0.00 GB","thresholds":{"medium_range_start":60,"high_range_start":90}},"node_cpu_summary":{"current_usage":"49 %","used":"5.41 cores","total":"11.00 cores","thresholds":{"medium_range_start":98,"high_range_start":99}},"node_mem_summary":{"current_usage":"22 %","used":"21660434432.00 B","total":"97547956224.00 B","thresholds":{"medium_range_start":98,"high_range_start":99}},"last_updated_time":"Wednesday, 05-Mar-25 15:00:25 UTC"},"actions":{"cancelJob":false,"deployVM":false,"eraseVM":false,"retry":false,"viewDetails":true},"vm_state":"Running","vm_id":"0","availability":"Not protected","recommendation_available":false,"vm_os_version":"base-cw-image-v7.2.0"},"title":"Summary of Crosswork Node","$$ref":"#/components/schemas/clusterNodeSummary"}},"dc_name":{"description":"Name of the Data Center","type":"string"},"dc_id":{"description":"Identifier of the Data Center","type":"string"}},"example":{"node_summary":[{"node_name":"192-168-133-165-hybrid.cw.cisco","node_id":"192.168.133.165","node_health":"Healthy","node_type":"HYBRID","vm_name":"svm1-az1","node_resource":{"cpu_summary":{"current_usage":"39 %","used":"4.68 cores","total":"12.00 cores","thresholds":{"medium_range_start":60,"high_range_start":90}},"memory_summary":{"current_usage":"24 %","used":"22.98 GB","total":"94.29 GB","thresholds":{"medium_range_start":60,"high_range_start":90}},"disk_summary":{"current_usage":"5 %","used":"47.53 GB","total":"0.00 GB","thresholds":{"medium_range_start":60,"high_range_start":90}},"node_cpu_summary":{"current_usage":"49 %","used":"5.41 cores","total":"11.00 cores","thresholds":{"medium_range_start":98,"high_range_start":99}},"node_mem_summary":{"current_usage":"22 %","used":"21660434432.00 B","total":"97547956224.00 B","thresholds":{"medium_range_start":98,"high_range_start":99}},"last_updated_time":"Wednesday, 05-Mar-25 14:50:25 UTC"},"actions":{"cancelJob":false,"deployVM":false,"eraseVM":false,"retry":false,"viewDetails":true},"vm_state":"Running","vm_id":"0","availability":"Not protected","recommendation_available":false,"vm_os_version":"base-cw-image-v7.2.0"}],"dc_name":"DC1","dc_id":"DC1"},"title":"clusterDCSummary","$$ref":"#/components/schemas/clusterDCSummary"}}