Copy Software Image to a Device - Crosswork Network Controller 7.1 APIs

{"type":"api","title":"Copy Software Image to a Device","meta":{"id":"/apps/pubhub/media/crosswork-network-controller-7-1/f445c17e25a1120e8fbde4bd413083d0fd88b2b3/6a2ef59a-ba2d-3415-a824-195345c9d1ae","info":{"contact":{"email":"support@cisco.com","name":"Crosswork Team, Cisco"},"description":"Software Images APIs allow the user to perform CRUD operations on SWIM service.","license":{"name":"Cisco Software License Agreement","url":"http://www.cisco.com/public/sw-license-agreement.html"},"title":"APIs exposed by SWIM service","version":"1.0.0"},"x-parser-conf":{"overview":{"markdownPath":"reference/EMF/swim-api-overview.md"}},"openapi":"3.0.0","servers":[{"url":"https://{server_ip}:30603/crosswork/swim/{version}","variables":{"version":{"description":"API version","default":"v1"}}}]},"spec":{"responses":{"200":{"content":{"application/json":{"schema":{"description":"Swim job result DTO wrapper","example":{"swimJobResultDTO":{"jobId":"445446","jobStatus":"Image activation scheduled successfully."}},"properties":{"swimJobResultDTO":{"description":"Swim job result DTO","properties":{"jobId":{"description":"Job Id","type":"string"},"jobStatus":{"description":"Job status","type":"string"}},"type":"object","$$ref":"#/components/schemas/SwimJobResultDTO"}},"type":"object","$$ref":"#/components/schemas/SwimJobResultDTOWrapper"}}},"description":"OK"},"400":{"description":"Bad Request - Invalid request"},"500":{"description":"Internal Server Error - operation-failed"}},"tags":["Operation APIs"],"operationId":"distribute_1","requestBody":{"content":{"application/json":{"schema":{"description":"Software image distribution DTO wrapper","properties":{"softwareImageDistributionDTO":{"description":"Software image distribution DTO","properties":{"activeImage":{"description":"activeImage","example":false,"type":"boolean"},"allowRevertorDowngrade":{"description":"Allow revert or downgrade","example":false,"type":"boolean"},"applyTo":{"description":"Apply to","example":"","type":"string"},"backupCurrentImage":{"description":"Backup current image","example":false,"type":"boolean"},"ccoPassword":{"description":"CCO password","example":"","type":"string"},"ccoUserName":{"description":"CCO userName","example":"","type":"string"},"cleanRepository":{"description":"Clean repository","example":false,"type":"boolean"},"commit":{"description":"Confirms the packages that were previously activated","example":false,"type":"boolean"},"continueOnFailure":{"description":"Continue on failure","example":true,"type":"boolean"},"deviceImgLocList":{"description":"Device image location list","example":[{"currentReleaseToRetry":"","deviceId":"111111","deviceIp":"10.104.120.20","deviceType":"","encryptionSoftwareIndicator":"","externalServerIpaddress":"Local File Server","imageGUID":"","imageSize":100000,"imgName":"ncs4k-mgbl.pkg-6.5.29","langSelected":"","location":"disk1:","md5CheckSum":"","mdfID":"","metaTransactionId":"","softwareTypeIdToRetry":"","udi":""}],"items":{"description":"Device image location DTO","required":["deviceIp"],"properties":{"currentReleaseToRetry":{"description":"Current release to retry","type":"string"},"deviceId":{"description":"Device Id","type":"string"},"deviceIp":{"description":"Device IP","type":"string"},"deviceType":{"description":"Device type","type":"string"},"encryptionSoftwareIndicator":{"description":"Encryption software indicator","type":"string"},"externalServerIpaddress":{"description":"External server IP address","type":"string"},"imageGUID":{"description":"Image GUID","type":"string"},"imageSize":{"description":"Image size","format":"int64","type":"integer"},"imgName":{"description":"Image name","type":"string"},"langSelected":{"description":"Language selected","type":"string"},"location":{"description":"Device location","example":"bootflash / harddisk: / disk1:","type":"string"},"md5CheckSum":{"description":"Md5 checksum","type":"string"},"mdfID":{"description":"MDF ID","type":"string"},"metaTransactionId":{"description":"Meta Transaction Id","type":"string"},"softwareTypeIdToRetry":{"description":"Software type ID to retry","type":"string"},"udi":{"description":"udi","type":"string"}},"type":"object","$$ref":"#/components/schemas/DeviceImageLocationDTO"},"type":"array"},"deviceUpgradeMode":{"description":"Device upgrade mode","example":"currentlyExists","type":"string"},"distributeParallel":{"description":"Distribute parallel","example":true,"type":"boolean"},"eraseFlash":{"description":"Erase flash","example":false,"type":"boolean"},"eraseRunningImage":{"description":"eraseRunningImage","example":false,"type":"boolean"},"fpd":{"description":"fpd","example":false,"type":"boolean"},"interfaceModuleDelay":{"description":"interfaceModuleDelay","example":"0","type":"string"},"isCommit":{"description":"isCommit","example":false,"type":"boolean"},"isISSUUpgrade":{"description":"isISSUUpgrade","example":false,"type":"boolean"},"issuupgrade":{"description":"ISSU upgrade","example":false,"type":"boolean"},"jobDto":{"description":"Job DTO","example":{"description":"description","jobName":"jobName","jobSchedule":{"daily":false,"dayOfWeek":"","dayRepetition":"","fortnight":false,"hourRepetition":"","hourly":false,"jobScheduleTime":{"endDate":"undefined","hour":"","minute":"","startDate":""},"minute":false,"monthly":false,"monthlyDay":"","monthlyMonth":"","monthlyWeek":"","monthlyWeekDay":"","noOfRepetitions":"0","now":true,"weekly":false,"yearly":false},"jobSpecification":{"taskSpecification":{"domainSpecId":"100"}},"jobType":"jobType","userName":""},"properties":{"parameters":{"description":"Parameters","items":{"description":"Property name and value","properties":{"instanceCreatedOn":{"description":"Instance created on","format":"date-time","type":"string"},"instanceId":{"description":"Instance Id","format":"int64","type":"integer"},"instanceTenantId":{"description":"Instance tenant Id","type":"string"},"instanceUpdatedOn":{"description":"Instance updated on","format":"date-time","type":"string"},"instanceUuid":{"description":"Instance uuid","type":"string"},"instanceVersion":{"description":"Instance version","format":"int32","type":"integer"},"lazyLoadedEntities":{"description":"Lazy loaded entities","additionalProperties":{"description":"Lazy load info","type":"object","$$ref":"#/components/schemas/LazyLoadInfo"},"type":"object"},"propertyName":{"description":"Property name","type":"string"}},"type":"object","$$ref":"#/components/schemas/PropertyNameAndValue"},"type":"array","uniqueItems":true},"customFlag":{"description":"Custom flag","type":"string"},"description":{"description":"Description","type":"string"},"jobName":{"description":"Job Name","type":"string"},"jobSchedule":{"description":"Job Schedule","properties":{"daily":{"description":"Daily","type":"boolean"},"dayOfWeek":{"description":"Day of week","type":"string"},"dayRepetition":{"description":"Day repetition","type":"string"},"fortnight":{"description":"Fortnight","type":"boolean"},"hourRepetition":{"description":"Hour repetition","type":"string"},"hourly":{"description":"Hourly","type":"boolean"},"jobScheduleTime":{"description":"Job schedule time","properties":{"day":{"description":"Day","type":"string"},"endDate":{"description":"End date","type":"string"},"hour":{"description":"Hour","type":"string"},"minute":{"description":"Minute","type":"string"},"month":{"description":"Month","type":"string"},"startDate":{"description":"Start date","type":"string"},"year":{"description":"Year","type":"string"}},"type":"object","xml":{"name":"JobTimeDto"},"$$ref":"#/components/schemas/JobTimeDto"},"minute":{"description":"Minute","type":"boolean"},"monthly":{"description":"Monthly","type":"boolean"},"monthlyDay":{"description":"Monthly day","type":"string"},"monthlyMonth":{"description":"Monthly month","type":"string"},"monthlyWeek":{"description":"Monthly week","type":"string"},"monthlyWeekDay":{"description":"Monthly weekday","type":"string"},"noOfRepetitions":{"description":"Number of repetitions","type":"string"},"now":{"description":"Now","type":"boolean"},"weekly":{"description":"Weekly","type":"boolean"},"yearly":{"description":"Yearly","type":"boolean"}},"type":"object","xml":{"name":"JobScheduleDto"},"$$ref":"#/components/schemas/JobScheduleDto"},"jobSpecification":{"description":"Job Specification","properties":{"runTaskInParallel":{"description":"Run task in parallel","type":"boolean"},"runTaskInSequence":{"description":"Run task in sequence","type":"boolean"},"taskSpecification":{"description":"Task specification","properties":{"domainSpecId":{"description":"Domain Specification Id","type":"string"},"taskName":{"description":"Task name","type":"string"}},"type":"object","$$ref":"#/components/schemas/TaskElementSpecificationDto"}},"type":"object","$$ref":"#/components/schemas/JobSpecificationDto"},"jobType":{"description":"Job type","type":"string"},"userName":{"description":"Username","type":"string"}},"type":"object","xml":{"name":"JobDto"},"$$ref":"#/components/schemas/JobDto"},"rebootType":{"description":"rebootType","example":0,"format":"int32","type":"integer"},"skipDistribution":{"description":"skipDistribution","example":false,"type":"boolean"},"sourceInterface":{"description":"Source interface","example":"","type":"string"},"tftpFallback":{"description":"tftpFallback","example":false,"type":"boolean"},"useSSH":{"description":"useSSH","example":false,"type":"boolean"},"vrfName":{"description":"vrfName","example":"","type":"string"}},"type":"object","$$ref":"#/components/schemas/SoftwareImageDistributionDTO"}},"type":"object","$$ref":"#/components/schemas/SoftwareImageDistributionDTOWrapper"},"example":{"softwareImageDistributionDTO":{"activeImage":false,"allowRevertorDowngrade":false,"applyTo":"","backupCurrentImage":false,"ccoPassword":"","ccoUserName":"","cleanRepository":false,"commit":false,"continueOnFailure":true,"deviceImgLocList":[{"currentReleaseToRetry":"","deviceId":"111111","deviceIp":"10.104.120.20","deviceType":"","encryptionSoftwareIndicator":"","externalServerIpaddress":"Local File Server","imageGUID":"","imageSize":100000,"imgName":"ncs4k-mgbl.pkg-6.5.29","langSelected":"","location":"disk1:","md5CheckSum":"","mdfID":"","metaTransactionId":"","softwareTypeIdToRetry":"","udi":""}],"deviceUpgradeMode":"currentlyExists","distributeParallel":true,"eraseFlash":false,"eraseRunningImage":false,"fpd":false,"interfaceModuleDelay":"0","isCommit":false,"isISSUUpgrade":false,"issuupgrade":false,"jobDto":{"jobSchedule":{"daily":false,"monthly":false,"now":true,"weekly":false,"minute":false,"yearly":false,"fortnight":false,"hourly":false,"hourRepetition":"","dayRepetition":"","noOfRepetitions":"0","monthlyDay":"","monthlyMonth":"","monthlyWeek":"","monthlyWeekDay":"","dayOfWeek":"","jobScheduleTime":{"hour":"","minute":"","startDate":"","endDate":""}},"jobSpecification":{"taskSpecification":{"domainSpecId":"100"}},"jobName":"image_distribute_10-09-2024_11-16-44_AM","userName":"","jobType":"SWIM_Distribution","description":"Distribute/Activate the image to device"},"rebootType":0,"skipDistribution":false,"sourceInterface":"","tftpFallback":false,"useSSH":false,"vrfName":""}}}},"required":true},"summary":"Copy Software Image to a Device.","__originalOperationId":"distribute_1","method":"post","path":"/distribute"}}