{"type":"api","title":"Update Any of the SWIM Preferences","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":{"example":["System successes to save the preference : Y on default.swim : ContinueDistributionOnFailure","System successes to save the preference : 1800000 on default.swim : inventoryCollectionTimeOut","System successes to save the preference : N on default.swim : InsertBootCommand","System successes to save the preference : N on default.swim : RemoveActivationAtDistribution","System successes to save the preference : N on default.swim : isWaitForInventoryCollectionComplete","System successes to save the preference : TELNET on default.swim : ConfigProtocolOrder","System successes to save the preference : N on default.swim : RecommendLatestMR","System successes to save the preference : Y on default.swim : copyByServer","System successes to save the preference : Y on default.swim : IncludeCCOForUpgradeAnalysis","System successes to save the preference : N on default.swim : DistributeParallelly","System successes to save the preference : N on default.swim : UseSSHForImageUpgradeAndImport","System successes to save the preference : Y on default.swim : IncludeCCOForRecommendation","System successes to save the preference : N on default.swim : RecommendGDImages","System successes to save the preference : N on default.swim : SmartFlashDeleteBeforeDistribution","System successes to save the preference : http on default.swim : CCOSmartsImageUrl","System successes to save the preference : /tftpboot on default.swim : TFTPBootLocation","System successes to save the preference : N on default.swim : RecommendVersionHigherThanCurrent","System successes to save the preference : N on default.swim : RebootParallellyAfterDistribution","System successes to save the preference : /opt/CSCOlumos/conf/ifm/swim/jobs on default.swim : JobDirectory","System successes to save the preference : 288000000 on default.swim : distributionJobTimeout","System successes to save the preference : 3600000 on default.swim : deviceMaxReloadWaitTime","System successes to save the preference : 60000 on default.swim : deviceIsAlivePollingInterval","System successes to save the preference : /opt/CSCOlumos/Staging on default.swim : StagingDirectory","System successes to save the preference : N on default.swim : InventoryCollectionIntegration","System successes to save the preference : N on default.swim : BackUpCurrentImage","System successes to save the preference : N on default.swim : RecommendSameImageFeature","System successes to save the preference : 20 on default.swim : distributionThreadPoolSize","System successes to save the preference : Y on default.swim : ActivatePatches","System successes to save the preference : /localdisk/sftp on default.swim : SCPDirectory","System successes to save the preference : N on default.swim : RebootImmediately","System successes to save the preference : SCP on default.swim : ImageTransferProtocolOrder","System successes to save the preference : 3 on default.swim : externalServerLimit","System successes to save the preference : 20 on default.swim : activationThreadPoolSize","System successes to save the preference : N on default.swim : TFTPFallback","System successes to save the preference : 60000 on default.swim : inventoryCompletionPollingInterval"],"type":"array"}}},"description":"OK"},"400":{"description":"Bad Request - Invalid request"},"500":{"description":"Internal Server Error - operation-failed"}},"tags":["Operation APIs"],"operationId":"updateSwimPreference_3","requestBody":{"content":{"application/json":{"schema":{"description":"System preference list DTO","example":{"items":[{"anyOf":[{"key":"ContinueDistributionOnFailure","value":"Y"},{"key":"inventoryCollectionTimeOut","value":"1800000"},{"key":"RemoveActivationAtDistribution","value":"N"},{"key":"InsertBootCommand","value":"N"},{"key":"isWaitForInventoryCollectionComplete","value":"N"},{"key":"ConfigProtocolOrder","value":"TELNET,SSH"},{"key":"RecommendLatestMR","value":"N"},{"key":"IncludeCCOForUpgradeAnalysis","value":"Y"},{"key":"copyByServer","value":"Y"},{"key":"DistributeParallelly","value":"N"},{"key":"IncludeCCOForRecommendation","value":"Y"},{"key":"RecommendGDImages","value":"N"},{"key":"UseSSHForImageUpgradeAndImport","value":"N"},{"key":"SmartFlashDeleteBeforeDistribution","value":"Y"},{"key":"CCOSmartsImageUrl","value":"http"},{"key":"TFTPBootLocation","value":"/tftpboot"},{"key":"RecommendVersionHigherThanCurrent","value":"N"},{"key":"JobDirectory","value":"/opt/CSCOlumos/conf/ifm/swim/jobs"},{"key":"RebootParallellyAfterDistribution","value":"N"},{"key":"distributionJobTimeout","value":"288000000"},{"key":"deviceMaxReloadWaitTime","value":"3600000"},{"key":"deviceIsAlivePollingInterval","value":"60000"},{"key":"BackUpCurrentImage","value":"N"},{"key":"InventoryCollectionIntegration","value":"N"},{"key":"StagingDirectory","value":"/opt/CSCOlumos/Staging"},{"key":"RecommendSameImageFeature","value":"N"},{"key":"distributionThreadPoolSize","value":"20"},{"key":"ActivatePatches","value":"Y"},{"key":"SCPDirectory","value":"/localdisk/sftp"},{"key":"RebootImmediately","value":"N"},{"key":"ImageTransferProtocolOrder","value":"SCP"},{"key":"externalServerLimit","value":"3"},{"key":"activationThreadPoolSize","value":"20"},{"key":"TFTPFallback","value":"N"},{"key":"inventoryCompletionPollingInterval","value":"60000"}]}]},"properties":{"items":{"description":"items","items":{"description":"System preference input DTO","properties":{"key":{"description":"Key","type":"string"},"value":{"description":"Value","type":"string"}},"type":"object","$$ref":"#/components/schemas/SystemPreferenceInputDTO"},"type":"array"}},"type":"object","$$ref":"#/components/schemas/SystemPreferenceListDTO"}}},"required":true},"summary":"Update Any of the SWIM Preferences.","__originalOperationId":"updateSwimPreference_3","method":"put","path":"/preference"}}