Get configuration from device

The config_manager/get function will return the either the current active or current saved configuration from an Cisco IOS devices. This function is only supported over network_cli connections.

The config_manager/get function will also parse the device active configuration into a set of host facts during its execution. All of the parsed facts are stored in the cisco_ios.config top level facts key.

How to get the device configuration

Retrieving the configuration from the device involves just calling the config_manager/get function from the role. By default, the config_manager/get role will return the device active (running) configuraiton. The text configuration will be returned as a fact for the host. The configuration text is stored in the configuration fact.

Below is an example of calling the config_manager/get function from the playbook.

- hosts: cisco_ios

  roles:
    - name ansible-network.cisco_ios
      function: config_manager/get

The above playbook will return the current running config from each host listed in the cisco_ios group in inventory.

Get the current startup config

By default the config_manager/get function will return the device running configuration. If you want to retrieve the device startup configuration, set the value of source to startup.

- hosts: cisco_ios

  roles:
    - name ansible-network.cisco_ios
      function: config_manager/get
      source: startup

Implement using tasks

The config_manager/get function can also be implemented in the tasks during the playbook run using either the include_role or import_role modules as shown below.

- hosts: cisco_ios

  tasks:
    - name: collect facts from cisco ios devices
      include_role:
        name: ansible-network.cisco_ios
        tasks_from: config_manager/get

How to add additional parsers

The configuration facts are returned by this function are parsed using the parsers in the parser_templates/config folder. To add a new parser, simply create a PR and add the new parser to the folder. Once merged, the config_manager/get function will automatically use the new parser.

Arguments

source

Defines the configuration source to return from the device. This argument accepts one of running or startup. When the value is set to running (default), the current active configuration is returned. When the value is set to sartup, the device saved configuration is returned.

The default value is running

Notes

None

2.5 KiB Raw Blame History