An operation to add or update multiple devices using a batch job.
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.
TL1 Credentials Support
- Transaction Language 1 (TL1) credentials are not currently supported for this operation.
Since Product Version: 2.2
-
Jump To
- AAA/TACACS+ Servers Operations Service (4)
- AP Onboarding Profile Management Service (4)
- API Health Service (6)
- Access Point Operations (4)
- Alarms Management Service (5)
- Application Visibility and Control Service (1)
- BNG IP Pool Statistics (3)
- BNG Sessions Statistics (3)
- CEM Statistics (3)
- CLI Template Configuration (12)
- Circuit Statistics (4)
- Clients (7)
- Configuration Archive Service (7)
- Credential Profile Management Service (5)
- Credentials Service (1)
- Device Details (9)
- Device Operations (9)
- Device Sensors Statistics (3)
- Group Management Service (8)
- Group Summary Service (8)
- Guest User Management Service (8)
- IPSLA (ICMP JITTER) Statistics (3)
- IPSLA Y1731 Statistics (3)
- Interface CRC Errors Statistics (3)
- Job Operations (6)
- Link Statistics (3)
- MAC Filters Management Service (5)
- Manage and Monitor Info Service (5)
- Managed Servers Operations (6)
- Me1200 Quality of Service Statistics (3)
- Network Topology Layout (2)
- Optical Ethernet Statistics (3)
- Optical OTN Data Statistics (3)
- Optical Physical Statistics (3)
- Optical SFP Statistics (3)
- Optical Sonet SDH Statistics (3)
- PTP Clock Statistics (3)
- PTP and SyncE settings (5)
- Plug and Play (7)
- Quality of Service Statistics (3)
- Rate Limits Management Service (2)
- Report Service (5)
- Site Map Service (3)
- Software Updates (2)
- Statistics (91)
- SyncE Statistics (3)
- System Settings (26)
- TDM and Sonet Port Statistics (3)
- Trap Receivers (4)
- User Defined Field Management (3)
- User Management Service (5)
- VNF Provisioning (16)
- Virtual Domains Management Service (10)
- Virtual Image Repository (8)
- WLAN Provisioning (16)
- Wireless Device Details (22)
- Y1731 Bins Statistics (3)
- v1
- v2
- v3
- v4
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 |
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/devices/bulkImportRequest Payload Parameters
Attribute | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
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://172.20.127.108/webacs/api/v1/op/devices/bulkImport
<?xml version="1.0" ?>
<devicesImport>
<devices>
<device>
<cliEnablePassword>String value</cliEnablePassword>
<cliPassword>String value</cliPassword>
<cliRetries>String value</cliRetries>
<cliTimeout>String value</cliTimeout>
<cliUsername>String value</cliUsername>
<credentialProfileName>String value</credentialProfileName>
<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>
<networkMask>String value</networkMask>
<protocol>String value</protocol>
<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>
<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>
<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>
<credentialProfileName>Another string value</credentialProfileName>
<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>
<networkMask>Another string value</networkMask>
<protocol>Another string value</protocol>
<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>
<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://172.20.127.108/webacs/api/v1/op/devices/bulkImport.json
{
"devicesImport" : {
"devices" : {
"device" : [{
"cliEnablePassword" : "String value",
"cliPassword" : "String value",
"cliRetries" : "String value",
"cliTimeout" : "String value",
"cliUsername" : "String value",
"credentialProfileName" : "String value",
"httpConfigPassword" : "String value",
"httpConfigUsername" : "String value",
"httpMonitorPassword" : "String value",
"httpMonitorUsername" : "String value",
"httpPort" : "String value",
"httpServer" : "String value",
"ipAddress" : "String value",
"networkMask" : "String value",
"protocol" : "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",
"udfs" : {
"udf" : [{
"name" : "String value",
"value" : "String value"
},
{
"name" : "Another string value",
"value" : "Another string value"
}]
}
},
{
"cliEnablePassword" : "Another string value",
"cliPassword" : "Another string value",
"cliRetries" : "Another string value",
"cliTimeout" : "Another string value",
"cliUsername" : "Another string value",
"credentialProfileName" : "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",
"networkMask" : "Another string value",
"protocol" : "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",
"udfs" : {
"udf" : [{
"name" : "String value",
"value" : "String value"
},
{
"name" : "Another string value",
"value" : "Another string value"
}]
}
}]
}
}
}
Sample XML Response Payload
https://172.20.127.108/webacs/api/v1/op/devices/bulkImport
<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="../../../../pages/common/login.jsp.html" rootUrl="https://172.20.127.108/webacs/api/v1/op">
<bulkImportResult>
<jobName>String value</jobName>
<message>String value</message>
</bulkImportResult>
</mgmtResponse>
Sample JSON Response Payload
https://172.20.127.108/webacs/api/v1/op/devices/bulkImport.json
{
"mgmtResponse" : {
"@responseType" : "operation",
"@requestUrl" : "https : \/\/172.20.127.108\/webacs\/api\/v1\/op\/devices\/bulkImport",
"@rootUrl" : "https : \/\/172.20.127.108\/webacs\/api\/v1\/op",
"bulkImportResult" : {
"jobName" : "String value",
"message" : "String value"
}
}
}
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/v2/op/devices/bulkImportUnmodified
This resource has not been modified since the previous API version.
Request Payload Parameters
Attribute | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
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://172.20.127.108/webacs/api/v2/op/devices/bulkImport
<?xml version="1.0" ?>
<devicesImport>
<devices>
<device>
<cliEnablePassword>String value</cliEnablePassword>
<cliPassword>String value</cliPassword>
<cliRetries>String value</cliRetries>
<cliTimeout>String value</cliTimeout>
<cliUsername>String value</cliUsername>
<credentialProfileName>String value</credentialProfileName>
<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>
<networkMask>String value</networkMask>
<protocol>String value</protocol>
<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>
<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>
<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>
<credentialProfileName>Another string value</credentialProfileName>
<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>
<networkMask>Another string value</networkMask>
<protocol>Another string value</protocol>
<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>
<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://172.20.127.108/webacs/api/v2/op/devices/bulkImport.json
{
"devicesImport" : {
"devices" : {
"device" : [ {
"cliEnablePassword" : "String value",
"cliPassword" : "String value",
"cliRetries" : "String value",
"cliTimeout" : "String value",
"cliUsername" : "String value",
"credentialProfileName" : "String value",
"httpConfigPassword" : "String value",
"httpConfigUsername" : "String value",
"httpMonitorPassword" : "String value",
"httpMonitorUsername" : "String value",
"httpPort" : "String value",
"httpServer" : "String value",
"ipAddress" : "String value",
"networkMask" : "String value",
"protocol" : "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",
"udfs" : {
"udf" : [ {
"name" : "String value",
"value" : "String value"
}, {
"name" : "Another string value",
"value" : "Another string value"
} ]
}
}, {
"cliEnablePassword" : "Another string value",
"cliPassword" : "Another string value",
"cliRetries" : "Another string value",
"cliTimeout" : "Another string value",
"cliUsername" : "Another string value",
"credentialProfileName" : "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",
"networkMask" : "Another string value",
"protocol" : "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",
"udfs" : {
"udf" : [ {
"name" : "String value",
"value" : "String value"
}, {
"name" : "Another string value",
"value" : "Another string value"
} ]
}
} ]
}
}
}
Sample XML Response Payload
https://172.20.127.108/webacs/api/v2/op/devices/bulkImport
<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="../../../../pages/common/login.jsp.html" rootUrl="https://172.20.127.108/webacs/api/v2/op">
<bulkImportResult>
<jobName>String value</jobName>
<message>String value</message>
</bulkImportResult>
</mgmtResponse>
Sample JSON Response Payload
https://172.20.127.108/webacs/api/v2/op/devices/bulkImport.json
{
"mgmtResponse" : {
"@requestUrl" : "../../../../pages/common/login.jsp.html",
"@responseType" : "operation",
"@rootUrl" : "https://172.20.127.108/webacs/api/v2/op",
"bulkImportResult" : [ {
"jobName" : "String value",
"message" : "String value"
} ]
}
}
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/bulkImportUnmodified
This resource has not been modified since the previous API version.
Request Payload Parameters
Attribute | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
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://172.20.127.108/webacs/api/v3/op/devices/bulkImport
<?xml version="1.0" ?>
<devicesImport>
<devices>
<device>
<cliEnablePassword>String value</cliEnablePassword>
<cliPassword>String value</cliPassword>
<cliRetries>String value</cliRetries>
<cliTimeout>String value</cliTimeout>
<cliUsername>String value</cliUsername>
<credentialProfileName>String value</credentialProfileName>
<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>
<networkMask>String value</networkMask>
<protocol>String value</protocol>
<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>
<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>
<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>
<credentialProfileName>Another string value</credentialProfileName>
<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>
<networkMask>Another string value</networkMask>
<protocol>Another string value</protocol>
<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>
<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://172.20.127.108/webacs/api/v3/op/devices/bulkImport.json
{
"devicesImport" : {
"devices" : {
"device" : [ {
"cliEnablePassword" : "String value",
"cliPassword" : "String value",
"cliRetries" : "String value",
"cliTimeout" : "String value",
"cliUsername" : "String value",
"credentialProfileName" : "String value",
"httpConfigPassword" : "String value",
"httpConfigUsername" : "String value",
"httpMonitorPassword" : "String value",
"httpMonitorUsername" : "String value",
"httpPort" : "String value",
"httpServer" : "String value",
"ipAddress" : "String value",
"networkMask" : "String value",
"protocol" : "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",
"udfs" : {
"udf" : [ {
"name" : "String value",
"value" : "String value"
}, {
"name" : "Another string value",
"value" : "Another string value"
} ]
}
}, {
"cliEnablePassword" : "Another string value",
"cliPassword" : "Another string value",
"cliRetries" : "Another string value",
"cliTimeout" : "Another string value",
"cliUsername" : "Another string value",
"credentialProfileName" : "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",
"networkMask" : "Another string value",
"protocol" : "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",
"udfs" : {
"udf" : [ {
"name" : "String value",
"value" : "String value"
}, {
"name" : "Another string value",
"value" : "Another string value"
} ]
}
} ]
}
}
}
Sample XML Response Payload
https://172.20.127.108/webacs/api/v3/op/devices/bulkImport
<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="../../../../pages/common/login.jsp.html" rootUrl="https://172.20.127.108/webacs/api/v3/op">
<bulkImportResult>
<jobName>String value</jobName>
<message>String value</message>
</bulkImportResult>
</mgmtResponse>
Sample JSON Response Payload
https://172.20.127.108/webacs/api/v3/op/devices/bulkImport.json
{
"mgmtResponse" : {
"@requestUrl" : "../../../../pages/common/login.jsp.html",
"@responseType" : "operation",
"@rootUrl" : "https://172.20.127.108/webacs/api/v3/op",
"bulkImportResult" : [ {
"jobName" : "String value",
"message" : "String value"
} ]
}
}
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/v4/op/devices/bulkImportUnmodified
This resource has not been modified since the previous API version.
Request Payload Parameters
Attribute | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
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://172.20.127.108/webacs/api/v4/op/devices/bulkImport
<?xml version="1.0" ?>
<devicesImport>
<devices>
<device>
<cliEnablePassword>String value</cliEnablePassword>
<cliPassword>String value</cliPassword>
<cliRetries>String value</cliRetries>
<cliTimeout>String value</cliTimeout>
<cliUsername>String value</cliUsername>
<credentialProfileName>String value</credentialProfileName>
<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>
<networkMask>String value</networkMask>
<protocol>String value</protocol>
<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>
<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>
<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>
<credentialProfileName>Another string value</credentialProfileName>
<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>
<networkMask>Another string value</networkMask>
<protocol>Another string value</protocol>
<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>
<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://172.20.127.108/webacs/api/v4/op/devices/bulkImport.json
{
"devicesImport" : {
"devices" : {
"device" : [ {
"cliEnablePassword" : "String value",
"cliPassword" : "String value",
"cliRetries" : "String value",
"cliTimeout" : "String value",
"cliUsername" : "String value",
"credentialProfileName" : "String value",
"httpConfigPassword" : "String value",
"httpConfigUsername" : "String value",
"httpMonitorPassword" : "String value",
"httpMonitorUsername" : "String value",
"httpPort" : "String value",
"httpServer" : "String value",
"ipAddress" : "String value",
"networkMask" : "String value",
"protocol" : "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",
"udfs" : {
"udf" : [ {
"name" : "String value",
"value" : "String value"
}, {
"name" : "Another string value",
"value" : "Another string value"
} ]
}
}, {
"cliEnablePassword" : "Another string value",
"cliPassword" : "Another string value",
"cliRetries" : "Another string value",
"cliTimeout" : "Another string value",
"cliUsername" : "Another string value",
"credentialProfileName" : "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",
"networkMask" : "Another string value",
"protocol" : "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",
"udfs" : {
"udf" : [ {
"name" : "String value",
"value" : "String value"
}, {
"name" : "Another string value",
"value" : "Another string value"
} ]
}
} ]
}
}
}
Sample XML Response Payload
https://172.20.127.108/webacs/api/v4/op/devices/bulkImport
<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="../../../../pages/common/login.jsp.html" rootUrl="https://172.20.127.108/webacs/api/v4/op">
<bulkImportResult>
<jobName>String value</jobName>
<message>String value</message>
</bulkImportResult>
</mgmtResponse>
Sample JSON Response Payload
https://172.20.127.108/webacs/api/v4/op/devices/bulkImport.json
{
"mgmtResponse" : {
"@requestUrl" : "../../../../pages/common/login.jsp.html",
"@responseType" : "operation",
"@rootUrl" : "https://172.20.127.108/webacs/api/v4/op",
"bulkImportResult" : [ {
"jobName" : "String value",
"message" : "String value"
} ]
}
}