{"type":"api","title":"Get Configured Clusters","meta":{"id":"/apps/pubhub/media/crosswork-network-controller-7-1/f445c17e25a1120e8fbde4bd413083d0fd88b2b3/e7cf6406-31b8-3f42-91c0-19f86a4708d2","info":{"title":"Crosswork VM Node Install APIs","description":"Crosswork VM Node Install APIs allow users to add and delete nodes.","version":"3.0.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/VM_INSTALL/vm-install-overview.md"}},"swagger":"2.0","basePath":"/crosswork/platform/v1","schemes":["http","https"],"securityDefinitions":{"bearerAuth":{"type":"apiKey","name":"Authorization","in":"header","description":"Bearer token for API authentication."}}},"spec":{"description":"Get map of Clusters configured in Crosswork.","summary":"Get Configured Clusters","operationId":"CwVmMangager_GetClusters","responses":{"200":{"description":"A successful response.","schema":{"type":"object","properties":{"CwClusterAndActions":{"type":"object","additionalProperties":{"type":"object","properties":{"CwCluster":{"type":"object","properties":{"Cw_VM_Image":{"type":"string","title":"Target Cw cluster image"},"ClusterIPStack":{"type":"string","description":"Cluster IP Stack Type; IPv4 or IPv6 or DUALSTACK."},"ManagementVIP":{"type":"string","title":"Cluster Management Virtual IPv4 address"},"ManagementIPNetmask":{"type":"string","title":"Cluster Management netmask in dotted decimal"},"ManagementIPGateway":{"type":"string","title":"Cluster Management default gateway"},"DataVIP":{"type":"string","title":"Cluster Data Virtual IPv4 address"},"DataIPNetmask":{"type":"string","title":"Cluster Data netmask in dotted decimal"},"DataIPGateway":{"type":"string","title":"Cluster Data default gateway"},"DNS":{"type":"string","title":"DNS server address"},"DomainName":{"type":"string","title":"DNS Domain Name used by the cluster"},"CWPassword":{"type":"string","title":"Cluster VMs password"},"VMSize":{"type":"string","title":"Cluster VMs size profile (Small, Large or XLarge)"},"NTP":{"type":"string","title":"NTP Server address"},"ClusterHostName":{"type":"string","title":"Virtual Host name for the cluster"},"ClusterName":{"type":"string","title":"The name/id of the cluster and DC"},"ClusterVMs":{"type":"array","items":{"type":"string"},"title":"List of VMs in the cluster"},"SchemaVersion":{"type":"string","title":"The configuration schema version"},"ManagementVIPName":{"type":"string","title":"Cluster Management Virtual IP Name"},"DataVIPName":{"type":"string","title":"Cluster Data Virtual IP Name"},"EnableHardReservations":{"type":"boolean","title":"Request hard resource reservations"},"ManagerDataFsSize":{"type":"integer","format":"int32","title":"The manager/hybrid node data filesystem size"},"RamDiskSize":{"type":"integer","format":"int32","title":"The high speed ram disk size"},"BackupMinPercent":{"type":"integer","format":"int32","title":"The min percentage of datafs assigned for backup"},"LogFsSize":{"type":"integer","format":"int32","title":"Log partition size in GB"},"WorkerDataFsSize":{"type":"integer","format":"int32","title":"The worker node data filesystem size"},"ThinProvisioned":{"type":"boolean","title":"Thin or thick provisioning for all disks"},"cluster_recommendation":{"title":"Any actions to be taken at cluster level","type":"object","properties":{"recommendation":{"type":"string"},"action":{"type":"object","properties":{"action_name":{"type":"string"},"action_id":{"type":"string"}},"example":{"action_name":"Scale","action_id":"scaleAction1"},"$$ref":"#/definitions/install_apiCwAction"}},"example":{"recommendation":"Increase RAM","action":{"action_name":"Scale","action_id":"scaleAction1"}},"$$ref":"#/definitions/install_apiCwClusterRecommendation"},"K8sServiceNetwork":{"type":"string","title":"Kubernetes Service Network - Custom"},"K8sPodNetwork":{"type":"string","title":"Kubernetes Pod Network - Custom"},"Timezone":{"type":"string","title":"Timezone support"},"ManagementVIPv4":{"type":"string","title":"Cluster Management Virtual IPv4 address, in dualstack mode"},"ManagementIPv4Netmask":{"type":"string","title":"Cluster Management netmask in dotted decimal, in dualstack mode"},"ManagementIPv4Gateway":{"type":"string","title":"Cluster Management IPv4 default gateway, in dualstack mode"},"DataVIPv4":{"type":"string","title":"Cluster Data Virtual IPv4 address, in dualstack mode"},"DataIPv4Netmask":{"type":"string","title":"Cluster Data netmask in dotted decimal, in dualstack mode"},"DataIPv4Gateway":{"type":"string","title":"Cluster Data default gateway, in dualstack mode"},"DNSv4":{"type":"string","title":"DNS server IPv4 address, in dualstack mode"},"ManagementVIPv6":{"type":"string","title":"Cluster Management Virtual IPv6 address, in dualstack mode"},"ManagementIPv6Netmask":{"type":"string","title":"Cluster Management netmask in hexadecimal, in dualstack mode"},"ManagementIPv6Gateway":{"type":"string","title":"Cluster Management default gateway in IPv6, in dualstack mode"},"DataVIPv6":{"type":"string","title":"Cluster Data Virtual IPv6 address, in dualstack mode"},"DataIPv6Netmask":{"type":"string","title":"Cluster Data netmask in hexadecimal, in dualstack mode"},"DataIPv6Gateway":{"type":"string","title":"Cluster Data default gateway for IPv6, in dualstack mode"},"DNSv6":{"type":"string","title":"DNS server IPv6 address, in dualstack mode"}},"example":{"Cw_VM_Image":"ubuntu-18.04","ClusterIPStack":"DUALSTACK","ManagementVIP":"192.168.1.10","ManagementIPNetmask":"255.255.255.0","ManagementIPGateway":"192.168.1.1","DataVIP":"10.0.0.10","DataIPNetmask":"255.255.255.0","DataIPGateway":"10.0.0.1","DNS":"8.8.8.8","DomainName":"example.com","CWPassword":"securePass123","VMSize":"Large","NTP":"ntp.example.com","ClusterHostName":"clusterHost1","ClusterName":"cluster1","ClusterVMs":["vm1","vm2"],"SchemaVersion":"1.0","ManagementVIPName":"mgmtVIP","DataVIPName":"dataVIP","EnableHardReservations":true,"ManagerDataFsSize":50,"RamDiskSize":10,"BackupMinPercent":20,"LogFsSize":5,"WorkerDataFsSize":100,"ThinProvisioned":false,"cluster_recommendation":{"recommendation":"Increase RAM","action":{"action_name":"Scale","action_id":"scaleAction1"}},"K8sServiceNetwork":"172.16.0.0/16","K8sPodNetwork":"172.17.0.0/16","Timezone":"UTC","ManagementVIPv4":"192.168.2.10","ManagementIPv4Netmask":"255.255.255.0","ManagementIPv4Gateway":"192.168.2.1","DataVIPv4":"10.1.0.10","DataIPv4Netmask":"255.255.255.0","DataIPv4Gateway":"10.1.0.1","DNSv4":"8.8.4.4","ManagementVIPv6":"2001:0db8:85a3:0000:0000:8a2e:0370:7334","ManagementIPv6Netmask":"ffff:ffff:ffff:ffff::","ManagementIPv6Gateway":"2001:0db8:85a3::1","DataVIPv6":"2001:0db8:85a3:0000:0000:8a2e:0370:7334","DataIPv6Netmask":"ffff:ffff:ffff:ffff::","DataIPv6Gateway":"2001:0db8:85a3::1","DNSv6":"2001:4860:4860::8888"},"$$ref":"#/definitions/install_apiCwCluster"},"ClusterActions":{"type":"object","properties":{"Actions":{"type":"object","additionalProperties":{"type":"boolean"}}},"title":"Node Actions","example":{"Actions":{"start":true,"stop":false}},"$$ref":"#/definitions/install_apiNodeActions"}},"example":{"CwCluster":{"Cw_VM_Image":"ubuntu-18.04","ClusterIPStack":"DUALSTACK","ManagementVIP":"192.168.1.10","ManagementIPNetmask":"255.255.255.0","ManagementIPGateway":"192.168.1.1","DataVIP":"10.0.0.10","DataIPNetmask":"255.255.255.0","DataIPGateway":"10.0.0.1","DNS":"8.8.8.8","DomainName":"example.com","CWPassword":"securePass123","VMSize":"Large","NTP":"ntp.example.com","ClusterHostName":"clusterHost1","ClusterName":"cluster1","ClusterVMs":["vm1","vm2"],"SchemaVersion":"1.0","ManagementVIPName":"mgmtVIP","DataVIPName":"dataVIP","EnableHardReservations":true,"ManagerDataFsSize":50,"RamDiskSize":10,"BackupMinPercent":20,"LogFsSize":5,"WorkerDataFsSize":100,"ThinProvisioned":false,"cluster_recommendation":{"recommendation":"Increase RAM","action":{"action_name":"Scale","action_id":"scaleAction1"}},"K8sServiceNetwork":"172.16.0.0/16","K8sPodNetwork":"172.17.0.0/16","Timezone":"UTC","ManagementVIPv4":"192.168.2.10","ManagementIPv4Netmask":"255.255.255.0","ManagementIPv4Gateway":"192.168.2.1","DataVIPv4":"10.1.0.10","DataIPv4Netmask":"255.255.255.0","DataIPv4Gateway":"10.1.0.1","DNSv4":"8.8.4.4","ManagementVIPv6":"2001:0db8:85a3:0000:0000:8a2e:0370:7334","ManagementIPv6Netmask":"ffff:ffff:ffff:ffff::","ManagementIPv6Gateway":"2001:0db8:85a3::1","DataVIPv6":"2001:0db8:85a3:0000:0000:8a2e:0370:7334","DataIPv6Netmask":"ffff:ffff:ffff:ffff::","DataIPv6Gateway":"2001:0db8:85a3::1","DNSv6":"2001:4860:4860::8888"},"ClusterActions":{"Actions":{"start":true,"stop":false}}},"$$ref":"#/definitions/install_apiCwClusterAndActions"},"description":"Map is keyed by cluster id."}},"example":{"CwClusterAndActions":{"cluster1":{"CwCluster":{"Cw_VM_Image":"ubuntu-18.04","ClusterIPStack":"DUALSTACK","ManagementVIP":"192.168.1.10","ManagementIPNetmask":"255.255.255.0","ManagementIPGateway":"192.168.1.1","DataVIP":"10.0.0.10","DataIPNetmask":"255.255.255.0","DataIPGateway":"10.0.0.1","DNS":"8.8.8.8","DomainName":"example.com","CWPassword":"securePass123","VMSize":"Large","NTP":"ntp.example.com","ClusterHostName":"clusterHost1","ClusterName":"cluster1","ClusterVMs":["vm1","vm2"],"SchemaVersion":"1.0","ManagementVIPName":"mgmtVIP","DataVIPName":"dataVIP","EnableHardReservations":true,"ManagerDataFsSize":50,"RamDiskSize":10,"BackupMinPercent":20,"LogFsSize":5,"WorkerDataFsSize":100,"ThinProvisioned":false,"cluster_recommendation":{"recommendation":"Increase RAM","action":{"action_name":"Scale","action_id":"scaleAction1"}},"K8sServiceNetwork":"172.16.0.0/16","K8sPodNetwork":"172.17.0.0/16","Timezone":"UTC","ManagementVIPv4":"192.168.2.10","ManagementIPv4Netmask":"255.255.255.0","ManagementIPv4Gateway":"192.168.2.1","DataVIPv4":"10.1.0.10","DataIPv4Netmask":"255.255.255.0","DataIPv4Gateway":"10.1.0.1","DNSv4":"8.8.4.4","ManagementVIPv6":"2001:0db8:85a3:0000:0000:8a2e:0370:7334","ManagementIPv6Netmask":"ffff:ffff:ffff:ffff::","ManagementIPv6Gateway":"2001:0db8:85a3::1","DataVIPv6":"2001:0db8:85a3:0000:0000:8a2e:0370:7334","DataIPv6Netmask":"ffff:ffff:ffff:ffff::","DataIPv6Gateway":"2001:0db8:85a3::1","DNSv6":"2001:4860:4860::8888"},"ClusterActions":{"Actions":{"start":true,"stop":false}}}}},"$$ref":"#/definitions/install_apiClustersResp"}},"default":{"description":"An unexpected error response.","schema":{"type":"object","properties":{"error":{"type":"string"},"code":{"type":"integer","format":"int32"},"message":{"type":"string"},"details":{"type":"array","items":{"type":"object","properties":{"type_url":{"type":"string"},"value":{"type":"string","format":"byte"}},"example":{"type_url":"type.googleapis.com/google.protobuf.Any","value":"Error details in binary format"},"$$ref":"#/definitions/protobufAny"}}},"example":{"error":"RuntimeException","code":500,"message":"An unexpected error occurred during execution.","details":[{"type_url":"type.googleapis.com/google.protobuf.Any","value":"Error details in binary format"}]},"$$ref":"#/definitions/runtimeError"}}},"tags":["CwVmMangager"],"__originalOperationId":"CwVmMangager_GetClusters","consumes":["application/json"],"produces":["application/json"],"security":[{"bearerAuth":[]}],"method":"get","path":"/node-manager/clusters"}}