mirror of
https://github.com/librenms/librenms.git
synced 2024-10-07 16:52:45 +00:00
bcedc0ed77
* Use GitLab instead of Gitlab Only change text part, the Alert.Transport.Gitlab class left as is. * Fix href in document * Move section in document The agent list in this document is sorted by alphabetical order, "SDFS info" is the only exception. * Remove trailing spaces in document * Align code in document * Fix Markdown in document - Escape underline - Add syntax highlight - Add two space in the end of line to make it a newline - Add newline before list or code section * Update LibreNMS/Alert/Transport/Gitlab.php Co-authored-by: Jellyfrog <Jellyfrog@users.noreply.github.com>
118 lines
3.6 KiB
Markdown
118 lines
3.6 KiB
Markdown
source: API/Inventory.md
|
|
path: blob/master/doc/
|
|
|
|
### `get_inventory`
|
|
|
|
Retrieve the inventory for a device. If you call this without any
|
|
parameters then you will only get part of the inventory. This is
|
|
because a lot of devices nest each component, for instance you may
|
|
initially have the chassis, within this the ports - 1 being an sfp
|
|
cage, then the sfp itself. The way this API call is designed is to
|
|
enable a recursive lookup. The first call will retrieve the root
|
|
entry, included within this response will be entPhysicalIndex, you can
|
|
then call for entPhysicalContainedIn which will then return the next
|
|
layer of results. To retrieve all items together, see
|
|
[get_inventory_for_device](#get_inventory_for_device).
|
|
|
|
Route: `/api/v0/inventory/:hostname`
|
|
|
|
- hostname can be either the device hostname or the device id
|
|
|
|
Input:
|
|
|
|
- entPhysicalClass: This is used to restrict the class of the
|
|
inventory, for example you can specify chassis to only return items
|
|
in the inventory that are labelled as chassis.
|
|
- entPhysicalContainedIn: This is used to retrieve items within the
|
|
inventory assigned to a previous component, for example specifying
|
|
the chassis (entPhysicalIndex) will retrieve all items where the
|
|
chassis is the parent.
|
|
|
|
Example:
|
|
|
|
```curl
|
|
curl -H 'X-Auth-Token: YOURAPITOKENHERE' https://librenms.org/api/v0/inventory/localhost?entPhysicalContainedIn=65536
|
|
```
|
|
|
|
Output:
|
|
|
|
```json
|
|
{
|
|
"status": "ok",
|
|
"message": "",
|
|
"count": 1,
|
|
"inventory": [
|
|
{
|
|
"entPhysical_id": "2",
|
|
"device_id": "32",
|
|
"entPhysicalIndex": "262145",
|
|
"entPhysicalDescr": "Linux 3.3.5 ehci_hcd RB400 EHCI",
|
|
"entPhysicalClass": "unknown",
|
|
"entPhysicalName": "1:1",
|
|
"entPhysicalHardwareRev": "",
|
|
"entPhysicalFirmwareRev": "",
|
|
"entPhysicalSoftwareRev": "",
|
|
"entPhysicalAlias": "",
|
|
"entPhysicalAssetID": "",
|
|
"entPhysicalIsFRU": "false",
|
|
"entPhysicalModelName": "0x0002",
|
|
"entPhysicalVendorType": "zeroDotZero",
|
|
"entPhysicalSerialNum": "rb400_usb",
|
|
"entPhysicalContainedIn": "65536",
|
|
"entPhysicalParentRelPos": "-1",
|
|
"entPhysicalMfgName": "0x1d6b",
|
|
"ifIndex": "0"
|
|
}
|
|
]
|
|
}
|
|
```
|
|
|
|
### `get_inventory_for_device`
|
|
|
|
Retrieve the flattened inventory for a device. This retrieves all
|
|
inventory items for a device regardless of their structure, and may be
|
|
more useful for devices with with nested components.
|
|
|
|
Route: `/api/v0/inventory/:hostname/all`
|
|
|
|
- hostname can be either the device hostname or the device id
|
|
|
|
Example:
|
|
|
|
```curl
|
|
curl -H 'X-Auth-Token: YOURAPITOKENHERE' https://librenms.org/api/v0/inventory/localhost?entPhysicalContainedIn=65536
|
|
```
|
|
|
|
Output:
|
|
|
|
```json
|
|
{
|
|
"status": "ok",
|
|
"message": "",
|
|
"count": 1,
|
|
"inventory": [
|
|
{
|
|
"entPhysical_id": "2",
|
|
"device_id": "32",
|
|
"entPhysicalIndex": "262145",
|
|
"entPhysicalDescr": "Linux 3.3.5 ehci_hcd RB400 EHCI",
|
|
"entPhysicalClass": "unknown",
|
|
"entPhysicalName": "1:1",
|
|
"entPhysicalHardwareRev": "",
|
|
"entPhysicalFirmwareRev": "",
|
|
"entPhysicalSoftwareRev": "",
|
|
"entPhysicalAlias": "",
|
|
"entPhysicalAssetID": "",
|
|
"entPhysicalIsFRU": "false",
|
|
"entPhysicalModelName": "0x0002",
|
|
"entPhysicalVendorType": "zeroDotZero",
|
|
"entPhysicalSerialNum": "rb400_usb",
|
|
"entPhysicalContainedIn": "65536",
|
|
"entPhysicalParentRelPos": "-1",
|
|
"entPhysicalMfgName": "0x1d6b",
|
|
"ifIndex": "0"
|
|
}
|
|
]
|
|
}
|
|
```
|