ios_config enchancement, allow restorable config, remove non-config lines from return

[IPvSean]

SUMMARY

When a backup config of an IOS / IOS-XE device is done, there is a line in the config ```Building configuration...` which is not a legitimate config, meaning we can't do a restore from the config that is returned. The means playbooks get more complicated, in the workshop we are doing this today->

    - name: REMOVE NON CONFIG LINES
      lineinfile:
        path: "{{playbook_dir}}/backup/{{inventory_hostname}}.config"
        line: "Building configuration..."
        state: absent

    - name: REMOVE NON CONFIG LINES - REGEXP
      lineinfile:
        path: "{{playbook_dir}}/backup/{{inventory_hostname}}.config"
        regexp: 'Current configuration.*'
        state: absent

ISSUE TYPE

• Feature Idea

COMPONENT NAME

ios_config

ADDITIONAL INFORMATION

This feature could be an additional parameter, something intuitive and easy like

    - name: BACKUP THE CONFIG
      ios_config:
        backup: yes
        remove_extraneous: true
      register: config_output

imho we should make this the default

[ansibot]

Files identified in the description:

• lib/ansible/modules/network/ios/ios_config.py

If these files are inaccurate, please update the component name section of the description or use the !component bot command.

click here for bot help

[ansibot]

cc @privateip @rcarrillocruz
click here for bot help

[ansibot]

@IPvSean, just so you are aware we have a dedicated Working Group for network.
You can find other people interested in this in #ansible-network on Freenode IRC
For more information about communities, meetings and agendas see https://github.com/ansible/community

click here for bot help

[ikhan2010]

@justjais Can you please look at this?

[justjais]

@ikhan2010 sure, will check and update the issue asap.

[abenokraitis]

preference by @privateip is to use a filter here instead of modifying module code. Thoughts, @IPvSean ?

[IPvSean]

@privateip @abenokraitis can I get an example?

[justjais]

@IPvSean this is the example I could come up with:

---
- hosts: ios
  gather_facts: no
  tasks:
  - name: ios backup
    ios_config:
      backup: yes
    register: location
  - shell: cat "{{ location.backup_path }}"
    register: result
  - debug:
      msg: "{{ result.stdout | regex_replace(pattern='Building configuration...', replacement='') }}"
    register: changed_backup
  - local_action: copy content={{ changed_backup.msg }} dest={{ location.backup_path }}

I know it's not straightforward and similar to what you have explained in issue description but via available filters we can solve the issue like above. @privateip kindly confirm if this is similar to what you meant.

[IPvSean]

i mean personally that looks absolutely awful, that was not the goal of this issue.... my vote is NO 👎 , if I get a vote :)

[IPvSean]

bump, is there any movement on this?

[ikhan2010]

@justjais please go ahead and close this, please.

[justjais]

Closing the bug, as we shall be resolving this via available filters.