Skip to content

Latest commit

 

History

History
89 lines (62 loc) · 2.85 KB

load.md

File metadata and controls

89 lines (62 loc) · 2.85 KB
Raw

Load configuration into device

The config_manager/load function provides a means to load either a configuration file or configuration text onto a target device running Cisco NX-OS. The config_manager/load function provides configuration values that allow the source configuration to either be merged with the current active configuration (default) or to replace the current active configuration on the device.

How to load a configuration

Loading a configuration onto a target device is fairly simple and straightforward. By default, the config_manager/load function will merge the contents of the provided configuration file with the configuration running on the target device.

Below is an example of how to call the config_manager/load function.

- hosts: nxos
  
  roles:
    - name: ansible-network.cisco_nxos
      function: config_manager/load
      config_manager_text: "{{ lookup('file', 'nxos.cfg') }}"

The example playbook above will simple load the contents of nxos.cfg onto the target network devices.

How to load and replace a configuration

The config_manager/load function also provides support for replacing the current configuration on a device. replace option is only supported on Cisco NXOS 9K devices.

In order to replace the configuration, the function as before but adds the value replace: yes to the playbook to indicate that the configuration should be replace and replace_fs: <destination> where the file will be placed.

Note: Take caution when doing configuration replace that you do not inadvertantly replace your access to the device.

- hosts: nxos

  roles:
    - name: ansible-network.cisco_nxos
      function: config_manager/load
      config_manager_text: "{{ lookup('file', 'nxos.cfg') }}"
      config_manager_replace: yes

Arguments

config_manager_text

This value accepts the text form of the configuration to be loaded on to the remote device. The configuration file should be the native set of commands used to configure the remote device

The default value is null

config_manager_replace

This value enables or disables the configuration replace feature of the function. In order to use nxos_config_replace the target device must support config replace function, currently only NXOS 9K device supports replace.

The default value is False

nxos_config_replace_fs

This value provides the directory on the device where the config file will be pushed during replace.

The default value is bootflash:

This value is required when nxos_config_replace is set to yes or True.

nxos_config_remove_temp_files

Configures the function to remove or not remove the temp files created when preparing to load the configuration file. There are two locations for temp files, one on the Ansible controller and one on the device. This argument accepts a boolean value.

The default value is True