Set variable based on a file's string search

35 views
Skip to first unread message

Alex Wanderley

unread,
Mar 7, 2024, 11:02:55 AM3/7/24
to ansible...@googlegroups.com
Hello,

(And apologies if this is something too trivial...)

I have a working playbook that searches and collects a string from a file and, based on that string, sets another variable.
But I'm retrieving the string using grep/awk:

- name: Collect server location
  ansible.builtin.shell: "/bin/grep {{ inventory_hostname }} {{ server_list_file }} | /bin/awk '{print $3}'"
  register: grep_result
  changed_when: ( grep_result.rc != 0 )


"{{ server_list_file }}" points to a file that looks like this:
serverA    flavor    locationX    owner
serverB    flavor    locationY    owner
serverC    flavor    locationZ    owner

For completeness, this is how I'm using "grep_result":
- name: Set snmpd config file
  ansible.builtin.set_fact:
  snmpd_conf: "{% if grep_result.stdout == 'locationX' %}snmpd.conf-X\
               {% elif grep_result.stdout == 'locationY' %}snmpd.conf-Y\
               {% else %}snmpd.conf-Z\
               {% endif %}"


How could I, as simply as using the command/shell modules, accomplish the same results without resourcing to shell commands?

Thanks a lot,

Alex

--

 

Edmonton_sig_RGB_S.jpg

Alex Wanderley

Application and Infrastructure Analyst II
Server Solutions & Automation

Financial and Corporate Services | Open City and Technology  

 

780-496-4156  Office

780-819-0273  Mobile

 

City of Edmonton

Century Place, 19th Floor

9803 102A Avenue NW

Edmonton AB, T5J 3A3

 

All information contained in this email post is proprietary to the City of Edmonton, confidential and intended only for the addressed recipient. If you have received this post in error, please disregard the contents, inform the sender of the misdirection, and remove it from your system. The copying, dissemination or distribution of this email, if misdirected, is strictly prohibited.


The contents of this message and any attachment(s) are confidential, proprietary to the City of Edmonton, and are intended only for the addressed recipient. If you have received this in error, please disregard the contents, inform the sender of the misdirection, and remove it from your system. The copying, dissemination, or distribution of this message, if misdirected, is strictly prohibited.

Todd Lewis

unread,
Mar 7, 2024, 11:54:55 AM3/7/24
to ansible...@googlegroups.com, uto...@gmail.com
I'm curious how these notions caught on that very clearly expressed shell expressions are inherently "bad", and that unfathomably complex jinja2 expressions are inherently "better".

I seriously doubt you're going to find a more maintainable, all-Ansible expression to accomplish what you're doing.

However, I would suggest a couple alterations.
(A) I'd make that "changed_when:" into a "failed_when:", and
(B) I'd add "changed_when: false" (because it doesn't ever change anything).
(C) I might also add a "vars:" to your set_fact task that maps "location[XYZ]" to your smtp.conf expressions:
  vars:
    locmap:
      locationX: snmpd.conf-X
      locationY: snmpd.conf-Y
      locationZ: snmpd.conf-Z
Then your set_fact becomes "snmpd_conf: '{{ locmap[grep_result.stdout_lines[0]] }}'
That way you don't have to change "code" to update your location map data.
The contents of this message and any attachment(s) are confidential, proprietary to the City of Edmonton, and are intended only for the addressed recipient. If you have received this in error, please disregard the contents, inform the sender of the misdirection, and remove it from your system. The copying, dissemination, or distribution of this message, if misdirected, is strictly prohibited. --
You received this message because you are subscribed to the Google Groups "Ansible Project" group.
To unsubscribe from this group and stop receiving emails from it, send an email to ansible-proje...@googlegroups.com.
To view this discussion on the web visit https://groups.google.com/d/msgid/ansible-project/CADp8UUQB4UhuBYY1ujzs%2BJpyyV8WTr6-xu4bV8uFNWz3vmMB1g%40mail.gmail.com.

-- 
Todd

Alex Wanderley

unread,
Mar 7, 2024, 12:42:59 PM3/7/24
to ansible...@googlegroups.com, uto...@gmail.com
Thanks a lot for the insights, Tod. Very appreciated...
And suggestions as well. I'll give them a try.

I'm still in an Ansible learning process and  sometimes I also come upon that curiosity of yours...
How come the notion of avoiding shell "at all cost" exists even for very specific situations, like this one.
That's why I, based on the "no shell" assumption, tried to make my playbook better.

Regards,

Alex

Will McDonald

unread,
Mar 7, 2024, 1:25:13 PM3/7/24
to ansible...@googlegroups.com, uto...@gmail.com
I suspect the broad notion that shell == bad and native statements == good is probably just conflation/extrapolation. And human nature :)

The generally received wisdom when I was taught Ansible by Ansible folk was native modules > command > shell. 

Note this is not 'no shell at any costs', but rather, try and avoid shell because it can be fragile with globbing, expansion, unexpected behaviour with weird file names etc.

Second thought, on this topic is you could collapse the shell to command here like so:

  - name: Collect server location command
    ansible.builtin.command: /bin/awk '/{{ inventory_hostname }}/ { print $3 }' {{ server_list_file}}
    register: command_result
    changed_when: ( command_result.rc != 0 )

And finally, while the general pattern probably fits your purposes Alex, it kinda feels like getting stuff that might more naturally be considered inventory information from flat/static files?  That's probably totally cool for your current needs but I'd potentially think about exposing location as a fact, either through inference from dynamic inventory/inventory plugins, or baking into custom facts so the host can report its location (though you might have some chicken-and-egg constraints guiding you down your current path.)


Rowe, Walter P. (Fed)

unread,
Mar 7, 2024, 1:28:17 PM3/7/24
to ansible...@googlegroups.com
- name: Collect server location
  ansible.builtin.shell: "/bin/awk '$1 ~ /{{ inventory_hostname }}/ { print $3 }' {{ server_list_file }}"
  register: grep_result
  changed_when: ( grep_result.rc != 0 )

You don't need grep AND awk. Learn to use awk's expressions to find what you need in a single command.

% cat serverlist.txt 

serverA    flavor    locationX    owner

serverB    flavor    locationY    owner

serverC    flavor    locationZ    owner


% awk '$1 ~ /serverB/ { print $3; }' serverlist.txt 

locationY



Walter
--
Walter Rowe, Division Chief
Infrastructure Services Division
Mobile: 202.355.4123

Alex Wanderley

unread,
Mar 7, 2024, 1:41:19 PM3/7/24
to ansible...@googlegroups.com
Hi Walter,

Yes, that's how I usually go with (no grep + awk).
But back then, I was having so many "trouble" escaping the special characters associated with awk's syntax that I decided to go that way.
Now that things are looking better, I'll give that a try again. Otherwise I'll miss learning...

Thanks,
Alex

--
You received this message because you are subscribed to the Google Groups "Ansible Project" group.
To unsubscribe from this group and stop receiving emails from it, send an email to ansible-proje...@googlegroups.com.

Alex Wanderley

unread,
Mar 7, 2024, 1:57:10 PM3/7/24
to ansible...@googlegroups.com, uto...@gmail.com
Thanks, Will
Yes, I may have exaggerated a bit by going with 'avoid at all cost'...    :-)     You are right about the  modules > command > shell  statement. But that still made me think the solution I used was not the way to go.

"(though you might have some chicken-and-egg constraints guiding you down your current path.)" Yup, that's exactly the reason.
For now I have to rely on collecting that information from an already established way of locating our servers.
Eventually will migrate away from that and have something more coupled with Ansible. Thank you for your suggestions, by the way...

Regards,

Alex


Reply all
Reply to author
Forward
0 new messages