{"type":"model","meta":{"id":"/apps/pubhub/media/crosswork-network-controller-7-1/f445c17e25a1120e8fbde4bd413083d0fd88b2b3/6caa8081-e6ba-312b-ae5a-89988569dbc0","info":{"title":"Crosswork Workflow Manager Solutions - Fleetupgrade","description":"Software Conformance in the Fleetupgrade application helps users identify network devices that don't meet required software image policies. Users can create image policy from the Image repository to suit device functions or locations. These policy act as benchmarks for verifying software compliance, ensuring devices run the appropriate software. Verification can be done once or regularly, and non-compliant devices can be upgraded to meet the policy standards.\nFleetupgrade SoftwareUpdate facilitates automated upgrade installations, allowing you to choose the Method of Procedure (MOP) for your installation. Additionally, you can customize execution variables such as the job name and execution schedule. CWMS Fleetupgrade offers prebuilt MOPs to efficiently carry out all upgrade tasks.","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"},"version":"7.1.0"},"x-parser-conf":{"overview":{"markdownPath":"reference/CWM-SOLUTIONS/fleetupgrade-api.overview.md"}},"openapi":"3.0.1","servers":[{"url":"https://crosswork-ip:30603/crosswork/cwms/fleetupgrade/v1"}],"securitySchemes":{"Bearer":{"type":"apiKey","description":"Type \"Bearer\" followed by a space and JWT token.","name":"Authorization","in":"header"}}},"spec":{"required":["deviceUuid","jobName","mopId","productSeries","softwareImages","vendor"],"type":"object","properties":{"batchSize":{"type":"integer","description":"BatchSize is the size of the batch for the parallel upgrade.","example":1},"deviceUuid":{"type":"array","description":"DeviceUuid is a list of device UUIDs to be upgraded.","example":["714af8ac-0c68-43bc-b51d-3788d89fa4ff"],"items":{"type":"string"}},"errorBudget":{"type":"integer","description":"ErrorBudget is the allowable error budget for the job.","example":1},"jobName":{"type":"string","description":"JobName is the name of the job. This field is required and must follow specific naming rules.","example":"Fleet Upgrade Job"},"jobTags":{"type":"array","description":"JobTags are tags associated with the job.","example":["upgrade","fleet"],"items":{"type":"string"}},"mop":{"type":"string","description":"Mop is the Method of Procedure for the job. This field is optional.","example":"XR Upgrade"},"mopId":{"type":"integer","description":"MopId is the ID of the mop workflow.","example":1},"productSeries":{"type":"string","description":"ProductSeries is the series of the device.","example":"Cisco 8000 Series Routers"},"scheduleCalendars":{"type":"array","description":"ScheduleCalendars defines the schedule for the job.","items":{"type":"object","properties":{"dayOfMonth":{"type":"array","description":"DayOfMonth defines the time range for days of the month.","items":{"type":"object","properties":{"end":{"type":"integer","description":"End is the ending value of the time range.","example":1},"start":{"type":"integer","description":"Start is the starting value of the time range.","example":1},"step":{"type":"integer","description":"Step is the step value for the time range.","example":1}},"description":"TimeRange represents a range of time with a start, end, and step. This struct is used to define the time ranges for scheduling.","$$ref":"#/components/schemas/models.TimeRange"}},"dayOfWeek":{"type":"array","description":"DayOfWeek defines the time range for days of the week.","items":{"type":"object","properties":{"end":{"type":"integer","description":"End is the ending value of the time range.","example":1},"start":{"type":"integer","description":"Start is the starting value of the time range.","example":1},"step":{"type":"integer","description":"Step is the step value for the time range.","example":1}},"description":"TimeRange represents a range of time with a start, end, and step. This struct is used to define the time ranges for scheduling.","$$ref":"#/components/schemas/models.TimeRange"}},"hour":{"type":"array","description":"Hour defines the time range for hours.","items":{"type":"object","properties":{"end":{"type":"integer","description":"End is the ending value of the time range.","example":1},"start":{"type":"integer","description":"Start is the starting value of the time range.","example":1},"step":{"type":"integer","description":"Step is the step value for the time range.","example":1}},"description":"TimeRange represents a range of time with a start, end, and step. This struct is used to define the time ranges for scheduling.","$$ref":"#/components/schemas/models.TimeRange"}},"minute":{"type":"array","description":"Minute defines the time range for minutes.","items":{"type":"object","properties":{"end":{"type":"integer","description":"End is the ending value of the time range.","example":1},"start":{"type":"integer","description":"Start is the starting value of the time range.","example":1},"step":{"type":"integer","description":"Step is the step value for the time range.","example":1}},"description":"TimeRange represents a range of time with a start, end, and step. This struct is used to define the time ranges for scheduling.","$$ref":"#/components/schemas/models.TimeRange"}},"month":{"type":"array","description":"Month defines the time range for months.","items":{"type":"object","properties":{"end":{"type":"integer","description":"End is the ending value of the time range.","example":1},"start":{"type":"integer","description":"Start is the starting value of the time range.","example":1},"step":{"type":"integer","description":"Step is the step value for the time range.","example":1}},"description":"TimeRange represents a range of time with a start, end, and step. This struct is used to define the time ranges for scheduling.","$$ref":"#/components/schemas/models.TimeRange"}},"second":{"type":"array","description":"Second defines the time range for seconds.","items":{"type":"object","properties":{"end":{"type":"integer","description":"End is the ending value of the time range.","example":1},"start":{"type":"integer","description":"Start is the starting value of the time range.","example":1},"step":{"type":"integer","description":"Step is the step value for the time range.","example":1}},"description":"TimeRange represents a range of time with a start, end, and step. This struct is used to define the time ranges for scheduling.","$$ref":"#/components/schemas/models.TimeRange"}},"year":{"type":"array","description":"Year defines the time range for years.","items":{"type":"object","properties":{"end":{"type":"integer","description":"End is the ending value of the time range.","example":1},"start":{"type":"integer","description":"Start is the starting value of the time range.","example":1},"step":{"type":"integer","description":"Step is the step value for the time range.","example":1}},"description":"TimeRange represents a range of time with a start, end, and step. This struct is used to define the time ranges for scheduling.","$$ref":"#/components/schemas/models.TimeRange"}}},"description":"ScheduleCalendar represents the schedule for the report. This struct is used to define the time ranges for scheduling.","$$ref":"#/components/schemas/models.ScheduleCalendar"}},"softwareImages":{"type":"array","description":"SoftwareImages is a list of software images to be used in the device upgrade.","example":["image1.iso"],"items":{"type":"string"}},"timeZoneName":{"type":"string","description":"TimeZoneName is the name of the time zone associated with the report.","example":"America/New_York"},"vendor":{"type":"string","description":"Vendor is the name of the vendor.","example":"Cisco Systems"}},"description":"FleetJob represents a job for upgrading a fleet of devices. This struct is used to define the job details and parameters.","$$ref":"#/components/schemas/models.FleetJob","title":"models.FleetJob"}}