itential-devices skill
✓ VerifiedManage network device inventory, configurations, backups, device groups, and Jinja2 templates.
- GitHub stars
- 18
- Files
- 5
- Last commit
- Nov 5, 2026
- License
- GPL-3.0
- Allowed tools
- —
What does the itential-devices skill do?
itential-devices manages network device inventory, configurations, backups, device groups, and Jinja2 templates.
Summary generated from the skill's SKILL.md.
About the itential-devices skill
Managing network device inventory and configurations is what this skill enables for network administrators and automation engineers. It provides a centralized way to handle the full lifecycle of device configurations, including retrieving current settings, performing backups, and applying new configurations to specific hardware. An agent should load this skill when a user needs to audit device states, manage device groups for bulk operations, or compare configuration versions.
The toolset includes capabilities for creating logical device groups, using Jinja2 templates via the Template Designer, and performing diffs between backups to identify changes. It supports various comparison granularities such as line, word, or character levels. For large-scale environments, it handles large configurations by storing them in GridFS. While it manages the core configuration lifecycle, users looking for compliance grading, remediation, or golden configuration trees should use the specialized /itential-golden-config endpoint instead.
What an agent can do with it
- 1Perform configuration backupsCreate a new backup of a specific network device configuration before making changes.
- 2Compare configuration versionsIdentify the specific text differences between two stored device backups.
- 3Organize devices into groupsCreate a logical group of devices using a comma-separated list of names for bulk management.
Written from the skill's SKILL.md. Every use case is checked against a quote from it.
How to install the itential-devices skill
Each command copies the skill folder into the client's skills directory. Restart the client or start a new session to load it.Install the itential-devices skill in Plugin
/plugin marketplace add itential/builder-skills /plugin install itential-builder@itential-builder
Install the itential-devices skill in Claude Code
~/.claude/skills/itential-devices/SKILL.md
$ npx degit itential/builder-skills/skills/itential-devices ~/.claude/skills/itential-devicesInstall the itential-devices skill in Claude Code (project)
.claude/skills/itential-devices/SKILL.md
$ npx degit itential/builder-skills/skills/itential-devices .claude/skills/itential-devicesInstall the itential-devices skill in Codex
~/.agents/skills/itential-devices/SKILL.md
$ npx degit itential/builder-skills/skills/itential-devices ~/.agents/skills/itential-devicesInstall the itential-devices skill in Gemini CLI
~/.gemini/skills/itential-devices/SKILL.md
$ npx degit itential/builder-skills/skills/itential-devices ~/.gemini/skills/itential-devicesInstall the itential-devices skill in Claude.ai
npx degit itential/builder-skills/skills/itential-devices itential-devices && zip -r itential-devices.zip itential-devices # claude.ai → Customize → Skills → + → Create skill → Upload a skill → itential-devices.zip
Automated checks
Ran Nov 14, 2026Full report →Passed our automated checks. That is not a security audit: read the scripts before you let an agent run them. How checks work
- Source repository linked and reachableitential/builder-skills/skills/itential-devices is public and reachablegithub.com/itential/builder-skills/tree/HEAD/skills/itential ↗Pass
- Open source license (OSI)GPL-3.0spdx.org/licenses/GPL-3.0.html ↗Pass
- Commit or release in the last yearLast commit 2026-11-05github.com/itential/builder-skills/commits ↗Pass
- No download-and-run or credential theft in scriptsNo scripts in the skill folderPass
- No hidden instructions in SKILL.mdNo override phrases, safeguard switches, credential requests or hidden charactersgithub.com/itential/builder-skills/blob/HEAD/skills/itential ↗Pass
- Pre-approved tools are scopedNo pre-approved tools; the agent asks before using onegithub.com/itential/builder-skills/blob/HEAD/skills/itential ↗Pass
- SKILL.md follows the Agent Skills formatValid name and description; says when to use it; 459 linesgithub.com/itential/builder-skills/blob/HEAD/skills/itential ↗Pass
SKILL.md
View on GitHubConfiguration Manager - Developer Skills Guide
Configuration Manager is the Itential Platform application for managing devices, their configurations, and compliance. It provides the tools to retrieve, back up, apply, and diff device configurations.
For Golden Configurations, compliance, and grading, use /itential-golden-config.
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.
Gotchas
POST /configuration_manager/devicesis a POST, not GET — requires{"options": {...}}body- Device list is in the
listfield, notdevicesorresults - Backup response returns
{status, message, id}— theidis the backup's MongoDB insertedId - Apply config body has nested structure:
{"config": {"device": "...", "config": "..."}}— config inside config - Diff endpoint is PUT
/configuration_manager/lookup_diff, not POST. Supportsoptions.type:'line','word'(default),'char' - Create group:
/devicegroup(singular), list groups:/deviceGroups(plural) deviceNamesin create group is a comma-separated string, NOT an array:"dev1, dev2"providerin backup can be a string OR an array depending on the adapter- Empty device config → backup silently not created (returns error, no backup stored)
- Large configs auto-stored in GridFS —
rawConfigfield is empty in the document, config is in GridFS - Cannot delete device groups referenced by a Compliance Plan or Golden Config — deletion is blocked
- Device group update only accepts:
name,devices,description,gbac— other fields silently dropped - Duplicate group names blocked on create and rename
searchDeviceGroupscaps page size at 100 regardless of requested limitgetDeviceGroupByIdaccepts both ID and name — auto-detects which one you passed- Device template apply checks OS type compatibility — fails if device
ostypedoesn't match template'sdeviceOSTypes - Backup search uses regex by default — set
options.regex: falsefor exact matching
What is Configuration Manager?
Configuration Manager handles the full lifecycle of device configuration:
- Devices - Inventory of network devices discovered through adapters, with the ability to retrieve, back up, and apply configurations
- Device Groups - Logical groupings of devices for bulk operations
- Template Designer - Reusable Jinja2 config templates that can be applied to devices
- Backups & Diff - Backup device configs and compare versions to see what changed
- Golden Configurations - Use
/itential-golden-configfor trees, config specs, compliance, grading, and remediation
How They Connect
Devices ──────────────────────────────────────────────────┐
│ │
├── belong to Device Groups │
│ │
├── configs can be backed up and diffed │
│ │
├── Device Templates can be applied to devices │
│ │
├── are assigned to Golden Config tree nodes │
│ │ │
│ └── See /itential-golden-config for full details │
│ │
└── Compliance runs compare device config ◄─────────────┘
against Config Specs → produce Compliance Reports
API Reference
Base Path: /configuration_manager
Authentication: Bearer token (OAuth), Query token, Basic Auth, or Cookie
Devices
Devices are discovered through adapters (e.g., IAG, Cisco DNA). Configuration Manager can retrieve, back up, and apply configurations to them.
| Method | Endpoint | Description |
|---|---|---|
| POST | /configuration_manager/devices |
Find devices with filtering and pagination |
| GET | /configuration_manager/devices/{name} |
Get device details by name |
| GET | /configuration_manager/devices/{name}/configuration |
Get current device configuration |
| POST | /configuration_manager/devices/{deviceName}/configuration |
Apply a config to a device |
| POST | /configuration_manager/devices/backups |
Backup device configuration |
| POST | /configuration_manager/backups |
Search/list backups with filtering and pagination |
| GET | /configuration_manager/backups/{id} |
Get a backup by ID |
| PUT | /configuration_manager/backups/{id} |
Update backup metadata (description, notes) |
| DELETE | /configuration_manager/backups |
Delete backups by array of IDs |
| GET | /configuration_manager/devices/{name}/isAlive |
Check if device is connected |
Get device details:
GET /configuration_manager/devices/IOS-CAT8KV-1
{
"name": "IOS-CAT8KV-1",
"device-type": "network_cli",
"ipaddress": "10.1.8.80",
"port": 22,
"ostype": "cisco-ios",
"chosenAdapter": "AutomationGateway",
"origin": "AutomationGateway"
}
Find devices with filtering:
POST /configuration_manager/devices
{
"options": {
"filter": { "name": "" },
"start": 0,
"limit": 25,
"sort": [{ "name": 1 }],
"order": "ascending"
}
}
Options fields:
limit(integer, required) - max results to return (min: 1)start(integer) - pagination offset (min: 0)filter(object) - filter byname,address(IP),portsort(array) - sort objects, e.g.[{"name": 1}](1 = ascending, -1 = descending)order(string) -"ascending"or"descending"adapterType(array) - filter by adapter type, e.g.["AnsibleManager", "NSO"]adapterId(array) - filter by adapter instance IDexactMatch(boolean) -truefor exact match,falsefor partial/contains match
Response:
{
"entity": "device",
"total": 24,
"unique_device_count": 24,
"return_count": 24,
"start_index": 0,
"list": [
{
"name": "IOS-CAT8KV-1",
"device-type": "network_cli",
"ipaddress": "10.1.8.80",
"port": 22,
"ostype": "cisco-ios",
"host": "AutomationGateway",
"chosenAdapter": "AutomationGateway"
}
]
}
Note: devices are in the list field, not devices.
Get device config response:
{
"device": "IOS-CAT8KV-1",
"config": "! Last configuration change at ...\nversion 17.15\nservice timestamps debug datetime msec\n..."
}
The config field contains the full running configuration as a string.
Backup device config:
POST /configuration_manager/devices/backups
{
"name": "IOS-CAT8KV-1",
"options": {
"description": "Pre-change backup",
"notes": "Backup before port turn-up"
}
}
Response:
{
"status": "success",
"message": "Device IOS-CAT8KV-1 backed up successfully",
"id": "699b69e25ae7d527cda5ffe4"
}
The id field is the backup's MongoDB ID — use it to retrieve the backup later.
Note: If the device returns an empty configuration, the backup is NOT created and returns an error.
Backup structure (GET /configuration_manager/backups/{id}):
{
"_id": "699b69e25ae7d527cda5ffe4",
"name": "IOS-CAT8KV-1",
"provider": "AutomationGateway",
"type": "native",
"date": "2026-02-22T20:41:06.160Z",
"rawConfig": "...(full config text)...",
"description": "Pre-change backup",
"notes": "Backup before port turn-up"
}
Note: provider can be a string or array depending on the adapter. For very large configs, rawConfig may be empty — the config is stored in GridFS (check storage.type === 'gridfs').
Search/list backups:
POST /configuration_manager/backups
{
"options": {
"filter": { "name": "IOS-CAT8KV-1" },
"start": "0",
"limit": 25,
"sort": { "date": -1 },
"regex": true
}
}
Response:
{
"total": 3,
"list": [
{ "_id": "699b69e25ae7d527cda5ffe4", "name": "IOS-CAT8KV-1", "date": "...", "description": "..." }
]
}
options.startmust be a string (not integer)options.regexdefaults totrue(filter values use regex). Setfalsefor exact matching.- Backups are in the
listfield.
Update backup metadata:
PUT /configuration_manager/backups/{id}
{
"description": "Updated description",
"notes": "Updated notes"
}
Delete backups:
DELETE /configuration_manager/backups
{
"backupIds": ["699b69e25ae7d527cda5ffe4", "699b6c745ae7d527cda5ffe8"]
}
Apply config to a device (POST /configuration_manager/devices/{deviceName}/configuration):
The deviceName is a path parameter, not in the body. The config field is an object:
{
"config": {
"device": "IOS-CAT8KV-1",
"config": "interface GigabitEthernet0/1\n switchport access vlan 100\n no shutdown"
},
"options": {}
}
Compare two backups (diff):
PUT /configuration_manager/lookup_diff
{
"id": "699b69e25ae7d527cda5ffe4",
"nextId": "699b6c745ae7d527cda5ffe8",
"collection": "backups",
"nextCollection": "backups"
}
collection- must be one of:backups,nodes,deviceGroupsnextCollection- must be one of:devices,backups,nodes,deviceGroupsoptions(optional) -{"type": "word"}where type is"line","word"(default), or"char"- Response is an array of
[operation, text]tuples:0= unchanged text1= added text-1= removed text
Run compliance on backups (compare backup against golden config without touching the device):
POST /configuration_manager/compliance_reports/backups
{
"treeInfo": { "treeId": "...", "version": "initial", "nodePath": "base" },
"backupIds": ["699b69e25ae7d527cda5ffe4"]
}
DiffViewer (workflow task for visual diff):
- Task:
ConfigurationManager.DiffViewer - Incoming:
compareFirstString,firstTitle,compareSecondString,secondTitle,darkMode - Displays a side-by-side diff for manual review in a workflow
Device Groups
Logical groupings of devices for running bulk compliance checks, golden config assignments, and operational tasks.
| Method | Endpoint | Description |
|---|---|---|
| GET | /configuration_manager/deviceGroups |
List all device groups |
| POST | /configuration_manager/devicegroup |
Create a device group |
| GET | /configuration_manager/deviceGroups/{id} |
Get a device group by ID |
| GET | /configuration_manager/name/devicegroups |
Get a device group by name |
| PUT | /configuration_manager/deviceGroups/{id} |
Update a device group |
| DELETE | /configuration_manager/deviceGroups |
Delete device groups |
| POST | /configuration_manager/deviceGroups/{id}/devices |
Add devices to a group |
| DELETE | /configuration_manager/deviceGroups/{id}/devices |
Remove devices from a group |
| POST | /configuration_manager/deviceGroups/search |
Search groups with pagination |
| GET | /configuration_manager/groups/device/{deviceName} |
Find all groups containing a device |
Create a device group:
POST /configuration_manager/devicegroup
{
"groupName": "Cisco Devices",
"groupDescription": "All Cisco IOS devices in the lab",
"deviceNames": "IOS-CAT8KV-1, IOS-CSR-AWS-1"
}
Device group structure:
{
"_id": "683a07a602c95837ccbfd39f",
"name": "Cisco Devices",
"devices": ["IOS-CAT8KV-1", "IOS-CSR-AWS-1"],
"description": "",
"created": "2025-05-30T19:31:50.069Z",
"createdBy": "ankit.bhansali@itential.com"
}
Template Designer (Device Templates)
Device templates are reusable Jinja2 configuration snippets that can be applied to devices. They store both the template text and default variable values.
| Method | Endpoint | Description |
|---|---|---|
| POST | /configuration_manager/templates |
Create a device template |
| POST | /configuration_manager/templates/search |
Search/get device templates |
| PUT | /configuration_manager/templates |
Update a device template |
| DELETE | /configuration_manager/templates |
Delete device templates by ID |
| POST | /configuration_manager/templates/apply |
Apply a template to a device |
| POST | /configuration_manager/import/templates |
Import device templates |
Create a device template:
POST /configuration_manager/templates
{
"name": "IOS_Subinterface_Config",
"template": "interface GigabitEthernet1.{{ vlan_id }}\n description {{ description }}\n encapsulation dot1Q {{ vlan_id }}\n ip address {{ ip_address }} {{ subnet_mask }}",
"variables": {
"vlan_id": "800",
"description": "Test Subinterface",
"ip_address": "10.80.0.1",
"subnet_mask": "255.255.255.0"
}
}
template- Jinja2 template text with{{ variable }}placeholdersvariables- default values for the template variables (used when applying without overrides)
Response:
{
"result": "success",
"data": {
"_id": "699b6b8a5ae7d527cda5ffe7",
"name": "IOS_Subinterface_Config",
"template": "interface GigabitEthernet1.{{ vlan_id }}\n ...",
"variables": { "vlan_id": "800", "description": "Test Subinterface", ... },
"deviceOSTypes": []
}
}
Apply a template to a device:
POST /configuration_manager/templates/apply
{
"deviceName": "IOS-CAT8KV-1",
"templateId": "699b6b8a5ae7d527cda5ffe7",
"options": {}
}
Response:
{
"status": "success",
"result": [{ "value": "4 Command(s) Sent." }],
"chosenAdapter": "AutomationGateway"
}
The template is rendered with the stored variables and pushed to the device as CLI commands.
Search templates:
POST /configuration_manager/templates/search
{
"name": "IOS_Subinterface",
"options": {}
}
Import/Export
| Method | Endpoint | Description |
|---|---|---|
| POST | /configuration_manager/import/backups |
Import backup documents |
| POST | /configuration_manager/import/groups |
Import device group documents |
| POST | /configuration_manager/import/templates |
Import device config templates |
For golden config import/export, use /itential-golden-config.
Developer Scenarios
1. Device configuration management
GET /configuration_manager/devices/{name} → get device details
GET /configuration_manager/devices/{name}/configuration → get current config
POST /configuration_manager/devices/backups → backup before changes
POST /configuration_manager/templates/apply → apply a template
GET /configuration_manager/devices/{name}/configuration → verify change
POST /configuration_manager/devices/backups → backup after changes
PUT /configuration_manager/lookup_diff → diff pre vs post backups
2. Create and apply a device template
POST /configuration_manager/templates → create template with Jinja2 text + variables
POST /configuration_manager/templates/apply → apply to device {deviceName, templateId}
Verify: GET /configuration_manager/devices/{name}/configuration
3. Golden config and compliance
Use /itential-golden-config for the full flow.
Files in this skill
5itential-devices skill questions
How do I install the itential-devices skill in Claude Code?
Run npx degit itential/builder-skills/skills/itential-devices ~/.claude/skills/itential-devices. Claude Code loads skills from ~/.claude/skills (all projects) or .claude/skills (one project) and uses a skill when its description matches the task.
Which clients can use the itential-devices skill?
Any client that reads the Agent Skills format: Claude Code, Codex, Gemini CLI and claude.ai (upload as a ZIP). Scripts in the skill run only where the client allows code execution.
What happens if I try to back up a device with an empty configuration?
The backup will not be created and the system will return an error.
How can I compare two different configurations?
You can use the PUT /configuration_manager/lookup_diff endpoint to compare two backups, device groups, or nodes, with diff types supporting line, word, or character levels.
Where are large device configurations stored?
Large configurations are automatically stored in GridFS, which means the rawConfig field in the document will be empty.