topic Re: Ansible using Loop with registered variables in DevNet General Discussions

Ansible using Loop with registered variables

Netmart — Fri, 10 May 2024 23:22:59 GMT

Hello,

I was wondering, whether it is possible instead of creating three separate tasks, one processing one element of an array, to actually loop through an array.

Example:

vars:

ansible_become_pass: "{{ vault_sudo_password }}"

ansible_python_interpreter: /usr/bin/python3

prefix:

- 10.0.1.0/25

- 10.0.3.0/25

- 10.0.5.0/25

- name: Task1- remove prefix

ios_config:

commands:

- no ip prefix-list MTDC-nets permit {{prefix[0]}}

when: output2.stdout is search ~prefix[0]

become: true

- name: Task2- remove prefix

ios_config:

commands:

- no ip prefix-list cisco-nets permit {{prefix[1]}}

when: output2.stdout is search ~prefix[1]

become: true

- name: Task3- remove prefix

ios_config:

commands:

- no ip prefix-list MTDC-nets permit {{prefix[2]}}

when: output2.stdout is search ~prefix[2]

become: true

Is it possible to create only one task and looping through the elements of an array:

vars:

ansible_become_pass: "{{ vault_sudo_password }}"

ansible_python_interpreter: /usr/bin/python3

loop:

- 10.0.1.0/25

- 10.0.3.0/25

- 10.0.5.0/25

- name: Task1- remove prefix

ios_config:

commands:

- no ip prefix-list Cisco-nets permit {{prefix}}

when: output2.stdout is search ~prefix

become: true

Re: Ansible using Loop with registered variables

bigevilbeard — Sat, 11 May 2024 07:04:57 GMT

You can, instead of creating separate tasks for each element in the array, use a single task with a loop. Then use a dictionary to store the prefix list and its corresponding network name.

---
vars:
ansible_become_pass: "{{ vault_sudo_password }}"
ansible_python_interpreter: /usr/bin/python3

prefix_list:
- { network: "MTDC-nets", prefix: "10.0.1.0/25" }
- { network: "cisco-nets", prefix: "10.0.3.0/25" }
- { network: "MTDC-nets", prefix: "10.0.5.0/25" }

tasks:
- name: Remove prefix
ios_config:
commands:
- "no ip prefix-list {{ item.network }} permit {{ item.prefix }}"
when: output2.stdout is search ~item.prefix
become: true
register: output
loop: "{{ prefix_list }}"

Re: Ansible using Loop with registered variables

Netmart — Mon, 13 May 2024 16:52:40 GMT

Thank you.

I tried to apply it, but it seems still to be an error

prefix_list:
- {network:"Test-nets",prefix:"10.0.0.0/25"}
- {network:"Test-nets",prefix:"10.0.2.0/25"}
- {network:"Test-nets",prefix:"10.0.5.0/25"}

:
- name: Task2 - sh run
ios_command:
commands:
- "sh run | i Test-nets"

become: true
register: output2

:
- name: Task3- remove prefix
ios_config:
commands:
- "no ip prefix-list {{ item.network }} permit {{ item.prefix }}"
when: output2.stdout is search ~item.prefix

become: true
register: output3
loop: "{{ prefix_list }}"

\nThe offending line appears to be:\n\n\n - name: Task3- remove prefix\n ^ here\n"
TASK [Task3- remove prefix] ********************************************************************************************

fatal: [cisco.org]: FAILED! => {"msg": "The conditional check 'output2.stdout is search ~item.prefix' failed.
The error was: error while evaluating conditional (output2.stdout is search ~item.prefix):
'dict object' has no attribute 'stdout'. 'dict object' has no attribute 'stdout'\n\nThe error appears to be in
'/home/cisco/Ansible/library/lib-ios-xe-staging/site-ios-xe-CE-bgp-prefix-list-update-loop.yml': line 39, column 8,
but may\nbe elsewhere in the file depending on the exact syntax problem.\n

Re: Ansible using Loop with registered variables

bigevilbeard — Mon, 13 May 2024 17:21:48 GMT

Looks like the the error is due to the when condition in Task3. The output2 variable is not accessible in the scope of Task3.

Try and use the output variable from Task2 to check the prefix.

Re: Ansible using Loop with registered variables

Netmart — Mon, 20 May 2024 04:51:49 GMT

It seems that it is already complaining at Task2

TASK [Task2 - sh run] **********************************************************************************************************************
fatal: [cisco.org]: FAILED! => {"msg": "The task includes an option with an undefined variable. The error was: 'dict object' has no attribute 'prefix'. 'dict object'
has no attribute 'prefix'\n\nThe error appears to be in '/home/cisco/Ansible/library/lib-ios-xe-staging/site-ios-xe-CE-bgp-prefix-list-update-loop.yml':
line 28, column 8, but may\nbe elsewhere in the file depending on the exact syntax problem.\n\nThe offending line appears to be:\n\n\n - name: Task2 - sh run\n ^ here\n"}

PLAY RECAP *********************************************************************************************************************************
cisco.org : ok=2 changed=0 unreachable=0 failed=1 skipped=0 rescued=0 ignored=0

site-ios-xe-CE-bgp-prefix-list-update-loop.yml

:
vars:
ansible_become_pass: "{{ vault_sudo_password }}"
ansible_python_interpreter: /usr/bin/python3

prefix_list:
- {network:"Test-nets",prefix:"10.0.0.0/25"}
- {network:"Test-nets",prefix:"10.0.2.0/25"}
- {network:"Test-nets",prefix:"10.0.5.0/25"}

tasks:

- name: Task1 - sh run | count Test-nets
ios_command:
commands:
- sh run | count Test-nets

become: true
register: output1

- name: Task2 - sh run [ line 28, column 8,]
ios_command:
commands:
- sh run | i {{ item.prefix }}

become: true
register: output2
loop: "{{ prefix_list }}"

- name: Task3- remove prefix
ios_config:
commands:
- "no ip prefix-list {{ item.network }} permit {{ item.prefix }}"
when: output2.stdout is search ~item.prefix

become: true
register: output2
loop: "{{ prefix_list }}"

- name: Task4 check prefix has been removed
ios_command:
commands:
- "sh run | i {{ item.prefix }}"

become: true
register: output4

- name: Task5 - sh run | count Test-nets
ios_command:
commands:
- sh run | count Test-nets

become: true
register: output5

# ******** Output results ********

- name: Result1 prefix count prior to update - sh run | count TestC-nets
debug:
var: output1

- name: Result2.1 check if prefix is configured
debug:
msg: " Prefix is configured @ {{inventory_hostname}}: {{ item.network }} permit {{ item.prefix }}"
when: output2.stdout is search {{ item.network }} permit {{ item.prefix }}

- name: Result2.2 check if prefix is NOT oonfigured
debug:
msg: " Prefix is configured @ {{inventory_hostname}}: {{ item.network }} permit {{ item.prefix }}"
when: output2.stdout is not search {{ item.network }} permit {{ item.prefix }}

- name: Result4 check if prefix has been removed
debug:
msg: " Prefix has been removed @ {{inventory_hostname}}: {{ item.network }} permit {{ item.prefix }}"
when: output4.stdout is not search {{ item.network }} permit {{ item.prefix }}

- name: Result5 prefix count post to update - sh run | count Test-nets
debug:
var: output5

Re: Ansible using Loop with registered variables

bigevilbeard — Mon, 20 May 2024 07:45:10 GMT

Got it, try by adding loop_var: item

- name: Task2 - sh run ios_command: commands: - sh run | i {{ item.prefix }} become: true register: output2 loop: "{{ prefix_list }}" loop_var: item

Re: Ansible using Loop with registered variables

Netmart — Sun, 26 May 2024 03:36:48 GMT

Thank you.

I tried, but...

ERROR! conflicting action statements: ios_command, loop_vars

The error appears to be in '/home/cisco/Ansible/library/lib-ios-xe-staging/site-ios-xe-CE-bgp-prefix-list-update-loop.yml': line 30, column 8, but may

be elsewhere in the file depending on the exact syntax problem.

The offending line appears to be:

- name: Task2 - sh run

^ here0

======================

Extract playbook:

site-ios-xe-CE-bgp-prefix-list-update-loop.yml

:
vars:
ansible_become_pass: "{{ vault_sudo_password }}"
ansible_python_interpreter: /usr/bin/python3

prefix_list:
- {network:"Test-nets",prefix:"10.0.0.0/25"}
- {network:"Test-nets",prefix:"10.0.2.0/25"}
- {network:"Test-nets",prefix:"10.0.5.0/25"}

tasks:

- name: Task1 - sh run | count Test-nets
ios_command:
commands:
- sh run | count Test-nets

become: true
register: output1

- name: Task2 - sh run [ line 30,column 8,]
ios_command:
commands:
- sh run | i {{ item.prefix }}

become: true
register: output2
loop: "{{ prefix_list }}“

loop_var: item

Re: Ansible using Loop with registered variables

bigevilbeard — Sun, 26 May 2024 10:30:41 GMT

For your error message is indicating that there is a conflict between the ios_command and loop_vars directives in the "Task2". I would suggest move the loop_var directive inside the loop_control block.

Hope this helps.

Re: Ansible using Loop with registered variables

Netmart — Mon, 10 Jun 2024 20:24:02 GMT

Thank you.

I tried the following:

vars:

ansible_become_pass: "{{ vault_sudo_password }}"

ansible_python_interpreter: /usr/bin/python3

network: "{{ item.network }}"

prefix: "{{ item.prefix }}"

prefix_list:

- {network:"Test-nets",prefix:"10.0.0.0/25"}

- {network:"Test-nets",prefix:"10.0.2.0/25"}

- {network:"Test-nets",prefix:"10.0.5.0/25"}

- name: Task2 - sh run

ios_command:

commands:

- sh run | i "{{ item.prefix }}"

loop_control:

loop: "{{ prefix_list }}"

loop_vars: "{{ item.prefix }}"

And received the following error:

ERROR! 'loop' is not a valid attribute for a LoopControl

The error appears to be in '/home/cisco/Ansible/library/lib-ios-xe-staging/site-ios-xe-CE-bgp-prefix-list-update-loop2.yml': line 40, column 10, but may
be elsewhere in the file depending on the exact syntax problem.

The offending line appears to be:

loop_control:
loop: "{{ prefix_list }}"
^ here
We could be wrong, but this one looks like it might be an issue with
missing quotes. Always quote template expression brackets when they
start a value. For instance:

with_items:
- {{ foo }}

Should be written as:

with_items:
- "{{ foo }}"

I would appreciate any advice.

Thanks.

Re: Ansible using Loop with registered variables

Torbjørn — Tue, 11 Jun 2024 08:25:24 GMT

Loop control should not contain the loop itself, only other "loop parameters". You can try this:

- name: Task2 - sh run ios_command: commands: - sh run | i "{{ item.prefix }}" loop: "{{ prefix_list }}" loop_control: loop_vars: "{{ item.prefix }}"

Re: Ansible using Loop with registered variables

Netmart — Mon, 17 Jun 2024 04:41:02 GMT

Hi Torbjoern,

Thank you.

I tried, but it seems to still have an issue:

FAILED! => {"msg": "The field 'loop_var' has an invalid value, which includes an undefined variable. The error was: 'item' is undefined. 'item' is undefined\n\nThe error appears to be in '/home/cisco/Ansible/library/lib-ios-xe-staging/site-ios-xe-CE-bgp-prefix-list-update-loop2.yml': line 40, column 11, but may\nbe elsewhere in the file depending on the exact syntax problem.\n\nThe offending line appears to be:\n\n loop_control:\n loop_var: \"{{item.prefix}}\"\n ^ here\nWe could be wrong, but this one looks like it might be an issue with\nmissing quotes. Always quote template expression brackets when they\nstart a value. For instance:\n\n with_items:\n - {{ foo }}\n\nShould be written as:\n\n with_items:\n - \"{{ foo }}\"\n"}

Please advise.

Thanks.

Re: Ansible using Loop with registered variables

Torbjørn — Tue, 18 Jun 2024 09:02:11 GMT

After reading over this again - sorry, my last response wasn't a good response to the original question asked. It was only answering to the specific syntax error you posted.

The simplest way to do this would be to do something like this:

- name: Remove prefix ios_command: commands: - "no ip prefix-list {{ item.name }} permit {{ item.prefix }}" loop: "{{ prefix_list }}"

If you need to verify that the prefix-list entry exists before removing like in your original playbook you can do something like this:

- name: Get running-config ios_command: - "show running-config" register: running_config - name: Remove prefix ios_command: commands: - "no ip prefix-list {{ item.name }} permit {{ item.prefix }}" loop: "{{ prefix_list }}" when: running_config.stdout is search(item.name) | running_config.stdout is search(item.prefix)

Re: Ansible using Loop with registered variables

Netmart — Wed, 19 Jun 2024 19:24:19 GMT

Thank you Torbjoern.

The issues remains the same:

The error appears to be in '/home/cisco/Ansible/library/lib-ios-xe-staging/site-ios-xe-CE-bgp-prefix-list-update-loop2.yml': line 44, column 9, but may
be elsewhere in the file depending on the exact syntax problem.

The offending line appears to be:

- "no ip prefix-list {{ item.network }} permit {{ item.prefix }}"
loop: "{{ prefix_list }}"
^ here
We could be wrong, but this one looks like it might be an issue with
missing quotes. Always quote template expression brackets when they
start a value. For instance:

with_items:
- {{ foo }}

Should be written as:

with_items:
- "{{ foo }}"

Re: Ansible using Loop with registered variables

Netmart — Wed, 19 Jun 2024 20:18:06 GMT

vars:

prefix_list:

- {network:"Test-nets",prefix:"10.0.0.0/25"}

- {network:"Test-nets",prefix:"10.0.2.0/25"}

- {network:"Test-nets",prefix:"10.0.5.0/25"}

tasks:

- name: Task3 - remove prefix

ios_config:

commands:

- "no ip prefix-list {{ item.network }} permit {{ item.prefix }}"

loop: "{{ prefix_list }}"

loop_control:

loop_var: prefix_list

I get:

FAILED! =>
{"msg": "The task includes an option with an undefined variable.
The error was: 'item' is undefined. 'item' is undefined\n\nThe error appears to be in
'/home/cisco/Ansible/library/lib-ios-xe-staging/site-ios-xe-CE-bgp-prefix-list-update-loop2.yml':
line 36, column 8, but may\nbe elsewhere in the file depending on the exact syntax problem.
\n\nThe offending line appears to be:\n\n\n - name: Task3 - remove prefix\n ^ here\n"}

Re: Ansible using Loop with registered variables

Torbjørn — Thu, 20 Jun 2024 11:31:05 GMT

I believe this should work if you remove the whole "loop_control:" portion.

Re: Ansible using Loop with registered variables

Netmart — Fri, 28 Jun 2024 21:54:15 GMT

Sorry Torbjoern, this has been already tried without success.

Is there no example available illustrating looping through an array as in my case.

The material I"ve found so far in Ansible is not really matching what I am looking for.

The closest I was able to find has been:

Iterating over a list of hashes 

If you have a list of hashes, you can reference subkeys in a loop. For example:

- name: Add several users
  ansible.builtin.user:
    name: "{{ item.name }}"
    state: present
    groups: "{{ item.groups }}"
  loop:
    - { name: 'testuser1', groups: 'wheel' }
    - { name: 'testuser2', groups: 'root' }


https://docs.ansible.com/ansible/latest/playbook_guide/playbooks_loops.html

Re: Ansible using Loop with registered variables

Netmart — Sat, 29 Jun 2024 05:54:14 GMT

Hi Torbjorn,

I am sorry, it is still failing.

I also tried the following:

- name: Task3- remove prefix

ios_config:

commands:

- "no ip prefix-list {{ item.network }} permit {{ item.prefix }}"

loop:

- network:"Test-nets",prefix:"10.0.0.0/25"

- network:"Test-nets",prefix:"10.0.2.0/25"

- network:"Test-nets",prefix:"10.0.5.0/25"

However, Ansible is still complaining that has no attribute network and prefix. And following the Ansible documentation, the loop is configured underneath the task.

fatal: [switch: FAILED! => {"msg": "The task includes an option with an undefined variable. The error was: 'ansible.parsing.yaml.objects.AnsibleUnicode object' has no attribute 'network'. 'ansible.parsing.yaml.objects.AnsibleUnicode object' has no attribute 'network'\n\nThe error appears to be in '/home/cisco/Ansible/library/lib-ios-xe-staging/site-ios-xe-CE-bgp-prefix-list-update-loop2.yml': line 34, column 8, but may\nbe elsewhere in the file depending on the exact syntax problem.\n\nThe offending line appears to be:\n\n\n - name: Task3- remove prefix\n ^ here\n"}

Re: Ansible using Loop with registered variables

Netmart — Sat, 29 Jun 2024 06:34:34 GMT

Sorry, still the same.

I also tried the following:

Extract Playbook:

- name: Task3- remove prefix

ios_config:

commands:

- "no ip prefix-list {{ item.network }} permit {{ item.prefix }}"

loop:

- { network:"Test-nets",prefix:"10.0.0.0/25" }

- { network:"Test-nets",prefix:"10.0.2.0/25" }

- { network:"Test-nets",prefix:"10.0.5.0/25" }

The previous setup follows the example as illustrated in the Ansible documentation. The only difference that I am using the ios_config command to iterate a command with a loop variable.

Iterating over a list of hashes 

If you have a list of hashes, you can reference subkeys in a loop. For example:

- name: Add several users
  ansible.builtin.user:
    name: "{{ item.name }}"
    state: present
    groups: "{{ item.groups }}"
  loop:
    - { name: 'testuser1', groups: 'wheel' }
    - { name: 'testuser2', groups: 'root' }

Re: Ansible using Loop with registered variables

netmart2 — Thu, 04 Jul 2024 05:56:24 GMT

After reviewing it together with someone from Ansible Community, it turned out that the syntax for loop was not correct:

A space is needed after each ‘:’ and ‘,’ in the dictionary. Tip: use ``` before and after a block of YAML/code to make it easier to read.

It is working as followed:

- ios_config:

commands:

- "no ip prefix-list {{ item.network }} permit {{ item.prefix }}"

loop:

- { network: Test-nets, prefix: "10.0.0.0/25" }

- { network: Test-nets, prefix: "10.0.2.0/25" }

- { network: Test-nets, prefix: "10.0.5.0/25" }

Re: Ansible using Loop with registered variables

netmart2 — Thu, 04 Jul 2024 05:57:51 GMT

The same is illustrated in Ansible documetation:

Iterating over a list of hashes

If you have a list of hashes, you can reference subkeys in a loop. For example:

- name: Add several users

ansible.builtin.user:

name: "{{ item.name }}"

state: present

groups: "{{ item.groups }}"

loop:

- { name: 'testuser1', groups: 'wheel' }

- { name: 'testuser2', groups: 'root' }

https://docs.ansible.com/ansible/latest/playbook_guide/playbooks_loops.html

topic Re: Ansible using Loop with registered variables in DevNet General Discussions

Ansible using Loop with registered variables

Re: Ansible using Loop with registered variables

Re: Ansible using Loop with registered variables

Re: Ansible using Loop with registered variables

Re: Ansible using Loop with registered variables

Re: Ansible using Loop with registered variables

Re: Ansible using Loop with registered variables

Re: Ansible using Loop with registered variables

Re: Ansible using Loop with registered variables

Re: Ansible using Loop with registered variables

Re: Ansible using Loop with registered variables

Re: Ansible using Loop with registered variables

Re: Ansible using Loop with registered variables

Re: Ansible using Loop with registered variables

Re: Ansible using Loop with registered variables

Re: Ansible using Loop with registered variables

Iterating over a list of hashes

Re: Ansible using Loop with registered variables

Re: Ansible using Loop with registered variables

Iterating over a list of hashes

Re: Ansible using Loop with registered variables

Re: Ansible using Loop with registered variables

Iterating over a list of hashes 

Iterating over a list of hashes 