Replace Fabric Software Update Groups - Nexus Dashboard API, Release 4.1(1)

{"type":"api","title":"Replace Fabric Software Update Groups","meta":{"id":"/apps/pubhub/media/nexus-dashboard-api-411/1d680a4cdd0fc79ff5ea7816bfd85c04c5374398/6892077b-82e7-33df-b47a-dd1fcda33552","info":{"contact":{"name":"API Support","url":"https://developer.cisco.com/docs/nexus-dashboard/4-1/developer-support/"},"description":"Manage APIs provide the ability to manage resources connected to the cluster","title":"Nexus Dashboard Manage v1","version":"1.0.130","x-nd-server-ignore":true},"x-parser-conf":{"overview":{"markdownPath":"reference-overviews/overview-manage.md"},"labelConfig":{"endpoint":{"field":"operationId","format":"startCase"}}},"openapi":"3.0.3","servers":[{"description":"Nexus Dashboard Manage APIs","url":"https://{cluster}/api/v1/manage","variables":{"cluster":{"default":"example.com","description":"The cluster URL/IP address","enum":["example.com","10.1.1.20"]}}}],"securitySchemes":{"OAuth2":{"type":"oauth2","description":"OAuth2 security scheme","flows":{"implicit":{"authorizationUrl":"https://example.com/login","scopes":{"observer":"Grants read access","fabric-admin":"Grants write access to fabric resources","support-engineer":"Primarily a role for support engineers to operate the managed resources","super-admin":"Grants access to all operations","approver":"Grants access to approve policies","designer":"Grants access to design policies"}}}},"http_signature":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"HTTP Signature security scheme"},"cookieAuth":{"type":"apiKey","description":"Cookie based authentication","in":"cookie","name":"AuthCookie"}}},"spec":{"description":"Modify update group membership and details within the switch software update plan.","operationId":"replaceFabricSoftwareUpdateGroups","parameters":[{"description":"Name of the fabric","example":"fabric1","in":"path","name":"fabricName","required":true,"schema":{"type":"string","maxLength":64,"minLength":1},"$$ref":"#/components/parameters/pathFabricName"}],"requestBody":{"content":{"application/json":{"example":{"updateGroups":[{"analysis":"snapshot","contingency":"continue","execution":"parallel","isDisruptiveUpdate":true,"isMaintenance":true,"updateGroupName":"vxlanFabric_N9K_leaf","updateGroupSwitches":["FDO24020JNK","FDO2338083P"]},{"analysis":"snapshot","contingency":"continue","execution":"parallel","isDisruptiveUpdate":true,"isMaintenance":true,"updateGroupName":"vxlanFabric_N9K_spine","updateGroupSwitches":["FDO24020JJJ","FDO23380888"]}]},"schema":{"description":"Update group details","properties":{"updateGroups":{"description":"List of update groups","items":{"description":"Update group details","properties":{"analysis":{"description":"Provide the report details to generate","enum":["snapshot","noAnalysis","fullAnalysis","usePreExistingAnalysis"],"example":"snapshot","type":"string","$$ref":"#/components/schemas/analysis"},"contingency":{"description":"Type of contingency","enum":["continue","pause"],"example":"continue","type":"string","$$ref":"#/components/schemas/contingency"},"execution":{"description":"Type of execution","enum":["parallel","serial"],"example":"parallel","type":"string","$$ref":"#/components/schemas/execution"},"isDisruptiveUpdate":{"description":"True, force disruptive update","example":true,"type":"boolean"},"isMaintenance":{"description":"True, if switch required to move Maintenance mode before start update","example":true,"type":"boolean"},"updateGroupName":{"description":"Update group name","type":"string"},"updateGroupSwitches":{"description":"Update group switch list","items":{"description":"Switch serial number","example":"FDO222419B7","type":"string"},"type":"array"}},"type":"object"},"type":"array"}},"type":"object","$$ref":"#/components/schemas/listFabricSoftwareUpdateGroups"}}},"required":true},"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request","headers":{"Date":{"description":"Date","example":"Tue, 15 Nov 1994 08:12:31 GMT","schema":{"type":"string","example":"Tue, 15 Nov 1994 08:12:31 GMT","nullable":true},"$$ref":"#/components/headers/Date"},"Cache-Control":{"description":"Cache-Control","example":"no-cache, no-store, must-revalidate","schema":{"type":"string","default":"no-cache","nullable":true},"$$ref":"#/components/headers/Cache-Control"}},"content":{"application/json":{"schema":{"description":"Error object","type":"object","properties":{"message":{"description":"The message that can be displayed to the user","type":"string"},"description":{"description":"A detailed description or suggestions on how to correct the error","type":"string"},"code":{"description":"The error code","type":"integer"},"errors":{"description":"An array of errors","type":"array","items":{"description":"Sub error object","type":"object","properties":{"message":{"description":"The message that can be displayed to the user","type":"string"},"description":{"description":"A detailed description or suggestions on how to correct the error","type":"string"},"code":{"description":"The error code","type":"integer"}},"required":["message","code","description"],"example":{"message":"Invalid email","description":"The email you provided is invalid","code":4066},"$$ref":"#/components/schemas/SubError"}}},"example":{"message":"Unauthorized","description":"You are not authorized to access this resource","code":4065},"required":["message","code","description"],"$$ref":"#/components/schemas/Error"},"example":{"message":"Bad Request","description":"The server could not understand the request due to incorrect syntax.","code":400}}},"$$ref":"#/components/responses/400"},"401":{"description":"Unauthorized","headers":{"Date":{"description":"Date","example":"Tue, 15 Nov 1994 08:12:31 GMT","schema":{"type":"string","example":"Tue, 15 Nov 1994 08:12:31 GMT","nullable":true},"$$ref":"#/components/headers/Date"},"Cache-Control":{"description":"Cache-Control","example":"no-cache, no-store, must-revalidate","schema":{"type":"string","default":"no-cache","nullable":true},"$$ref":"#/components/headers/Cache-Control"}},"content":{"application/json":{"schema":{"description":"Error object","type":"object","properties":{"message":{"description":"The message that can be displayed to the user","type":"string"},"description":{"description":"A detailed description or suggestions on how to correct the error","type":"string"},"code":{"description":"The error code","type":"integer"},"errors":{"description":"An array of errors","type":"array","items":{"description":"Sub error object","type":"object","properties":{"message":{"description":"The message that can be displayed to the user","type":"string"},"description":{"description":"A detailed description or suggestions on how to correct the error","type":"string"},"code":{"description":"The error code","type":"integer"}},"required":["message","code","description"],"example":{"message":"Invalid email","description":"The email you provided is invalid","code":4066},"$$ref":"#/components/schemas/SubError"}}},"example":{"message":"Unauthorized","description":"You are not authorized to access this resource","code":4065},"required":["message","code","description"],"$$ref":"#/components/schemas/Error"},"example":{"message":"Unauthorized","description":"Indicates that the request requires user authentication information.","code":401}}},"$$ref":"#/components/responses/401"},"404":{"description":"Not Found","headers":{"Date":{"description":"Date","example":"Tue, 15 Nov 1994 08:12:31 GMT","schema":{"type":"string","example":"Tue, 15 Nov 1994 08:12:31 GMT","nullable":true},"$$ref":"#/components/headers/Date"},"Cache-Control":{"description":"Cache-Control","example":"no-cache, no-store, must-revalidate","schema":{"type":"string","default":"no-cache","nullable":true},"$$ref":"#/components/headers/Cache-Control"}},"content":{"application/json":{"schema":{"description":"Error object","type":"object","properties":{"message":{"description":"The message that can be displayed to the user","type":"string"},"description":{"description":"A detailed description or suggestions on how to correct the error","type":"string"},"code":{"description":"The error code","type":"integer"},"errors":{"description":"An array of errors","type":"array","items":{"description":"Sub error object","type":"object","properties":{"message":{"description":"The message that can be displayed to the user","type":"string"},"description":{"description":"A detailed description or suggestions on how to correct the error","type":"string"},"code":{"description":"The error code","type":"integer"}},"required":["message","code","description"],"example":{"message":"Invalid email","description":"The email you provided is invalid","code":4066},"$$ref":"#/components/schemas/SubError"}}},"example":{"message":"Unauthorized","description":"You are not authorized to access this resource","code":4065},"required":["message","code","description"],"$$ref":"#/components/schemas/Error"},"example":{"message":"Not Found","description":"The server cannot find the requested resource.","code":404}}},"$$ref":"#/components/responses/404"},"500":{"description":"Internal Server Error","headers":{"Date":{"description":"Date","example":"Tue, 15 Nov 1994 08:12:31 GMT","schema":{"type":"string","example":"Tue, 15 Nov 1994 08:12:31 GMT","nullable":true},"$$ref":"#/components/headers/Date"},"Cache-Control":{"description":"Cache-Control","example":"no-cache, no-store, must-revalidate","schema":{"type":"string","default":"no-cache","nullable":true},"$$ref":"#/components/headers/Cache-Control"}},"content":{"application/json":{"schema":{"description":"Error object","type":"object","properties":{"message":{"description":"The message that can be displayed to the user","type":"string"},"description":{"description":"A detailed description or suggestions on how to correct the error","type":"string"},"code":{"description":"The error code","type":"integer"},"errors":{"description":"An array of errors","type":"array","items":{"description":"Sub error object","type":"object","properties":{"message":{"description":"The message that can be displayed to the user","type":"string"},"description":{"description":"A detailed description or suggestions on how to correct the error","type":"string"},"code":{"description":"The error code","type":"integer"}},"required":["message","code","description"],"example":{"message":"Invalid email","description":"The email you provided is invalid","code":4066},"$$ref":"#/components/schemas/SubError"}}},"example":{"message":"Unauthorized","description":"You are not authorized to access this resource","code":4065},"required":["message","code","description"],"$$ref":"#/components/schemas/Error"},"example":{"message":"Internal Server Error","description":"The server encountered an unexpected condition that prevented it from fulfilling the request.","code":500}}},"$$ref":"#/components/responses/500"}},"security":[{"OAuth2":["fabric-admin","super-admin"]}],"summary":"Modify switch software update groups","tags":["Fabric Software Management"],"__originalOperationId":"replaceFabricSoftwareUpdateGroups","method":"put","path":"/fabrics/{fabricName}/softwareUpdatePlan"}}