CINXE.COM
Ansible Documentation
<!DOCTYPE html> <html lang="en"> <head> <meta charset="utf-8" /> <meta name="viewport" content="width=device-width, initial-scale=1.0" /> <title>Ansible Documentation</title> <meta name="description" content="Ansible Documentation" /> <meta name="author" content="Ansible Community" /> <link rel="canonical" href="https://docs.ansible.com/"/> <link rel="stylesheet" href="https://static.redhat.com/libs/redhat/redhat-font/2.0.0/webfonts/red-hat-font.css"/> <link rel="stylesheet" href="https://use.fontawesome.com/releases/v5.1.0/css/all.css" integrity="sha384-lKuwvrZot6UHsBSfcMvOkWwlCMgc0TaWr+30HWe3a4ltaBwTZhyTEggF5tJv8tbt" crossorigin="anonymous"/> <link rel="stylesheet" href="https://docs.ansible.com/static/css/styles.min.css"/> <link rel="stylesheet" href="https://docs.ansible.com/static/css/main.css"> <link rel="stylesheet" href="https://docs.ansible.com/static/css/redhat-footer.css"> </head> <body> <nav class="navbar navbar-expand-md p-1"> <div class="container"> <a href="https://docs.ansible.com/"> <span class="navbar-brand d-flex justify-content-center"> <svg version="1.1" id="Layer_1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" x="0px" y="0px" width="28" height="28" viewBox="0 0 28 28" style="enable-background: new 0 0 28 28" xml:space="preserve" class="mr-1"> <style type="text/css"> .ansHeader { fill: #ffffff; } </style> <circle class="ansHeader" cx="14" cy="14" r="13.5" /> <path d="M20.4,19.3L15,6.4c-0.2-0.4-0.5-0.6-0.8-0.6c-0.4,0-0.7,0.2-0.9,0.6L7.5,20.6h2l2.3-5.8l7,5.6c0.3,0.2,0.5,0.3,0.7,0.3c0.5,0,1-0.4,1-1C20.5,19.6,20.4,19.5,20.4,19.3z M14.2,8.7l3.5,8.6l-5.3-4.1L14.2,8.7z"/> </svg> Ansible documentation </span> </a> <button class="navbar-toggler collapsed" type="button" data-toggle="collapse" data-target="#main-menu" aria-controls="main-menu" aria-expanded="false" aria-label="Toggle navigation"> <span class="sr-only">Toggle navigation</span> <span class="icon-bar top"></span> <span class="icon-bar center"></span> <span class="icon-bar bottom"></span> </button> <div class="collapse navbar-collapse" id="main-menu"> <ul class="navbar-nav ml-auto"> <li class="nav-item"> <a class="nav-link" href="https://www.ansible.com/products/automation-platform">Products</a> </li> <li class="nav-item"> <a class="nav-link" href="https://www.ansible.com/blog">Blog</a> </li> <li class="nav-item"> <a class="nav-link" href="https://www.ansible.com/community">Community</a> </li> <li class="nav-item"> <a class="nav-link" href="https://www.ansible.com/resources/webinars-training">Webinars and training</a> </li> <li class="nav-item"> <a class="nav-link" href="https://www.redhat.com/en/technologies/management/ansible/try-it">Try it now</a> </li> </ul> </div> </div> </nav> <nav class="navbar navbar-expand-md p-1 docbar"> <div class="container"> <button class="navbar-toggler collapsed" type="button" data-toggle="collapse" data-target="#sub-menu" aria-controls="sub-menu" aria-expanded="false" aria-label="Toggle navigation"> <span class="sr-only">Toggle navigation</span> <span class="icon-bar top"></span> <span class="icon-bar center"></span> <span class="icon-bar bottom"></span> </button> <div class="collapse navbar-collapse" id="sub-menu"> <ul class="navbar-nav mx-auto p-0"> <li class="nav-item"> <a class="nav-link" href="https://docs.ansible.com/community.html">Join the community</a> </li> <li class="nav-item"> <a class="nav-link" href="https://docs.ansible.com/users.html">Users</a> </li> <li class="nav-item"> <a class="nav-link" href="https://docs.ansible.com/developers.html">Developers</a> </li> <li class="nav-item"> <a class="nav-link" href="https://docs.ansible.com/maintainers.html">Maintainers</a> </li> <li class="nav-item"> <a class="nav-link" href="https://docs.ansible.com/core.html">Ansible core</a> </li> <li class="nav-item"> <a class="nav-link" href="https://docs.ansible.com/ecosystem.html">Ansible ecosystem</a> </li> <li class="nav-item"> <a class="nav-link" href="https://docs.ansible.com/platform.html">Red Hat Ansible Automation Platform</a> </li> </ul> </div> </div> </nav> <!-- <div class="container"> <div class="grid-wrapper"> <div class="width-12-12 width-12-12-m"> <div class="ansible-banner"> <div class="ansible-banner-text"> <p> We want to hear from you! Help us gain insights into the state of the Ansible ecosystem.<br> <a href="https://www.surveymonkey.com/r/P9Q2SNG" target="_blank">Take the Ansible Project Survey 2024</a> </p> </div> </div> </div> </div> </div> --> <div class="container"> <div class="full-width-bg component"> <div class="grid-wrapper"> <div class="width-9-12 width-12-12-m"> <div class="page-title"> <h2>Ansible community documentation</h2> <p>Ansible offers open-source automation that is simple, flexible, and powerful.</p> <p class="feedback"><i class="fas fa-comments"></i> Got thoughts or feedback on this site? We want to hear from you! <br /> Join us in the <a href="https://forum.ansible.com/tag/documentation">Ansible Forum</a> or open a <a href="https://github.com/ansible/docsite/issues" target="_blank">GitHub issue</a> in the docsite repository.</p> </div> </div> <!-- Start quicklinks --> <div class="width-3-12 width-12-12-m"> <div class="quicklinks"> <h2>Quicklinks</h2> <ul class="fa-ul"> <li> <span class="fa-li"><i class="fas fa-book"></i></span> <a href="https://docs.ansible.com/ansible/latest/index.html" target="_blank">Ansible package docs home</a> </li> <li> <span class="fa-li"><i class="fas fa-book"></i></span> <a href="https://docs.ansible.com/ansible/latest/collections/index.html" target="_blank">Collection index</a> </li> <li> <span class="fa-li"><i class="fas fa-book"></i></span> <a href="https://docs.ansible.com/ansible/latest/collections/all_plugins.html" target="_blank">Modules and plugins index</a> </li> </ul> <hr /> </div> </div> <!-- End quicklinks --> <!-- Start novice / getting started section --> <div class="width-6-12 width-12-12-m"> <h4>Get started with Ansible <i class="fas fa-rocket"></i></h4> <div class="btn-group-vertical" role="group" aria-label="Button group that links to Ansible community documentation."> <a class="btn" href="https://docs.ansible.com/ansible/latest/index.html" role="button">Understand the fundamentals of Ansible automation</a> <a class="btn" href="https://docs.ansible.com/ansible/latest/installation_guide/intro_installation.html#installing-and-upgrading-ansible" role="button">Install the Ansible package</a> <a class="btn" href="https://docs.ansible.com/ansible/latest/getting_started/index.html" role="button">Run your first ad hoc command in a few easy steps</a> </div> </div> <!-- End novice / getting started section --> <!-- Start Ansible users section --> <div class="width-6-12 width-12-12-m"> <h4>Users <i class="fas fa-cogs"></i></h4> <div class="btn-group-vertical" role="group" aria-label="Button group that links to Ansible community documentation."> <a class="btn" href="https://docs.ansible.com/ansible/latest/playbook_guide/playbooks_intro.html#playbook-syntax" role="button">Start writing Ansible playbooks</a> <a class="btn" href="https://docs.ansible.com/ansible/latest/module_plugin_guide/modules_intro.html" role="button">Learn about Ansible modules</a> <a class="btn" href="https://docs.ansible.com/ansible/latest/inventory_guide/intro_inventory.html" role="button">Build inventory files to manage multiple hosts</a> </div> <p> <a class="btn" href="https://docs.ansible.com/users.html" role="button"><i class="fas fa-angle-double-right"></i> Continue the Ansible user journey</a> </p> </div> <!-- End Ansible users section --> <!-- Start Ansible developers section --> <div class="width-6-12 width-12-12-m"> <h4>Developers <i class="fas fa-code"></i></h4> <div class="btn-group-vertical" role="group" aria-label="Button group that links to Ansible community documentation."> <a class="btn" href="https://docs.ansible.com/ansible/latest/dev_guide/developing_modules_general.html#environment-setup" role="button">Set up your development environment</a> <a class="btn" href="https://docs.ansible.com/ansible/latest/dev_guide/overview_architecture.html" role="button">Learn how Ansible works</a> <a class="btn" href="https://docs.ansible.com/ansible/latest/dev_guide/developing_locally.html" role="button">Write custom modules or plugins</a> </div> <p> <a class="btn" href="https://docs.ansible.com/developers.html" role="button"><i class="fas fa-angle-double-right"></i> Continue the Ansible developer journey</a> </p> </div> <!-- End Ansible developers section --> <!-- Start Ansible community maintainers section --> <div class="width-6-12 width-12-12-m"> <h4>Maintainers <i class="fas fa-project-diagram"></i></h4> <div class="btn-group-vertical" role="group" aria-label="Button group that links to Ansible community documentation."> <a class="btn" href="https://docs.ansible.com/ansible/latest/community/maintainers_guidelines.html" role="button">Review community maintainer responsibilities</a> <a class="btn" href="https://docs.ansible.com/ansible/latest/community/contributor_path.html" role="button">Understand Ansible contributor paths</a> <a class="btn" href="https://docs.ansible.com/ansible/latest/community/maintainers_guidelines.html#expanding-the-collection-community" role="button">Explore ways to grow community</a> </div> <p> <a class="btn" href="https://docs.ansible.com/maintainers.html" role="button"><i class="fas fa-angle-double-right"></i> Continue the Ansible community maintainer journey</a> </p> </div> <!-- End Ansible community maintainers section --> </div> </div> </div> <div class="content-slim redhat-footer"> <span class="licence"> <i class="fab fa-creative-commons"></i><i class="fab fa-creative-commons-by"></i> <a href="https://creativecommons.org/licenses/by-sa/4.0/" target="_blank">CC BY-SA 4.0 |</a> <a href="https://www.redhat.com/en/about/privacy-policy">Privacy policy |</a> </span> <span class="redhat"> Sponsored by </span> <span class="redhat-logo"> <a href="https://www.redhat.com/" target="_blank"><img src="https://docs.ansible.com/static/images/redhat_reversed.svg" alt="Red Hat logo"></a> </span> </div> <script src="https://docs.ansible.com/static/js/iframeResizer.min.js" type="javascript"></script> <script src="https://code.jquery.com/jquery-3.2.1.slim.min.js" crossorigin="anonymous"></script> <script src="https://cdn.jsdelivr.net/npm/bootstrap@4.6.1/dist/js/bootstrap.bundle.min.js"></script> <script src="https://www.redhat.com/dtm.js"></script> </body> </html>