man pages section 1: User Commands

ansible (1)

Name

ansible - run a task on target host(s)

Synopsis

ansible host-pattern [-m module_name] [-a args] [options]

ansible --help

Description

ansible(1)                       User Commands                      ansible(1)



NAME
       ansible - run a task on target host(s)

SYNOPSIS
       ansible host-pattern [-m module_name] [-a args] [options]

       ansible --help

DESCRIPTION
       Ansible is a simple tool/framework/API for performing tasks over SSH.


       See 'ansible --help'  for help on argument, options and usage.

OPERAND
       host-pattern

           The  name  of  a  group  in  the  inventory file, a shell-like glob
           selecting hosts in an inventory file, or any combination of the two
           separated by semicolons.

       Inventory

       Ansible stores the hosts it can potentially operate on in an inventory.
       This can be an ini-like file, a script, directory or a  list.  The  ini
       syntax  is  one  host  per  line.  Groups  headers  are allowed and are
       included on their own line, enclosed in square brackets that start  the
       line.

       Ranges of hosts are also supported. For more information and additional
       options, see the documentation on http://docs.ansible.com.

FILES
       /etc/ansible/hosts

           Default inventory file.

       /usr/share/ansible/

           Default module library.

       /etc/ansible/ansible.cfg

           Config file, used if present.

       ~/.ansible.cfg

           User config file. Overrides the default config if present.

ENVIRONMENT VARIABLES
       The following environment variables can be specified:

       ANSIBLE_INVENTORY

           Override the default ansible inventory sources.

       ANSIBLE_LIBRARY

           Override the default ansible module library path.

       ANSIBLE_CONFIG

           Override the default ansible config file.

AUTHOR
       Ansible was originally written by Michael DeHaan. See the AUTHORS  file
       in the source code for a complete list of contributors.



ATTRIBUTES
       See attributes(7) for descriptions of the following attributes:


       +---------------+---------------------------+
       |ATTRIBUTE TYPE |     ATTRIBUTE VALUE       |
       +---------------+---------------------------+
       |Availability   | system/management/ansible |
       +---------------+---------------------------+
       |Stability      | Pass-through volatile     |
       +---------------+---------------------------+

NOTES
       For   other   Ansible   Command   Line  tools,  see  https://docs.ansi-
       ble.com/ansible/latest/user_guide/command_line_tools.html


       Source code for open source software components in Oracle  Solaris  can
       be found at https://www.oracle.com/downloads/opensource/solaris-source-
       code-downloads.html.

       This    software    was    built    from    source     available     at
       https://github.com/oracle/solaris-userland.    The  original  community
       source  was  downloaded  from    https://github.com/ansible/ansible/ar-
       chive/stable-2.10.tar.gz.

       Further information about this software can be found on the open source
       community website at https://github.com/ansible/ansible.



2.10                              22 Oct 2021                       ansible(1)