|
| 1 | +# Itential Integration Setup |
| 2 | + |
| 3 | +This guide will walk you through steps to set up Itential integration with the `nautobot_ssot` app. |
| 4 | + |
| 5 | +## Prerequisites |
| 6 | + |
| 7 | +Before configuring the integration, please ensure, that `nautobot-ssot` app was [installed with the Itential integration extra dependencies](../install.md#install-guide). |
| 8 | + |
| 9 | +```shell |
| 10 | +pip install nautobot-ssot[itential] |
| 11 | +``` |
| 12 | + |
| 13 | +## Configuration |
| 14 | + |
| 15 | +The integration with Itential primarily utilizes the [External Integrations](https://docs.nautobot.com/projects/core/en/stable/user-guide/platform-functionality/externalintegration/?h=external) and [Secrets](https://docs.nautobot.com/projects/core/en/stable/user-guide/platform-functionality/secret/?h=secrets) features within Nautobot to set up the integration. To enable this integration, the only modification needed is to activate it in the nautobot_config.py file. |
| 16 | + |
| 17 | +Below is an example snippet from `nautobot_config.py` that demonstrates how to enable the Itential integration: |
| 18 | + |
| 19 | +```python |
| 20 | +PLUGINS_CONFIG = { |
| 21 | + "nautobot_ssot": { |
| 22 | + "enable_itential": True, |
| 23 | + } |
| 24 | +} |
| 25 | +``` |
| 26 | + |
| 27 | +Remaining configurations are performed in the Nautobot UI or through the Nautobot API. |
| 28 | + |
| 29 | +### Secrets |
| 30 | + |
| 31 | +The Itential integration necessitates four secret values: (1) Itential API access username, (2) Itential API access password, (3) network device access username, and (4) network device access password. You can store these secrets using the secrets provider of your choice. |
| 32 | + |
| 33 | +### Secrets Group |
| 34 | + |
| 35 | +When assigning secrets to a secrets group, please refer to the table below to correctly assign each secret to its respective access type and secret type. |
| 36 | + |
| 37 | +| Secret Description | Access Type | Secret Type | |
| 38 | +|-----------------------|-------------|-------------| |
| 39 | +| Itential API username | REST | Username | |
| 40 | +| Itential API password | REST | Password | |
| 41 | +| Device username | GENERIC | Username | |
| 42 | +| Device password | GENERIC | Password | |
| 43 | + |
| 44 | +### External Integration |
| 45 | + |
| 46 | +When setting up an external integration, you must provide the following required fields: |
| 47 | + |
| 48 | +1. **Name**: The unique identifier for the integration. |
| 49 | +2. **Remote URL**: The endpoint URL, including the protocol and port, if applicable. |
| 50 | +3. **Verify SSL**: A boolean value indicating whether SSL certificates should be verified. |
| 51 | +4. **Secrets Group**: The group of secrets associated with the integration, containing necessary authentication details. |
| 52 | + |
| 53 | +The remote URL must include both the protocol (either http or https) and the TCP port used by the automation gateway. For example, to access the automation gateway, you would enter a URL like: https://iag.example.com:8443. |
| 54 | + |
| 55 | +### Automation Gateway Management |
| 56 | + |
| 57 | +To manage the Automation Gateway, navigate to Plugins -> Single Source of Truth -> Itential Automation Gateway in your application. From this interface, you can input details about the automation gateway, which include: |
| 58 | + |
| 59 | +1. **Name**: Specify the name of the automation gateway. |
| 60 | +2. **Description**: Provide a brief description of what the automation gateway is used for. |
| 61 | +3. **Location**: Indicate the primary location of the devices managed by the automation gateway. |
| 62 | +4. **Location Descendants**: This boolean value determines whether the automation gateway should also manage devices in child locations of the specified primary location. |
| 63 | +5. **Enabled**: This boolean setting allows you to enable or disable inventory synchronization with the automation gateway. |
0 commit comments