- Itential Cloud
- Release Announcements
- Admin Portal
- Automation Service
- Getting Started
- Automation Service Guides
- Releases & Highlights
- Itential Automation Gateway 5 (IAG5)
- What's New
- Intro to IAG5
- Installation
- Scalable Designs
- Creating a Service
- Decorators
- Using IAG5
- Command References
- Config Variables
- FAQ & Support
- Itential Platform (2023.2)
- Orchestration Environments
- Admin Essentials
- API Documentation
- Automation Studio
- Navigation & User Interface
- Automation Builder in IAP
- Intro to Automation Builder
- Gen 1 Automation Builder
- New Canvas Experience in Automation Builder
- How to Create and Run Workflows on the Canvas
- How to Configure and Edit Tasks on the Canvas
- How to Use Transitions and Task States on the Canvas
- How to Use Search in the New Canvas
- How to Use the Reference View
- Parallel Branching on the Canvas
- Troubleshooting Errors & Warnings on the New Canvas
- Keyboard Shortcuts for the Canvas
- Projects
- Forms
- JSON Forms
- Template Builder
- Analytic Templates
- Command Templates
- Task References
- Transformations
- Configuration Manager
- Integrations & Adapters
- Legacy & Custom
- Lifecycle Manager
- Operations Manager
- Using NSO with IAP
- Breaking Changes
- Broken References
- Data Path Property Renamed
- DryRun & View DryRun Manual Tasks Removed
- Help and Status API Endpoints Removed
- IAP Key Removed
- Integration API Routes Removed
- Job Variable Changes in Child Workflows
- IWAN Tasks Removed
- NSO Features Removed
- Merge Task Variables - Null vs. Undefined
- Operations Manager API Changes
- Removed Inline Images from Pre-built Automation README Files
- Reserved Method Output Name
- Seed Scripts Removed in Template Builder
- Service Manager UI Removed
- Workflow Engine API Routes Removed
- Itential Platform (2023.1)
- Orchestration Environments
- Admin Essentials
- API Documentation
- Automation Studio
- Navigation & User Interface
- Automation Builder in IAP
- Intro to Automation Builder
- Gen 1 Automation Builder
- New Canvas Experience in Automation Builder
- How to Create and Run Workflows on the Canvas
- How to Configure and Edit Tasks on the Canvas
- How to Use Transitions and Task States on the Canvas
- How to Use Search in the New Canvas
- How to Use the Reference View
- Parallel Branching on the Canvas
- Troubleshooting Errors and Warnings on the New Canvas
- Keyboard Shortcuts for the Canvas
- Forms
- JSON Forms
- Template Builder
- Analytic Templates
- Command Templates
- Task References
- Transformations
- Configuration Manager
- Integrations & Adapters
- Legacy & Custom
- Lifecycle Manager
- Operations Manager
- Using NSO with IAP
- Itential Cloud Use Case Walk-Throughs
- QuickStart Automation Use Cases
- Asset Reservation
- Itential Cloud Use Case Walk-Through - Port/VLAN Configuration (IOS) 2023.1
- Port/VLAN Configuration (IOS) - Overview
- Port/VLAN Configuration (IOS) - Device Configuration
- Port/VLAN Configuration (IOS) - Command Templates
- Port/VLAN Configuration (IOS) - JSON Form
- Port/VLAN Configuration (IOS) - Transformations
- Port/VLAN Configuration (IOS) - Pre-Built
- Port/VLAN Configuration (IOS) - Workflow
- Port/VLAN Configuration (IOS) - Operations Manager
- Port/VLAN Configuration (IOS) - Configuration Manager
- Port/VLAN Configuration (IOS) - Summary
- Itential Cloud Use Case Walk-Through - Port/VLAN Configuration (EOS) 2023.1
- Port/VLAN Configuration (EOS) - Overview
- Port/VLAN Configuration (EOS) - Device Configuration
- Port/VLAN Configuration (EOS) - Command Templates
- Port/VLAN Configuration (EOS) - JSON Form
- Port/VLAN Configuration (EOS) - Transformations
- Port/VLAN Configuration (EOS) - Pre-Built
- Port/VLAN Configuration (EOS) - Workflow
- Port/VLAN Configuration (EOS) - Operations Manager
- Port/VLAN Configuration (EOS) - Configuration Manager
- Port/VLAN Configuration (EOS) - Summary
- Itential Cloud Use Case Walk-Through - Create a Security Rule (Panorama) 2023.1
- Itential Cloud Use Case Walk-Through - Create Pool and Virtual Server (Big-IP) 2023.1
- Create Pool & Virtual Server (BIG-IP) - Overview
- Create Pool & Virtual Server (BIG-IP) - JSON Forms
- Create Pool & Virtual Server (BIG-IP) - Transformations
- Create Pool & Virtual Server (BIG-IP) - Workflow
- Create Pool & Virtual Server (BIG-IP) - Operations Manager
- Create Pool & Virtual Server (BIG-IP) - Summary (2023.1)
- Itential Cloud Use Case Walk-Through - Create and Update Change Request (ServiceNow)
- Create and Update Change Request (ServiceNow) - Overview
- Create and Update Change Request (ServiceNow) - Jinja2 Template
- Create and Update Change Request (ServiceNow) - JSON Form
- Create and Update Change Request (ServiceNow) - Transformation
- Create and Update Change Request (ServiceNow) - Workflow
- Create and Update Change Request (ServiceNow) - Operations Manager
- Create and Update Change Request (ServiceNow) - Summary
- Itential Cloud Use Case Walk-Through - Create and Update Incident (ServiceNow)
- Create and Update Incident (ServiceNow) - Overview
- Create and Update Incident (ServiceNow) - Configuration Manager
- Create and Update Incident (ServiceNow) - Jinja2 Templates
- Create and Update Incident (ServiceNow) - JSON Forms
- Create and Update Incident (ServiceNow) - Transformations
- Create and Update Incident (ServiceNow) - Workflow
- Create and Update Incident (ServiceNow) - Operations Manager
- Create and Update Incident (ServiceNow) - Summary
- Itential Cloud Use Case Walk-Through - Golden Configuration (IOS)
- Itential Cloud Use Case Walk-Through - Provision VPC & EC2 (AWS)
- Provision VPC and EC2 Instance (AWS) - Overview
- Provision VPC and EC2 Instance (AWS) - Transformation
- Provision VPC and EC2 Instance (AWS) - Pre-Built Workflows
- Provision VPC and EC2 Instance (AWS) - JSON Form
- Provision VPC and EC2 Instance (AWS) - Workflow
- Provision VPC and EC2 Instance (AWS) - Operations Manager
- Provision VPC and EC2 Instance (AWS) - Clean Up
- Provision VPC and EC2 Instance (AWS) - Summary
- Itential Cloud Use Case Walk-Through - Software Upgrade (IOS)
- Software Upgrade (IOS) - Overview
- Software Upgrade (IOS) - Device Configuration
- Software Upgrade (IOS) - Command Templates
- Software Upgrade (IOS) - JSON Form
- Software Upgrade (IOS) - Transformation
- Software Upgrade (IOS) - Workflow
- Software Upgrade (IOS) - Operations Manager
- Software Upgrade (IOS) - Configuration Manager
- Software Upgrade (IOS) - Summary
- Itential Cloud Use Case Walk-Through - Software Upgrade (EOS)
- Software Upgrade (EOS) - Overview
- Software Upgrade (EOS) - Device Configuration
- Software Upgrade (EOS) - Command Templates
- Software Upgrade (EOS) - JSON Form
- Software Upgrade (EOS) - Transformation
- Software Upgrade (EOS) - Workflow
- Software Upgrade (EOS) - Operations Manager
- Software Upgrade (EOS) - Configuration Manager
- Software Upgrade (EOS) - Summary
- Itential Cloud Use Case Walk-Through - API Compliance (AWS)
- Itential Cloud Use Case Walk-Through - Bulk IP Address Allocation (Netbox)
- Bulk IP Address Allocation (Netbox) - Overview
- Bulk IP Address Allocation (Netbox) - Jinja2 Template
- Bulk IP Address Allocation (Netbox) - Pre-Built Workflow
- Bulk IP Address Allocation (Netbox) - JSON Form
- Bulk IP Address Allocation (Netbox) - Workflow
- Bulk IP Address Allocation (Netbox) - Operations Manager
- Bulk IP Address Allocation (Netbox) - Transformation
- Bulk IP Address Allocation (Netbox) - Workflow Modification
- Bulk IP Address Allocation (Netbox) - Operations Manager Part 2
- Bulk IP Address Allocation (Netbox) - Summary
- Itential Cloud Use Case Walk-Through - Cloud Managed Network (Meraki)
- Cloud Managed Network (Meraki) - Overview
- Cloud Managed Network (Meraki) - Pre-Built Installation
- Cloud Managed Network (Meraki) - JSON Forms
- Cloud Managed Network (Meraki) - Transformation
- Cloud Managed Network (Meraki) - Workflows
- Cloud Managed Network (Meraki) - Create an Automation
- Cloud Managed Network (Meraki) - Device Configuration
- Cloud Managed Network (Meraki) - Summary
- Itential Cloud Use Case Walk-Through - Assign Network & IP (Infoblox)
- Assign Network & IP (Infoblox) - Overview
- Assign Network & IP (Infoblox) - Pre-Built Resources
- Assign Network & IP (Infoblox) - JSON Form
- Assign Network & IP (Infoblox) - Transformation
- Assign Network & IP (Infoblox) - Workflow
- Assign Network & IP (Infoblox) - Operations Manager
- Assign Network & IP (Infoblox) - Summary
- Itential Cloud Use Case Walk-Through - Create a DNS A Record (Infoblox)
- Create a DNS A Record (Infoblox) - Overview
- Create a DNS A Record (Infoblox) - Jinja2 Templates
- Create a DNS A Record (Infoblox) - Pre-Builts
- Create a DNS A Record (Infoblox) - JSON Forms
- Create a DNS A Record (Infoblox) - Transformation
- Create a DNS A Record (Infoblox) - Workflows
- Create a DNS A Record (Infoblox) - Operations Manager
- Create a DNS A Record (Infoblox) - Summary
- Itential Cloud Use Case Walk-Through - Managing the Lifecycle of a Service (IOS)
- Managing the Lifecycle of a Service (IOS) - Overview
- Managing the Lifecycle of a Service (IOS) - Pre-Built Resources
- Managing the Lifecycle of a Service (IOS) - Configuration Manager (Part 1)
- Managing the Lifecycle of a Service (IOS) - Workflows
- Managing the Lifecycle of a Service (IOS) - Lifecycle Manager (Part 1)
- Managing the Lifecycle of a Service (IOS) - Configuration Manager (Part 2)
- Managing the Lifecycle of a Service (IOS) - Lifecycle Manager (Part 2)
- Managing the Lifecycle of a Service (IOS) - Summary
- Itential Cloud Use Case Walk-Through - Golden Configuration (IOS) 2023.1
- Itential Cloud Use Case Walk-Through - Create and Update Incident (ServiceNow) (2023.1)
- Create and Update Incident (ServiceNow) - Overview
- Create and Update Incident (ServiceNow) - Configuration Manager
- Create and Update Incident (ServiceNow) - Jinja2 Templates
- Create and Update Incident (ServiceNow) - JSON Forms
- Create and Update Incident (ServiceNow) - Transformations
- Create and Update Incident (ServiceNow) - Workflow
- Create and Update Incident (ServiceNow) - Operations Manager
- Create and Update Incident (ServiceNow) - Summary
- Itential Cloud Use Case Walk-Through - Create and Update Change Request (ServiceNow) 2023.1
- Create and Update Change Request (ServiceNow) - Overview
- Create and Update Change Request (ServiceNow) - Jinja2 Template
- Create and Update Change Request (ServiceNow) - JSON Form
- Create and Update Change Request (ServiceNow) - Transformation
- Create and Update Change Request (ServiceNow) - Workflow
- Create and Update Change Request (ServiceNow) - Operations Manager
- Create and Update Change Request (ServiceNow) - Summary
- 18 Oct 2024
-
DarkLight
-
PDF
Configuration Examples
- Updated on 18 Oct 2024
-
DarkLight
-
PDF
Use the following examples to configure various rules and comparison operators and operands for a Command Template.
Example 1
In this example, we need to verify Cisco CSR has sufficient memory. The IOS command show platform software vmemory info
prints memory statistics, including the total system memory.
In the application:
- Create a new Command Template.
- Select a device name for testing.
- Type
show platform software vmemory info
in the command field of Command #1. - Keep the default contains operator.
- Click Test This Command.
- The test results will display.
Example Test Results
Memory Upgrade Limits:
Total System Memory: 3890 MB
Memory From Upgrade Licenses: 0 MB
Memory From Feature Licenses: 0 MB
Memory Available For Upgrade:
Available System Memory: 0 MB
Available Upgrade Licensed Memory: 0 MB
Available Feature Licensed Memory: 0 MB
Current Memory Allocation:
IOSD: 2354 MB (default) + 0 MB upgrade
Data Plane: 1536 MB (default) + 0 MB upgrade
Top Comparison Operand
To build a regular expression to select data:
- Select RegEx operator.
- Type a regular expression to select the command's output data containing the first operand. The line containing "Total System Memory" includes the first operand, 3890 MB.
- Type
Total System Memory:\s+\d+ MB
in the rule field. - Click Test This Command.
- Verify a green check is displayed, indicating the rule matches.
- If a red dash is displayed, check the regular expression for errors.
To build a capture group:
-
Change the command operator to
#comparison
. -
Surround the regular expression rule with slash characters:
/Total System Memory:\s+\d+ MB/
Bash -
Add a capture group by placing a pair of parentheses around the part of our regular expression matching installed memory:
/Total System Memory:\s+(\d+) MB/
Bash
To set the comparison operator:
- Select >= comparison operator.
Bottom Comparison Operand
To define a comparison using a Bottom Operand:
- Type
3000
in the compare with field. - Click Test This Command.
- Verify a green check is displayed, indicating the rule matches.
- If a red dash is displayed, check the top comparison operand regular expression for errors.
Example 2
This example extends the previous example; we need to verify Cisco CSR has sufficient memory. In the previous example, we compared installed memory to a static value. In this example, we compare installed memory to a variable.
Variable MEM-THRESH
will be passed to the MOP command template.
Bottom Comparison Operand
- Type
<!MEM-THRESH!>
in the Compare with field.
Example 3
In this example, we have an EBGP adjacency configured with a maximum prefix of 10 prefixes. The adjacency is configured to log warning messages when the neighbor sends 80% or more of the maximum number of prefixes, and the adjacency is reset if the neighbor sends more than 10 prefixes. In this example, we verify the number of sent prefixes is not greater than the warning threshold.
The IOS command show ip bgp neighbor X.X.X.X
prints the number of accepted prefixes, the maximum prefix limit, and the warning threshold.
-
In the application, create a new command template.
-
Select a device name for testing.
-
Type
show ip bgp neighbor X.X.X.X
in the command field for Command 1.- Replace
X.X.X.X
with a valid EBGP neighbor's router ID.
- Replace
-
Keep the default contains operator.
-
Click Test This Command.
-
The test results will display.
Router_B#show ip bgp neighbor 10.0.0.1 BGP neighbor is 10.0.0.1, remote AS 200, external link BGP version 4, remote router ID 10.0.0.1 BGP state = Established, up for 00:13:22 Last read 00:00:21, hold time is 180, keepalive interval is 60 seconds Neighbor capabilities: Route refresh: advertised and received(old & new) Address family IPv4 Unicast: advertised and received IPv4 MPLS Label capability: Received 930 messages, 0 notifications, 0 in queue Sent 919 messages, 1 notifications, 0 in queue Default minimum time between advertisement runs is 30 seconds For address family: IPv4 Unicast BGP table version 30, neighbor version 30 Index 1, Offset 0, Mask 0x2 Route refresh request: received 0, sent 0 9 accepted prefixes consume 432 bytes Prefix advertised 0, suppressed 0, withdrawn 0, maximum limit 10 (warning-only ) Threshold for warning message 80% Connections established 2; dropped 1 Last reset 00:29:13, due to BGP Notification sent, update malformed Message received that caused BGP to send a Notification: FFFFFFFF FFFFFFFF FFFFFFFF FFFFFFFF 003C0200 00001940 01010040 02040201 00C84003 040A0000 01800404 00000000 180A000A 180A000B 180A000C External BGP neighbor can be up to 2 hops away. Connection state is ESTAB, I/O status: 1, unread input bytes: 0 Local host: 10.0.0.2, Local port: 15668 Foreign host: 10.0.0.1, Foreign port: 179 Enqueued packets for retransmit: 0, input: 0 mis-ordered: 0 (0 bytes) Event Timers (current time is 0x3A46EB54): Timer Starts Wakeups Next Retrans 18 0 0x0 TimeWait 0 0 0x0 AckHold 22 9 0x0 SendWnd 0 0 0x0 KeepAlive 0 0 0x0 GiveUp 0 0 0x0 PmtuAger 0 0 0x0 DeadWait 0 0 0x0 iss: 2047376434 snduna: 2047376784 sndnxt: 2047376784 sndwnd: 16035 irs: 821061364 rcvnxt: 821062116 rcvwnd: 16188 delrcvwnd: 196 SRTT: 279 ms, RTTO: 500 ms, RTV: 221 ms, KRTT: 0 ms minRTT: 24 ms, maxRTT: 384 ms, ACK hold: 200 ms Flags: higher precedence, nagle Datagrams (max data segment is 536 bytes): Rcvd: 33 (out of order: 0), with data: 22, total data bytes: 751 Sent: 29 (retransmit: 0, fastretransmit: 0), with data: 17, total data bytes: 349
Bash -
Select the
#comparison
operator. -
Type
/maximum limit\s(\d+)/
in the Rule field. -
Select the
%comparison
operator. -
Type
80
in the Max accepted % field. -
Type
/(\d+) accepted prefixes/
in the Compare with field.