Scribd
Upload
243 views2 pages

Ansible Commands & YAML Guide

Ansible provides simple but powerful automation for cross-platform computer support through YAML playbooks that can be executed locally or remotely. The Ansible cheat sheet outlines commands for running playbooks, authentication options, control options, playbook structure including tasks that import modules with parameters, and the YAML syntax used.

Uploaded by

carlespla
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
243 views2 pages

Ansible Commands & YAML Guide

Ansible provides simple but powerful automation for cross-platform computer support through YAML playbooks that can be executed locally or remotely. The Ansible cheat sheet outlines commands for running playbooks, authentication options, control options, playbook structure including tasks that import modules with parameters, and the YAML syntax used.

Uploaded by

carlespla
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
You are on page 1/ 2

Ansible Cheat Sheet By Seth Kenlon

Ansible provides simple but powerful automation for cross-platform computer support. Ansible
playbooks are written in YAML, and executed either locally or remotely.

Command
ansible-playbook [Link] Run an Ansible playbook called [Link]
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
--become Escalate privileges
--ask-become-pass Prompt for a password for become
--become-method Escalate privilege using a specific method
ansible-doc –-type foo --list List choices for become, connection, and
other Ansible options

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

[Link] Twitter @opensourceway • [Link]/@osdc CC BY-SA 4.0


Ansible Cheat Sheet By Seth Kenlon

Playbook and YAML


Parameter: value A YAML mapping entry is a key and a value
- foo A YAML sequence entry is an itemized list
- bar
- baz
Distro: A mapping entry can contain a sequence
- Fedora
- RHEL
- Debian
- Slackware
OS: Sequence items can contain mappings
- Linux: Fedora
- BSD: NetBSD
Playbook structure
--- YAML files start with three dashes
- name: “My play” Use the name mapping to name your play
hosts: all Indent, and define which hosts the play runs on. List target
hosts in etc/ansible/hosts
tasks: Open a tasks mapping, which will contain a sequence
- name: “My task” Give the task a name with the name mapping
some_module: Import a module as a new mapping containing a
sequence of parameters. Find required and optional
parameters in the module’s documentation.
path: ‘/example/’ Parameters are usually mappings using the command
option as the key and an argument as the value.
- name: “My other task” A play may contain more than one task
other_module: A task usually imports a module
foo: ‘bar’

[Link] Twitter @opensourceway • [Link]/@osdc CC BY-SA 4.0

You might also like