Itential Platform

https://docs.itential.com/docs
Admin
Itential Platform provides network orchestration solutions for end-to-end automation of cross-system...
Tokens:384,389
Snippets:2,047
Trust Score:9.4
Update:1 year ago
Show doc for...
Tokens:
Raw
### Configure and Start Itential Platform Server

Source: https://docs.itential.com/docs/platform-6-installation

Steps to finalize the NSO Service Management installation and start the Itential Platform server. This involves moving NSO apps to the server's services directory and then executing the server startup script.

```bash
cd /opt/itential/platform/services
mv /opt/itential/platform/services/* /opt/itential/platform/server/services
cd /opt/itential/platform/server
node server.js
```

--------------------------------

### Manage NSO Service Management Apps and Start Itential Platform

Source: https://docs.itential.com/docs/platform-6-install

This snippet covers navigating to the services directory, moving NSO applications to the Itential Platform server's services directory, and finally starting the Itential Platform server. This ensures the NSO apps are available and running within the Itential Platform instance.

```Bash
cd /opt/itential/platform/services

```

```Bash
mv /opt/itential/platform/services/* /opt/itential/platform/server/services

```

```Bash
ls /opt/itential/platform/server/services

```

```Bash
cd /opt/itential/platform/server
node server.js
```

--------------------------------

### Start Itential Platform Service (Bash)

Source: https://docs.itential.com/docs/platform-6-installation

Command to start the Itential Platform as a systemd service. This command assumes the service unit file for Itential Platform is correctly configured.

```bash
systemctl start itential-platform
```

--------------------------------

### Example: Start a Gateway Runner Instance

Source: https://docs.itential.com/docs/iagctl-runner-iag5

This example demonstrates how to start a gateway runner instance. The runner will connect to a configured gateway core node to receive and execute automation requests.

```bash
>_ iagctl runner

```

--------------------------------

### Download and Extract Redis Source Code (Bash)

Source: https://docs.itential.com/docs/platform-6-installation

Downloads the Redis source code archive (version 7.4.2 in this example) using wget and extracts it. This prepares the source code for compilation.

```bash
wget https://download.redis.io/releases/redis-7.4.2.tar.gz
tar -xzvf redis-7.4.2.tar.gz
cd redis-7.4.2
```

--------------------------------

### Start Redis Service (Bash)

Source: https://docs.itential.com/docs/platform-6-installation

Reloads the systemd daemon to recognize the new service file and then starts the Redis service. This command is typically used after configuring Redis and its systemd service.

```bash
systemctl daemon-reload
systemctl start redis
```

--------------------------------

### Install Itential Platform Binary (Bash)

Source: https://docs.itential.com/docs/installation-itential-platform

This snippet demonstrates how to install the Itential Platform using its binary package on a Linux server. It requires setting permissive mode and executing the installer with administrative privileges. Ensure you replace placeholders with your specific build ID and version.

```bash
sudo setenforce permissive
sudo bash itential-<build-id>_<version>.linux.x86_64.bin -i
```

--------------------------------

### Install Redis Binaries (Bash)

Source: https://docs.itential.com/docs/platform-6-installation

Installs the compiled Redis binaries to the system. This command should be run after the source code has been successfully compiled.

```bash
make install
```

--------------------------------

### Install Itential Platform 6 RPM

Source: https://docs.itential.com/docs/platform-6-installation

Installs the Itential Platform 6 core artifact using the rpm command. Assumes the artifact is already downloaded. The installation directory is /opt/itential/platform/server, and a platform.properties file in /etc/itential/ is required for configuration.

```bash
rpm -Uh itential-platform-6.0.0-1.noarch.rpm
```

--------------------------------

### Example Object 2 for GET Helper Function in JavaScript

Source: https://docs.itential.com/docs/query-task-itential-platform-1

This JavaScript code defines an example object named 'exampleObj2' which will be used to demonstrate queries with the GET helper function.

```javascript
const exampleObj2 = {
    "platform": {
        "ned": "cisco-ios",
        "description": "Cisco IOS Router or Switch"
    },
    "POPs": {
        "ATL:1": {
            "COUNTRY": "US",
            "ST": "GEORGIA",
            "LN": "ATLANTA",
            "cisco-ios-xr": [
                {
                    "name": "cr1.atl",
                    "type": "router",
                    "make": "Cisco",
                    "model": "ASR9K"
                }
            ],
            "cisco-ios": [
                {
                    "name": "er1.atl",
                    "type": "router",
                    "make": "Cisco",
                    "model": "3945"
                },
                {
                    "name": "sw1",
                    "type": "switch",
                    "make": "Cisco",
                    "model": "Catalyt 2960G"
                }
            ]
        },
        "ORF": {
            "COUNTRY": "US",
            "ST": "VIRGINIA",
            "LN": "NORFOLK",
            "cisco-ios": [
                {
                    "name": "cr1.orf",
                    "type": "router",
                    "make": "Cisco",
                    "model": "7600"
                }
            ],
            "juniper-junos": [
                {
                    "name": "er1.orf",
                    "type": "router",
                    "make": "Juniper",
                    "model": "MX10"
                }
            ]
        }
    }
};
```

--------------------------------

### Verify Installed Python Packages (System-wide)

Source: https://docs.itential.com/docs/platform-6-installation

Lists all Python packages currently installed on the system for Python 3.11, allowing verification of package versions after a system-wide installation.

```bash
python3.11 -m pip list
```

--------------------------------

### Verify Host Python Package Installation

Source: https://docs.itential.com/docs/platform-6-install

Lists all installed Python packages for the Python 3.11 environment on the host system, used to verify the installation of Template Builder's dependencies.

```bash
python3.11 -m pip list

```

--------------------------------

### Enable and Start Itential Platform Service (Bash)

Source: https://docs.itential.com/docs/start-itential-platform-first-time

Enables the Itential Platform service to start automatically on server reboot and starts it immediately. This command is run on the server where Itential Platform is installed.

```bash
systemctl enable --now pronghorn
```

--------------------------------

### Install Template Builder Python Dependencies to Host

Source: https://docs.itential.com/docs/platform-6-install

Installs specific versions of Jinja2, MarkupSafe, and TextFSM Python packages to the host system using pip for Python 3.11. This can be run before or after Platform installation.

```bash
python3.11 -m pip install jinja2==3.1.2 markupsafe==2.1.4 textfsm==1.1.3

```

--------------------------------

### Verify Redis Installation (Bash)

Source: https://docs.itential.com/docs/platform-6-installation

Verifies the installed version of Redis by running the redis-server executable with the --version flag. This confirms the installation was successful.

```bash
redis-server --version
```

--------------------------------

### Install Template Builder Python Dependencies for Itential User

Source: https://docs.itential.com/docs/platform-6-install

Installs specific versions of Jinja2, MarkupSafe, and TextFSM Python packages for the 'itential' user. This command must be run after the Platform has been installed.

```bash
su itential -c 'python3.11 -m pip install --user jinja2==3.1.2 markupsafe==2.1.4 textfsm==1.1.3'

```

--------------------------------

### Example IAG Gateway Log Output

Source: https://docs.itential.com/docs/iag5-install-binaries

Sample output from the Itential Automation Gateway (IAG) logs, indicating successful startup, configuration file usage, database connection, and GRPC server initialization.

```bash
2024-09-27T15:18:39Z INF using configuration file at /etc/gateway/gateway.conf
2024-09-27T15:18:39Z INF using local store database file at gateway.db
2024-09-27T15:18:39Z INF starting gateway server
2024-09-27T15:18:39Z INF working directory is /etc/gateway
2024-09-27T15:18:39Z INF

===================
 CREATED TEMPORARY ADMIN
 username: admin
 password: admin
===================


2024-09-27T15:18:39Z INF starting grpc server on [::]:50051/tcp
```

--------------------------------

### Install FreeRADIUS

Source: https://docs.itential.com/docs/radius-adapters-itential-platform

Provides basic steps for installing FreeRADIUS. This is an example scenario, and specific IPs, usernames, groups, and passwords will vary depending on the environment. Always use your environment's specific information.

```bash
# Example installation steps for FreeRADIUS (commands may vary by OS)
sudo apt update
sudo apt install freeradius freeradius-utils

```

--------------------------------

### Configure Redis (Bash)

Source: https://docs.itential.com/docs/platform-6-installation

Sets up the Redis configuration directory and copies the default configuration file. It also provides a placeholder for customizing the configuration.

```bash
mkdir -p /etc/redis
cp ./redis.conf /etc/redis/redis.conf
# Customize configuration for your use case
$EDITOR /etc/redis.conf
```

--------------------------------

### Install Redis Build Tools and Libraries (Bash)

Source: https://docs.itential.com/docs/platform-6-installation

Installs necessary build tools and libraries for compiling Redis from source. This includes GCC, Make, and optional development packages for systemd and TLS support.

```bash
dnf install gcc make
# For systemd support, add the systemd development package
dnf install systemd-devel
# For TLS support, add the OpenSSL development package
dnf install openssl-devel
```

--------------------------------

### Install Template Builder Python Dependencies (System-wide)

Source: https://docs.itential.com/docs/platform-6-installation

Installs specific versions of Jinja2, MarkupSafe, and TextFSM Python packages to the host system using pip for Python 3.11. This method is suitable for system-wide installation and can be run before or after the Itential Platform installation.

```bash
python3.11 -m pip install jinja2==3.1.2 markupsafe==2.1.4 textfsm==1.1.3
```

--------------------------------

### Verify Itential User Python Package Installation

Source: https://docs.itential.com/docs/platform-6-install

Lists user-specific installed Python packages for Python 3.11 for the 'itential' user, used to verify that dependencies are installed only for this user.

```bash
su itential -c 'python3.11 -m pip list --user'

```

--------------------------------

### Navigate to Platform 6 Services Directory - Bash

Source: https://docs.itential.com/docs/platform-6-adapters-custom-apps

This command changes the directory to the location where adapters and custom applications should be installed in Itential Platform 6.

```Bash
cd /opt/itential/platform/services
```

--------------------------------

### Install Template Builder Python Dependencies (Itential User)

Source: https://docs.itential.com/docs/platform-6-installation

Installs specific versions of Jinja2, MarkupSafe, and TextFSM Python packages for the 'itential' user using pip for Python 3.11. This method installs packages only for the specified user and requires the Itential Platform to be installed first to create the 'itential' user.

```bash
su itential -c 'python3.11 -m pip install --user jinja2==3.1.2 markupsafe==2.1.4 textfsm==1.1.3'
```

--------------------------------

### Install NSO Service Management RPM

Source: https://docs.itential.com/docs/platform-6-installation

Installs the NSO Service Management RPM using the dnf command. This requires downloading the architecture-specific artifact (e.g., aarch64). After installation, the NSO apps are moved to the Itential Platform services directory.

```bash
sudo dnf install itential-service_management-6.0.1-rc1.aarch64.rpm
```

--------------------------------

### Verify Itential User's Python Packages

Source: https://docs.itential.com/docs/platform-6-installation

Lists the Python packages installed specifically for the 'itential' user using pip for Python 3.11. This command helps verify that Template Builder's dependencies are correctly installed for the user and do not affect system-level packages.

```bash
su itential -c 'python3.11 -m pip list --user'
```

--------------------------------

### Compile Redis Source Code (Bash)

Source: https://docs.itential.com/docs/platform-6-installation

Compiles the Redis source code. Demonstrates a base build and variations for enabling systemd and TLS support during the compilation process.

```bash
# Base build with no optional features:
make

# For systemd support, add USE_SYSTEMD=yes when building:
make USE_SYSTEMD=yes

# For TLS support, add BUILD_TLS=yes when building. This may be combined with the systemd option:
make BUILD_TLS=yes USE_SYSTEMD=yes
```

--------------------------------

### Pre-built Automation Repository Branching Strategy Example

Source: https://docs.itential.com/docs/prebuilt-automation-repository-itential-platform

Illustrates the required branch naming convention for Pre-built Automations to be recognized by Itential Platform. Each branch corresponds to a specific Itential Platform release version.

```bash
* master
* release/2021.1 -> consumable by IAP release/2021.1
* release/2020.2 -> consumable by IAP release/2020.2
* release/2020.1 -> consumable by IAP release/2020.1
```

--------------------------------

### Navigate to Legacy Adapter Directory - Bash

Source: https://docs.itential.com/docs/platform-6-adapters-custom-apps

This command navigates to the default directory where adapters are located in older versions of the Itential Platform.

```Bash
cd /opt/itential/pronghorn/node_modules/@itentialopensource
```

--------------------------------

### Manage OpenLDAP Service

Source: https://docs.itential.com/docs/configuring-open-ldap-itential-platform

Enables the OpenLDAP service to start on boot and restarts the service. This ensures the LDAP server is running and accessible.

```Bash
systemctl enable slapd
service slapd restart

```

--------------------------------

### SSO HTML File Path (Shell)

Source: https://docs.itential.com/docs/itential-sso-set-up-itential-platform

This example indicates the recommended file path for the sso.html file within a custom directory for Itential installations. This file is crucial for redirecting login requests to Azure SSO.

```shell
custom/sso.html
```

--------------------------------

### Get Device List from Automation Gateway API

Source: https://docs.itential.com/docs/installation-validation-iag

This example shows how to retrieve a list of all managed devices within the Automation Gateway. It involves an initial login to obtain an authentication token, followed by a GET request to the devices endpoint.

```bash
curl -X POST --header 'Content-Type: application/json' --header 'Accept: application/json' -d '{ "password": "admin", "username": "admin@itential" }' 'http://localhost:8083/api/v2.0/login'
{"token": "NTAuMjczOTA4MTYwNDM5OTY2"}

curl -X GET --header 'Authorization: <COPY TOKEN VALUE FROM PREVIOUS CMD HERE>' --header 'Accept: application/json' 'http://localhost:8083/api/v2.0/devices'
```

--------------------------------

### Set up Redis Systemd Service (Bash)

Source: https://docs.itential.com/docs/platform-6-installation

Copies the systemd service file template from the Redis source code to the systemd service directory and provides instructions for customization, including referencing the configuration file and creating a dedicated user.

```bash
# Add the service file to your Systemd service directory
cp ./utils/systemd-redis_server.service /usr/lib/systemd/system/redis.service

# If you created a configuration file above, reference it in 'ExecStart'
# Recommended: Create and apply a dedicated 'redis' user for use with this service
$EDITOR /usr/lib/systemd/system/redis.service
```

--------------------------------

### Create Simple OpenTofu Service with iagctl

Source: https://docs.itential.com/docs/create-service-opentofu-plan-iag5

This example demonstrates the basic usage of the `iagctl create service opentofu-plan` command to create a new OpenTofu service. It specifies the service name and the repository containing the plan files. No specific working directory or variables are defined in this simple case.

```Bash
iagctl create service opentofu-plan my-opentofu-service \
--repository my-repo
```

--------------------------------

### Start Dependency Services (Bash)

Source: https://docs.itential.com/docs/prerequisite-checklist-itential-platform

Initiates the startup sequence for Itential Platform dependencies including MongoDB, RabbitMQ, and Redis. Use this command if any dependency services are found to be inactive.

```bash
systemctl start mongod.service
systemctl start rabbitmq-server
systemctl start redis
```

--------------------------------

### Create Complex OpenTofu Service with iagctl

Source: https://docs.itential.com/docs/create-service-opentofu-plan-iag5

This example shows a comprehensive usage of the `iagctl create service opentofu-plan` command, utilizing several optional flags. It specifies the repository, the working directory within the repository, custom variables, a variable file, a decorator for input validation, a descriptive text, and metadata tags.

```Bash
iagctl create service opentofu-plan deployment-service \
--repository example-repo \
--working-dir deployment-plans \
--var server_name=examplehostname \
--var-file prod.tfvars \
--decorator my-decorator \
--description "An OpenTofu plan to deploy servers" \
--tag servers
```

--------------------------------

### Bundles Directory Structure for Pre-built Automations

Source: https://docs.itential.com/docs/prebuilt-automation-repository-itential-platform

Provides an example of the directory structure within the `/bundles` directory for a Pre-built Automation. It shows how different Itential Platform component files, such as transformations and workflows, should be organized.

```bash
/bundles
|--> /ac_-_agenda_job
    |--> automation-catalog-1.json
|--> /forms
    |--> form-1.json
|--> /golden_config
    |--> golden-config-1.json
|--> /json_forms
    |--> json-forms.json
|--> /mop_template
    |--> mop-template-1.json
|--> /mop_analytic_template
    |--> mop-analytic-template-1.json
|--> /service_catalog
    |--> service-catalog-1.json
|--> /template
    |--> template-1.json
|--> /transformation
    |--> transformation-1.json
    |--> transformation-2.json
|--> /workflow
    |--> workflow.json
```

--------------------------------

### Sample Repository Configuration (JSON)

Source: https://docs.itential.com/docs/itential-platform-admin-essentials-repositories

This JSON snippet demonstrates the structure for configuring a Pre-Built Automation repository. It includes properties such as enabled status, version control, repository type, hostname, path, and credentials required for accessing the repository.

```json
{
    "repoConfigs": {
        "@itentialopensource": {
            "enabled": true,
            "versionStatus": "current",
            "type": "gitlab",
            "hostname": "gitlab.com",
            "path": "itentialopensource/pre-built-automations",
            "credentials": {
                "token": "TOKEN STRING"
            }
        }
    }
}
```

--------------------------------

### OpenSSL s_client Output Example

Source: https://docs.itential.com/docs/nso-adapter-itential-platform

An example output from the `openssl s_client` command, showing the established SSL session details including the protocol, cipher used, and verification status. This helps in verifying SSL/TLS connection parameters.

```text
SSL-Session:
    Protocol  : TLSv1.2
    Cipher    : ECDHE-RSA-AES128-GCM-SHA256
    Session-ID: 1A1D51D03BFB624A617626DCEEDACAF6AD0317DF9C34DF7F55802BAA776EC112
    Master-Key: 4B7827941C
    Start Time: 1595966521
    Timeout   : 7200 (sec)
    Verify return code: 0 (ok)


```

--------------------------------

### MongoDB Connection String Examples

Source: https://docs.itential.com/docs/initial-configuration-itential-platform

Examples of how to configure the MongoDB connection string in the Itential Platform's properties.json file. This covers local hosting on the IAP server, standalone servers, and replica sets. Ensure the correct hostname, IP address, or replica set name is used.

```json
# Option 1) Hosted locally on IAP server.
mongodb://localhost:27017

# Option 2) Hosted on a standalone MongoDB server.
mongodb://mongodb.test.com:27017

# Option 3) MongoDB replica set.
mongodb://mongo01.test.com:27017,mongo02.test.com:27017,mongo03.test.com:27017?replicaSet=rs0
```

--------------------------------

### Install Node.js on RHEL/Rocky Linux

Source: https://docs.itential.com/docs/platform-6-install

Installs Node.js version 20 on RHEL 8, RHEL 9, Rocky 8, and Rocky 9 using the DNF package manager.

```bash
dnf module enable nodejs:20
dnf install nodejs

```

--------------------------------

### Install Lifecycle, Config, or Service Manager RPM

Source: https://docs.itential.com/docs/platform-6-installation

Installs RPM artifacts for Lifecycle Manager, Enterprise Configuration Manager, or Service Manager. The command is similar for all, requiring the specific artifact name. The default installation directory for these services is /opt/itential/platform/services.

```bash
rpm -Uh itential-lifecycle_manager-VERSION.noarch.rpm
```

--------------------------------

### Install Python 3.11 and Pip

Source: https://docs.itential.com/docs/platform-6-install

Installs Python 3.11 and its corresponding pip package manager on RHEL 8, RHEL 9, Rocky 8, Rocky 9, and Amazon Linux 2023.

```bash
dnf install python3.11 python3.11-pip

```

--------------------------------

### Install and Configure Node.js on Amazon Linux 2023

Source: https://docs.itential.com/docs/platform-6-install

Installs Node.js 20 on Amazon Linux 2023 and configures alternatives to make 'node', 'npm', and 'npx' point to the Node.js 20 executables.

```bash
# Install Nodejs 20
dnf install nodejs20

# Use 'node-20' as provider for 'node' with priority 1000
alternatives --install /usr/bin/node node /usr/bin/node-20 1000 \
  --slave /usr/bin/npm npm /usr/bin/npm-20 \
  --slave /usr/bin/npx npx /usr/bin/npx-20

```

--------------------------------

### Install Node.js on RHEL/Rocky Linux

Source: https://docs.itential.com/docs/platform-6-installation

Installs Node.js version 20 on RHEL 8, RHEL 9, Rocky 8, and Rocky 9 systems using the DNF package manager. This command enables the Node.js 20 module and then installs the Node.js package.

```bash
dnf module enable nodejs:20
dnf install nodejs
```

--------------------------------

### Example Itential Automation Gateway Configuration File

Source: https://docs.itential.com/docs/iag5-config-variables

This is an example configuration file for Itential Automation Gateway. It shows the structure and available sections for setting various gateway parameters. Uncomment lines to enable and configure specific settings.

```ini
[application]
#mode                = local
#ca_certificate_file = 
#cluster_id          = cluster_1
#working_dir         = ~/.gateway.d

[client]
#certificate_file = 
#host             = 
#port             = 50051
#private_key_file = 
#use_tls          = true

[connect]
#certificate_file     = /etc/gateway/gw-manager.pem
#private_key_file     = /etc/gateway/gw-manager-key.pem
#enabled              = true
#insecure_tls         = false
#server_ha_enabled    = false
#server_ha_is_primary = false
#hosts                = # space separated list

[features]
#ansible_enabled  = true
#hostkeys_enabled = true
#opentofu_enabled = true
#python_enabled   = true

[log]
#console_json       = false
#file_enabled       = true
#file_json          = false
#level              = INFO
#server_dir         = /var/log/gateway
#timestamp_timezone = utc

[runner]
#announcement_address = 
#certificate_file     = 
#listen_address       = 127.0.0.1
#port                 = 50051
#private_key_file     = 
#runtime_data_dir     = /var/lib/gateway
#use_tls              = true

[secrets]
#encrypt_key_file = 

[server]
#api_key_expiration = 1440
#certificate_file   = 
#distributed_execution      = true
#listen_address     = 127.0.0.1
#port               = 50051
#private_key_file   = 
#runtime_data_dir   = /var/lib/gateway
#use_tls            = true

[store]
#backend                      = local
#etcd_hosts                   = "localhost:2379" # space separated list
#etcd_use_tls                 = true
#etcd_ca_certificate_file     = 
#etcd_certificate_file        = 
#etcd_client_cert_auth        = false
#etcd_private_key_file        = 

[terminal]
#no_color           = false
#timestamp_timezone = utc

```

--------------------------------

### Install Gateway Manager on IAP 2023.2 with Custom Directory

Source: https://docs.itential.com/docs/gateway-manager-installation

This command installs Gateway Manager version 1.5.0 on IAP 2023.2, specifying a custom installation directory using the `--prefix` flag. Replace `/YOUR/INSTALL/DIR` with your desired path, for example, `/opt/itential/current/node_modules/@itential`.

```bash
rpm -Uh --prefix=/YOUR/INSTALL/DIR app-gateway_manager-1.5.0.noarch.rpm

```

--------------------------------

### Install NetBox Ansible Collection

Source: https://docs.itential.com/docs/netbox-dynamic-inventory-iag

Command to install the NetBox Ansible collection into the IAG server. This should be integrated into the IAG build plan for automation.

```bash
ansible-galaxy collection install netbox.netbox
```

--------------------------------

### Package JSON for Itential Pre-built Automation Project

Source: https://docs.itential.com/docs/prebuilt-automation-repository-itential-platform

The package.json file, adhering to npm conventions, contains metadata for the Pre-built Automation project. It includes the project name, version, description, author, license, repository details, and essential Itential Platform dependencies.

```json
{
  "name": "Custom Pre-built Automation",
  "version": "1.0.0-2021.1.1",
  "description": "A description of the Pre-built Automation",
  "author": "John Doe",
  "license": "Apache-2.0",
  "repository": {
    "type": "gitlab",
    "hostname": "gitlab.com",
    "path": "/path/to/my/prebuilts-repo"
  },
  "IAPDependencies": {
    "@itential/app-automation_catalog": "2.5.4",
    "@itential/app-json_forms": "1.13.5",
    "@itential/app-workflow_engine": "6.7.10"
  }
}
```

--------------------------------

### Enable and Start Automation Gateway Service

Source: https://docs.itential.com/docs/rhel-8-full-installation-method-iag-20233-and-20232

Enables the Automation Gateway service to start automatically on system boot and then starts the service immediately. It also reloads the systemd daemon to recognize the new service file.

```bash
systemctl enable automation-gateway
systemctl daemon-reload
systemctl start automation-gateway
```

--------------------------------

### Install Gateway Client on Linux

Source: https://docs.itential.com/docs/iag5-deploy-container

Installs the gateway client on a Linux system. This involves extracting an archive, running the executable, and moving it to the system's bin directory.

```Bash
tar -zxvf iagctl-x.y.z_linux_arch.tar.gz
./iagctl
mv ./iagctl /usr/local/bin/iagctl
```

--------------------------------

### REST API GET Request Example - Itential Platform

Source: https://docs.itential.com/docs/restcall-task-itential-platform-1

This example demonstrates a simple GET request using the restCall task. It fetches data from a specified URI and returns the response, including headers. The task is configured with a static URI and verb, suitable for APIs that do not require authentication or a request body.

```JSON
{
  "success": true,
  "deck_id": "tay82vn7nlsu",
  "remaining": 52,
  "shuffled": true
}
```

--------------------------------

### iagctl describe __ Command Synopsis and Options

Source: https://docs.itential.com/docs/iagctl-describe-iag5

This section details the basic usage and available flags for the `iagctl describe __` command. It includes help options and inherited configurations for managing gateway resources.

```bash
iagctl describe __

This command displays all of the information about a specific resource within the gateway data store.

Options:
  -h, --help   Help for describe

Options Inherited from Parent Commands:
  --config string   Path to the configuration file
  --raw             Displays the result of the command in its raw format
  --verbose         Enable verbose output
```

--------------------------------

### Install Python 3

Source: https://docs.itential.com/docs/template-builder-dependencies-itential-platform

Installs Python 3 using the yum package manager. This is a prerequisite for other Python-based dependencies. Pip is included starting with Python 3.4.

```Bash
sudo yum install -y python3

```

--------------------------------

### Install Python 3.11 and Pip

Source: https://docs.itential.com/docs/platform-6-installation

Installs Python version 3.11 and its corresponding pip package manager on RHEL 8, RHEL 9, Rocky 8, Rocky 9, and Amazon Linux 2023 systems using the DNF package manager.

```bash
dnf install python3.11 python3.11-pip
```

--------------------------------

### iagctl create command synopsis and options

Source: https://docs.itential.com/docs/iagctl-create-iag5

This snippet shows the basic synopsis and options for the 'iagctl create' command. It includes help flags and configuration options for interacting with the Itential Automation Gateway.

```bash
iagctl create 

Options:
  -h, --help   help for create

Options Inherited from Parent Commands:
      --config string   Path to the configuration file
      --raw             Displays the result of the command in its raw format
      --verbose         Enable verbose output
```

--------------------------------

### String Matching Operators (starts-with, ends-with, contains) in API and Workflow Formats

Source: https://docs.itential.com/docs/ops-manager-search-api

These operators filter documents where a field starts with, ends with, or contains a specified string. The 'contains' operator on the 'description' field in the '/jobs' API supports MongoDB text search syntax for complex queries. Examples are shown for both API GET requests and workflow task JSON formats.

```http
GET /operations-manager/jobs?starts-with[name]=NamePrefix
GET /operations-manager/tasks?ends-with[name]=Suffix
GET /operations-manager/jobs?contains[description]=InternalString
```

```json
{
    "starts-with": {
        "name": "NamePrefix"
    }
}

{
    "ends-with": {
        "name": "Suffix"
    }
}

{
    "contains": {
        "description": "InternalString"
    }
}
```

--------------------------------

### Get a Device List

Source: https://docs.itential.com/docs/installation-validation-iag

Retrieves a list of all managed devices.

```APIDOC
## GET /api/v2.0/devices

### Description
Retrieves a list of all managed devices.

### Method
GET

### Endpoint
`http://localhost:8083/api/v2.0/devices`

### Parameters
No specific parameters are detailed for this GET request in the source. Authentication is required via the Authorization header.

### Request Example
```bash
curl -X GET --header 'Authorization: <COPY TOKEN VALUE FROM PREVIOUS CMD HERE>' --header 'Accept: application/json' 'http://localhost:8083/api/v2.0/devices'
```

### Response
#### Success Response (200)
Returns a JSON array of device objects.

#### Response Example
(No specific response example provided in source.)
```

--------------------------------

### Example: Create New User

Source: https://docs.itential.com/docs/create-user-iag5

Demonstrates the process of creating a new user named 'kevin'. The command prompts for a password and its verification, confirming successful user creation.

```bash
iagctl create user kevin
Enter your password:
Re-enter your password for verification:
Password verified successfully!

Successfully created user
Name:   kevin
```

--------------------------------

### Configure live status command prefix

Source: https://docs.itential.com/docs/customizable-device-support-itential-platform

This snippet shows how to use the `commandPrefix` property to define a custom shortcut for built-in command-line actions in live status configurations. It's useful for simplifying complex commands.

```json
"liveStatusProps": [
    {
        "nedType": "cisco-iosxr-cli-7.36",
        "actions": [
        {
            "commandPrefix": "fake_command",
            "actionPath": "live-status/cisco-ios-xr-stats:exec/cisco-ios-xr-stats:show"
        }
        ]
    }
]
```

--------------------------------

### Manage FreeRADIUS Service (Bash)

Source: https://docs.itential.com/docs/installing-freeradius

Commands to start, enable, and check the status of the FreeRADIUS service (radiusd.service) using systemctl. This ensures the RADIUS server is running and configured to start on boot.

```bash
systemctl start radiusd.service
systemctl enable radiusd.service
systemctl status radiusd.service
```

--------------------------------

### NSO Adapter Configuration Example (JSON)

Source: https://docs.itential.com/docs/nso-adapter-iap

A sample JSON configuration for an NSO adapter. This configuration specifies HTTP and Netconf connection details, SSL settings, credentials, and authentication strategy. It is crucial for establishing communication between Itential Platform and NSO.

```json
{
  "id": "nso",
  "type": "NSO",
  "properties": {
    "http": {
      "host": "localhost",
      "port": 8888
    },
    "ssl": {
      "enabled": true,
      "acceptInvalidCerts": false,
      "caFile": "/etc/ssl/ca.cert",
      "ciphers": "DHE-RSA-AES256-SHA"
    },
    "netconf": {
      "host": "localhost",
      "port": 2022,
      "protocol": "ssh",
      "frame_size": 16736
    },
    "credentials": {
      "user": "admin",
      "passwd": "admin"
    },
    "authenticationStrategy": {
      "type": "dynamic",
      "location": "NSO",
      "method": "machineLogin"
    },
    "netconfSubscriptions": [ "ncs-events", "ncs-alarms", "device-notifications", "service-state-changes" ],
    "commitWait": 30000,
    "commitQueue": false,
    "max_reconnect_attempts": 0,
    "total_reconnect_window": 120,
    "min_reconnect_interval": 30,
    "max_reconnect_interval": 900,
    "entity_cache_TTL": 24,
    "max_cache_entries": 5000,
    "poolSize": 3,
    "yangdirs": []
  }
}
```

--------------------------------

### Start Itential Gateway Server (Bash)

Source: https://docs.itential.com/docs/iagctl-server-iag5

This command starts the Itential Automation Gateway server. Ensure the `GATEWAY_APPLICATION_MODE` is set to `server` in the configuration. Optional flags for certificate and private key files can be provided.

```bash
iactl server
iactl server --cert-file /etc/gateway/gateway.crt --private-key-file /etc/gateway/gateway.key
```

--------------------------------

### Querying Object Properties with Special Characters using :get()

Source: https://docs.itential.com/docs/query-task-itential-platform-1

This example demonstrates the use of the `:get()` helper function to query an object property whose key contains a special character, specifically a colon. It retrieves the value of the `host:name` property from `exampleObj` by using `get('host:name')`.

```javascript
exampleObj.get('host:name')
```

--------------------------------

### Executing OpenTofu Apply with Variable Sets

Source: https://docs.itential.com/docs/create-open-tofu-service-iag5

This command executes the OpenTofu 'apply' process using the IAG CLI. It applies a plan named 'hello-world', sets the 'content' and 'location' variables using '--set', and specifies an output state file using '--state-out'.

```bash
iagctl run opentofu-plan apply hello-world --set content=hello --set location=/tmp/iagctlTest.txt --state-out @tofu.tfstate

```

--------------------------------

### Install and Configure Node.js 20 on Amazon Linux 2023

Source: https://docs.itential.com/docs/platform-6-installation

Installs Node.js 20 on Amazon Linux 2023 and configures the 'alternatives' system to use Node.js 20 as the default for 'node', 'npm', and 'npx'. This is necessary because Amazon Linux 2023's default 'nodejs' package is version 18.

```bash
# Install Nodejs 20
dnf install nodejs20

# Use 'node-20' as provider for 'node' with priority 1000
alternatives --install /usr/bin/node node /usr/bin/node-20 1000 \
  --slave /usr/bin/npm npm /usr/bin/npm-20 \
  --slave /usr/bin/npx npx /usr/bin/npx-20
```

--------------------------------

### Sample Script Execution Parameters (Multiple Arguments)

Source: https://docs.itential.com/docs/script-execution-engine-iag-2023-3

Demonstrates how to provide arguments for script execution using the default schema. The 'args' object contains 'argument_list' with multiple entries, each representing a command-line argument.

```json
{
  "args":{
    "argument_list":[
      "--src file1",
      "--dest sample_host:file2"
    ]
  },
  "hosts": []
}
```

--------------------------------

### Install OpenLDAP Packages

Source: https://docs.itential.com/docs/configuring-open-ldap-itential-platform

Installs the necessary OpenLDAP server and client packages using yum. This is the initial step for setting up an OpenLDAP environment.

```Bash
yum install -y openldap openldap-clients openldap-servers

```

--------------------------------

### Example Output for Nexus IAG Upgrade

Source: https://docs.itential.com/docs/upgrading-iag

Illustrates the expected output when upgrading Itential Automation Gateway (IAG) from the Nexus repository. This example shows the process of pip collecting and installing the gateway package.

```bash
Created temporary directory: /tmp/pip-ephem-wheel-cache-hpp3436z
Created temporary directory: /tmp/pip-req-tracker-m18dli2n
Created requirements tracker '/tmp/pip-req-tracker-m18dli2n'
Created temporary directory: /tmp/pip-install-k11d6prh
Looking in indexes: https://pypi.org/simple, https://registry.aws.itential.com/repository/automation-gateway-release/simple
Collecting automation-gateway==...
    ...
    ...
Successfully installed automation-gateway-...
Cleaning up...
Removed build tracker '/tmp/pip-req-tracker-m18dli2n'
```

--------------------------------

### Example Output for JFrog IAG Upgrade

Source: https://docs.itential.com/docs/upgrading-iag

Illustrates the expected output when upgrading Itential Automation Gateway (IAG) from the JFrog repository. This example shows the process of pip collecting and installing the gateway package.

```bash
Created temporary directory: /tmp/pip-ephem-wheel-cache-hpp3436z
Created temporary directory: /tmp/pip-req-tracker-m18dli2n
Created requirements tracker '/tmp/pip-req-tracker-m18dli2n'
Created temporary directory: /tmp/pip-install-k11d6prh
Looking in indexes: https://pypi.org/simple,  https://itential.jfrog.io/artifactory/automation-gateway/
Collecting automation-gateway==...
    ...
    ...
Successfully installed automation-gateway-...
Cleaning up...
Removed build tracker '/tmp/pip-req-tracker-m18dli2n'
```

--------------------------------

### LDAP Search Filter Examples

Source: https://docs.itential.com/docs/ldap-adapter-configuration-itential-platform

Demonstrates correct and incorrect syntax for LDAP search filters, highlighting the importance of avoiding whitespace between attribute assertions. The valid example shows how to correctly group conditions for a successful search.

```json
The filter example will _not_ work.
```
(| (&(objectClass=groupOfNames) (cn=UAT Power Users)) (&(objectClass=groupOfNames)(cn=QuickSight Members)) )

```

This filter example will work.
```
(|(&(objectClass=groupOfNames)(cn=UAT Power Users))(&(objectClass=groupOfNames)(cn=QuickSight Members)))

```
```

--------------------------------

### iagctl db Command Synopsis and Options

Source: https://docs.itential.com/docs/iagctl-db-iag5

This snippet shows the basic synopsis and options for the `iagctl db` command, including help flags. It also lists inherited options such as configuration file path, raw output, and verbose logging.

```Bash
### Synopsis __
This command allows interaction with gateway configuration elements.
### Options __
```
  -h, --help   help for db

```
```

```Bash
### Options Inherited from Parent Commands __
```
--config string   Path to the configuration file
--raw             Displays the result of the command in its raw format
--verbose         Enable verbose output

```
```

--------------------------------

### Pagination API Parameters (GET Request)

Source: https://docs.itential.com/docs/ops-manager-search-api

Shows how to use 'skip' and 'limit' parameters in a GET request for pagination of results from the Operations Manager API. 'skip' determines the starting point, and 'limit' controls the number of items returned.

```http
?skip=< number >&limit=< number >
```

--------------------------------

### properties.json Example Configuration

Source: https://docs.itential.com/docs/managing-aaa-sources-via-itential-platform-profiles

An example of the properties.json file, demonstrating how to specify MongoDB connection details and the active profile ID. This file is essential for the Itential Platform's initialization process.

```json
{
  "pathProps": {
    "description": "File Path Variables",
    "sdk_dir": "/opt/pronghorn-applications",
    "encrypted": true
  },
  "id": "Local_AAA",
  "mongoProps": {
    "credentials": {
      "passwd": "itentialPassword",
      "user": "itentialUser"
    },
    "db": "pronghorn",
    "url": "mongodb://localhost:27017"
  }
}
```

--------------------------------

### Example GET Request with Pagination (Itential API)

Source: https://docs.itential.com/docs/using-query-parameters-in-api-requests-itential-platform

This example demonstrates how to use the 'limit' query parameter to retrieve more than the default number of results in an API call. This is particularly useful when dealing with environments that have a large number of adapters.

```http
GET health/adapters?limit=100

```

--------------------------------

### Create and Install Open Source Adapter Directory - Shell

Source: https://docs.itential.com/docs/running-containers-itential-platform

This snippet demonstrates how to create a directory for open-source adapters or custom applications and then clone and install an adapter using npm. It ensures the application is installed with production dependencies.

```shell
mkdir -p ./itential/platform/custom_adapters_apps/@itentialopensource
cd ./itential/platform/custom_adapters_apps/@itentialopensource

# Clone your open source adapter / application here. Then, install it:

cd open_source_adapter
npm install --install-strategy=nested --prod
```

--------------------------------

### Get Configuration for a Device

Source: https://docs.itential.com/docs/installation-validation-iag

Retrieves the configuration for a specified managed device using a POST request to an execute endpoint.

```APIDOC
## POST /api/v2.0/roles/itential_get_config/execute or POST /api/v2.0/getConfig

### Description
Retrieves the configuration for one or more managed devices. This can be done via the `itential_get_config` role execution or the `getConfig` endpoint.

### Method
POST

### Endpoint
`https://localhost:8083/api/v2.0/roles/itential_get_config/execute` or `https://localhost:8083/api/v2.0/getConfig`

### Parameters
#### Request Body
- **hosts** (array of strings) - Required - A list of device hostnames for which to retrieve configurations.
- **template** (string) - Optional - Specifies a template to use for configuration retrieval (used with `/api/v2.0/getConfig`).

### Request Example (using itential_get_config)
```json
{
   "hosts": [ "ios01" ]
 }
```

### Request Example (using getConfig)
```json
{
   "hosts": [ "ios01" ],
   "template": "ios_config"
 }
```

### Response
#### Success Response (200)
Returns the configuration data for the specified devices. The exact structure depends on the device and any applied templates.

#### Response Example
(No specific response example provided in source.)
```

--------------------------------

### Redis Hostname Configuration Examples

Source: https://docs.itential.com/docs/initial-configuration-itential-platform

Examples for configuring the Redis host in the Itential Platform's properties.json file. This demonstrates setting the host to 'localhost' for local IAP server hosting or to a specific hostname for a standalone Redis server. Proper network configuration is essential.

```json
# Option 1) Hosted locally on IAP server.
"host": "localhost"

# Option 2) Hosted on a standalone Redis server.
"host": "redis.test.com"
```

--------------------------------

### Basic Example: 'gt' Operator and Field Inclusion

Source: https://docs.itential.com/docs/ops-manager-search-api

Shows how to retrieve specific fields (ID and name) for jobs started after a certain date using the 'gt' (greater than) operator with Unix epoch time. Includes examples for API format and workflow tasks.

```javascript
GET /operations-manager/jobs?include=_id,name&gt[metrics.start_time]=1637279999
```

```json
{
  "include": "_id,name",
  "gt": {
    "metrics.start_time": "1637279999"
  }
}
```

--------------------------------

### LDAP Group Membership Mapping Example

Source: https://docs.itential.com/docs/ldap-installation-and-configuration-iag

This example demonstrates how Itential Automation Gateway (IAG) can interpret LDAP user group memberships from the `memberOf` attribute. It shows sample `memberOf` entries and explains how IAG extracts group names like 'iag-operator' and 'iag-user' to assign roles.

```bash
memberOf: group=iag-operator,cn=example,cn=com 
memberOf: group=iag-user,cn=example,cn=com
```
Tokens:
Raw