Przejdź do treści
Biblioteka skilli
DevOps i chmura · Integracja z narzędziem

itential-inventory

/itential-inventory

Zarządza inwentarzami urządzeń, węzłami, akcjami i tagami w Itential Inventory Manager, w tym masowym zasilaniem węzłów i uruchamianiem akcji na urządzeniach.

Repozytorium
builder-skills ↗
Licencja
GPL-3.0
Ostatnia zmiana repozytorium
15.10.2026

Ocena i bezpieczeństwo

100/ 100Klasa: dobry
Format25 / 25
Frontmatter z nazwą i opisem, poprawna nazwa, opis do 1024 znaków, nazwa zgodna z folderem.
Odkrywalność25 / 25
Opis mówi, kiedy użyć skilla, ma sensowną długość i jest w 3. osobie.
Treść35 / 35
Co najmniej 150 słów i do 500 linii, nagłówki, listy kroków, przykłady albo kod.
Higiena15 / 15
Bez zaślepek typu TODO, bez ścieżek Windows, z licencją.
Ryzykobrak sygnałów w skanie
Pliki w paczce
5
Skrypty
0
Komentarze HTML
0
Adresy URL w SKILL.md
0
Przestarzałość

Brak sygnałów. Repozytorium zmienione 15.10.2026, bez odwołań do wycofanych modeli i API.

Licencja

GPL-3.0, otwarta.

Co robi i kiedy

Zarządza inwentarzami urządzeń, węzłami, akcjami i tagami w Itential Inventory Manager, w tym masowym zasilaniem węzłów i uruchamianiem akcji na urządzeniach.

Argumenty

/itential-inventory [action or inventory-name]
Oryginalny opis (EN)

Manage device inventories, nodes, actions, and tags in Itential Inventory Manager. Use when working with IAG5 inventory, bulk node population, or running actions against inventory devices.

Jak działa

  1. Customization
  2. Concepts
  3. Gotchas
  4. API Reference
  5. Device Broker Adapter
  6. How It Connects to IAG
  7. RBAC
  8. Developer Scenarios
Sekcje z nagłówków SKILL.md, w oryginale · 405 linii, 2 212 słów
Podgląd SKILL.md
---
name: itential-inventory
description: Manage device inventories, nodes, actions, and tags in Itential Inventory Manager. Use when working with IAG5 inventory, bulk node population, or running actions against inventory devices.
argument-hint: "[action or inventory-name]"
---

# Inventory Manager - Developer Skills Guide

Inventory Manager provides centralized device and endpoint inventory for the Itential Platform. It maintains inventories of nodes (devices/targets), with actions that can be executed against them via IAG5 services. Required for IAG5 and Configuration Manager Enterprise. Configuration Manager and command templates only see inventory nodes once an Inventory Manager adapter instance is running (see [Device Broker Adapter](#device-broker-adapter)).

## Customization

Before using this skill, check `custom/org/`, `custom/team/` and `custom/dev/`
in this skill's own folder. Read every `.md` file found — any folder may be
empty or absent. Apply them on top of everything below; where a file overrides a
specific rule here, follow the override. More specific wins: dev > team > org >
this document. No customization may weaken this skill's safety
rules or put credentials in committed files.
---

## Concepts

- **Inventory** — a named collection of nodes with associated actions. Has groups for access control.
- **Node** — a device or target within an inventory. Has a name, attributes (key-value pairs like host, platform, credentials), and tags.
- **Action** — an operation that can be run against nodes. Currently only `iag5-service` type. Links to IAG services via `service_name` and `cluster_id`. (Note: `/itential-lcm` also has an "Action" concept, meaning a create/update/delete/import lifecycle operation — different meaning, same word.)
- **Tag** — a label for organizing inventories and nodes. Auto-created on first use, auto-cleaned when unused. Stored lowercase.

## Gotchas

- Response shape is `{status: "Success", result: {...}}` — extract data from `result`, not top-level
- Paginated responses inside `result` use `{data: [...], totalRecords, currentPage, pageSize, totalPages}`
- Inventories require at least one `group` — without it, creation fails
- Node names must be unique within an inventory (database constraint on `inventory_id + name`)
- `populateInventory` (bulk) **clears ALL existing nodes first** before inserting — it's a full replace, not append
- Action names must be unique within an inventory
- Only `iag5-service` action type is currently supported
- `cluster_id` resolves from `action_config.cluster_id` first, then falls back to `node.attributes.cluster_id`
- Tag names are stored lowercase — `"Core"` becomes `"core"`
- Identifiers accept both MongoDB ObjectId and name strings — auto-detected
- `createBrokerActions: true` auto-creates 4 standard actions (get-config, set-config, run-command, is-alive) — requires `defaultClusterId`
- **Inventory nodes only appear in Configuration Manager and command templates once an Inventory Manager *adapter instance* is running.** Creating an inventory and nodes (even with broker actions) is not enough — Device Broker only sees them through that adapter, so without it `POST /configuration_manager/devices` returns no devices and `GET /adapters/brokers/mapping` shows an empty `device` list. See [Device Broker Adapter](#device-broker-adapter) and check it **before** reporting an inventory task done

## API Reference

**Base Path:** `/inventory_manager/v1`

### Inventories

| Method | Endpoint | Description |
|--------|----------|-------------|
| POST | `/inventory_manager/v1/inventories` | Create a new inventory |
| GET | `/inventory_manager/v1/inventories` | List inventories with filtering and pagination |
| GET | `/inventory_manager/v1/inventories/{identifier}` | Get inventory by ID or name |
| DELETE | `/inventory_manager/v1/inventories/{identifier}` | Delete an inventory |
| GET | `/inventory_manager/v1/stats` | Get overview stats (total inventories, nodes, actions) |

**Create an inventory:**
```
POST /inventory_manager/v1/inventories
```
```json
{
  "name": "Lab Routers",
  "description": "Routers in the Atlanta Lab",
  "groups": ["Solutions Engineering"],
  "tags": ["routers", "lab"],
  "actions": [
    {
      "name": "get-config",
      "action_type": "iag5-service",
      "action_config": {
        "service_name": "get-config",
        "cluster_id": "labCluster"
      },
      "action_parameters": {}
    }
  ]
}
```
- `name` — required, must be unique
- `groups` — required, at least one group name for access control
- `tags` — optional, auto-created if they don't exist
- `actions` — optional, define operations runnable against nodes

**Or use `createBrokerActions` for standard actions:**
```json
{
  "name": "DC Switches",
  "description": "Data center switches",
  "groups": ["Solutions Engineering"],
  "createBrokerActions": true,
  "defaultClusterId": "dcCluster"
}
```
This auto-creates 4 actions: `get-config`, `set-config`, `run-command`, `is-alive` — all as `iag5-service` type pointing to the specified cluster.

**Response:**
```json
{
  "status": "Success",
  "result": {
    "_id": "697eb0fc4aef5efec3d7bbcf",
    "name": "Lab Routers",
    "groups": ["67c85954abe686cf9cb78b2e"],
    "description": "Routers in the Atlanta Lab",
    "actions": [
      {
        "name": "get-config",
        "action_type": "iag5-service",
        "action_config": {"service_name": "get-config", "cluster_id": "labCluster"},
        "action_parameters": {},
        "created_at": "2026-02-01T01:48:44.786Z",
        "created_by": "Pronghorn"
      }
    ],
    "tags": ["routers", "lab"]
  }
}
```

**List inventories with filtering:**
```
GET /inventory_manager/v1/inventories?page=1&pageSize=25&search=router&tags=core&sortField=name&sortOrder=1
```

**Query parameters:**
- `page` — page number (default 1)
- `pageSize` — results per page (default 25)
- `sortField` — field to sort by
- `sortOrder` — `1` ascending, `-1` descending
- `search` — text search across name/description
- `names` — filter by inventory names (array)
- `groups` — filter by group IDs or names
- `tags` — filter by tag names
- `minNodes` / `maxNodes` — filter by node count

**Stats:**
```
GET /inventory_manager/v1/stats
```
```json
{
  "status": "Success",
  "result": {
    "totalInventories": 1,
    "totalNodes": 2,
    "totalActions": 4
  }
}
```

### Nodes

| Method | Endpoint | Description |
|--------|----------|-------------|
| GET | `/inventory_manager/v1/nodes` | List all nodes with filtering and pagination |
| GET | `/inventory_manager/v1/inventories/{identifier}/nodes` | List nodes for a specific inventory |
| GET | `/inventory_manager/v1/inventories/{inventoryId}/nodes/{nodeId}` | Get a single node |
| POST | `/inventory_manager/v1/nodes/bulk` | Bulk populate inventory with nodes (replaces all existing) |
| DELETE | `/inventory_manager/v1/nodes/clear/{identifier}` | Clear all nodes from an inventory |
| POST | `/inventory_manager/v1/nodes/expand` | Expand node identifiers to full documents |
| POST | `/inventory_manager/v1/nodes/filter/build` | Build filter structure for service execution |

**Bulk populate an inventory with nodes:**
```
POST /inventory_manager/v1/nodes/bulk
```
```json
{
  "inventory_identifier": "Lab Routers",
  "nodes": [
    {
      "name": "core-router-1",
      "attributes": {
        "itential_host": "10.1.1.1",
        "itential_platform": "iosxr",
        "cluster_id": "cluster_east",
        "itential_user": "$SECRET.network_devices.username",
        "itential_password": "$SECRET.network_devices.password"
      },
      "tags": ["core", "datacenter-1"]
    },
    {
      "name": "core-router-2",
      "attributes": {
        "itential_host": "10.1.1.2",
        "itential_platform": "iosxr",
        "cluster_id": "cluster_east"
      },
      "tags": ["core", "datacenter-1"]
    }
  ]
}
```
- `inventory_identifier` — inventory name or ID
- **WARNING:** This clears ALL existing nodes first, then inserts. It's a full replace, not append.
- Tags are auto-created if they don't exist
- Node names must be unique within the inventory

**Response:**
```json
{
  "status": "Success",
  "result": {
    "data": [
      {
        "_id": "697eb1be4aef5efec3d7bbd2",
        "inventory_id": "697eb0fc4aef5efec3d7bbcf",
        "name": "core-router-1",
        "attributes": {"itential_host": "10.1.1.1", "itential_platform": "iosxr", ...},
        "tags": ["core", "datacenter-1"]
      }
    ],
    "totalRecords": 2,
    "currentPage": 1,
    "pageSize": 25,
    "totalPages": 1
  }
}
```

**Broker actions:** create the inventory with `"createBrokerActions": true` (and `"defaultClusterId"`) on `POST /inventory_manager/v1/inventories` to get the platform's standard device actions — `run-command`, `set-config`, `get-config`, `is-alive` — added automatically. They run on the Gateway5 cluster against any node whose attributes follow the broker convention below. Verified against an Arista EOS device over SSH (with a lab password; use a secret reference as shown in production):

```json
{"name": "ceos1", "attributes": {
  "itential_host": "10.0.0.5", "itential_user": "admin", "itential_password": "$SECRET.network_devices.password",
  "itential_platform": "arista_eos", "itential_driver": "netmiko",
  "itential_driver_options": {"netmiko": {"port": 22, "conn_timeout": 60}},
  "cluster_id": "cluster_1"}, "tags": ["arista"]}
```
`run-command` takes `{"command": "show version"}`; `GatewayManager.sendCommand` takes `{"commands": [...]}` and the same `inventory` reference. Moving devices off a Gateway4 built-in inventory: `ansible_host` → `itential_host`, `ansible_user` → `itential_user`, `ansible_password` → `itential_password` (as a secret reference), `ansible_network_os` (`arista.eos.eos`) → `itential_platform` (`arista_eos`), SSH `ansible_port` → `itential_driver_options.netmiko.port`, groups → tags.

**Node attributes:** Arbitrary key-value pairs. Common patterns:
- `itential_host` — device IP or hostname
- `itential_platform` — OS type (iosxr, ios, eos, etc.)
- `itential_user` / `itential_password` — credentials (use `$SECRET.` prefix for vault references)
- `cluster_id` — IAG cluster for this node (used as fallback if action doesn't specify one)

### Actions

| Method | Endpoint | Description |
|--------|----------|-------------|
| GET | `/inventory_manager/v1/actions` | List all actions across all inventories |
| GET | `/inventory_manager/v1/inventories/{identifier}/actions` | List actions for a specific inventory |
| GET | `/inventory_manager/v1/inventories/{identifier}/actions/{actionId}` | Get a single action |
| POST | `/inventory_manager/v1/inventories/{identifier}/actions` | Create a new action |
| DELETE | `/inventory_manager/v1/inventories/{identifier}/actions/{actionId}` | Delete an action |

**Create an action:**
```
POST /inventory_manager/v1/inventories/Lab%20Routers/actions
```
```json
{
  "name": "backup-config",
  "action_type": "iag5-service",
  "action_config": {
    "service_name": "backup-config",
    "cluster_id": "labCluster"
  },
  "action_parameters": {}
}
```
- `action_type` — currently only `"iag5-service"` is supported
- `action_config.service_name` — the IAG service to call (required)
- `action_config.cluster_id` — IAG cluster (optional, falls back to node's `cluster_id` attribute)

**Action execution** (via workflow task `InventoryManager.runInventoryAction`):
- Calls `GatewayManager.runService` with the action's `service_name` and `cluster_id`
- Response is JSON-RPC wrapped (same as IAG service responses)
- Non-zero `return_code` or error status throws an error

### Tags

| Method | Endpoint | Description |
|--------|----------|-------------|
| GET | `/inventory_manager/v1/tags` | List all tags with pagination |
| GET | `/inventory_manager/v1/tags/accessible` | Get tags from accessible inventories only |
| GET | `/inventory_manager/v1/tags/{identifier}` | Get a single tag by ID or name |
| GET | `/inventory_manager/v1/tags/{identifier}/usage` | Get usage statistics for a tag |
| POST | `/inventory_manager/v1/tags/search` | Find inventories and nodes by tags |

**Search by tags:**
```
POST /inventory_manager/v1/tags/search
```
```json
{
  "tagIdentifiers": ["core", "datacenter-1"]
}
```
- Field is `tagIdentifiers`, NOT `tags`
- Returns `{inventories: [...], nodes: [...]}` matching the specified tags

## Device Broker Adapter

Configuration Manager (device list, device groups, backups, golden configuration, compliance) and command templates reach inventory nodes through the **Inventory Manager adapter**, not through the `/inventory_manager/v1` API. The adapter is an instance you create once per platform; it is separate from the Inventory Manager application (which is already running if `GET /health/applications` lists `InventoryManager` as `RUNNING`). Nodes are exposed as `<inventory-name>::<node-name>` (for example `Main::AWS-IOS-XE`) unless `prepend_inventory_name` is `false`.

**Check first** — do this whenever a task adds inventories or nodes that Configuration Manager should see:

```
GET /health/adapters                 → is there an adapter whose properties.type is InventoryManager, state RUNNING, connection ONLINE?
GET /adapters/brokers/mapping        → "device" should list that adapter's name
```
(`GET /automation-studio/apps/list` shows the model: `@itential/adapter-inventory_manager`, name `InventoryManager`.) If one is already `RUNNING`, do not create a second one.

**Create and start it** if none exists (verified on Itential Platform; the adapter instance has no connection settings to supply):
```
POST /adapters
```
```json
{
  "properties": {
    "name": "inventory-manager-adapter",
    "model": "@itential/adapter-inventory_manager",
    "type": "Adapter",
    "isEncrypted": false,
    "description": "Exposes Inventory Manager inventories to Device Broker",
    "properties": {
      "id": "inventory-manager-adapter",
      "type": "InventoryManager",
      "brokers": ["device"],
      "groups": [],
      "properties": {"inventories": "all", "prepend_inventory_name": true}
    }
  }
}
```
```
PUT /adapters/inventory-manager-adapter/start
```
- `inventory-manager-adapter` is the recommended name. `properties.id` must equal `name`.
- A newly created adapter shows `DEAD`/`OFFLINE` until you start it. Re-check `GET /health/adapters` (it can take a few seconds to show `RUNNING`/`ONLINE`).
- `properties.properties.inventories` is `"all"` (default) or a list of inventory names to expose; `prepend_inventory_name` controls the `inventory::node` naming. Keep the defaults unless the request says otherwise.
- The adapter instance is platform-wide configuration, not a per-inventory one, so say in the report that you created it.

**Verify:**
```
POST /configuration_manager/devices   {"options": {"start": 0, "limit": 50}}
```
The response `list` should contain the node as `<inventory>::<node>` with `host` set to the adapter name and `totalByAdapter` counting it. If you added nodes after the adapter was already running and they do not show, `POST /configuration_manager/devices/refresh`.

**Actions are a separate requirement.** The adapter makes devices *visible*; Configuration Manager operations on them (backup, `get-config`, compliance, command templates) additionally need the inventory's broker actions (`createBrokerActions: true` with a `defaultClusterId`, or the actions added afterwards). A node listed with `"actions": []` is visible but cannot be operated on yet.

**Gateway prerequisite for the actions.** The built-in broker services run on the Gateway host's Python. If an action such as `is-alive` fails with `Failed to find compatible interpreter ... Version matches <3.15,>=3.10`, the Gateway host's Python is outside that range (3.9 was seen). This cannot be fixed through the platform API — ask a Gateway administrator to install a compatible Python, then re-run the action.

## How It Connects to IAG

Inventory Manager is the bridge between device inventory and IAG5 services:

```
Inventory (Lab Routers)
  ├── Nodes: core-router-1, core-router-2
  │     └── attributes: host, platform, cluster_id, credentials
  │
  ├── Actions: get-config, set-config, run-command, is-alive
  │     └── each action → IAG5 service via GatewayManager.runService
  │
  └── In a workflow:
        InventoryManager.runInventoryAction
          → resolves node attributes + action config
          → calls GatewayManager.runService(serviceName, clusterId, params, inventory)
          → returns JSON-RPC response
```

To use inventory nodes in IAG workflow tasks, the `inventory` parameter in `GatewayManager.runService` takes:
```json
[{"inventory": "Lab Routers", "nodeNames": ["core-router-1"]}]
```

## RBAC

Access is controlled through groups:
- `inventory:read` — list, get, search
- `inventory:create` — create inventories, nodes, tags
- `inventory:update` — update inventories, nodes, actions
- `inventory:delete` — delete inventories, nodes, actions
- `inventory:run` — execute actions

Users must be in a group with the required role. The Pronghorn internal account bypasses authorization.

## Developer Scenarios

### 1. Create an inventory with devices and test an action
```
0. Make sure the Inventory Manager adapter is running (see Device Broker Adapter) — otherwise nothing below shows in Configuration Manager
1. POST /inventory_manager/v1/inventories        → create with groups + createBrokerActions
2. POST /inventory_manager/v1/nodes/bulk          → populate with device nodes
3. GET  /inventory_manager/v1/inventories/{name}  → verify inventory + actions
4. In a workflow: InventoryManager.runInventoryAction on a node
5. Or via GatewayManager.runService with inventory parameter
6. If Configuration Manager should see the nodes: POST /configuration_manager/devices → expect "<inventory>::<node>"
```

### 2. Organize with tags
```
1. Create inventory with tags: ["production", "datacenter-1"]
2. Add nodes with tags: ["core", "border"]
3. POST /inventory_manager/v1/tags/search → find all "core" nodes across inventories
4. GET  /inventory_manager/v1/tags/{name}/usage → see how many inventories/nodes use a tag
```

### 3. Bulk refresh inventory from external source
```
1. Pull device list from external system (CMDB, IPAM, etc.)
2. Transform to node format: [{name, attributes, tags}, ...]
3. POST /inventory_manager/v1/nodes/bulk → replaces all nodes (WARNING: clears first)
4. Verify: GET /inventory_manager/v1/inventories/{name}/nodes
```
Pliki w paczce (5)
  • SKILL.md 18 KB
  • agents/openai.yaml 1 KB
  • custom/dev/.gitkeep 1 KB
  • custom/org/.gitkeep 1 KB
  • custom/team/.gitkeep 1 KB

Wersje

W bazie nie ma innych skilli o nazwie itential-inventory.

Migawka bazy z 13.11.2026 · wersja paczki e1a53e29a1f3 (skrót SHA-256 całej paczki)

Pobrania w ostatnich 30 dniach: 1 · ranking

Zgłoś problem z tym skillem: szkodliwa treść, błędny opis albo prośba autora o usunięcie.

Podobne skille

  • 100itential-devices
    Zarządza urządzeniami sieciowymi, kopiami zapasowymi, różnicami, grupami urządzeń i szablonami urządzeń w Itential Configuration Manager.
  • 100itential-lcm
    Zarządza modelami zasobów, instancjami, akcjami i wykonywaniem cyklu życia w Itential Lifecycle Manager, w tym historią wykonania akcji.
  • 100itential-automation
    Obsługuje Itential Automation Platform (IAP) przez ponad 65 narzędzi MCP: orkiestracja automatyzacji sieci, zarządzanie konfiguracją urządzeń, zgodność, workflow, golden config i cykl życia.
  • 100inventory-manager
    Porządkuje pliki inwentarza Ansible, zarządza grupami hostów i konfiguruje dynamiczne źródła inwentarza.
  • 100pyats-config-mgmt
    Prowadzi zarządzanie zmianami sieci przez pyATS: stan bazowy przed zmianą, wdrożenie konfiguracji, weryfikacja po zmianie, wycofanie i kontrole zgodności.
  • 100inventory
    Tworzy raport tylko do odczytu z lokalnych workflow n8n: zestawienie użytych węzłów, modeli LLM, poświadczeń i wyzwalaczy zapisane w docs/INVENTORY.md.

Uwagi i zgłoszenia

Wiadomość trafi do Bartosza Sokolińskiego. Adres e-mail jest potrzebny tylko do odpowiedzi. Szczegóły w polityce prywatności.