{"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 Crosswork VM Node Cluster List","type":"object","properties":{"cluster_summary":{"description":"Summary of the Crosswork VM Node Cluster","type":"object","properties":{"health_summary":{"description":"Health Summary Message","type":"object","properties":{"state":{"description":"Health State of the Cluster Component","type":"string","enum":["Healthy","Degraded","Down","NA","Unknown"],"default":"Healthy","$$ref":"#/components/schemas/clusterHealthState"},"total":{"description":"Total number of components","type":"integer","format":"int32"},"healthy":{"description":"Number of healthy components","type":"integer","format":"int32"},"degraded":{"description":"Number of degraded components","type":"integer","format":"int32"},"down":{"description":"Number of down components","type":"integer","format":"int32"},"obj_name":{"description":"Name of the object","type":"string"},"availability":{"description":"Availability status","type":"string"}},"title":"Health Summary Message","$$ref":"#/components/schemas/clusterHealthSummary"},"cluster_id":{"description":"Identifier of the Cluster","type":"string"},"crosswork_ip_model":{"description":"IP Model of the Crosswork Cluster","type":"string"}},"example":{"health_summary":{"state":"Healthy","total":1,"healthy":1,"degraded":0,"down":0,"obj_name":"","availability":"Not protected"},"cluster_id":"day0-cluster","crosswork_ip_model":"IPV4"},"title":"Summary of Crosswork VM Node Cluster","$$ref":"#/components/schemas/clusterClusterSummary"}},"example":{"cluster_summary":{"health_summary":{"state":"Healthy","total":1,"healthy":1,"degraded":0,"down":0,"obj_name":"","availability":"Not protected"},"cluster_id":"day0-cluster","crosswork_ip_model":"IPV4"}},"title":"clusterClusterListSummary","$$ref":"#/components/schemas/clusterClusterListSummary"}}