ansible/docs/docsite/rst/user_guide/intro_getting_started.rst

Getting Started

Now that you have read the installation guide<installation_guide> and installed Ansible on a control node, you are ready to learn how Ansible works. A basic Ansible command or playbook:

• selects machines to execute against from inventory
• connects to those machines (or network devices, or other managed nodes), usually over SSH
• copies one or more modules to the remote machines and starts execution there

Ansible can do much more, but you should understand the most common use case before exploring all the powerful configuration, deployment, and orchestration features of Ansible. This page illustrates the basic process with a simple inventory and an ad-hoc command. Once you understand how Ansible works, you can read more details about ad-hoc commands<intro_adhoc>, organize your infrastructure with inventory<intro_inventory>, and harness the full power of Ansible with playbooks<playbooks_intro>.

Selecting machines from inventory

Ansible reads information about which machines you want to manage from your inventory. Although you can pass an IP address to an ad-hoc command, you need inventory to take advantage of the full flexibility and repeatability of Ansible.

Action: create a basic inventory

For this basic inventory, edit (or create) /etc/ansible/hosts and add a few remote systems to it. For this example, use either IP addresses or FQDNs:

192.0.2.50
aserver.example.org
bserver.example.org

Beyond the basics

Your inventory can store much more than IPs and FQDNs. You can create aliases<inventory_aliases>, set variable values for a single host with host vars<host_variables>, or set variable values for multiple hosts with group vars<group_variables>.

Connecting to remote nodes

Ansible communicates with remote machines over the SSH protocol. By default, Ansible uses native OpenSSH and connects to remote machines using your current user name, just as SSH does.

Action: check your SSH connections

Confirm that you can connect using SSH to all the nodes in your inventory using the same username. If necessary, add your public SSH key to the authorized_keys file on those systems.

Beyond the basics

You can override the default remote user name in several ways, including:

• passing the -u parameter at the command line
• setting user information in your inventory file
• setting user information in your configuration file
• setting environment variables

See general_precedence_rules for details on the (sometimes unintuitive) precedence of each method of passing user information. You can read more about connections in connections.

Copying and executing modules

Once it has connected, Ansible transfers the modules required by your command or playbook to the remote machine(s) for execution.

Action: run your first Ansible commands

Use the ping module to ping all the nodes in your inventory:

$ ansible all -m ping

Now run a live command on all of your nodes:

$ ansible all -a "/bin/echo hello"

You should see output for each host in your inventory, similar to this:

aserver.example.org | SUCCESS => {
    "ansible_facts": {
        "discovered_interpreter_python": "/usr/bin/python"
    },
    "changed": false,
    "ping": "pong"
}

Beyond the basics

By default Ansible uses SFTP to transfer files. If the machine or device you want to manage does not support SFTP, you can switch to SCP mode in intro_configuration. The files are placed in a temporary directory and executed from there.

If you need privilege escalation (sudo and similar) to run a command, pass the become flags:

# as bruce
$ ansible all -m ping -u bruce
# as bruce, sudoing to root (sudo is default method)
$ ansible all -m ping -u bruce --become
# as bruce, sudoing to batman
$ ansible all -m ping -u bruce --become --become-user batman

You can read more about privilege escalation in become.

Congratulations! You have contacted your nodes using Ansible. You used a basic inventory file and an ad-hoc command to direct Ansible to connect to specific remote nodes, copy a module file there and execute it, and return output. You have a fully working infrastructure.

Next steps

Next you can read about more real-world cases in intro_adhoc, explore what you can do with different modules, or read about the Ansible working_with_playbooks language. Ansible is not just about running commands, it also has powerful configuration management and deployment features.

intro_inventory

More information about inventory

intro_adhoc

Examples of basic commands

working_with_playbooks

Learning Ansible's configuration management language

Mailing List

Questions? Help? Ideas? Stop by the list on Google Groups

irc.freenode.net

#ansible IRC chat channel