List Fabric Software Update Plan - Nexus Dashboard API, Release 4.1(1)

{"type":"api","title":"List Fabric Software Update Plan","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":"Software update plan summary details","operationId":"listFabricSoftwareUpdatePlan","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"}],"responses":{"200":{"content":{"application/json":{"examples":{"softwareUpdatePlan":{"value":{"softwareUpdateSummary":{"fabricImagePolicyName":"mypolicy1","fabricName":"vxlan","switchesToBeUpdated":1,"totalSwitches":2,"updatePlanStatus":"Yet To Start"},"tableHeaders":{"analyses":["snapshot noAnalysis fullAnalysis usePreExistingAnalysis"],"autoAssignGroups":["roleBased evenOdd"],"contingencies":["continue pause"],"executions":["parallel serial"]},"updateGroups":[{"analysis":"snapshot","contingency":"continue","estimatedTime":0,"execution":"parallel","installEndTime":"2024-07-23T10:00:00.00Z","installStartTime":"2024-07-23T10:00:00.00Z","installStatus":"success","isDisruptiveUpdate":true,"isMaintenance":true,"postUpdateAnalysis":"No warnings","postUpdateAnalysisId":"123453212","preUpdateAnalysis":"No warnings","preUpdateAnalysisId":"123453212","switchCount":1,"updateGroupName":"vxlan_N9K_leaf_Secondary","updateGroupStatus":"success","updateGroupSwitches":[{"deviceImagePolicyName":"myPolicy1","fabricName":"fab1","lastUpdateAction":"2024-07-23T10:00:00.00Z","switchId":"FDO222419B7","switchManagementIP":"10.127.117.41","switchMode":"normal","switchModel":"N9K-C9504-FM","switchName":"N9K_41","switchRole":"leaf","switchVersion":"10.3(3)","systemMode":"normal","updateStatus":"success","updateType":"disruptive","vpcPeer":"N9K-42","vpcRole":"secondary"}],"updateGroupType":"nonDisruptive","updateType":"disruptive","warnings":[{"message":"","switchName":""}]},{"analysis":"snapshot","contingency":"continue","estimatedTime":55,"execution":"parallel","installEndTime":null,"installStartTime":null,"installStatus":"ready","isDisruptiveUpdate":true,"isMaintenance":true,"postUpdateAnalysis":"Will run after software install","postUpdateAnalysisId\"":"","preUpdateAnalysis":"No warnings","preUpdateAnalysisId":"123453212","switchCount":1,"updateGroupName":"vxlan_N9K_leaf_Primary","updateGroupStatus":"stageSuccess","updateGroupSwitches":[{"deviceImagePolicyName":"myPolicy1","fabricName":"fab1","lastUpdateAction":null,"switchId":"FDO222419B7","switchManagementIP":"10.127.117.41","switchMode":"normal","switchModel":"N9K-C9504-FM","switchName":"N9K_41","switchRole":"leaf","switchVersion":"10.3(3)","systemMode":"normal","updateStatus":"stageSuccess","updateType":"none","vpcPeer":"N9K-42","vpcRole":"secondary"}],"updateGroupType":"nonDisruptive","updateType":"disruptive","warnings":[{"message":"Validation not yet completed.","switchName":"N9K-42"}]}]}}},"schema":{"description":"Update groups summary","properties":{"softwareUpdateSummary":{"description":"Software update summary","properties":{"fabricImagePolicyName":{"description":"Name of the fabric policy","example":"policy1","nullable":true,"type":"string"},"fabricName":{"description":"Name of the fabric","example":"vxlanFabric","type":"string"},"switchesToBeUpdated":{"description":"Software update pending switches count","example":2,"type":"integer"},"totalSwitches":{"description":"Total number of switches in a fabric","example":4,"type":"integer"},"updatePlanStatus":{"description":"Update group plan status","example":"Yet To Start","type":"string"}},"type":"object","$$ref":"#/components/schemas/softwareUpdateSummary"},"tableHeaders":{"description":"Table headers","properties":{"analyses":{"description":"Provide the report details to generate","items":{"description":"Provide the report details","example":"snapshot","type":"string"},"type":"array"},"autoAssignGroups":{"description":"Type of auto groups","items":{"description":"Type of auto groups","example":"roleBased","type":"string"},"type":"array"},"contingencies":{"description":"Type of contingencies","items":{"description":"Type of contingency","example":"continue","type":"string"},"type":"array"},"executions":{"description":"Type of executions","items":{"description":"Type of execution","example":"parallel","type":"string"},"type":"array"}},"type":"object","$$ref":"#/components/schemas/softwareUpdateTableHeaders"},"updateGroups":{"description":"Software update group details","items":{"description":"Software 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"},"estimatedTime":{"description":"Estimated time to update switches in the selected update group in minutes","example":30,"type":"integer"},"execution":{"description":"Type of execution","enum":["parallel","serial"],"example":"parallel","type":"string","$$ref":"#/components/schemas/execution"},"installEndTime":{"description":"Update end time","example":"2024-07-23T10:00:00.00Z","format":"date-time","nullable":true,"type":"string"},"installStartTime":{"description":"Update start time","example":"2024-07-23T10:00:00.00Z","format":"date-time","nullable":true,"type":"string"},"installStatus":{"description":"Update group results","enum":["ready","none","inProgress","success","failed"],"example":"ready","type":"string","$$ref":"#/components/schemas/softwareUpdateInstallStatus"},"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"},"postUpdateAnalysis":{"description":"Post update analysis","example":"No warning","nullable":true,"type":"string"},"postUpdateAnalysisId":{"description":"Post update analysis id","example":"12102391606816153926","nullable":true,"type":"string"},"preUpdateAnalysis":{"description":"Pre update analysis","example":"No warning","nullable":true,"type":"string"},"preUpdateAnalysisId":{"description":"Pre update analysis id","example":"12102391606816153926","nullable":true,"type":"string"},"switchCount":{"description":"List of switches in the fabric","example":4,"type":"integer"},"updateGroupName":{"description":"Update group name","example":"vxlanFabric_N9K_leaf","type":"string"},"updateGroupStatus":{"description":"Update group status","enum":["none","stageSuccess","stageFailed","validateSuccess","validateFailed","success","failed","inProgress"],"example":"stageSuccess","type":"string","$$ref":"#/components/schemas/softwareUpdateStatus"},"updateGroupSwitches":{"description":"Software update switch list","items":{"description":"Update software for switches in update group","properties":{"deviceImagePolicyName":{"description":"Name of the image policy","example":"policy1","nullable":true,"type":"string"},"fabricName":{"description":"Name of the fabric","example":"vxlanFabric","type":"string"},"lastUpdateAction":{"description":"Last update/install done from image management","example":"Never","nullable":true,"type":"string"},"switchId":{"description":"Switch serial number","example":"FDO24020ABC","type":"string"},"switchManagementIP":{"description":"IP address of switch","example":"10.127.117.79","type":"string"},"switchMode":{"description":"Switch mode","enum":["normal","maintenance","migration","inconsistent","waiting"],"example":"normal","type":"string","$$ref":"#/components/schemas/systemMode"},"switchModel":{"description":"Switch model","example":"N9K-C9504-FM","type":"string"},"switchName":{"description":"Name of device or switch","example":"N9K-42","type":"string"},"switchRole":{"type":"string","description":"The role of the switch, meta is a read-only switch role","example":"leaf","enum":["border","borderGateway","borderGatewaySpine","borderGatewaySuperSpine","borderSpine","borderSuperSpine","leaf","spine","superSpine","tier2Leaf","tor","access","aggregation","coreRouter","edgeRouter","meta","neighbor"],"$$ref":"#/components/schemas/switchRole"},"switchVersion":{"description":"Installed image version on the switch","example":"10.3(4)","type":"string"},"systemMode":{"description":"System mode","enum":["normal","maintenance","migration","inconsistent","waiting"],"example":"normal","type":"string","$$ref":"#/components/schemas/systemMode"},"updateStatus":{"description":"Device update status","enum":["none","stageSuccess","stageFailed","validateSuccess","validateFailed","success","failed","inProgress"],"example":"stageSuccess","type":"string","$$ref":"#/components/schemas/softwareUpdateStatus"},"updateType":{"description":"Installation type, disruptive or nonDisruptive","enum":["disruptive","nonDisruptive","none"],"example":"disruptive","type":"string","$$ref":"#/components/schemas/softwareUpdateType"},"vpcPeer":{"description":"VPC peer switch name","example":"N9K-42","nullable":true,"type":"string"},"vpcRole":{"description":"Vpc role","example":"none","enum":["none","primary","secondary","operationalPrimary","operationalSecondary"],"$$ref":"#/components/schemas/vpcRole"}},"type":"object","$$ref":"#/components/schemas/softwareUpdateDeviceDetails"},"type":"array"},"updateType":{"description":"Installation type, disruptive or nonDisruptive","enum":["disruptive","nonDisruptive","none"],"example":"disruptive","type":"string","$$ref":"#/components/schemas/softwareUpdateType"},"warnings":{"description":"List of warning messages","items":{"description":"Warning messages","properties":{"message":{"description":"Error description","example":"Validation not yet completed","nullable":true,"type":"string"},"switchName":{"description":"Switch name","example":"N9K-40","nullable":true,"type":"string"}},"type":"object"},"type":"array"}},"type":"object","$$ref":"#/components/schemas/softwareUpdateGroupsSummary"},"type":"array"}},"type":"object","$$ref":"#/components/schemas/softwareUpdateGroupSummary"}}},"description":"OK"},"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","observer","support-engineer","designer","approver"]}],"summary":"Software update plan summary","tags":["Fabric Software Management"],"__originalOperationId":"listFabricSoftwareUpdatePlan","method":"get","path":"/fabrics/{fabricName}/softwareUpdatePlan/summary"}}