Inventory

The inventory API provides the core functionality of manipulating devices in the Net LineDancer inventory, including: adding devices, deleting devices, modifying devices, searching devices, etc.

See the Inventory Objects section for a description of the various objects consumed and returned by these APIs.

Inventory.createDevice

Add a device to the inventory, in the specified network. If the device was created successfully, the return value is null, otherwise an error message is returned.

Parameters

Return: an error message or null

Inventory.deleteDevice

Delete a device from the inventory.

Parameters

Return: null

Inventory.getDevice

The Inventory.getDevice method returns a Device object as described above, or null if the requested device does not exist.

Parameters

Return: Device object or null

Inventory.updateDevice

The Inventory.updateDevice method is used to update an existing device in the inventory. It requires only network and ipAddress as parameters, all other parameters are optional.

Return: null

Python Example:

error = netld.call('Inventory.updateDevice', 'Default', '10.0.0.1', null, null, null, 'newhostname')

Inventory.updateDevices

The Inventory.updateDevices method updates Adapter IDs and/or custom field values for multiple devices in a single operation.

The ipCsv parameter is a comma separated list of devices of the form IPAddress@network (e.g. 192.168.0.254@NetworkA,10.0.0.1@NetworkB).

The adapterId parameter is either a new Adapter ID to assign to the specified devices, or null to leave the device’s Adapter ID at their current values. See Appendix A for a list of valid Adapter IDs.

The customFields parameter is an array of UTF-8 string values. The first element of the array corresponds to the Custom 1 custom field, and the fifth element corresponds to the Custom 5 custom field. Elements of the customFields array that are null will leave the corresponding custom fields at their current values.

Return: null

Python example:

netld.call('Inventory.updateDevices',
           '192.168.0.254@NetworkA,192.168.0.252@NetworkA',
           null,
           ['Tokyo HQ', 'Rack 1F-8'])

Inventory.search

The Inventory.search method is the fundemental way of retrieving devices from the inventory. Search supports many criteria, and the criteria can be combined to perform powerful searches.

The scheme parameter is a single value or a comma separated list of search schemes from the following table:

The query parameter defines the query criteria to be used and is in association with the schemes defined by the scheme parameter. For example, if you wish to search based on scheme ipAddress and hostname you would specify a scheme parameter of “ipaddress,hostname”, and a query parameter of “192.168.0.0/24\ntokyo*”. Note the newline character between the ipAddress query value and the hostname query value.

Return: A PageData object

The PageData object that is returned will contain an attribute called devices, which is an array of Device objects. If the initial offset that is passed is zero (0), the returned PageData object will also contain a populated total attribute, telling you how many total results are available. By incrementing the offset by pageSize you can retrieve subsequent pages of results. When offset + pageSize is greater than or equal to total there are no more results available.

Sample Request JSON:

{
   "jsonrpc": "2.0",
   "method": "Inventory.search",
   "params": {
              "network": ["Default"],
              "scheme": "ipAddress",
              "query": "10.0.3.0/24",
              "pageData": {
                           "offset": 0,
                           "pageSize": 100
                          },
              "sortColumn": "ipAddress",
              "descending": false
             },
   "id": 1
}

Sample Response JSON:

{  
   "jsonrpc": "2.0",
   "id": 1,
   "result": {
      "offset": 0,
      "pageSize": 100,
      "total": 2,
      "devices": [
         {  
            "ipAddress": "10.0.3.1",
            "hostname": "C2611",
            "adapterId": "Cisco::IOS",
            "deviceType": "Router",
            "hardwareVendor": "Cisco",
            "model": "CISCO2611",
            "softwareVendor": "Cisco",
            "osVersion": "12.1(19)",
            "backupStatus": "SUCCESS",
            "complianceState": 0,
            "lastBackup": 1410324616600,
            "lastTelemetry": null,
            "memoSummary": null,
            "custom1": "",
            "custom2": "",
            "custom3": "",
            "custom4": "",
            "custom5": "",
            "network": "Default",
            "serialNumber": "JAB03060AX0"
         },
         {  
            "ipAddress": "10.0.3.6",
            "hostname": "C2611-2",
            "adapterId": "Cisco::IOS",
            "deviceType": "Router",
            "hardwareVendor": "Cisco",
            "model": "CISCO2611XM-2FE",
            "softwareVendor": "Cisco",
            "osVersion": "12.4(12)",
            "backupStatus": "SUCCESS",
            "complianceState": 0,
            "lastBackup": 1410324618367,
            "lastTelemetry": null,
            "memoSummary": null,
            "custom1": "",
            "custom2": "",
            "custom3": "",
            "custom4": "",
            "custom5": "",
            "network": "Default",
            "serialNumber": "JAE07170Q8S"
         }
      ]
   }
}

Sample Request JSON combining two search schemes:

{
   "jsonrpc": "2.0",
   "method": "Inventory.search",
   "params": {
              "network": ["Default"],
              "scheme": "ipAddress,custom",
              "query": "10.0.3.0/24\ncustom2=New York*,custom4=core",
              "pageData": {
                           "offset": 0,
                           "pageSize": 100
                          }
             },
   "id": 1
}

Inventory Objects

Device

PageData

Inventory.getDeviceHardware

The Inventory.getDeviceHardware returns a list of hardware of the requested device.

Parameters

Return: list of Hardware Objects