==environment==
o.s. = debian stretch (this will work with any linux)
 xserver = xserver-xorg-core 2:1.19.2-1+deb9u5
 xdotool = 1:3.20160805.1-3

==problem==
need to program keyboard keys (macros) to send keyboard input or launch programs

==solution==
install xdotool and configure

==="snooping" keyboard input keycodes===

in a terminal run program '''xev''' (comes with xserver-xorg-core i think) and then just hit the keyboard key of interest. you will see output such as...

KeyPress event, serial 37, synthetic NO, window 0x3600001,
root 0x4a0, subw 0x0, time 9652301, (164,120), root:(2235,492),
'''state 0x10, keycode 133''' (keysym 0xffeb, Super_L), same_screen YES,
XLookupString gives 0 bytes:
XmbLookupString gives 0 bytes:
XFilterEvent returns: False

make a note of the state and keycode which are to be input into the xdotool config

===example keyboard input===

here we will program the "windows" key (between left ctrl and alt) to send "hahah lol" text as if entered by the keyboard.

edit $HOME/.xbindkeysrc, add a section like the one below. first line is a comment, 2nd is the commands to execute, 3rd line is the keycode line where 0x10 is from the state above and 133 is the keycode.

## "windows" key macro
"sleep 0.2 && xdotool type --delay 15 'hahaha lol';"
m:0x10 + c:133

save .xbindkeysrc

start or restart xbindkeys

$ killall xbindkeys; xbindkeys

in a terminal or text editor test you keyboard input by pressing you "windows key"

it should output...

hahaha lol

===example keyboard input===

same steps as above, add the following section to $HOME/.xbindkeys (did this after installing screengrab). my printscreen keycode was 107, yours may be different.

## printscreen keyboard shortcut
"/usr/bin/screengrab"
m:0x10 + c:107

start or restart xbindkeys

test by hitting you printscreen button, hope it works!

===common key codes===

 KP_Space, KP_Enter, KP_Tab, KP_F1, KP_Up, KP_Right, Shift_L

 key 1, key a

send a string

xdotool type --delay 15 'abc123'

where delay is in ms between simulated key strokes

mouse clicks

xdotool click 1, xdotool click 2

[[category:linux]]
[[category:automation]]

Keyboard automation

2025-04-24T17:22:42Z

Nighthawk:

ansible notes

2025-04-16T22:12:06Z

Nighthawk: /* types */

[https://www.redhat.com/en/services/training/ex457-red-hat-certified-specialist-in-ansible-network-automation-exam?section=objectives https://www.redhat.com/en/services/training/ex457-red-hat-certified-specialist-in-ansible-network-automation-exam?section=objectives]

==installation==
pip install ansible

==variables==

A variable name can only include letters, numbers, and underscores. [https://docs.python.org/3/reference/lexical_analysis.html#keywords Python keywords] or [https://docs.ansible.com/ansible/latest/reference_appendices/playbooks_keywords.html#playbook-keywords playbook keywords] are not valid variable names. A variable name cannot begin with a number. Use use double curly braces to reference them. i.e.
<nowiki>
{{ foo }}
</nowiki>
===types===

Simple vars store a single value.

List variables store multiple.

referencing specific fields
region: "{{ region[0] }}"

Dictionary vars store data in key-value pairs

get var type

<nowiki>
{{ myvar | type_debug }}
</nowiki>

Combining list variables
ansible.builtin.set_fact:
merged_list: <nowiki>"{{ list1 + list2 }}"</nowiki>

Combining dictionary variables
ansible.builtin.set_fact:
merged_dict: <nowiki>"{{ dict1 | ansible.builtin.combine(dict2) }}"</nowiki>

merge variables that match the given prefixes, suffixes, or regular expressions, you can use the community.general.merge_variables lookup, for example:

merged_variable: <nowiki>"{{ lookup('community.general.merge_variables', '__my_pattern', pattern_type='suffix') }}"</nowiki>

===[https://docs.ansible.com/ansible/latest/inventory_guide/intro_inventory.html#variables-in-inventory Adding variables to inventory]===

Reference nested variables using either bracket notation or dot notation
<nowiki>
'{{ ansible_facts["eth0"]["ipv4"]["address"] }}'
or
{{ ansible_facts.eth0.ipv4.address }}
</nowiki>

===setting variables===
Variables can be set via files (like inventory), plays or command line at run time.

setfact
- name: set a var
set_fact:
somevar: "foo"

Registering variables with the task keyword register.

- name: Run a shell command and register its output as a variable
ansible.builtin.shell: /usr/bin/foo
register: foo_result

Defining variables at runtime

key=value syntax
values are interpreted as strings

ansible-playbook release.yml --extra-vars "version=1.23.45 other_variable=foo"

Use the JSON format if you need to pass non-string values such as Booleans, integers, floats, lists...

ansible-playbook release.yml --extra-vars '{"version":"1.23.45","other_variable":"foo"}'
ansible-playbook arcade.yml --extra-vars '{"pacman":"mrs","ghosts":["inky","pinky","clyde","sue"]}'

you must escape quotes and other special characters

ansible-playbook arcade.yml --extra-vars "{\"name\":\"Conan O\'Brien\"}"
ansible-playbook arcade.yml --extra-vars '{"name":"Conan O'\\\''Brien"}'
ansible-playbook script.yml --extra-vars "{\"dialog\":\"He said \\\"I just can\'t get enough of those single and double-quotes"\!"\\\"\"}"

==Connecting to hosts==

===[https://docs.ansible.com/ansible/latest/vault_guide/vault.html#vault Secure credentials with Ansible Vault]===

common commands

$ ansible-vault create <path to file>

$ ansible-vault edit <path to file>

$ ansible-vault rekey <path to file>

$ ansible-vault view <path to file>

default directories for encrypted vault files

group_vars

host_vars

use hostname/groupname from inventory file as name of the file

===connection plugins===

variable ansible_connection

listing connection types/plugins
$ '''ansible-doc -t connection -l'''
kubectl Execute tasks in pods running on Kubernetes
libvirt_lxc Run tasks in lxc containers via libvirt
chroot Interact with local chroot
psrp Run tasks over Microsoft PowerShell Remoting Protocol
network_cli Use network_cli to run command on network appliances
vmware_tools Execute tasks inside a VM via VMware Tools
ssh connect via ssh client binary
httpapi Use httpapi to run command on network appliances
docker Run tasks in docker containers
...

==playbooks==
===examples===
- name: My first play
hosts: myhosts
tasks:
- name: Print wall message
ansible.builtin.command: /usr/bin/wall hello

- name: output test
hosts: myhosts
tasks:
- name: run uname thru awk
ansible.builtin.shell: /usr/bin/uname -a | awk '{print $NF}'
register: results
- debug:
var: results.stdout

$ '''ansible-playbook -i inventory.ini shelltest.yaml'''
PLAY [output test] ********************************************************************************************************************************
 
TASK [run uname thru awk] *************************************************************************************************************************
changed: [10.0.0.15]
 
TASK [debug] **************************************************************************************************************************************
ok: [10.0.0.15] => {
"results.stdout": "GNU/Linux"
}
 
PLAY RECAP ****************************************************************************************************************************************
10.0.0.15 : ok=2 changed=1 unreachable=0 failed=0 skipped=0 rescued=0 ignored=0

==programming==

===[https://docs.ansible.com/ansible/latest/playbook_guide/playbooks_conditionals.html conditionals]===

===[https://docs.ansible.com/ansible/latest/playbook_guide/playbooks_loops.html loops]===

===jinja2===
[https://docs.ansible.com/ansible/latest/playbook_guide/playbooks_templating.html Templating (Jinja2)]
==output==
===parsing json===
use community.general.json_query which uses
[https://jmespath.org/proposals/functions.html#join jmespath]

[https://docs.ansible.com/ansible/latest/collections/community/general/docsite/filter_guide_selecting_json_data.html Selecting JSON data: JSON queries]

===writing to files===
- name: output to file
lineinfile:
insertafter: EOF
dest: "out.txt"
line: "foo bar"

==modules and plugins==
[https://docs.ansible.com/ansible/latest/module_plugin_guide/index.html Using Ansible modules and plugins]

[https://thecloudops.org/difference-between-modules-and-plugins/ Difference between Modules and Plugins in Ansible]

===collections===
[https://docs.ansible.com/ansible/5/user_guide/collections_using.html Using collections]
Collections are a distribution format for Ansible content that can include playbooks, roles, modules, and plugins. As modules move from the core Ansible repository into collections, the module documentation will move to the collections pages.

==use cases==
===network/security automation===

[https://docs.ansible.com/ansible/latest/network/user_guide/platform_index.html#platform-options platform modules (Maintained by Ansible Network Team)]

====[https://galaxy.ansible.com/ui/namespaces/check_point/ checkpoint modules (gaia / mgmt)]====

====fortinet====
[https://galaxy.ansible.com/ui/namespaces/fortinet/ fortinet]

[https://docs.fortinet.com/document/fortisoar/7.4.2/playbooks-guide/767891/jinja-filters-and-functions Jinja Filters and Functions]

[https://galaxy.ansible.com/ui/namespaces/paloaltonetworks/ paloalto]
===cloud===
====kvm====
[https://docs.ansible.com/ansible/latest/collections/community/libvirt/virt_module.html KVM libvirt module]

[https://thenathan.net/2022/09/30/ansible-libvirt-dynamic-inventory/ Ansible libvirt dynamic inventory]

[https://access.redhat.com/documentation/en-us/red_hat_enterprise_linux/7/html/virtualization_deployment_and_administration_guide/sect-domain_commands-connecting_the_serial_console_for_the_guest_virtual_machine Connecting the Serial Console for the Guest Virtual Machine]

[[category:ansible]]

[https://www.uni-koeln.de/~pbogusze/posts/Ansible_export_facts_to_simple_csv_file.html Ansible export facts to simple csv file]

ansible notes

2025-04-16T21:53:44Z

Nighthawk: /* Adding variables to inventory */

[https://www.redhat.com/en/services/training/ex457-red-hat-certified-specialist-in-ansible-network-automation-exam?section=objectives https://www.redhat.com/en/services/training/ex457-red-hat-certified-specialist-in-ansible-network-automation-exam?section=objectives]

==installation==
pip install ansible

==variables==

A variable name can only include letters, numbers, and underscores. [https://docs.python.org/3/reference/lexical_analysis.html#keywords Python keywords] or [https://docs.ansible.com/ansible/latest/reference_appendices/playbooks_keywords.html#playbook-keywords playbook keywords] are not valid variable names. A variable name cannot begin with a number. Use use double curly braces to reference them. i.e.
<nowiki>
{{ foo }}
</nowiki>
===types===

Simple vars store a single value.

List variables store multiple.

referencing specific fields
region: "{{ region[0] }}"

Dictionary vars store data in key-value pairs

get var type

<nowiki>
{{ myvar | type_debug }}
</nowiki>

Combining list variables
ansible.builtin.set_fact:
merged_list: "{{ list1 + list2 }}"

Combining dictionary variables
ansible.builtin.set_fact:
merged_dict: "{{ dict1 | ansible.builtin.combine(dict2) }}"

merge variables that match the given prefixes, suffixes, or regular expressions, you can use the community.general.merge_variables lookup, for example:

merged_variable: "{{ lookup('community.general.merge_variables', '__my_pattern', pattern_type='suffix') }}"

===[https://docs.ansible.com/ansible/latest/inventory_guide/intro_inventory.html#variables-in-inventory Adding variables to inventory]===

Reference nested variables using either bracket notation or dot notation
<nowiki>
'{{ ansible_facts["eth0"]["ipv4"]["address"] }}'
or
{{ ansible_facts.eth0.ipv4.address }}
</nowiki>

===setting variables===
Variables can be set via files (like inventory), plays or command line at run time.

setfact
- name: set a var
set_fact:
somevar: "foo"

Registering variables with the task keyword register.

- name: Run a shell command and register its output as a variable
ansible.builtin.shell: /usr/bin/foo
register: foo_result

Defining variables at runtime

key=value syntax
values are interpreted as strings

ansible-playbook release.yml --extra-vars "version=1.23.45 other_variable=foo"

Use the JSON format if you need to pass non-string values such as Booleans, integers, floats, lists...

ansible-playbook release.yml --extra-vars '{"version":"1.23.45","other_variable":"foo"}'
ansible-playbook arcade.yml --extra-vars '{"pacman":"mrs","ghosts":["inky","pinky","clyde","sue"]}'

you must escape quotes and other special characters

ansible-playbook arcade.yml --extra-vars "{\"name\":\"Conan O\'Brien\"}"
ansible-playbook arcade.yml --extra-vars '{"name":"Conan O'\\\''Brien"}'
ansible-playbook script.yml --extra-vars "{\"dialog\":\"He said \\\"I just can\'t get enough of those single and double-quotes"\!"\\\"\"}"

==Connecting to hosts==

===[https://docs.ansible.com/ansible/latest/vault_guide/vault.html#vault Secure credentials with Ansible Vault]===

common commands

$ ansible-vault create <path to file>

$ ansible-vault edit <path to file>

$ ansible-vault rekey <path to file>

$ ansible-vault view <path to file>

default directories for encrypted vault files

group_vars

host_vars

use hostname/groupname from inventory file as name of the file

===connection plugins===

variable ansible_connection

listing connection types/plugins
$ '''ansible-doc -t connection -l'''
kubectl Execute tasks in pods running on Kubernetes
libvirt_lxc Run tasks in lxc containers via libvirt
chroot Interact with local chroot
psrp Run tasks over Microsoft PowerShell Remoting Protocol
network_cli Use network_cli to run command on network appliances
vmware_tools Execute tasks inside a VM via VMware Tools
ssh connect via ssh client binary
httpapi Use httpapi to run command on network appliances
docker Run tasks in docker containers
...

==playbooks==
===examples===
- name: My first play
hosts: myhosts
tasks:
- name: Print wall message
ansible.builtin.command: /usr/bin/wall hello

- name: output test
hosts: myhosts
tasks:
- name: run uname thru awk
ansible.builtin.shell: /usr/bin/uname -a | awk '{print $NF}'
register: results
- debug:
var: results.stdout

$ '''ansible-playbook -i inventory.ini shelltest.yaml'''
PLAY [output test] ********************************************************************************************************************************
 
TASK [run uname thru awk] *************************************************************************************************************************
changed: [10.0.0.15]
 
TASK [debug] **************************************************************************************************************************************
ok: [10.0.0.15] => {
"results.stdout": "GNU/Linux"
}
 
PLAY RECAP ****************************************************************************************************************************************
10.0.0.15 : ok=2 changed=1 unreachable=0 failed=0 skipped=0 rescued=0 ignored=0

==programming==

===[https://docs.ansible.com/ansible/latest/playbook_guide/playbooks_conditionals.html conditionals]===

===[https://docs.ansible.com/ansible/latest/playbook_guide/playbooks_loops.html loops]===

===jinja2===
[https://docs.ansible.com/ansible/latest/playbook_guide/playbooks_templating.html Templating (Jinja2)]
==output==
===parsing json===
use community.general.json_query which uses
[https://jmespath.org/proposals/functions.html#join jmespath]

[https://docs.ansible.com/ansible/latest/collections/community/general/docsite/filter_guide_selecting_json_data.html Selecting JSON data: JSON queries]

===writing to files===
- name: output to file
lineinfile:
insertafter: EOF
dest: "out.txt"
line: "foo bar"

==modules and plugins==
[https://docs.ansible.com/ansible/latest/module_plugin_guide/index.html Using Ansible modules and plugins]

[https://thecloudops.org/difference-between-modules-and-plugins/ Difference between Modules and Plugins in Ansible]

===collections===
[https://docs.ansible.com/ansible/5/user_guide/collections_using.html Using collections]
Collections are a distribution format for Ansible content that can include playbooks, roles, modules, and plugins. As modules move from the core Ansible repository into collections, the module documentation will move to the collections pages.

==use cases==
===network/security automation===

[https://docs.ansible.com/ansible/latest/network/user_guide/platform_index.html#platform-options platform modules (Maintained by Ansible Network Team)]

====[https://galaxy.ansible.com/ui/namespaces/check_point/ checkpoint modules (gaia / mgmt)]====

====fortinet====
[https://galaxy.ansible.com/ui/namespaces/fortinet/ fortinet]

[https://docs.fortinet.com/document/fortisoar/7.4.2/playbooks-guide/767891/jinja-filters-and-functions Jinja Filters and Functions]

[https://galaxy.ansible.com/ui/namespaces/paloaltonetworks/ paloalto]
===cloud===
====kvm====
[https://docs.ansible.com/ansible/latest/collections/community/libvirt/virt_module.html KVM libvirt module]

[https://thenathan.net/2022/09/30/ansible-libvirt-dynamic-inventory/ Ansible libvirt dynamic inventory]

[https://access.redhat.com/documentation/en-us/red_hat_enterprise_linux/7/html/virtualization_deployment_and_administration_guide/sect-domain_commands-connecting_the_serial_console_for_the_guest_virtual_machine Connecting the Serial Console for the Guest Virtual Machine]

[[category:ansible]]

[https://www.uni-koeln.de/~pbogusze/posts/Ansible_export_facts_to_simple_csv_file.html Ansible export facts to simple csv file]

ansible loop fail

2025-04-16T21:35:46Z

Nighthawk: /* Example Play */

Problem: loops were failing when trying to pass a variable with something like "foo,bar" in it. This is just a string with a comma in it.

ansible error: Invalid data passed to 'loop', it requires a list

Solution: enscapsulate with square brackets [ ] and quotes around individual elements.

example:

["foo","bar"]

== Example Play ==

<source lang="yaml">
- name: example play showing common loop/list error
hosts: localhost
gather_facts: false
tasks:
- name: set var1
set_fact:
var1: "foo,bar"

- name: set var2
set_fact:
var2: ["foo","bar"]

- name: output var1 type
debug:
msg: "{{ var1 | type_debug }}"

- name: output var2 type
debug:
msg: "{{ var2 | type_debug }}"

- name: try to loop var2
debug:
msg: "{{ item }}"
loop: "{{ var2 }}"

- name: try to loop var1
debug:
msg: "{{ item }}"
loop: "{{ var1 }}"
</source>

$ '''ansible-playbook example_list.yml'''
<source lang="yaml">
PLAY [localhost]
*******************************************************************************************************

TASK [set var1]
*******************************************************************************************************
ok: [localhost]

TASK [set var2]
********************************************************************************************************
ok: [localhost]

TASK [output var1 type]
************************************************************************************************
ok: [localhost] => {
"msg": "AnsibleUnicode"
}

TASK [output var2 type]
************************************************************************************************
ok: [localhost] => {
"msg": "list"
}

TASK [try to loop var2]
************************************************************************************************
ok: [localhost] => (item=foo) => {
"msg": "foo"
}
ok: [localhost] => (item=bar) => {
"msg": "bar"
}

TASK [try to loop var1]
************************************************************************************************
fatal: [localhost]: FAILED! => {"msg": "Invalid data passed to 'loop', it requires a list, got this
instead: foo,bar. Hint: If you passed a list/dict of just one element, try adding wantlist=True to your
lookup invocation or use q/query instead of lookup."}

PLAY RECAP
*************************************************************************************************************
localhost : ok=5 changed=0 unreachable=0 failed=1 skipped=0 rescued=0
ignored=0

</source>

2025-04-16T15:52:30Z

Nighthawk: /* types */

ansible notes

2025-04-16T15:52:18Z

Nighthawk: /* types */

ansible notes

2025-04-16T15:44:46Z

Nighthawk:

ansible notes

2025-04-16T14:57:24Z

Nighthawk: /* Secure credentials with Ansible Vault */

[https://www.redhat.com/en/services/training/ex457-red-hat-certified-specialist-in-ansible-network-automation-exam?section=objectives https://www.redhat.com/en/services/training/ex457-red-hat-certified-specialist-in-ansible-network-automation-exam?section=objectives]

==installation==
pip install ansible

==variables==
===types===
[https://docs.ansible.com/ansible/latest/collections/ansible/builtin/type_debug_filter.html ansible.builtin.type_debug filter – show input data type]
===[https://docs.ansible.com/ansible/latest/inventory_guide/intro_inventory.html#variables-in-inventory Adding variables to inventory]===

===set_fact===

- name: set a var
set_fact:
somevar: "foo"

==Connecting to hosts==

===[https://docs.ansible.com/ansible/latest/vault_guide/vault.html#vault Secure credentials with Ansible Vault]===

common commands

$ ansible-vault create <path to file>

$ ansible-vault edit <path to file>

$ ansible-vault rekey <path to file>

$ ansible-vault view <path to file>

default directories for encrypted vault files

group_vars

host_vars

use hostname/groupname from inventory file as name of the file

===connection plugins===

variable ansible_connection

listing connection types/plugins
$ '''ansible-doc -t connection -l'''
kubectl Execute tasks in pods running on Kubernetes
libvirt_lxc Run tasks in lxc containers via libvirt
chroot Interact with local chroot
psrp Run tasks over Microsoft PowerShell Remoting Protocol
network_cli Use network_cli to run command on network appliances
vmware_tools Execute tasks inside a VM via VMware Tools
ssh connect via ssh client binary
httpapi Use httpapi to run command on network appliances
docker Run tasks in docker containers
...

==playbooks==
===examples===
- name: My first play
hosts: myhosts
tasks:
- name: Print wall message
ansible.builtin.command: /usr/bin/wall hello

- name: output test
hosts: myhosts
tasks:
- name: run uname thru awk
ansible.builtin.shell: /usr/bin/uname -a | awk '{print $NF}'
register: results
- debug:
var: results.stdout

$ '''ansible-playbook -i inventory.ini shelltest.yaml'''
PLAY [output test] ********************************************************************************************************************************
 
TASK [run uname thru awk] *************************************************************************************************************************
changed: [10.0.0.15]
 
TASK [debug] **************************************************************************************************************************************
ok: [10.0.0.15] => {
"results.stdout": "GNU/Linux"
}
 
PLAY RECAP ****************************************************************************************************************************************
10.0.0.15 : ok=2 changed=1 unreachable=0 failed=0 skipped=0 rescued=0 ignored=0

==programming==

===[https://docs.ansible.com/ansible/latest/playbook_guide/playbooks_conditionals.html conditionals]===

===[https://docs.ansible.com/ansible/latest/playbook_guide/playbooks_loops.html loops]===

===jinja2===
[https://docs.ansible.com/ansible/latest/playbook_guide/playbooks_templating.html Templating (Jinja2)]
==output==
===parsing json===
use community.general.json_query which uses
[https://jmespath.org/proposals/functions.html#join jmespath]

[https://docs.ansible.com/ansible/latest/collections/community/general/docsite/filter_guide_selecting_json_data.html Selecting JSON data: JSON queries]

===writing to files===
- name: output to file
lineinfile:
insertafter: EOF
dest: "out.txt"
line: "foo bar"

==modules and plugins==
[https://docs.ansible.com/ansible/latest/module_plugin_guide/index.html Using Ansible modules and plugins]

[https://thecloudops.org/difference-between-modules-and-plugins/ Difference between Modules and Plugins in Ansible]

===collections===
[https://docs.ansible.com/ansible/5/user_guide/collections_using.html Using collections]
Collections are a distribution format for Ansible content that can include playbooks, roles, modules, and plugins. As modules move from the core Ansible repository into collections, the module documentation will move to the collections pages.

==use cases==
===network/security automation===

[https://docs.ansible.com/ansible/latest/network/user_guide/platform_index.html#platform-options platform modules (Maintained by Ansible Network Team)]

====[https://galaxy.ansible.com/ui/namespaces/check_point/ checkpoint modules (gaia / mgmt)]====

====fortinet====
[https://galaxy.ansible.com/ui/namespaces/fortinet/ fortinet]

[https://docs.fortinet.com/document/fortisoar/7.4.2/playbooks-guide/767891/jinja-filters-and-functions Jinja Filters and Functions]

[https://galaxy.ansible.com/ui/namespaces/paloaltonetworks/ paloalto]
===cloud===
====kvm====
[https://docs.ansible.com/ansible/latest/collections/community/libvirt/virt_module.html KVM libvirt module]

[https://thenathan.net/2022/09/30/ansible-libvirt-dynamic-inventory/ Ansible libvirt dynamic inventory]

[https://access.redhat.com/documentation/en-us/red_hat_enterprise_linux/7/html/virtualization_deployment_and_administration_guide/sect-domain_commands-connecting_the_serial_console_for_the_guest_virtual_machine Connecting the Serial Console for the Guest Virtual Machine]

[[category:ansible]]

[https://www.uni-koeln.de/~pbogusze/posts/Ansible_export_facts_to_simple_csv_file.html Ansible export facts to simple csv file]

ansible notes

2025-04-16T14:56:16Z

Nighthawk: /* Secure credentials with Ansible Vault */