1. REST API for Unified Assurance Microservices
  2. Tasks
  3. Inventory

Update the Inventory

patch

/inventory

Updates the inventory with the discovery results.

Request

Query Parameters
  • Whether to prune instances (true) or not (false). If set to true, any instances that belong to the device in the database but are not included in the payload are delete.
  • Whether to publish errors (true) or not (false).
Supported Media Types
Request Body - application/json ()
Root Schema : schema
Type: object
Show Source
Nested Schema : ModelData
Type: object
Show Source
Nested Schema : Cisco
Type: array
Cisco Meraki API data discovered for the discovery.
Show Source
Nested Schema : Devices
Type: object
Additional Properties Allowed
Show Source
The list of devices discovered.
Example:
{
    "203.0.113.1":{
        "ICMPData":{
            "PollTimePCOM":300,
            "PollTimeACOM":300,
            "Available":true,
            "Hostname":"example1.oracle.com",
            "LastRTTNano":221198,
            "Timestamp":1702216942,
            "IPAddress":"203.0.113.1",
            "ZoneID":1
        },
        "SNMPData":{
            "DeviceSystemInfo":{
            }
        }
    },
    "203.0.113.2":{
        "ICMPData":{
            "PollTimePCOM":300,
            "PollTimeACOM":300,
            "Available":true,
            "Hostname":"example2.oracle.com",
            "LastRTTNano":645484,
            "Timestamp":1702216942,
            "IPAddress":"203.0.113.2",
            "ZoneID":1
        },
        "SNMPData":{
            "DeviceSystemInfo":{
            }
        }
    },
    "203.0.113.3":{
        "ICMPData":{
            "PollTimePCOM":300,
            "PollTimeACOM":300,
            "Available":true,
            "Hostname":"example3.oracle.com",
            "LastRTTNano":688044,
            "Timestamp":1702216942,
            "IPAddress":"203.0.113.3",
            "ZoneID":1
        },
        "SNMPData":{
            "Target":"192.0.2.1",
            "ProfileUUID":"df29b366-c3a4-4a89-8ec8-2f1527276c75",
            "Discovered":true,
            "Method":"BULK",
            "DeviceSystemInfo":{
                "SysDescription":"Oracle Software",
                "SysLocation":"telephone closet, 3rd floor",
                "SysName":"example3.oracle.com",
                "SysOid":"1.3.6.1.4.1.19.12.1.45.2.1.3.4.1.4"
            }
        }
    },
    "192.0.2.2":{
        "ICMPData":{
            "PollTimePCOM":300,
            "PollTimeACOM":300,
            "Available":true,
            "Hostname":"example4.oracle.com",
            "LastRTTNano":1491998,
            "Timestamp":1702216942,
            "IPAddress":"192.0.2.2",
            "ZoneID":1
        },
        "SNMPData":{
            "Target":"192.0.2.3",
            "ProfileUUID":"df29b366-c3a4-4a89-8ec8-2f1527276c75",
            "Discovered":true,
            "Method":"BULK",
            "DeviceSystemInfo":{
                "SysDescription":"Oracle Software",
                "SysLocation":"telephone closet, 3rd floor",
                "SysName":"example4.oracle.com",
                "SysOid":"1.3.6.1.4.1.19.12.1.45.2.1.3.4.1.3"
            }
        }
    }
}
Nested Schema : VMWare
Type: array
The VMware data discovered for the discovery.
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : MerakiDiscoveryData
Type: object
Discovery data for Meraki organizations and networks.
Show Source
Nested Schema : organizations
Type: array
List of organizations discovered by the Meraki API.
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : devices
Type: array
List of devices in the organization.
Show Source
Nested Schema : networks
Type: array
List of networks within the organization.
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : networkDevices
Type: array
List of devices associated with the network.
Show Source
Nested Schema : productTypes
Type: array
List of product types in the network.
Show Source
Nested Schema : items
Type: object
Show Source
  • The firmware version of the device.
    Example: wired-19-1-6
  • Latitude of the device.
    Example: 37.4180951010362
  • Longitude of the device.
    Example: -122.098531723022
  • The MAC address of the device.
    Example: FF:FF:FF:FF:FF:FF
  • The model of the device.
    Example: MX95
  • The serial number of the device.
    Example: XXXX-XXXX-XXXX
  • URL for the device management page.
    Example: https://n35.example.com/DE-Dortmund-Stag/n/AN3a-bJ/manage/nodes/new_list/9834197920531
  • The WAN IP address of the device.
    Example: 193.96.193.149
Nested Schema : additionalProperties
Type: object
Show Source
Nested Schema : ICMPData
Type: object
The ICMP data discovered for the discovery.
Show Source
Nested Schema : SNMPData
Type: object
The SNMP data discovered for the discovery.
Show Source
Nested Schema : Properties
Type: object
The device properties.
Show Source
  • Allowed Values: [ true, false ]
    The status of the devices can be managed. Possible values are true and false.
Nested Schema : Availability
Type: array
The availability data of the SNMP device.
Show Source
Nested Schema : DeviceSystemInfo
Type: object
The information about SNMP device system.
Show Source
Nested Schema : Performance
Type: array
The performance data of the SNMP device.
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : Instances
Type: array
The instance details of the SNMP device.
Nested Schema : items
Type: object
Show Source
Nested Schema : items
Type: object
Show Source
Back to Top

Response

Supported Media Types

200 Response

Successful operation
Body ()
Root Schema : schema
Type: object

204 Response

No content

401 Response

Unauthorized operation

405 Response

Bad request

500 Response

Internal server error
Back to Top