> For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://docs.itential.com/itential-gateway/4/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.itential.com/_mcp/server. # 4 ## Docs - [Itential Gateway](https://docs.itential.com/itential-gateway/overview.md): Overview of Itential Gateway features, automation frameworks, and compatibility with Itential Platform. - [Related terminology](https://docs.itential.com/itential-gateway/4/related-terminology.md): A brief primer on core Ansible concepts and their role in Itential Gateway. - [Gateway system requirements](https://docs.itential.com/itential-gateway/4/system-requirements.md): Review the server specifications, software requirements, and registry credentials you need before installing Itential Gateway. - [Gateway 2023.3 and 2023.2 RHEL 8 install](https://docs.itential.com/itential-gateway/4/rhel-8-install-20233-20232.md): Step-by-step guide for installing Itential Gateway on RHEL 8 for Gateway versions 2023.2 and 2023.3. - [Offline installation method](https://docs.itential.com/itential-gateway/4/offline-installation-method.md): How to perform an offline install of Itential Gateway on systems disconnected from the internet. - [Deploy Gateway container image](https://docs.itential.com/itential-gateway/4/deploy-container-image.md): Instructions for deploying Itential Gateway using a containerized deployment method. - [Initial Gateway configuration](https://docs.itential.com/itential-gateway/initial-configuration.md): General information on configuring system properties for Itential Gateway via UI and the properties.yml file. - [Configure HTTPS](https://docs.itential.com/itential-gateway/4/https-configuration.md): Configure HTTPS/TLS settings for Itential Gateway using SSL certificates and Unix socket binds. - [Configure Ansible](https://docs.itential.com/itential-gateway/4/ansible-configuration.md): Covers inventory files and paths for Ansible configuration in Itential Gateway. - [Configure caching](https://docs.itential.com/itential-gateway/4/configure-caching.md): Learn how to enable and configure the caching system in Itential Gateway to reduce load from repeated discovery operations. - [Update default password](https://docs.itential.com/itential-gateway/4/update-default-password.md): Validate your Itential Gateway installation by changing the default password. - [Git integration](https://docs.itential.com/itential-gateway/4/git-integration.md): Configure and use Git integration in Itential Gateway to import scripts from Git repositories. - [gRPC framework](https://docs.itential.com/itential-gateway/4/grpc-framework.md): Overview of gRPC framework support in Itential Gateway, including installation, configuration, device management, and TLS setup. - [HashiCorp Vault integration](https://docs.itential.com/itential-gateway/4/hashicorp-vault-integration.md): Configure HashiCorp Vault integration to manage secrets in Itential Gateway. - [HTTP requests](https://docs.itential.com/itential-gateway/4/http-requests.md): Send HTTP requests to inventory devices using the Itential Gateway HTTP Requests integration. - [NETCONF integration](https://docs.itential.com/itential-gateway/4/netconf-integration.md): Overview of the NETCONF execution engine in Itential Gateway, including capabilities, inventory management, and API endpoints. - [Netmiko integration](https://docs.itential.com/itential-gateway/4/netmiko-integration.md): Overview of the Netmiko execution engine in Itential Gateway for SSH-based network device interactions. - [Nornir integration](https://docs.itential.com/itential-gateway/4/nornir-integration.md): Configure and use the Nornir Python automation framework with Itential Gateway for network device inventory management and module execution. - [OpenConfig integration](https://docs.itential.com/itential-gateway/4/openconfig-integration.md): Configure and use OpenConfig (gRPC) in Itential Gateway for device connections using gNMI and gNOI. - [Python virtual environment (VENV)](https://docs.itential.com/itential-gateway/4/python-virtual-environment.md): How to configure and use Python virtual environments (VENV) in Itential Gateway to execute scripts with specific dependencies. - [Script execution engine](https://docs.itential.com/itential-gateway/4/script-execution-engine.md): Overview of the Script Execution Engine in Itential Gateway, including script decoration, execution parameters, and environment variable configuration. - [Support of multiple Ansible versions](https://docs.itential.com/itential-gateway/4/multiple-ansible-versions.md): Configure and use multiple Ansible versions in Itential Gateway via virtual environments. - [Terraform integration](https://docs.itential.com/itential-gateway/4/terraform-integration.md): Overview of Terraform integration with Itential Gateway, including module discovery, decoration, and command execution. - [Upgrade Gateway](https://docs.itential.com/itential-gateway/4/upgrade.md): Instructions for upgrading Itential Gateway using pip3 with JFrog or Nexus software repositories. - [Gateway 5 feature comparison](https://docs.itential.com/itential-gateway/gateway-feature-comparison.md) - [Optimize Gateway performance](https://docs.itential.com/itential-gateway/4/optimize-performance.md): Configure your Gateway instance for optimal performance based on performance testing results. - [Optimize database size and performance](https://docs.itential.com/itential-gateway/4/optimize-database-size.md): How to use retention settings and database vacuuming to manage database size and improve performance. - [Password reset for local Gateway users](https://docs.itential.com/itential-gateway/4/local-password-reset.md): How to reset passwords and recover credentials for Gateway servers configured with local authentication. - [Install and configure LDAP authentication](https://docs.itential.com/itential-gateway/4/install-configure-ldap.md): Configure LDAP authentication for Itential Gateway to replace local authentication. - [RBAC in Gateway](https://docs.itential.com/itential-gateway/4/rbac.md): Overview of role-based access control configuration for Itential Gateway, including roles, groups, and user management. - [Navigate the main canvas UI](https://docs.itential.com/itential-gateway/4/navigate-main-canvas-ui.md): A visual walk-through of navigating the main canvas, property details, and API documentation in Itential Gateway. - [Built-in Ansible roles](https://docs.itential.com/itential-gateway/4/ansible-roles-overview.md): Reference for the Ansible roles distributed with Itential Gateway for device monitoring and configuration tasks on supported network devices. - [Ansible roles, modules, and playbooks](https://docs.itential.com/itential-gateway/4/ansible-roles-modules-playbooks.md): Overview of how Itential Gateway aggregates and allows you to decorate Ansible modules, roles, and playbooks. - [Add new role](https://docs.itential.com/itential-gateway/4/ansible-add-new-role.md): How to add a new role to Ansible and synchronize it with Itential Gateway. - [Add a new playbook](https://docs.itential.com/itential-gateway/4/ansible-add-a-new-playbook.md): How to add new playbooks to Itential Gateway. - [Ansible collections in Gateway](https://docs.itential.com/itential-gateway/4/ansible-collections.md): How to discover, install, refresh, and navigate Ansible Collections in Itential Gateway. - [Ansible F5 device provider object](https://docs.itential.com/itential-gateway/4/ansible-f5-device-provider-object.md): Describes the provider dictionary object required to connect to F5 BIG-IP devices via Ansible in Itential Gateway. - [Role execution parameters](https://docs.itential.com/itential-gateway/4/ansible-role-execution-parameters.md): Reference for the JSON input parameters and response objects used when executing roles via the Itential Gateway REST API. - [Execution paths](https://docs.itential.com/itential-gateway/4/ansible-execution-paths.md): Overview of the three execution paths available for Itential roles in Gateway 2023.1 and higher based on inventory variables. - [Inventory integration variables](https://docs.itential.com/itential-gateway/4/integration-variables.md): Variables required by Itential Gateway to create inventory devices. - [Create and manage devices](https://docs.itential.com/itential-gateway/4/create-manage-devices.md): How to create and manage devices and device groups via GUI or API. - [Remove a device](https://docs.itential.com/itential-gateway/4/remove-a-device.md): Steps to remove a device using the Gateway API. - [Manage inventory via API](https://docs.itential.com/itential-gateway/4/manage-inventory-via-api.md) - [Inventory sources](https://docs.itential.com/itential-gateway/4/inventory-sources.md): Overview of internal and external inventory sources in Itential Gateway and how to manage them. - [Interactive devices](https://docs.itential.com/itential-gateway/4/interactive-devices.md): Add and manage internal inventory devices in Itential Gateway using the inventory API resource. - [Inventory encryption](https://docs.itential.com/itential-gateway/4/inventory-encryption.md): How Itential Gateway uses Fernet and HashiCorp Vault encryption for inventory passwords. - [Device broker support](https://docs.itential.com/itential-gateway/4/device-broker-support.md): Overview of how Itential Gateway implements device broker functionality in Itential Platform, including supported API calls, Ansible role execution, and SSH device connectivity. - [Dynamic device inventory](https://docs.itential.com/itential-gateway/4/dynamic-device-inventory.md): An overview of dynamic inventory and the Ansible plugins available for building device inventory from a source of truth system in Itential Gateway. - [Nautobot](https://docs.itential.com/itential-gateway/4/nautobot-dynamic-inventory.md): Configure the Nautobot dynamic inventory plugin for Itential Gateway. - [NetBox](https://docs.itential.com/itential-gateway/4/netbox-dynamic-inventory.md): Create and manage device inventory in Itential Gateway using the NetBox dynamic inventory plugin. - [ServiceNow dynamic inventory](https://docs.itential.com/itential-gateway/4/servicenow-dynamic-inventory.md): Configure the ServiceNow plugin for Ansible dynamic inventory in Itential Gateway. - [SolarWinds dynamic inventory](https://docs.itential.com/itential-gateway/4/solarwinds-dynamic-inventory.md): Guide to creating and managing SolarWinds NCM device inventory via plugin in Itential Gateway. - [ZPE Cloud dynamic inventory](https://docs.itential.com/itential-gateway/4/zpe-cloud-dynamic-inventory.md): How to create and manage ZPE Cloud dynamic inventory in Itential Gateway using the Nodegrid and ZPE Cloud plugins. - [Interactive devices 2023.2](https://docs.itential.com/itential-gateway/4/interactive-devices-2023-2.md): Guide for viewing and testing interactive device endpoints and methods in the Gateway API documentation. - [Automatic discovery in Gateway](https://docs.itential.com/itential-gateway/4/automatic-discovery.md): Use Redis-based discovery and the discoverAll task to automate cluster configuration across Gateway instances. - [Use hidden keyword extension](https://docs.itential.com/itential-gateway/4/hidden-keyword-extension.md): How to use the $hidden keyword extension to prevent sensitive parameter values from appearing in console logs. - [Edit the description field](https://docs.itential.com/itential-gateway/4/description-field.md): Overview of the description field feature in Itential Gateway for managing persistent descriptions of roles, playbooks, and scripts. - [Metadata file - edit JSON schema](https://docs.itential.com/itential-gateway/4/edit-json-schema.md): Overview of the metadata file and JSON schema property editor in Itential Gateway. - [Manage decorations](https://docs.itential.com/itential-gateway/4/manage-decorations.md): API reference for exporting, importing, and removing JSON schemas used to decorate Itential Gateway modules, roles, playbooks, and scripts. - [View audit logs](https://docs.itential.com/itential-gateway/4/view-audit-logs.md): Overview of Gateway audit logs, including how to access and interpret audit log data for troubleshooting and compliance. - [Release notes overview](https://docs.itential.com/itential-gateway/release-notes/overview.md): Release notes for all Itential Gateway 4.3, 2023.3, and 2023.2 versions, including feature releases and maintenance releases. - [Itential Gateway changelog](https://docs.itential.com/itential-gateway/release-notes/changelog.md): How to stay informed about Gateway 4.3 and 2023.3 releases. - [Changelog (all entries)](https://docs.itential.com/itential-gateway/release-notes/changelog/llms.txt) - [Gateway 4.4.0 feature announcement](https://docs.itential.com/itential-gateway/4/release-notes/feature-announcements/440.md): Highlights for the Gateway 4.4.0 minor release. - [Gateway 4.3.0 feature announcement](https://docs.itential.com/itential-gateway/4/release-notes/430-feature-announcement.md): Release notes for new features, improvements, and fixes in Itential Gateway 4.3.0. - [Gateway 2023.3 feature announcement](https://docs.itential.com/itential-gateway/4/release-notes/2023-3-feature-announcement.md): Release announcement for new features, improvements, and fixes in Itential Gateway 2023.3. - [Gateway 2023.2 feature announcement](https://docs.itential.com/itential-gateway/4/release-notes/2023-2-feature-announcement.md): Release announcement for Gateway 2023.2, including new features, improvements, and fixes. - [Gateway container image changes](https://docs.itential.com/itential-gateway/4/release-notes/contianer-image-breaking-changes.md): Breaking changes introduced in Gateway maintenance release versions 2023.2.7, 2023.1.10, and 2022.1.19. - [Gateway properties.yml location change](https://docs.itential.com/itential-gateway/4/release-notes/properties-file-location-change.md): Breaking change in 2022.1 that moves the default directory for properties.yml in new Gateway installations. - [Gateway 4.3 open source notices](https://docs.itential.com/itential-gateway/4/release-notes/43-open-source-notice.md): List of open source license notices related to Gateway 4.3. - [Gateway 2023.3 open source notices](https://docs.itential.com/itential-gateway/4/release-notes/20233-open-source-notice.md): List of open source license notices related to Gateway 2023.3. - [Gateway 2023.2 open source notices](https://docs.itential.com/itential-gateway/4/release-notes/20232-open-source-notice.md): List of open source license notices related to Gateway 2023.2.