Enable backup for Check Point Gaia via netmiko #166
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
jifox
requested review from
jvanderaa,
jmcgill298 and
itdependsnetworks
as code owners
jeffkala
reviewed
Sep 13, 2024
Comment on lines
+113
to
+140
|
|
||
|
|
||
| ## Dispatcher Configuration for Nautobot Golden Config | ||
|
|
||
| here are the steps needed to configure dispatchers for Nautobot Golden Config. | ||
|
|
||
| ### checkpoint_gaia | ||
|
|
||
| This section describes the **checkpoint_gaia** dispatcher that provides backup functionality for Check Point firewalls. | ||
|
|
||
| To configure the dispatcher for Nautobot Golden Config, follow these steps: | ||
|
|
||
| 1. Go to **Nautobot / Admin / Configuration**. | ||
| 2. In the **Golden Configuration** section, set the default framework to `"checkpoint_gaia": "netmiko"`. | ||
|
|
||
| Here is an example of the configuration in JSON format: | ||
|
|
||
| ```json | ||
| { | ||
| "all": "napalm", | ||
| "checkpoint_gaia": "netmiko" | ||
| } | ||
| ``` | ||
|
|
||
| 3. Add the Platform **checkpoint_gaia** to the **Platform** model in the Nautobot admin interface. | ||
|
|
||
| - **Name**: "checkpoint_gaia" | ||
| - **Network driver**: "checkpoint_gaia" |
There was a problem hiding this comment.
We cover this in a few other places, nautobot-plugin-nornir specifically. I'd say we delete this from here.
Comment on lines
+113
to
+140
|
|
||
|
|
||
| ## Dispatcher Configuration for Nautobot Golden Config | ||
|
|
||
| here are the steps needed to configure dispatchers for Nautobot Golden Config. | ||
|
|
||
| ### checkpoint_gaia | ||
|
|
||
| This section describes the **checkpoint_gaia** dispatcher that provides backup functionality for Check Point firewalls. | ||
|
|
||
| To configure the dispatcher for Nautobot Golden Config, follow these steps: | ||
|
|
||
| 1. Go to **Nautobot / Admin / Configuration**. | ||
| 2. In the **Golden Configuration** section, set the default framework to `"checkpoint_gaia": "netmiko"`. | ||
|
|
||
| Here is an example of the configuration in JSON format: | ||
|
|
||
| ```json | ||
| { | ||
| "all": "napalm", | ||
| "checkpoint_gaia": "netmiko" | ||
| } | ||
| ``` | ||
|
|
||
| 3. Add the Platform **checkpoint_gaia** to the **Platform** model in the Nautobot admin interface. | ||
|
|
||
| - **Name**: "checkpoint_gaia" | ||
| - **Network driver**: "checkpoint_gaia" |
There was a problem hiding this comment.
Suggested change
| ## Dispatcher Configuration for Nautobot Golden Config | |
| here are the steps needed to configure dispatchers for Nautobot Golden Config. | |
| ### checkpoint_gaia | |
| This section describes the **checkpoint_gaia** dispatcher that provides backup functionality for Check Point firewalls. | |
| To configure the dispatcher for Nautobot Golden Config, follow these steps: | |
| 1. Go to **Nautobot / Admin / Configuration**. | |
| 2. In the **Golden Configuration** section, set the default framework to `"checkpoint_gaia": "netmiko"`. | |
| Here is an example of the configuration in JSON format: | |
| ```json | |
| { | |
| "all": "napalm", | |
| "checkpoint_gaia": "netmiko" | |
| } | |
| ``` | |
| 3. Add the Platform **checkpoint_gaia** to the **Platform** model in the Nautobot admin interface. | |
| - **Name**: "checkpoint_gaia" | |
| - **Network driver**: "checkpoint_gaia" |
| from nornir_nautobot.plugins.tasks.dispatcher.default import NapalmDefault, NetmikoDefault | ||
| from nornir_nautobot.exceptions import NornirNautobotException | ||
|
|
||
| NETMIKO_DEVICE_TYPE = "linux" |
There was a problem hiding this comment.
In theory this will come directly from the nornir inventory in the platform definition. Would like to avoid hardcoding it here.
Comment on lines
+20
to
+51
| @classmethod | ||
| def get_config( # pylint: disable=R0913,R0914 | ||
| cls, task: Task, logger, obj, backup_file: str, remove_lines: list, substitute_lines: list | ||
| ) -> Result: | ||
| """Get the latest configuration from the device. | ||
|
|
||
| Args: | ||
| task (Task): Nornir Task. | ||
| logger (logging.Logger): Logger that may be a Nautobot Jobs or Python logger. | ||
| obj (Device): A Nautobot Device Django ORM object instance. | ||
| backup_file (str): The file location of where the back configuration should be saved. | ||
| remove_lines (list): A list of regex lines to remove configurations. | ||
| substitute_lines (list): A list of dictionaries with to remove and replace lines. | ||
|
|
||
| Returns: | ||
| Result: Nornir Result object with a dict as a result containing the running configuration | ||
| { "config: <running configuration> } | ||
| """ | ||
| try: | ||
| task.host.platform = NETMIKO_DEVICE_TYPE | ||
| result = super().get_config( | ||
| task, | ||
| logger, | ||
| obj, | ||
| backup_file, | ||
| remove_lines, | ||
| substitute_lines, | ||
| ) | ||
| return result | ||
| except Exception as exc: | ||
| error_msg = f"Failed to get configuration from {task.host.name} on {task.host.platform}" | ||
| raise NornirNautobotException(error_msg) from exc |
There was a problem hiding this comment.
don't believe any of this is needed. The overload of the config_command should be all that is needed. Like i said in previous comment, the task.host.platform should be sent in the nautobot-plugin-nornir dynamic inventory creation which is based on network_driver set in nautobot and there are other facilities to overwrite that from nautobot admin panel.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Closes #165