This operation can be used to copy image to cisco devices. Note: Please use only json payload. xml payload is not supported, it is generated from the framework.
Since Product Version: 1
Resource Information
Rate Limiting? |
No |
Sorting? |
No |
Paging? |
No |
Filtering? |
No |
Group Filtering? |
No |
Aggregation? |
No |
Response Formats |
xml json |
User Group |
NBI Write |
HTTP Methods |
POST |
This API version has been deprecated. It will be removed in a future release of the product. Please develop new clients using the latest API version. Please modify your existing clients to use a later API version.
Resource URL
/webacs/api/v1/op/swim/image/distributeSample Payloads
Sample payloads are for information only. They are automatically generated and the values included may not be representative of actual valid data values.
Sample XML Request Payload
https://10.56.58.149/webacs/api/v1/op/swim/image/distribute
<?xml version="1.0" ?>
<SoftwareImageDistributionDTO>
<activeImage>true</activeImage>
<allowRevertorDowngrade>true</allowRevertorDowngrade>
<applyTo>String value</applyTo>
<backupCurrentImage>true</backupCurrentImage>
<ccoPassword>String value</ccoPassword>
<ccoUserName>String value</ccoUserName>
<cleanRepository>true</cleanRepository>
<commit>true</commit>
<continueOnFailure>true</continueOnFailure>
<deviceImgLocList>
<currentReleaseToRetry>String value</currentReleaseToRetry>
<deviceId>String value</deviceId>
<deviceIp>String value</deviceIp>
<deviceType>String value</deviceType>
<encryptionSoftwareIndicator>String value</encryptionSoftwareIndicator>
<externalServerIpaddress>String value</externalServerIpaddress>
<imageGUID>String value</imageGUID>
<imageSize>15</imageSize>
<imgName>String value</imgName>
<langSelected>String value</langSelected>
<location>String value</location>
<MD5CheckSum>String value</MD5CheckSum>
<mdfID>String value</mdfID>
<metaTransactionId>String value</metaTransactionId>
<softwareTypeIdToRetry>String value</softwareTypeIdToRetry>
<UDI>String value</UDI>
</deviceImgLocList>
<deviceImgLocList>
<currentReleaseToRetry>Another string value</currentReleaseToRetry>
<deviceId>Another string value</deviceId>
<deviceIp>Another string value</deviceIp>
<deviceType>Another string value</deviceType>
<encryptionSoftwareIndicator>Another string value</encryptionSoftwareIndicator>
<externalServerIpaddress>Another string value</externalServerIpaddress>
<imageGUID>Another string value</imageGUID>
<imageSize>25</imageSize>
<imgName>Another string value</imgName>
<langSelected>Another string value</langSelected>
<location>Another string value</location>
<MD5CheckSum>Another string value</MD5CheckSum>
<mdfID>Another string value</mdfID>
<metaTransactionId>Another string value</metaTransactionId>
<softwareTypeIdToRetry>Another string value</softwareTypeIdToRetry>
<UDI>Another string value</UDI>
</deviceImgLocList>
<deviceUpgradeMode>String value</deviceUpgradeMode>
<distributeParallel>true</distributeParallel>
<eraseFlash>true</eraseFlash>
<eraseRunningImage>true</eraseRunningImage>
<fpd>true</fpd>
<ISSUUpgrade>true</ISSUUpgrade>
<interfaceModuleDelay>String value</interfaceModuleDelay>
<isCommit>true</isCommit>
<isISSUUpgrade>true</isISSUUpgrade>
<jobDto>
<customFlag>String value</customFlag>
<description>String value</description>
<jobName>String value</jobName>
<jobSchedule>
<daily>true</daily>
<dayOfWeek>String value</dayOfWeek>
<dayRepetition>String value</dayRepetition>
<fortnight>true</fortnight>
<hourRepetition>String value</hourRepetition>
<hourly>true</hourly>
<jobScheduleTime>
<day>String value</day>
<endDate>String value</endDate>
<hour>String value</hour>
<minute>String value</minute>
<month>String value</month>
<startDate>String value</startDate>
<year>String value</year>
</jobScheduleTime>
<minute>true</minute>
<monthly>true</monthly>
<monthlyDay>String value</monthlyDay>
<monthlyMonth>String value</monthlyMonth>
<monthlyWeek>String value</monthlyWeek>
<monthlyWeekDay>String value</monthlyWeekDay>
<noOfRepetitions>String value</noOfRepetitions>
<now>true</now>
<weekly>true</weekly>
<yearly>true</yearly>
</jobSchedule>
<jobSpecification>
<runTaskInParallel>true</runTaskInParallel>
<runTaskInSequence>true</runTaskInSequence>
<taskSpecification>
<domainSpecId>String value</domainSpecId>
<taskName>String value</taskName>
</taskSpecification>
</jobSpecification>
<jobType>String value</jobType>
<parameters>
<lazyLoadedEntities>
<entry>
<key>Another string value</key>
<value xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="xs:string">Another string value</value>
</entry>
<entry>
<key>String value</key>
<value xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="xs:string">String value</value>
</entry>
</lazyLoadedEntities>
<instanceCreatedOn>1986-07-24T00:00:00+03:00</instanceCreatedOn>
<instanceId>2</instanceId>
<instanceUpdatedOn>1986-07-24T00:00:00+03:00</instanceUpdatedOn>
<instanceUuid>String value</instanceUuid>
<instanceVersion>1</instanceVersion>
<propertyName>String value</propertyName>
</parameters>
<parameters>
<lazyLoadedEntities>
<entry>
<key>Another string value</key>
<value xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="xs:string">Another string value</value>
</entry>
<entry>
<key>String value</key>
<value xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="xs:string">String value</value>
</entry>
</lazyLoadedEntities>
<instanceCreatedOn>1991-01-11T00:00:00+02:00</instanceCreatedOn>
<instanceId>12</instanceId>
<instanceUpdatedOn>1991-01-11T00:00:00+02:00</instanceUpdatedOn>
<instanceUuid>Another string value</instanceUuid>
<instanceVersion>11</instanceVersion>
<propertyName>Another string value</propertyName>
</parameters>
<userName>String value</userName>
</jobDto>
<rebootType>1</rebootType>
<skipDistribution>true</skipDistribution>
<tftpFallback>true</tftpFallback>
<useSSH>true</useSSH>
<vrfName>String value</vrfName>
</SoftwareImageDistributionDTO>
Sample JSON Request Payload
https://10.56.58.149/webacs/api/v1/op/swim/image/distribute.json
{
"SoftwareImageDistributionDTO" : {
"activeImage" : true,
"allowRevertorDowngrade" : true,
"applyTo" : "String value",
"backupCurrentImage" : true,
"ccoPassword" : "String value",
"ccoUserName" : "String value",
"cleanRepository" : true,
"commit" : true,
"continueOnFailure" : true,
"deviceImgLocList" : [{
"currentReleaseToRetry" : "String value",
"deviceId" : "String value",
"deviceIp" : "String value",
"deviceType" : "String value",
"encryptionSoftwareIndicator" : "String value",
"externalServerIpaddress" : "String value",
"imageGUID" : "String value",
"imageSize" : 15,
"imgName" : "String value",
"langSelected" : "String value",
"location" : "String value",
"MD5CheckSum" : "String value",
"mdfID" : "String value",
"metaTransactionId" : "String value",
"softwareTypeIdToRetry" : "String value",
"UDI" : "String value"
},
{
"currentReleaseToRetry" : "Another string value",
"deviceId" : "Another string value",
"deviceIp" : "Another string value",
"deviceType" : "Another string value",
"encryptionSoftwareIndicator" : "Another string value",
"externalServerIpaddress" : "Another string value",
"imageGUID" : "Another string value",
"imageSize" : 25,
"imgName" : "Another string value",
"langSelected" : "Another string value",
"location" : "Another string value",
"MD5CheckSum" : "Another string value",
"mdfID" : "Another string value",
"metaTransactionId" : "Another string value",
"softwareTypeIdToRetry" : "Another string value",
"UDI" : "Another string value"
}],
"deviceUpgradeMode" : "String value",
"distributeParallel" : true,
"eraseFlash" : true,
"eraseRunningImage" : true,
"fpd" : true,
"ISSUUpgrade" : true,
"interfaceModuleDelay" : "String value",
"isCommit" : true,
"isISSUUpgrade" : true,
"jobDto" : {
"customFlag" : "String value",
"description" : "String value",
"jobName" : "String value",
"jobSchedule" : {
"daily" : true,
"dayOfWeek" : "String value",
"dayRepetition" : "String value",
"fortnight" : true,
"hourRepetition" : "String value",
"hourly" : true,
"jobScheduleTime" : {
"day" : "String value",
"endDate" : "String value",
"hour" : "String value",
"minute" : "String value",
"month" : "String value",
"startDate" : "String value",
"year" : "String value"
},
"minute" : true,
"monthly" : true,
"monthlyDay" : "String value",
"monthlyMonth" : "String value",
"monthlyWeek" : "String value",
"monthlyWeekDay" : "String value",
"noOfRepetitions" : "String value",
"now" : true,
"weekly" : true,
"yearly" : true
},
"jobSpecification" : {
"runTaskInParallel" : true,
"runTaskInSequence" : true,
"taskSpecification" : {
"domainSpecId" : "String value",
"taskName" : "String value"
}
},
"jobType" : "String value",
"parameters" : [{
"lazyLoadedEntities" : {
"entry" : [{
"key" : "Another string value",
"value" : {
"@xsi.type" : "xs : string",
"$" : "Another string value"
}
},
{
"key" : "String value",
"value" : {
"@xsi.type" : "xs : string",
"$" : "String value"
}
}]
},
"instanceCreatedOn" : "1986-07-24T00 : 00 : 00+03 : 00",
"instanceId" : 2,
"instanceUpdatedOn" : "1986-07-24T00 : 00 : 00+03 : 00",
"instanceUuid" : "String value",
"instanceVersion" : 1,
"propertyName" : "String value"
},
{
"lazyLoadedEntities" : {
"entry" : [{
"key" : "Another string value",
"value" : {
"@xsi.type" : "xs : string",
"$" : "Another string value"
}
},
{
"key" : "String value",
"value" : {
"@xsi.type" : "xs : string",
"$" : "String value"
}
}]
},
"instanceCreatedOn" : "1991-01-11T00 : 00 : 00+02 : 00",
"instanceId" : 12,
"instanceUpdatedOn" : "1991-01-11T00 : 00 : 00+02 : 00",
"instanceUuid" : "Another string value",
"instanceVersion" : 11,
"propertyName" : "Another string value"
}],
"userName" : "String value"
},
"rebootType" : 1,
"skipDistribution" : true,
"tftpFallback" : true,
"useSSH" : true,
"vrfName" : "String value"
}
}
Sample XML Response Payload
https://10.56.58.149/webacs/api/v1/op/swim/image/distribute
<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="https://10.56.58.149/webacs/api/v1/op/swim/image/distribute" rootUrl="https://10.56.58.149/webacs/api/v1/op">
<SwimJobResultDTO>
<jobId>String value</jobId>
<jobStatus>String value</jobStatus>
</SwimJobResultDTO>
</mgmtResponse>
Sample JSON Response Payload
https://10.56.58.149/webacs/api/v1/op/swim/image/distribute.json
{
"mgmtResponse" : {
"@responseType" : "operation",
"@requestUrl" : "https : \/\/10.56.58.149\/webacs\/api\/v1\/op\/swim\/image\/distribute",
"@rootUrl" : "https : \/\/10.56.58.149\/webacs\/api\/v1\/op",
"SwimJobResultDTO" : {
"jobId" : "String value",
"jobStatus" : "String value"
}
}
}