{"id":103,"date":"2022-03-28T22:01:08","date_gmt":"2022-03-29T02:01:08","guid":{"rendered":"http:\/\/triosdevelopers.com\/J.Smith\/rjeffsmith.ca\/wordpress\/?p=103"},"modified":"2024-10-11T09:35:07","modified_gmt":"2024-10-11T13:35:07","slug":"ansible-cheat-sheet","status":"publish","type":"post","link":"https:\/\/triosdevelopers.com\/J.Smith\/rjeffsmith.ca\/wordpress\/?p=103","title":{"rendered":"ansible cheat sheet"},"content":{"rendered":"\n

Command<\/strong><\/td><\/tr>
ansible-playbook file.yaml<\/td>Run an Ansible playbook called file.yaml<\/td><\/tr>

Authentication options<\/strong><\/td><\/tr>
–user, -u <username><\/td>Log in as username<\/td><\/tr>
–private-key, –key-file <key><\/td>Log in using SSH key (usually in ~\/.ssh)<\/td><\/tr>
–ssh-extra-args<\/td>Pass extra command options to SSH<\/td><\/tr>
–vault-id <id><\/td>Use vault identity ID<\/td><\/tr>
–vault-password-file <key><\/td>Use vault password file key<\/td><\/tr>
–ask-vault-pass<\/td>Prompt for a vault password<\/td><\/tr>
–become<\/td>Escalate privileges<\/td><\/tr>
–ask-become-pass<\/td>Prompt for a password for become<\/td><\/tr>
–become-method<\/td>Escalate privilege using a specific method<\/td><\/tr>
ansible-doc \u2013-type foo –list<\/td>List choices for become, connection, and other Ansible options<\/td><\/tr>

Control options<\/strong><\/td><\/tr>
–syntax-check<\/td>Verify syntax of a playbook, but do not run it<\/td><\/tr>
–list-hosts<\/td>Show hosts listed in a playbook<\/td><\/tr>
–list-tasks<\/td>Show tasks defined in a playbook<\/td><\/tr>
–start-at-task <task_name><\/td>Run playbook starting at task name<\/td><\/tr>
–check<\/td>Run the playbook but don\u2019t make changes<\/td><\/tr>
–diff<\/td>Show diffs for what changes are made<\/td><\/tr>
–module-path<\/td>Prepend colon-separated path to default path<\/td><\/tr>
–connection <method><\/td>Connect over method<\/td><\/tr>

Playbook and YAML<\/strong><\/td><\/tr>
Parameter: value<\/td>A YAML mapping entry is a key and a value<\/td><\/tr>
– foo<\/td>A YAML sequence entry is an itemized list<\/td><\/tr>
– bar<\/td>
<\/td><\/tr>
– baz<\/td>
<\/td><\/tr>
Distro:<\/td>A mapping entry can contain a sequence<\/td><\/tr>
– Fedora<\/td>
<\/td><\/tr>
– RHEL<\/td>
<\/td><\/tr>
– Debian<\/td>
<\/td><\/tr>
– Slackware<\/td>
<\/td><\/tr>
OS:<\/td>Sequence items can contain mappings<\/td><\/tr>
– Linux: Fedora<\/td>
<\/td><\/tr>
– BSD: NetBSD<\/td>
<\/td><\/tr>

Playbook structure<\/strong><\/td><\/tr>
—<\/td>YAML files start with three dashes<\/td><\/tr>
– name: \u201cMy play\u201d<\/td>Use the name mapping to name your play<\/td><\/tr>
hosts: all<\/td>Indent, and define which hosts the play runs on. List target hosts in etc\/ansible\/hosts<\/td><\/tr>
tasks:<\/td>Open a tasks mapping, which will contain a sequence<\/td><\/tr>
– name:<\/td>\u201cMy task\u201d Give the task a name with the name mapping<\/td><\/tr>
some_module:<\/td>Import a module as a new mapping containing a sequence of parameters. Find required and optional parameters in the module\u2019s documentation.<\/td><\/tr>
path: \u2018\/example\/\u2019<\/td>Parameters are usually mappings using the command option as the key and an argument as the value.<\/td><\/tr>
– name: \u201cMy other task\u201d<\/td>A play may contain more than one task<\/td><\/tr>
other_module:<\/td>A task usually imports a module<\/td><\/tr>
foo: \u2018bar\u2019<\/td>
<\/td><\/tr><\/tbody><\/table><\/figure>\n","protected":false},"excerpt":{"rendered":"

Command ansible-playbook file.yaml Run an Ansible playbook called file.yaml Authentication options –user, -u <username> Log in as username –private-key, –key-file <key> Log in using SSH key (usually in ~\/.ssh) –ssh-extra-args Pass extra command options to SSH –vault-id <id> Use vault identity ID –vault-password-file <key> Use vault password file key –ask-vault-pass Prompt for a vault password […]<\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[17],"tags":[],"class_list":["post-103","post","type-post","status-publish","format-standard","hentry","category-ansible"],"_links":{"self":[{"href":"https:\/\/triosdevelopers.com\/J.Smith\/rjeffsmith.ca\/wordpress\/index.php?rest_route=\/wp\/v2\/posts\/103","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/triosdevelopers.com\/J.Smith\/rjeffsmith.ca\/wordpress\/index.php?rest_route=\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/triosdevelopers.com\/J.Smith\/rjeffsmith.ca\/wordpress\/index.php?rest_route=\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/triosdevelopers.com\/J.Smith\/rjeffsmith.ca\/wordpress\/index.php?rest_route=\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/triosdevelopers.com\/J.Smith\/rjeffsmith.ca\/wordpress\/index.php?rest_route=%2Fwp%2Fv2%2Fcomments&post=103"}],"version-history":[{"count":1,"href":"https:\/\/triosdevelopers.com\/J.Smith\/rjeffsmith.ca\/wordpress\/index.php?rest_route=\/wp\/v2\/posts\/103\/revisions"}],"predecessor-version":[{"id":104,"href":"https:\/\/triosdevelopers.com\/J.Smith\/rjeffsmith.ca\/wordpress\/index.php?rest_route=\/wp\/v2\/posts\/103\/revisions\/104"}],"wp:attachment":[{"href":"https:\/\/triosdevelopers.com\/J.Smith\/rjeffsmith.ca\/wordpress\/index.php?rest_route=%2Fwp%2Fv2%2Fmedia&parent=103"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/triosdevelopers.com\/J.Smith\/rjeffsmith.ca\/wordpress\/index.php?rest_route=%2Fwp%2Fv2%2Fcategories&post=103"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/triosdevelopers.com\/J.Smith\/rjeffsmith.ca\/wordpress\/index.php?rest_route=%2Fwp%2Fv2%2Ftags&post=103"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}