Cisco Evolved Programmable Network Manager API
Evolved Programmable Network Manager API Documentation

PUT devices/bulkImport

An operation to add or update multiple devices using a batch job.

For Json payload, Content-Type should be provided in HTTP header with value "application/json". Example: Content-Type=application/json

Credential Profiles Support

  • There are limitations on importing devices with a credential profile. If credentialProfileName parameter is specified and is not empty, this device should not contain any other credential parameters. Parameters allowed to be used with credentialProfileName are: ipAddress, networkMask, and udfs. If other credential parameters are set along with credentialProfileName they will be ignored.

User Defined Field Support

  • This service supports importing and exporting devices with User Defined Fields (UDF).
  • The maximum length of a UDF value is 255 characters; devices which have UDF values greater than 255 characters will be ignored.
  • Each bulk Import service request overwrites existing UDF records. To update the UDF of a device, follow the steps:
    • Retrieve the full list UDFs of the device using the GET op/devices/exportDevices resource.
    • Find the UDF entry to be updated in the list.
    • Assign the new value of the entry.
    • Use this resource to save the change.

Civic Property Support

  • Civic properties country, region, county, state, city, street, building, room, floor, latitude, longitude and altitude are supported.
  • For attribute Country, the equivalent value is represented below.
  • Example: To set Country as "Afghanistan", use the value as "AFG".
    • "Afghanistan":"AFG", "Albania":"ALB", "Algeria":"DZA", "American Samoa":"ASM", "Andorra":"AND", Angola":"AGO", "Anguilla":"AIA", "Antarctica":"ATA", "Antigua and Barbuda":"ATG", "Argentina":"ARG", "Armenia":"ARM", "Aruba":"ABW", "Australia":"AUS", "Austria":"AUT", "Azerbaijan":"AZE", "Bahamas":"BHS", "Bahrain":"BHR", "Bangladesh":"BGD", "Barbados":"BRB", "Belarus":"BLR", "Belgium":"BEL", "Belize":"BLZ", "Benin":"BEN", "Bermuda":"BMU","Bhutan":"BTN", "Bolivia":"BOL", "Bosnia and Herzegovina":"BIH", "Botswana":"BWA", "Brazil":"BRA" , "British Indian Ocean Territory":"IOT", "British Virgin Islands":"VGB","Brunei":"BRN","Bulgaria":"BGR", "Burkina Faso":"BFA", "Burundi":"BDI", "Cambodia":"KHM", "Cameroon":"CMR", "Canada":"CAN", "Cape Verde":"CPV", "Cayman Islands":"CYM", "Central African Republic":"CAF", "Chad":"TCD", "Chile":"CHL", "China":"CHN", "Christmas Island":"CXR", "Cocos Islands":"CCK", "Colombia":"COL", "Comoros":"COM", "Cook Islands":"COK", "Costa Rica":"CRI", "Croatia":"HRV", "Cuba":"CUB", "Curacao":"CUW", "Cyprus":"CYP", "CzechRepublic":"CZE", "Democratic Republic of the Congo":"COD", "Denmark":"DNK", "Djibouti":"DJI", "Dominica":"DMA", "Dominican Republic":"DOM", "East Timor":"TLS", "Ecuador":"ECU", "Egypt":"EGY", "El Salvador":"SLV","Equatorial Guinea":"GNQ", "Eritrea":"ERI", "Estonia":"EST", "Ethiopia":"ETH", "Falkland Islands":"FLK", "Faroe Islands":"FRO", "Fiji":"FJI", "Finland":"FIN", "France":"FRA", "French Polynesia":"PYF", "Gabon":"GAB", "Gambia":"GMB", "Georgia":"GEO", "Germany":"DEU", "Ghana":"GHA", "Gibraltar":"GIB", "Greece":"GRC", "Greenland":"GRL", "Grenada":"GRD", "Guam":"GUM", "Guatemala":"GTM" , "Guernsey":"GGY", "Guinea":"GIN","Guinea-Bissau":"GNB", "Guyana":"GUY", "Haiti":"HTI", "Honduras":"HND", "Hong Kong":"HKG", "Hungary":"HUN", "Iceland":"ISL", "India":"IND", "Indonesia":"IDN", "Iran":"IRN", "Iraq":"IRQ", "Ireland":"IRL" , "Isle ofMan":"IMN", "Israel":"ISR", "Italy":"ITA", "Ivory Coast":"CIV", "Jamaica":"JAM", "Japan":"JPN", "Jersey":"JEY", "Jordan":"JOR", "Kazakhstan":"KAZ", "Kenya":"KEN", "Kiribati":"KIR", "Kosovo":"XKX", "Kuwait":"KWT", "Kyrgyzstan":"KGZ" , "Laos":"LAO", "Latvia":"LVA", "Lebanon":"LBN", "Lesotho":"LSO", "Liberia":"LBR", "Libya":"LBY", "Liechtenstein":"LIE", "Lithuania":"LTU" , "Luxembourg":"LUX", "Macao":"MAC", "Macedonia":"MKD","Madagascar":"MDG" , "Malawi":"MWI", "Malaysia":"MYS", "Maldives":"MDV", "Mali":"MLI" , "Malta":"MLT", "Marshall Islands":"MHL", "Mauritania":"MRT", "Mauritius":"MUS", "Mayotte":"MYT" , "Mexico":"MEX","Micronesia":"FSM", "Moldova":"MDA", "Monaco":"MCO" , "Mongolia":"MNG", "Montenegro":"MNE", "Montserrat":"MSR", "Morocco":"MAR", "Mozambique":"MOZ" , "Myanmar":"MMR", "Namibia":"NAM", "Nauru":"NRU", "Nepal":"NPL","Netherlands":"NLD" , "Netherlands Antilles":"ANT" , "New Caledonia":"NCL", "New Zealand":"NZL", "Nicaragua":"NIC" , "Niger":"NER", "Nigeria":"NGA", "Niue":"NIU", "North Korea":"PRK", "Northern MarianaIslands":"MNP", "Norway":"NOR", "Oman":"OMN", "Pakistan":"PAK" , "Palau":"PLW", "Palestine":"PSE", "Panama":"PAN", "Papua New Guinea":"PNG", "Paraguay":"PRY", "Peru":"PER", "Philippines":"PHL", "Pitcairn":"PCN" ,"Poland":"POL", "Portugal":"PRT", "Puerto Rico":"PRI", "Qatar":"QAT", "Reunion":"REU", "Romania":"ROU", "Russia":"RUS", "Rwanda":"RWA", "Saint Barthelemy":"BLM", "Saint Helena":"SHN" , "Saint Kitts and Nevis":"KNA", "SaintLucia":"LCA", "Saint Martin":"MAF", "Saint Pierre and Miquelon":"SPM", "Saint Vincent and the Grenadines":"VCT", "Samoa":"WSM", "San Marino":"SMR", "Sao Tome and Principe":"STP", "Saudi Arabia":"SAU", "Senegal":"SEN","Serbia":"SRB", "Seychelles":"SYC", "Sierra Leone":"SLE", "Singapore":"SGP", "Sint Maarten":"SXM", "Slovenia":"SVN", "Solomon Islands":"SLB", "Somalia":"SOM" , "South Africa":"ZAF", "South Korea":"KOR", "SouthSudan":"SSD", "Spain":"ESP", "Sri Lanka":"LKA", "Sudan":"SDN" , "Suriname":"SUR", "Svalbard and Jan Mayen":"SJM", "Swaziland":"SWZ", "Sweden":"SWE" , "Switzerland":"CHE","Syria":"SYR", "Taiwan":"TWN", "Tajikistan":"TJK", "Tanzania":"TZA", "Thailand":"THA", "Togo":"TGO", "Tokelau":"TKL", "Tonga":"TON", "Trinidad and Tobago":"TTO", "Tunisia":"TUN", "Turkey":"TUR","Turkmenistan":"TKM", "Turks and Caicos Islands":"TCA", "Tuvalu":"TUV", "U.S. Virgin Islands":"VIR", "Uganda":"UGA", "Ukraine":"UKR" , "United Arab Emirates":"ARE", "United Kingdom":"GBR", "United States":"USA", "Uruguay":"URY", "Uzbekistan":"UZB", "Vanuatu":"VUT", "Vatican":"VAT", "Venezuela":"VEN", "Vietnam":"VNM", "Wallis and Futuna":"WLF" , "Western Sahara":"ESH", "Yemen":"YEM", "Zambia":"ZMB", and "Zimbabwe":"ZWE".
  • For attribute region, the possible values are represented below.
  • Example: To set region as "Africa", use the value as "Africa".
    • "Africa", "Asia Pacific", "Europe", "Latin America", "Middle East", and "North America".

TL1 Credentials Support

  • Transaction Language 1 (TL1) credentials are not currently supported for this operation.

Since Product Version: 2.2

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

PUT

Resource URL

/webacs/api/v3/op/devices/bulkImport

Unmodified

This resource has not been modified since the previous API version.

Request Payload Parameters

Attribute Description

devices Arrow image Device[]

Required

A list of devices to be imported

Response Parameters

Attribute Description

jobName String

The job name created by the bulk import operation. The job name can be referred to check the status of the job using job management services

message String

A message returned from the bulk import operation

Sample 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.64.88.203/webacs/api/v3/op/devices/bulkImport

<?xml version="1.0" ?>
<devicesImport>
  <devices>
    <device>
      <altitude>String value</altitude>
      <building>String value</building>
      <city>String value</city>
      <cliEnablePassword>String value</cliEnablePassword>
      <cliPassword>String value</cliPassword>
      <cliRetries>String value</cliRetries>
      <cliTimeout>String value</cliTimeout>
      <cliUsername>String value</cliUsername>
      <country>String value</country>
      <county>String value</county>
      <credentialProfileName>String value</credentialProfileName>
      <floor>String value</floor>
      <httpConfigPassword>String value</httpConfigPassword>
      <httpConfigUsername>String value</httpConfigUsername>
      <httpMonitorPassword>String value</httpMonitorPassword>
      <httpMonitorUsername>String value</httpMonitorUsername>
      <httpPort>String value</httpPort>
      <httpServer>String value</httpServer>
      <ipAddress>String value</ipAddress>
      <latitude>String value</latitude>
      <longitude>String value</longitude>
      <networkMask>String value</networkMask>
      <protocol>String value</protocol>
      <region>String value</region>
      <room>String value</room>
      <snmpCommunity>String value</snmpCommunity>
      <snmpPort>String value</snmpPort>
      <snmpReadCommunity>String value</snmpReadCommunity>
      <snmpRetries>String value</snmpRetries>
      <snmpTimeout>String value</snmpTimeout>
      <snmpVersion>String value</snmpVersion>
      <snmpWriteCommunity>String value</snmpWriteCommunity>
      <snmpv3AuthPassword>String value</snmpv3AuthPassword>
      <snmpv3AuthType>String value</snmpv3AuthType>
      <snmpv3PrivacyPassword>String value</snmpv3PrivacyPassword>
      <snmpv3PrivacyType>String value</snmpv3PrivacyType>
      <snmpv3UserName>String value</snmpv3UserName>
      <state>String value</state>
      <street>String value</street>
      <udfs>
        <udf>
          <name>String value</name>
          <value>String value</value>
        </udf>
        <udf>
          <name>Another string value</name>
          <value>Another string value</value>
        </udf>
      </udfs>
    </device>
    <device>
      <altitude>Another string value</altitude>
      <building>Another string value</building>
      <city>Another string value</city>
      <cliEnablePassword>Another string value</cliEnablePassword>
      <cliPassword>Another string value</cliPassword>
      <cliRetries>Another string value</cliRetries>
      <cliTimeout>Another string value</cliTimeout>
      <cliUsername>Another string value</cliUsername>
      <country>Another string value</country>
      <county>Another string value</county>
      <credentialProfileName>Another string value</credentialProfileName>
      <floor>Another string value</floor>
      <httpConfigPassword>Another string value</httpConfigPassword>
      <httpConfigUsername>Another string value</httpConfigUsername>
      <httpMonitorPassword>Another string value</httpMonitorPassword>
      <httpMonitorUsername>Another string value</httpMonitorUsername>
      <httpPort>Another string value</httpPort>
      <httpServer>Another string value</httpServer>
      <ipAddress>Another string value</ipAddress>
      <latitude>Another string value</latitude>
      <longitude>Another string value</longitude>
      <networkMask>Another string value</networkMask>
      <protocol>Another string value</protocol>
      <region>Another string value</region>
      <room>Another string value</room>
      <snmpCommunity>Another string value</snmpCommunity>
      <snmpPort>Another string value</snmpPort>
      <snmpReadCommunity>Another string value</snmpReadCommunity>
      <snmpRetries>Another string value</snmpRetries>
      <snmpTimeout>Another string value</snmpTimeout>
      <snmpVersion>Another string value</snmpVersion>
      <snmpWriteCommunity>Another string value</snmpWriteCommunity>
      <snmpv3AuthPassword>Another string value</snmpv3AuthPassword>
      <snmpv3AuthType>Another string value</snmpv3AuthType>
      <snmpv3PrivacyPassword>Another string value</snmpv3PrivacyPassword>
      <snmpv3PrivacyType>Another string value</snmpv3PrivacyType>
      <snmpv3UserName>Another string value</snmpv3UserName>
      <state>Another string value</state>
      <street>Another string value</street>
      <udfs>
        <udf>
          <name>String value</name>
          <value>String value</value>
        </udf>
        <udf>
          <name>Another string value</name>
          <value>Another string value</value>
        </udf>
      </udfs>
    </device>
  </devices>
</devicesImport>

Sample JSON Request Payload

https://10.64.88.203/webacs/api/v3/op/devices/bulkImport.json

{
  "devicesImport" : {
    "devices" : {
      "device" : [ {
        "altitude" : "String value",
        "building" : "String value",
        "city" : "String value",
        "cliEnablePassword" : "String value",
        "cliPassword" : "String value",
        "cliRetries" : "String value",
        "cliTimeout" : "String value",
        "cliUsername" : "String value",
        "country" : "String value",
        "county" : "String value",
        "credentialProfileName" : "String value",
        "floor" : "String value",
        "httpConfigPassword" : "String value",
        "httpConfigUsername" : "String value",
        "httpMonitorPassword" : "String value",
        "httpMonitorUsername" : "String value",
        "httpPort" : "String value",
        "httpServer" : "String value",
        "ipAddress" : "String value",
        "latitude" : "String value",
        "longitude" : "String value",
        "networkMask" : "String value",
        "protocol" : "String value",
        "region" : "String value",
        "room" : "String value",
        "snmpCommunity" : "String value",
        "snmpPort" : "String value",
        "snmpReadCommunity" : "String value",
        "snmpRetries" : "String value",
        "snmpTimeout" : "String value",
        "snmpVersion" : "String value",
        "snmpWriteCommunity" : "String value",
        "snmpv3AuthPassword" : "String value",
        "snmpv3AuthType" : "String value",
        "snmpv3PrivacyPassword" : "String value",
        "snmpv3PrivacyType" : "String value",
        "snmpv3UserName" : "String value",
        "state" : "String value",
        "street" : "String value",
        "udfs" : {
          "udf" : [ {
            "name" : "String value",
            "value" : "String value"
          }, {
            "name" : "Another string value",
            "value" : "Another string value"
          } ]
        }
      }, {
        "altitude" : "Another string value",
        "building" : "Another string value",
        "city" : "Another string value",
        "cliEnablePassword" : "Another string value",
        "cliPassword" : "Another string value",
        "cliRetries" : "Another string value",
        "cliTimeout" : "Another string value",
        "cliUsername" : "Another string value",
        "country" : "Another string value",
        "county" : "Another string value",
        "credentialProfileName" : "Another string value",
        "floor" : "Another string value",
        "httpConfigPassword" : "Another string value",
        "httpConfigUsername" : "Another string value",
        "httpMonitorPassword" : "Another string value",
        "httpMonitorUsername" : "Another string value",
        "httpPort" : "Another string value",
        "httpServer" : "Another string value",
        "ipAddress" : "Another string value",
        "latitude" : "Another string value",
        "longitude" : "Another string value",
        "networkMask" : "Another string value",
        "protocol" : "Another string value",
        "region" : "Another string value",
        "room" : "Another string value",
        "snmpCommunity" : "Another string value",
        "snmpPort" : "Another string value",
        "snmpReadCommunity" : "Another string value",
        "snmpRetries" : "Another string value",
        "snmpTimeout" : "Another string value",
        "snmpVersion" : "Another string value",
        "snmpWriteCommunity" : "Another string value",
        "snmpv3AuthPassword" : "Another string value",
        "snmpv3AuthType" : "Another string value",
        "snmpv3PrivacyPassword" : "Another string value",
        "snmpv3PrivacyType" : "Another string value",
        "snmpv3UserName" : "Another string value",
        "state" : "Another string value",
        "street" : "Another string value",
        "udfs" : {
          "udf" : [ {
            "name" : "String value",
            "value" : "String value"
          }, {
            "name" : "Another string value",
            "value" : "Another string value"
          } ]
        }
      } ]
    }
  }
}

Sample XML Response Payload

https://10.64.88.203/webacs/api/v3/op/devices/bulkImport

<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="../../../../../pages/common/login.jsp.html" rootUrl="https://10.64.88.203/webacs/api/v3/op">
  <bulkImportResult>
    <jobName>String value</jobName>
    <message>String value</message>
  </bulkImportResult>
</mgmtResponse>

Sample JSON Response Payload

https://10.64.88.203/webacs/api/v3/op/devices/bulkImport.json

{
  "mgmtResponse" : {
    "@requestUrl" : "../../../../../pages/common/login.jsp.html",
    "@responseType" : "operation",
    "@rootUrl" : "https://10.64.88.203/webacs/api/v3/op",
    "bulkImportResult" : [ {
      "jobName" : "String value",
      "message" : "String value"
    } ]
  }
}