Modify a cluster - Nexus Dashboard API v1, Release 4.2 and above - Cisco DevNet

{"type":"api","title":"Modify a cluster","meta":{"id":"/apps/pubhub/media/nexus-dashboard-api-v1/86cc2501c92a7370499e3d537496e5c722396afb/abd43f69-5bcb-353b-b9fa-96dd0ada6dd7","info":{"contact":{"name":"API Support","url":"https://devnetapps.cisco.com/docs/nexus-dashboard/api-v1/developer-support/"},"title":"Nexus Dashboard API","description":"APIs for platform operations on Nexus Dashboard","version":"4.2.1"},"x-parser-conf":{"overview":{"markdownPath":"reference/overview-legacy-nd.md"},"labelConfig":{"endpoint":{"field":"operationId","format":"startCase"}}},"openapi":"3.0.2","servers":[{"url":"/"}]},"spec":{"description":"Modify a cluster","parameters":[{"in":"path","name":"specName","required":true,"schema":{"minimum":1,"type":"string"}},{"in":"header","name":"X-Nd-Rbac","schema":{"type":"string"}},{"in":"header","name":"X-Aci-Username","schema":{"type":"string"}},{"in":"header","name":"X-Aci-Sessionid","schema":{"type":"string"}},{"in":"header","name":"X-Aci-Usertype","schema":{"type":"string"}},{"in":"header","name":"X-Nd-UILogin","schema":{"type":"string"}},{"in":"header","name":"X-Aci-Avpair","schema":{"type":"string"}}],"requestBody":{"content":{"application/json; charset=utf-8":{"example":{"spec":{"appNetwork":{"subnet":"1.2.3.4/16","subnetv6":""},"dnsDomain":"clustername.case.local","nameServers":["9.10.11.12"],"ntpConfig":{"keys":[{"authType":"md5","id":1,"key":"123","trusted":true}],"servers":[{"host":"1.2.3.4","keyID":1,"trusted":true}]},"proxyConfig":{"ignoreHosts":["17.18.19.20"],"password":"","servers":[{"password":"","type":"HTTP","url":"http://notareallink.local","username":""},{"password":"","type":"HTTPS","url":"https://notareallink.local","username":""}],"username":""},"searchDomains":["21.22.23.24"],"serviceNetwork":{"subnet":"5.6.7.8/16","subnetv6":""}}},"schema":{"description":"Resource that represents configuration of the cluster","properties":{"metadata":{"properties":{"annotations":{"additionalProperties":{"type":"string"},"description":"A map of string key-value pairs that are used to store arbitrary metadata.","type":"object"},"kind":{"description":"A kind to which the resource belongs to.","type":"string"},"labels":{"additionalProperties":{"type":"string"},"description":"A map of string key-value pairs that are used to categorize objects and perform label selection.","type":"object"},"org":{"description":"An organization to which the resource belongs to.","type":"string"}},"$$ref":"#/components/schemas/ManagedObjectMeta_v1_argo.cisco.com_PUT"},"spec":{"properties":{"appNetwork":{"description":"Cluster app network","properties":{"subnet":{"description":"IPv4 network address and mask","type":"string"},"subnetv6":{"description":"IPv6 network address and mask","type":"string"}},"$$ref":"#/components/schemas/ClusterSpecNetwork_v1_platform_PUT"},"displayName":{"description":"Cluster Display name","type":"string"},"dnsDomain":{"description":"DNS domain","type":"string"},"name":{"description":"Cluster name","type":"string"},"nameServers":{"description":"DNS name servers","items":{"type":"string"},"type":"array"},"networkMode":{"description":"Shows what IP protocols are configured on this cluster","enum":["SingleStack-IPV4","SingleStack-IPV6","DualStack"],"type":"string"},"ntpConfig":{"description":"NTP servers and keys","properties":{"keys":{"description":"Cluster NTP keys","items":{"description":"Cluster NTP key","properties":{"authType":{"description":"Cluster NTP server key hash type","enum":["MD5","SHA1","AES128CMAC"],"type":"string"},"id":{"description":"Cluster NTP server key ID","type":"integer"},"key":{"description":"Cluster NTP server symmetrical key","type":"string"},"trusted":{"description":"Cluster NTP server key is trusted","type":"boolean"}},"$$ref":"#/components/schemas/ClusterSpecNTPKey_v2_platform_PUT"},"type":"array"},"servers":{"description":"Cluster NTP servers","items":{"description":"Cluster NTP Server","properties":{"host":{"description":"Cluster NTP server ip/fqdn","type":"string"},"keyID":{"description":"Cluster NTP server symmetrical key ID","type":"string"},"prefer":{"description":"Cluster NTP server is preferred","type":"boolean"}},"$$ref":"#/components/schemas/ClusterSpecNTPServer_v2_platform_PUT"},"type":"array"}},"$$ref":"#/components/schemas/ClusterSpecNTPConfig_v2_platform_PUT"},"proxyConfig":{"description":"Cluster proxy config","properties":{"ignoreHosts":{"description":"Proxy ignore host list","items":{"type":"string"},"type":"array"},"password":{"description":"Cluster proxy password","type":"string"},"servers":{"description":"Proxy server list","items":{"description":"Cluster proxy server config","properties":{"password":{"description":"Proxy password","type":"string"},"type":{"description":"Proxy type","enum":["HTTP","HTTPS"],"type":"string"},"url":{"description":"Proxy url","type":"string"},"username":{"description":"Proxy username","type":"string"}},"$$ref":"#/components/schemas/ClusterSpecProxyServer_v1_platform_PUT"},"type":"array"},"username":{"description":"Cluster proxy username","type":"string"}},"$$ref":"#/components/schemas/ClusterSpecProxyConfig_v1_platform_PUT"},"searchDomains":{"description":"DNS search domains","items":{"type":"string"},"type":"array"},"serviceNetwork":{"description":"Cluster service network","properties":{"subnet":{"description":"IPv4 network address and mask","type":"string"},"subnetv6":{"description":"IPv6 network address and mask","type":"string"}},"$$ref":"#/components/schemas/ClusterSpecNetwork_v1_platform_PUT"}},"$$ref":"#/components/schemas/ClusterSpecWrapper_v2_platform_PUT"}},"required":["spec"],"$$ref":"#/components/schemas/Cluster_v2_platform_PUT"}}},"required":true},"responses":{"200":{"content":{"application/json; charset=utf-8":{"example":{"metadata":{"account":"","annotations":{"status.crd.case.cncf.io":"true"},"creationTimestamp":"2022-08-09T22:55:34Z","deletionTimestamp":"0001-01-01T00:00:00Z","finalizers":{"falcon.case.cncf.io/clusterconfig-protection":true},"generation":0,"id":"9a5f9c2c-2594-4f8b-b86d-7c4eea57c136","kind":"platform/v1.Cluster","modificationTimestamp":"0001-01-01T00:00:00Z","org":"","resourceVersion":45252,"schemaVersion":"","statusGeneration":0},"spec":{"appNetwork":{"subnet":"1.2.3.4/16","subnetv6":""},"displayName":"youCanOnlyChangeThisName","dnsDomain":"clustername.case.local","name":"clustername","nameServers":["9.10.11.12"],"ntpConfig":{"keys":[{"authType":"md5","id":1,"key":"123","trusted":true}],"servers":[{"host":"1.2.3.4","keyID":1,"trusted":true}]},"proxyConfig":{"ignoreHosts":["17.18.19.20"],"password":"","servers":[{"password":"","type":"HTTP","url":"http://notareallink.local","username":""},{"password":"","type":"HTTPS","url":"https://notareallink.local","username":""}],"username":""},"searchDomains":["21.22.23.24"],"serviceNetwork":{"subnet":"5.6.7.8/16","subnetv6":""}},"status":{"currentVersion":"2.2.2a","error":{"message":"","time":""},"targetVersion":"","uuid":"1234"}},"schema":{"description":"Resource that represents configuration of the cluster","properties":{"metadata":{"properties":{"account":{"description":"An account to which the resource belongs to.","type":"string"},"annotations":{"additionalProperties":{"type":"string"},"description":"A map of string key-value pairs that are used to store arbitrary metadata.","type":"object"},"creationTimestamp":{"description":"A timestamp at which the resource was created.","type":"string"},"deletionTimestamp":{"description":"A timestamp at which the resource has been marked for deletion.","type":"string"},"finalizers":{"additionalProperties":{"type":"boolean"},"description":"A set of entries that are interested in the deletion of the resource. This set must be empty before the resource is fully deleted from the system.","type":"object"},"generation":{"description":"A running sequence number that represents the current generation of the resource.","type":"integer"},"id":{"description":"A Unique ID associated with the resource.","type":"string"},"intraTypeID":{"type":"string"},"intraTypeIDKey":{"type":"string"},"kind":{"description":"A kind to which the resource belongs to.","type":"string"},"labels":{"additionalProperties":{"type":"string"},"description":"A map of string key-value pairs that are used to categorize objects and perform label selection.","type":"object"},"modificationTimestamp":{"description":"A timestamp at which the resource was last modified.","type":"string"},"namespace":{"description":"A namespace to which the resource belongs to. Can be empty for non-namespaced resources.","type":"string"},"org":{"description":"An organization to which the resource belongs to.","type":"string"},"resourceVersion":{"description":"A value that identifies the internal revision of the resource. This is used for optimistic concurrency control.","type":"integer"},"schemaVersion":{"description":"A value that identifies the minor revision of the resource schema.","type":"string"},"statusGeneration":{"description":"A running sequence number that represents the current generation of the status portion of the resource.","type":"integer"}},"$$ref":"#/components/schemas/ManagedObjectMeta_v1_argo.cisco.com_GET"},"spec":{"properties":{"appNetwork":{"description":"Cluster app network","properties":{"subnet":{"description":"IPv4 network address and mask","type":"string"},"subnetv6":{"description":"IPv6 network address and mask","type":"string"}},"$$ref":"#/components/schemas/ClusterSpecNetwork_v1_platform_GET"},"displayName":{"description":"Cluster Display name","type":"string"},"dnsDomain":{"description":"DNS domain","type":"string"},"name":{"description":"Cluster name","type":"string"},"nameServers":{"description":"DNS name servers","items":{"type":"string"},"type":"array"},"networkMode":{"description":"Shows what IP protocols are configured on this cluster","enum":["SingleStack-IPV4","SingleStack-IPV6","DualStack"],"type":"string"},"ntpConfig":{"description":"NTP servers and keys","properties":{"keys":{"description":"Cluster NTP keys","items":{"description":"Cluster NTP key","properties":{"authType":{"description":"Cluster NTP server key hash type","enum":["MD5","SHA1","AES128CMAC"],"type":"string"},"id":{"description":"Cluster NTP server key ID","type":"integer"},"key":{"description":"Cluster NTP server symmetrical key","type":"string"},"trusted":{"description":"Cluster NTP server key is trusted","type":"boolean"}},"$$ref":"#/components/schemas/ClusterSpecNTPKey_v2_platform_GET"},"type":"array"},"servers":{"description":"Cluster NTP servers","items":{"description":"Cluster NTP Server","properties":{"host":{"description":"Cluster NTP server ip/fqdn","type":"string"},"keyID":{"description":"Cluster NTP server symmetrical key ID","type":"string"},"prefer":{"description":"Cluster NTP server is preferred","type":"boolean"}},"$$ref":"#/components/schemas/ClusterSpecNTPServer_v2_platform_GET"},"type":"array"}},"$$ref":"#/components/schemas/ClusterSpecNTPConfig_v2_platform_GET"},"proxyConfig":{"description":"Cluster proxy config","properties":{"ignoreHosts":{"description":"Proxy ignore host list","items":{"type":"string"},"type":"array"},"password":{"description":"Cluster proxy password","type":"string"},"servers":{"description":"Proxy server list","items":{"description":"Cluster proxy server config","properties":{"password":{"description":"Proxy password","type":"string"},"type":{"description":"Proxy type","enum":["HTTP","HTTPS"],"type":"string"},"url":{"description":"Proxy url","type":"string"},"username":{"description":"Proxy username","type":"string"}},"$$ref":"#/components/schemas/ClusterSpecProxyServer_v1_platform_GET"},"type":"array"},"username":{"description":"Cluster proxy username","type":"string"}},"$$ref":"#/components/schemas/ClusterSpecProxyConfig_v1_platform_GET"},"searchDomains":{"description":"DNS search domains","items":{"type":"string"},"type":"array"},"serviceNetwork":{"description":"Cluster service network","properties":{"subnet":{"description":"IPv4 network address and mask","type":"string"},"subnetv6":{"description":"IPv6 network address and mask","type":"string"}},"$$ref":"#/components/schemas/ClusterSpecNetwork_v1_platform_GET"}},"$$ref":"#/components/schemas/ClusterSpecWrapper_v2_platform_GET"},"status":{"properties":{"currentVersion":{"description":"Cluster version","type":"string"},"error":{"description":"error is the last observed error, if any.","properties":{"message":{"description":"message is a string detailing the encountered error","type":"string"},"time":{"description":"time is the timestamp when the error was encountered.","type":"string"}},"$$ref":"#/components/schemas/ClusterStatusError_v1_platform_GET"},"state":{"description":"State of dual-stack mode in cluster","enum":["Active","MigratingToDualStack"],"type":"string"},"targetVersion":{"description":"If mid-upgrade, the version this cluster is updating to","type":"string"},"uuid":{"description":"Cluster uuid","type":"string"}},"$$ref":"#/components/schemas/ClusterStatusWrapper_v2_platform_GET"}},"required":["spec","status"],"$$ref":"#/components/schemas/Cluster_v2_platform_GET"}}},"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too Many Requests"},"500":{"description":"Internal Server Error"}},"summary":"Modify a cluster","tags":["Node Management"],"method":"put","path":"/nexus/infra/api/platform/v2/clusters/{specName}"}}