├── .gitignore ├── CONTRIBUTING.md ├── README.md ├── autoload ├── actions.vim ├── argvals.vim ├── optargs.vim ├── reqargs.vim ├── rocannon.vim ├── states.vim └── vars.vim ├── bin ├── actions.txt ├── ans2txt.zsh ├── args.txt ├── sitedocs2txt.zsh ├── txt2actions.vim ├── txt2optargs.vim ├── txt2reqargs.vim └── txt2syn.vim ├── colors └── rocannon.vim ├── dict └── anskeywords.txt ├── doc ├── mod.txt │ ├── a10_server.txt │ ├── a10_service_group.txt │ ├── a10_virtual_server.txt │ ├── accelerate.txt │ ├── acl.txt │ ├── add_host.txt │ ├── airbrake_deployment.txt │ ├── alternatives.txt │ ├── apache2_module.txt │ ├── apt.txt │ ├── apt_key.txt │ ├── apt_repository.txt │ ├── apt_rpm.txt │ ├── assemble.txt │ ├── assert.txt │ ├── async_status.txt │ ├── at.txt │ ├── authorized_key.txt │ ├── azure.txt │ ├── bigip_facts.txt │ ├── bigip_monitor_http.txt │ ├── bigip_monitor_tcp.txt │ ├── bigip_node.txt │ ├── bigip_pool.txt │ ├── bigip_pool_member.txt │ ├── bigpanda.txt │ ├── boundary_meter.txt │ ├── bower.txt │ ├── bzr.txt │ ├── campfire.txt │ ├── capabilities.txt │ ├── cloudformation.txt │ ├── command.txt │ ├── composer.txt │ ├── copy.txt │ ├── cpanm.txt │ ├── cron.txt │ ├── crypttab.txt │ ├── datadog_event.txt │ ├── debconf.txt │ ├── debug.txt │ ├── digital_ocean.txt │ ├── digital_ocean_domain.txt │ ├── digital_ocean_sshkey.txt │ ├── django_manage.txt │ ├── dnf.txt │ ├── dnsimple.txt │ ├── dnsmadeeasy.txt │ ├── docker.txt │ ├── docker_image.txt │ ├── easy_install.txt │ ├── ec2.txt │ ├── ec2_ami.txt │ ├── ec2_ami_search.txt │ ├── ec2_asg.txt │ ├── ec2_eip.txt │ ├── ec2_elb.txt │ ├── ec2_elb_lb.txt │ ├── ec2_facts.txt │ ├── ec2_group.txt │ ├── ec2_key.txt │ ├── ec2_lc.txt │ ├── ec2_metric_alarm.txt │ ├── ec2_scaling_policy.txt │ ├── ec2_snapshot.txt │ ├── ec2_tag.txt │ ├── ec2_vol.txt │ ├── ec2_vpc.txt │ ├── ejabberd_user.txt │ ├── elasticache.txt │ ├── facter.txt │ ├── fail.txt │ ├── fetch.txt │ ├── file.txt │ ├── filesystem.txt │ ├── fireball.txt │ ├── firewalld.txt │ ├── flowdock.txt │ ├── gc_storage.txt │ ├── gce.txt │ ├── gce_lb.txt │ ├── gce_net.txt │ ├── gce_pd.txt │ ├── gem.txt │ ├── get_url.txt │ ├── getent.txt │ ├── git.txt │ ├── github_hooks.txt │ ├── glance_image.txt │ ├── gluster_volume.txt │ ├── group.txt │ ├── group_by.txt │ ├── grove.txt │ ├── haproxy.txt │ ├── hg.txt │ ├── hipchat.txt │ ├── homebrew.txt │ ├── homebrew_cask.txt │ ├── homebrew_tap.txt │ ├── hostname.txt │ ├── htpasswd.txt │ ├── include_vars.txt │ ├── ini_file.txt │ ├── irc.txt │ ├── jabber.txt │ ├── jboss.txt │ ├── jira.txt │ ├── kernel_blacklist.txt │ ├── keystone_user.txt │ ├── layman.txt │ ├── librato_annotation.txt │ ├── lineinfile.txt │ ├── linode.txt │ ├── lldp.txt │ ├── locale_gen.txt │ ├── logentries.txt │ ├── lvg.txt │ ├── lvol.txt │ ├── macports.txt │ ├── mail.txt │ ├── modprobe.txt │ ├── mongodb_user.txt │ ├── monit.txt │ ├── mount.txt │ ├── mqtt.txt │ ├── mysql_db.txt │ ├── mysql_replication.txt │ ├── mysql_user.txt │ ├── mysql_variables.txt │ ├── nagios.txt │ ├── netscaler.txt │ ├── newrelic_deployment.txt │ ├── nexmo.txt │ ├── nova_compute.txt │ ├── nova_keypair.txt │ ├── npm.txt │ ├── ohai.txt │ ├── open_iscsi.txt │ ├── openbsd_pkg.txt │ ├── openvswitch_bridge.txt │ ├── openvswitch_port.txt │ ├── opkg.txt │ ├── osx_say.txt │ ├── ovirt.txt │ ├── pacman.txt │ ├── pagerduty.txt │ ├── pause.txt │ ├── ping.txt │ ├── pingdom.txt │ ├── pip.txt │ ├── pkgin.txt │ ├── pkgng.txt │ ├── pkgutil.txt │ ├── portage.txt │ ├── portinstall.txt │ ├── postgresql_db.txt │ ├── postgresql_privs.txt │ ├── postgresql_user.txt │ ├── quantum_floating_ip.txt │ ├── quantum_floating_ip_associate.txt │ ├── quantum_network.txt │ ├── quantum_router.txt │ ├── quantum_router_gateway.txt │ ├── quantum_router_interface.txt │ ├── quantum_subnet.txt │ ├── rabbitmq_parameter.txt │ ├── rabbitmq_plugin.txt │ ├── rabbitmq_policy.txt │ ├── rabbitmq_user.txt │ ├── rabbitmq_vhost.txt │ ├── raw.txt │ ├── rax.txt │ ├── rax_cbs.txt │ ├── rax_cbs_attachments.txt │ ├── rax_cdb.txt │ ├── rax_cdb_database.txt │ ├── rax_cdb_user.txt │ ├── rax_clb.txt │ ├── rax_clb_nodes.txt │ ├── rax_dns.txt │ ├── rax_dns_record.txt │ ├── rax_facts.txt │ ├── rax_files.txt │ ├── rax_files_objects.txt │ ├── rax_identity.txt │ ├── rax_keypair.txt │ ├── rax_meta.txt │ ├── rax_network.txt │ ├── rax_queue.txt │ ├── rax_scaling_group.txt │ ├── rax_scaling_policy.txt │ ├── rds.txt │ ├── rds_param_group.txt │ ├── rds_subnet_group.txt │ ├── redhat_subscription.txt │ ├── redis.txt │ ├── replace.txt │ ├── rhn_channel.txt │ ├── rhn_register.txt │ ├── riak.txt │ ├── rollbar_deployment.txt │ ├── route53.txt │ ├── rpm_key.txt │ ├── s3.txt │ ├── script.txt │ ├── seboolean.txt │ ├── selinux.txt │ ├── service.txt │ ├── set_fact.txt │ ├── setup.txt │ ├── shell.txt │ ├── slack.txt │ ├── slurp.txt │ ├── snmp_facts.txt │ ├── sns.txt │ ├── stackdriver.txt │ ├── stat.txt │ ├── subversion.txt │ ├── supervisorctl.txt │ ├── svr4pkg.txt │ ├── swdepot.txt │ ├── synchronize.txt │ ├── sysctl.txt │ ├── tags │ ├── template.txt │ ├── twilio.txt │ ├── typetalk.txt │ ├── ufw.txt │ ├── unarchive.txt │ ├── uptimerobot.txt │ ├── uri.txt │ ├── urpmi.txt │ ├── user.txt │ ├── virt.txt │ ├── vsphere_guest.txt │ ├── wait_for.txt │ ├── win_chocolatey.txt │ ├── win_feature.txt │ ├── win_get_url.txt │ ├── win_group.txt │ ├── win_msi.txt │ ├── win_ping.txt │ ├── win_service.txt │ ├── win_stat.txt │ ├── win_updates.txt │ ├── win_user.txt │ ├── xattr.txt │ ├── yum.txt │ ├── zabbix_group.txt │ ├── zabbix_maintenance.txt │ ├── zfs.txt │ ├── zypper.txt │ └── zypper_repository.txt ├── rocannon.txt └── tags ├── examples ├── demo.md ├── demo2.gif ├── demo4.gif └── install.ans ├── ftdetect └── ansible.vim ├── ftplugin └── ansible.vim ├── img └── rainbow.jpg ├── plugin └── rocannon.vim ├── scripts.vim ├── skel └── skel.ans └── syntax ├── actions.vim └── ansible.vim /.gitignore: -------------------------------------------------------------------------------- 1 | /tmp 2 | -------------------------------------------------------------------------------- /autoload/argvals.vim: -------------------------------------------------------------------------------- 1 | " Not auto-generated 2 | " JUNK. DELETE THIS FILE. 3 | let bools = ['force', 'follow', 'recurse', 'backup', 'force', 'copy'] 4 | let argvals = { 5 | \ 'state': [ 'installed', 'present', 'absent'] 6 | } 7 | -------------------------------------------------------------------------------- /bin/ans2txt.zsh: -------------------------------------------------------------------------------- 1 | #! /usr/bin/env zsh 2 | 3 | # ans2vim — pull actions, abbrs, args from ansible and convert to vim dicts 4 | 5 | ### Generate doc dumps 6 | print 'Generating text dump of actions...' 7 | ansible-doc -l |sed '/^$/,$ d' >|actions.txt 8 | 9 | brokens=(ec2_metric_alarm ec2_scaling_policy rax_dns stackdriver) 10 | print 'Generating text dump of all args...' 11 | # Could ignore broken modules, but not worth it for now 12 | while read -r cmd txt; do ansible-doc -s $cmd 2>/dev/null; done |args.txt 13 | 14 | ### Actions 15 | print 'Wrote actions to ../autoload/actions.vim' 16 | vim --noplugin -u /dev/null -s txt2actions.vim actions.txt 17 | 18 | ### Abbreviations 19 | print 'Wrote required args to ../autoload/reqargs.vim' 20 | vim --noplugin -u /dev/null -s txt2reqargs.vim args.txt 21 | 22 | ### Args 23 | print 'Wrote optional args to ../autoload/optargs.vim' 24 | vim --noplugin -u /dev/null -s txt2optargs.vim args.txt 25 | 26 | ### Action Syntax 27 | print 'Wrote ansAction syntax to ../syntax/actions.vim' 28 | vim --noplugin -u /dev/null -s txt2syn.vim actions.txt 29 | -------------------------------------------------------------------------------- /bin/txt2actions.vim: -------------------------------------------------------------------------------- 1 | :%s/\s\+$/ 2 | :%s/'/''/g 3 | :%s/\s\+/', 'menu': '/ 4 | :%s/$/'},/ 5 | :%s/^/ \\ {'word': '/ 6 | ggOlet actions = [ 7 | ggO" Auto-generated by txt2actions.vim 8 | Go \ ] 9 | :w! ../autoload/actions.vim 10 | :q! 11 | -------------------------------------------------------------------------------- /bin/txt2optargs.vim: -------------------------------------------------------------------------------- 1 | :%s/\s\+$/ 2 | :g/[a-z]= /d 3 | :%s/'/''/g 4 | :%s/^ action: .*/&': [/ 5 | :%s/^ action: / \\\ '/ 6 | :g/^- name:/d 7 | :%s/\s\+# \(.*\)/', 'menu': '\1'},/ 8 | :%s/^\s\+\(\w\+\)/ \\\ {'word': '\1=/ 9 | :%s/^$/ \\\ ],/ 10 | ggOlet optargs = { 11 | ggO" Auto-generated by txt2optargs.vim 12 | Go \ } 13 | :w! ../autoload/optargs.vim 14 | :q! 15 | -------------------------------------------------------------------------------- /bin/txt2reqargs.vim: -------------------------------------------------------------------------------- 1 | :%s/\s\+#.* 2 | :g/^- name:/d 3 | :%s/^ action: \(.*\)/iab \1: \1: 4 | :g!/[=:]/d 5 | :g/=/-1j 6 | :g!/=/d 7 | :%s/$/=rocannon#Eatchar('\\s') 8 | ggO" Auto-generated by reqargs.vim 9 | :w! ../autoload/reqargs.vim 10 | :q! 11 | -------------------------------------------------------------------------------- /bin/txt2syn.vim: -------------------------------------------------------------------------------- 1 | :%s/\s.*// 2 | :g/./-1j 3 | :s/\s/\\|/g 4 | :s/^/syn match ansAction "\\<\\(/ 5 | :s/$/\\):"/ 6 | ggO" Auto-generated by txt2syn.vim 7 | :w! ../syntax/actions.vim 8 | :q! 9 | -------------------------------------------------------------------------------- /dict/anskeywords.txt: -------------------------------------------------------------------------------- 1 | ansible_facts 2 | ansible_all_ipv4_addresses 3 | ansible_all_ipv6_addresses 4 | ansible_architecture 5 | ansible_bios_date 6 | ansible_bios_version 7 | ansible_cmdline 8 | ansible_date_time 9 | ansible_default_ipv4 10 | ansible_default_ipv6 11 | ansible_devices 12 | ansible_distribution 13 | ansible_distribution_major_version 14 | ansible_distribution_release 15 | ansible_distribution_version 16 | ansible_domain 17 | ansible_env 18 | ansible_eth0 19 | ansible_fips 20 | ansible_form_factor 21 | ansible_fqdn 22 | ansible_hostname 23 | ansible_interfaces 24 | ansible_kernel 25 | ansible_lo 26 | ansible_machine 27 | ansible_memfree_mb 28 | ansible_memtotal_mb 29 | ansible_mounts 30 | ansible_nodename 31 | ansible_os_family 32 | ansible_pkg_mgr 33 | ansible_processor 34 | ansible_processor_cores 35 | ansible_processor_count 36 | ansible_processor_threads_per_core 37 | ansible_processor_vcpus 38 | ansible_product_name 39 | ansible_product_serial 40 | ansible_product_uuid 41 | ansible_product_version 42 | ansible_python_version 43 | ansible_selinux 44 | ansible_ssh_host_key_ecdsa_public 45 | ansible_ssh_host_key_rsa_public 46 | ansible_swapfree_mb 47 | ansible_swaptotal_mb 48 | ansible_system 49 | ansible_system_vendor 50 | ansible_user_id 51 | ansible_userspace_architecture 52 | ansible_userspace_bits 53 | ansible_virtualization_role 54 | ansible_virtualization_type 55 | -------------------------------------------------------------------------------- /doc/mod.txt/a10_server.txt: -------------------------------------------------------------------------------- 1 | SYNOPSIS *a10_server* 2 | 3 | New in version 1.8. 4 | 5 | Manage slb server objects on A10 Networks devices via aXAPI 6 | 7 | EXAMPLES *a10_server-examples* 8 | > 9 | # Create a new server 10 | - a10_server: 11 | host: a10.mydomain.com 12 | username: myadmin 13 | password: mypassword 14 | server: test 15 | server_ip: 1.1.1.100 16 | server_ports: 17 | - port_num: 8080 18 | protocol: tcp 19 | - port_num: 8443 20 | protocol: TCP 21 | 22 | Note 23 | 24 | Requires A10 Networks aXAPI 2.1 25 | 26 | MORE INFO *a10_server-moreinfo* 27 | > 28 | All arguments are omni-completed, but if you really want to see the online docs: 29 | http://docs.ansible.com/a10_server_module.html 30 | -------------------------------------------------------------------------------- /doc/mod.txt/a10_service_group.txt: -------------------------------------------------------------------------------- 1 | SYNOPSIS *a10_service_group* 2 | 3 | New in version 1.8. 4 | 5 | Manage slb service-group objects on A10 Networks devices via aXAPI 6 | 7 | EXAMPLES *a10_service_group-examples* 8 | > 9 | # Create a new service-group 10 | - a10_service_group: 11 | host: a10.mydomain.com 12 | username: myadmin 13 | password: mypassword 14 | service_group: sg-80-tcp 15 | servers: 16 | - server: foo1.mydomain.com 17 | port: 8080 18 | - server: foo2.mydomain.com 19 | port: 8080 20 | - server: foo3.mydomain.com 21 | port: 8080 22 | - server: foo4.mydomain.com 23 | port: 8080 24 | status: disabled 25 | 26 | Note 27 | 28 | Requires A10 Networks aXAPI 2.1 29 | 30 | Note 31 | 32 | When a server doesn’t exist and is added to the service-group the server will be created 33 | 34 | MORE INFO *a10_service_group-moreinfo* 35 | > 36 | All arguments are omni-completed, but if you really want to see the online docs: 37 | http://docs.ansible.com/a10_service_group_module.html 38 | -------------------------------------------------------------------------------- /doc/mod.txt/a10_virtual_server.txt: -------------------------------------------------------------------------------- 1 | SYNOPSIS *a10_virtual_server* 2 | 3 | New in version 1.8. 4 | 5 | Manage slb virtual server objects on A10 Networks devices via aXAPI 6 | 7 | EXAMPLES *a10_virtual_server-examples* 8 | > 9 | # Create a new virtual server 10 | - a10_virtual_server: 11 | host: a10.mydomain.com 12 | username: myadmin 13 | password: mypassword 14 | virtual_server: vserver1 15 | virtual_server_ip: 1.1.1.1 16 | virtual_server_ports: 17 | - port: 80 18 | protocol: TCP 19 | service_group: sg-80-tcp 20 | - port: 443 21 | protocol: HTTPS 22 | service_group: sg-443-https 23 | - port: 8080 24 | protocol: http 25 | status: disabled 26 | 27 | Note 28 | 29 | Requires A10 Networks aXAPI 2.1 30 | 31 | MORE INFO *a10_virtual_server-moreinfo* 32 | > 33 | All arguments are omni-completed, but if you really want to see the online docs: 34 | http://docs.ansible.com/a10_virtual_server_module.html 35 | -------------------------------------------------------------------------------- /doc/mod.txt/accelerate.txt: -------------------------------------------------------------------------------- 1 | SYNOPSIS *accelerate* 2 | 3 | New in version 1.3. 4 | 5 | This modules launches an ephemeral accelerate daemon on the remote node which Ansible can use to communicate with nodes at high speed. The daemon listens on a configurable port for a 6 | configurable amount of time. Fireball mode is AES encrypted 7 | 8 | EXAMPLES *accelerate-examples* 9 | > 10 | # To use accelerate mode, simply add "accelerate: true" to your play. The initial 11 | # key exchange and starting up of the daemon will occur over SSH, but all commands and 12 | # subsequent actions will be conducted over the raw socket connection using AES encryption 13 | 14 | - hosts: devservers 15 | accelerate: true 16 | tasks: 17 | - command: /usr/bin/anything 18 | 19 | Note 20 | 21 | See the advanced playbooks chapter for more about using accelerated mode. 22 | 23 | MORE INFO *accelerate-moreinfo* 24 | > 25 | All arguments are omni-completed, but if you really want to see the online docs: 26 | http://docs.ansible.com/accelerate_module.html 27 | -------------------------------------------------------------------------------- /doc/mod.txt/acl.txt: -------------------------------------------------------------------------------- 1 | SYNOPSIS *acl* 2 | 3 | New in version 1.4. 4 | 5 | Sets and retrieves file ACL information. 6 | 7 | EXAMPLES *acl-examples* 8 | > 9 | # Grant user Joe read access to a file 10 | - acl: name=/etc/foo.conf entity=joe etype=user permissions="r" state=present 11 | 12 | # Removes the acl for Joe on a specific file 13 | - acl: name=/etc/foo.conf entity=joe etype=user state=absent 14 | 15 | # Sets default acl for joe on foo.d 16 | - acl: name=/etc/foo.d entity=joe etype=user permissions=rw default=yes state=present 17 | 18 | # Same as previous but using entry shorthand 19 | - acl: name=/etc/foo.d entry="default:user:joe:rw-" state=present 20 | 21 | # Obtain the acl for a specific file 22 | - acl: name=/etc/foo.conf 23 | register: acl_info 24 | 25 | Note 26 | 27 | The “acl” module requires that acls are enabled on the target filesystem and that the setfacl and getfacl binaries are installed. 28 | 29 | MORE INFO *acl-moreinfo* 30 | > 31 | All arguments are omni-completed, but if you really want to see the online docs: 32 | http://docs.ansible.com/acl_module.html 33 | -------------------------------------------------------------------------------- /doc/mod.txt/add_host.txt: -------------------------------------------------------------------------------- 1 | SYNOPSIS *add_host* 2 | 3 | Use variables to create new hosts and groups in inventory for use in later plays of the same playbook. Takes variables so you can define the new hosts more fully. 4 | 5 | EXAMPLES *add_host-examples* 6 | > 7 | # add host to group 'just_created' with variable foo=42 8 | - add_host: name={{ ip_from_ec2 }} groups=just_created foo=42 9 | 10 | # add a host with a non-standard port local to your machines 11 | - add_host: name={{ new_ip }}:{{ new_port }} 12 | 13 | # add a host alias that we reach through a tunnel 14 | - add_host: hostname={{ new_ip }} 15 | ansible_ssh_host={{ inventory_hostname }} 16 | ansible_ssh_port={{ new_port }} 17 | 18 | MORE INFO *add_host-moreinfo* 19 | > 20 | All arguments are omni-completed, but if you really want to see the online docs: 21 | http://docs.ansible.com/add_host_module.html 22 | -------------------------------------------------------------------------------- /doc/mod.txt/airbrake_deployment.txt: -------------------------------------------------------------------------------- 1 | SYNOPSIS *airbrake_deployment* 2 | 3 | New in version 1.2. 4 | 5 | Notify airbrake about app deployments (see http://help.airbrake.io/kb/api-2/deploy-tracking) 6 | 7 | EXAMPLES *airbrake_deployment-examples* 8 | > 9 | - airbrake_deployment: token=AAAAAA 10 | environment='staging' 11 | user='ansible' 12 | revision=4.2 13 | 14 | MORE INFO *airbrake_deployment-moreinfo* 15 | > 16 | All arguments are omni-completed, but if you really want to see the online docs: 17 | http://docs.ansible.com/airbrake_deployment_module.html 18 | -------------------------------------------------------------------------------- /doc/mod.txt/alternatives.txt: -------------------------------------------------------------------------------- 1 | SYNOPSIS *alternatives* 2 | 3 | New in version 1.6. 4 | 5 | Manages symbolic links using the ‘update-alternatives’ tool provided on debian-like systems. Useful when multiple programs are installed but provide similar functionality (e.g. different 6 | editors). 7 | 8 | EXAMPLES *alternatives-examples* 9 | > 10 | - name: correct java version selected 11 | alternatives: name=java path=/usr/lib/jvm/java-7-openjdk-amd64/jre/bin/java 12 | 13 | - name: alternatives link created 14 | alternatives: name=hadoop-conf link=/etc/hadoop/conf path=/etc/hadoop/conf.ansible 15 | 16 | MORE INFO *alternatives-moreinfo* 17 | > 18 | All arguments are omni-completed, but if you really want to see the online docs: 19 | http://docs.ansible.com/alternatives_module.html 20 | -------------------------------------------------------------------------------- /doc/mod.txt/apache2_module.txt: -------------------------------------------------------------------------------- 1 | SYNOPSIS *apache2_module* 2 | 3 | New in version 1.6. 4 | 5 | Enables or disables a specified module of the Apache2 webserver. 6 | 7 | EXAMPLES *apache2_module-examples* 8 | > 9 | # enables the Apache2 module "wsgi" 10 | - apache2_module: state=present name=wsgi 11 | 12 | # disables the Apache2 module "wsgi" 13 | - apache2_module: state=absent name=wsgi 14 | 15 | MORE INFO *apache2_module-moreinfo* 16 | > 17 | All arguments are omni-completed, but if you really want to see the online docs: 18 | http://docs.ansible.com/apache2_module_module.html 19 | -------------------------------------------------------------------------------- /doc/mod.txt/apt_repository.txt: -------------------------------------------------------------------------------- 1 | SYNOPSIS *apt_repository* 2 | 3 | Add or remove an APT repositories in Ubuntu and Debian. 4 | 5 | EXAMPLES *apt_repository-examples* 6 | > 7 | # Add specified repository into sources list. 8 | apt_repository: repo='deb http://archive.canonical.com/ubuntu hardy partner' state=present 9 | 10 | # Add source repository into sources list. 11 | apt_repository: repo='deb-src http://archive.canonical.com/ubuntu hardy partner' state=present 12 | 13 | # Remove specified repository from sources list. 14 | apt_repository: repo='deb http://archive.canonical.com/ubuntu hardy partner' state=absent 15 | 16 | # On Ubuntu target: add nginx stable repository from PPA and install its signing key. 17 | # On Debian target: adding PPA is not available, so it will fail immediately. 18 | apt_repository: repo='ppa:nginx/stable' 19 | 20 | Note 21 | 22 | This module works on Debian and Ubuntu and requires python-apt. 23 | 24 | Note 25 | 26 | This module supports Debian Squeeze (version 6) as well as its successors. 27 | 28 | Note 29 | 30 | This module treats Debian and Ubuntu distributions separately. So PPA could be installed only on Ubuntu machines. 31 | 32 | MORE INFO *apt_repository-moreinfo* 33 | > 34 | All arguments are omni-completed, but if you really want to see the online docs: 35 | http://docs.ansible.com/apt_repository_module.html 36 | -------------------------------------------------------------------------------- /doc/mod.txt/apt_rpm.txt: -------------------------------------------------------------------------------- 1 | SYNOPSIS *apt_rpm* 2 | 3 | New in version 1.5. 4 | 5 | Manages packages with apt-rpm. Both low-level (rpm) and high-level (apt-get) package manager binaries required. 6 | 7 | EXAMPLES *apt_rpm-examples* 8 | > 9 | # install package foo 10 | - apt_rpm: pkg=foo state=present 11 | # remove package foo 12 | - apt_rpm: pkg=foo state=absent 13 | # description: remove packages foo and bar 14 | - apt_rpm: pkg=foo,bar state=absent 15 | # description: update the package database and install bar (bar will be the updated if a newer version exists) 16 | - apt_rpm: name=bar state=present update_cache=yes 17 | 18 | MORE INFO *apt_rpm-moreinfo* 19 | > 20 | All arguments are omni-completed, but if you really want to see the online docs: 21 | http://docs.ansible.com/apt_rpm_module.html 22 | -------------------------------------------------------------------------------- /doc/mod.txt/assemble.txt: -------------------------------------------------------------------------------- 1 | SYNOPSIS *assemble* 2 | 3 | Assembles a configuration file from fragments. Often a particular program will take a single configuration file and does not support a conf.d style structure where it is easy to build up the 4 | configuration from multiple sources. assemble will take a directory of files that can be local or have already been transferred to the system, and concatenate them together to produce a 5 | destination file. Files are assembled in string sorting order. Puppet calls this idea fragments. 6 | 7 | EXAMPLES *assemble-examples* 8 | > 9 | # Example from Ansible Playbooks 10 | - assemble: src=/etc/someapp/fragments dest=/etc/someapp/someapp.conf 11 | 12 | # When a delimiter is specified, it will be inserted in between each fragment 13 | - assemble: src=/etc/someapp/fragments dest=/etc/someapp/someapp.conf delimiter='### START FRAGMENT ###' 14 | 15 | MORE INFO *assemble-moreinfo* 16 | > 17 | All arguments are omni-completed, but if you really want to see the online docs: 18 | http://docs.ansible.com/assemble_module.html 19 | -------------------------------------------------------------------------------- /doc/mod.txt/assert.txt: -------------------------------------------------------------------------------- 1 | SYNOPSIS *assert* 2 | 3 | New in version 1.5. 4 | 5 | This module asserts that a given expression is true and can be a simpler alternative to the ‘fail’ module in some cases. 6 | 7 | EXAMPLES *assert-examples* 8 | > 9 | - assert: { that: "ansible_os_family != 'RedHat'" } 10 | 11 | - assert: 12 | that: 13 | - "'foo' in some_command_result.stdout" 14 | - "number_of_the_counting == 3" 15 | 16 | MORE INFO *assert-moreinfo* 17 | > 18 | All arguments are omni-completed, but if you really want to see the online docs: 19 | http://docs.ansible.com/assert_module.html 20 | -------------------------------------------------------------------------------- /doc/mod.txt/async_status.txt: -------------------------------------------------------------------------------- 1 | SYNOPSIS *async_status* 2 | 3 | This module gets the status of an asynchronous task. 4 | 5 | EXAMPLES *async_status-examples* 6 | > 7 | MORE INFO *async_status-moreinfo* 8 | > 9 | All arguments are omni-completed, but if you really want to see the online docs: 10 | http://docs.ansible.com/async_status_module.html 11 | -------------------------------------------------------------------------------- /doc/mod.txt/at.txt: -------------------------------------------------------------------------------- 1 | SYNOPSIS *at* 2 | 3 | New in version 1.5. 4 | 5 | Use this module to schedule a command or script file to run once in the future. All jobs are executed in the ‘a’ queue. 6 | 7 | EXAMPLES *at-examples* 8 | > 9 | # Schedule a command to execute in 20 minutes as root. 10 | - at: command="ls -d / > /dev/null" count=20 units="minutes" 11 | 12 | # Match a command to an existing job and delete the job. 13 | - at: command="ls -d / > /dev/null" state="absent" 14 | 15 | # Schedule a command to execute in 20 minutes making sure it is unique in the queue. 16 | - at: command="ls -d / > /dev/null" unique=true count=20 units="minutes" 17 | 18 | MORE INFO *at-moreinfo* 19 | > 20 | All arguments are omni-completed, but if you really want to see the online docs: 21 | http://docs.ansible.com/at_module.html 22 | -------------------------------------------------------------------------------- /doc/mod.txt/authorized_key.txt: -------------------------------------------------------------------------------- 1 | SYNOPSIS *authorized_key* 2 | 3 | Adds or removes authorized keys for particular user accounts 4 | 5 | EXAMPLES *authorized_key-examples* 6 | > 7 | # Example using key data from a local file on the management machine 8 | - authorized_key: user=charlie key="{{ lookup('file', '/home/charlie/.ssh/id_rsa.pub') }}" 9 | 10 | # Using alternate directory locations: 11 | - authorized_key: user=charlie 12 | key="{{ lookup('file', '/home/charlie/.ssh/id_rsa.pub') }}" 13 | path='/etc/ssh/authorized_keys/charlie' 14 | manage_dir=no 15 | 16 | # Using with_file 17 | - name: Set up authorized_keys for the deploy user 18 | authorized_key: user=deploy 19 | key="{{ item }}" 20 | with_file: 21 | - public_keys/doe-jane 22 | - public_keys/doe-john 23 | 24 | # Using key_options: 25 | - authorized_key: user=charlie 26 | key="{{ lookup('file', '/home/charlie/.ssh/id_rsa.pub') }}" 27 | key_options='no-port-forwarding,host="10.0.1.1"' 28 | 29 | MORE INFO *authorized_key-moreinfo* 30 | > 31 | All arguments are omni-completed, but if you really want to see the online docs: 32 | http://docs.ansible.com/authorized_key_module.html 33 | -------------------------------------------------------------------------------- /doc/mod.txt/azure.txt: -------------------------------------------------------------------------------- 1 | SYNOPSIS *azure* 2 | 3 | New in version 1.7. 4 | 5 | Creates or terminates azure instances. When created optionally waits for it to be ‘running’. This module has a dependency on python-azure >= 0.7.1 6 | 7 | EXAMPLES *azure-examples* 8 | > 9 | # Note: None of these examples set subscription_id or management_cert_path 10 | # It is assumed that their matching environment variables are set. 11 | 12 | # Provision virtual machine example 13 | - local_action: 14 | module: azure 15 | name: my-virtual-machine 16 | role_size: Small 17 | image: b39f27a8b8c64d52b05eac6a62ebad85__Ubuntu_DAILY_BUILD-precise-12_04_3-LTS-amd64-server-20131205-en-us-30GB 18 | location: 'East US' 19 | user: ubuntu 20 | ssh_cert_path: /path/to/azure_x509_cert.pem 21 | storage_account: my-storage-account 22 | wait: yes 23 | 24 | # Terminate virtual machine example 25 | - local_action: 26 | module: azure 27 | name: my-virtual-machine 28 | state: absent 29 | 30 | MORE INFO *azure-moreinfo* 31 | > 32 | All arguments are omni-completed, but if you really want to see the online docs: 33 | http://docs.ansible.com/azure_module.html 34 | -------------------------------------------------------------------------------- /doc/mod.txt/bigip_facts.txt: -------------------------------------------------------------------------------- 1 | SYNOPSIS *bigip_facts* 2 | 3 | New in version 1.6. 4 | 5 | Collect facts from F5 BIG-IP devices via iControl SOAP API 6 | 7 | EXAMPLES *bigip_facts-examples* 8 | > 9 | ## playbook task examples: 10 | 11 | --- 12 | # file bigip-test.yml 13 | # ... 14 | - hosts: bigip-test 15 | tasks: 16 | - name: Collect BIG-IP facts 17 | local_action: > 18 | bigip_facts 19 | server=lb.mydomain.com 20 | user=admin 21 | password=mysecret 22 | include=interface,vlan 23 | 24 | Note 25 | 26 | Requires BIG-IP software version >= 11.4 27 | 28 | Note 29 | 30 | F5 developed module ‘bigsuds’ required (see http://devcentral.f5.com) 31 | 32 | Note 33 | 34 | Best run as a local_action in your playbook 35 | 36 | Note 37 | 38 | Tested with manager and above account privilege level 39 | 40 | MORE INFO *bigip_facts-moreinfo* 41 | > 42 | All arguments are omni-completed, but if you really want to see the online docs: 43 | http://docs.ansible.com/bigip_facts_module.html 44 | -------------------------------------------------------------------------------- /doc/mod.txt/bigpanda.txt: -------------------------------------------------------------------------------- 1 | SYNOPSIS *bigpanda* 2 | 3 | New in version 1.8. 4 | 5 | Notify BigPanda when deployments start and end (successfully or not). Returns a deployment object containing all the parameters for future module calls. 6 | 7 | EXAMPLES *bigpanda-examples* 8 | > 9 | - bigpanda: component=myapp version=1.3 token={{ bigpanda_token }} state=started 10 | ... 11 | - bigpanda: component=myapp version=1.3 token={{ bigpanda_token }} state=finished 12 | 13 | or using a deployment object: 14 | - bigpanda: component=myapp version=1.3 token={{ bigpanda_token }} state=started 15 | register: deployment 16 | 17 | - bigpanda: state=finished 18 | args: deployment 19 | 20 | If outside servers aren't reachable from your machine, use local_action and pass the hostname: 21 | - local_action: bigpanda component=myapp version=1.3 hosts={{ansible_hostname}} token={{ bigpanda_token }} state=started 22 | register: deployment 23 | ... 24 | - local_action: bigpanda state=finished 25 | args: deployment 26 | 27 | MORE INFO *bigpanda-moreinfo* 28 | > 29 | All arguments are omni-completed, but if you really want to see the online docs: 30 | http://docs.ansible.com/bigpanda_module.html 31 | -------------------------------------------------------------------------------- /doc/mod.txt/boundary_meter.txt: -------------------------------------------------------------------------------- 1 | SYNOPSIS *boundary_meter* 2 | 3 | New in version 1.3. 4 | 5 | This module manages boundary meters 6 | 7 | EXAMPLES *boundary_meter-examples* 8 | > 9 | - name: Create meter 10 | boundary_meter: apiid=AAAAAA api_key=BBBBBB state=present name={{ inventory_hostname }}" 11 | 12 | - name: Delete meter 13 | boundary_meter: apiid=AAAAAA api_key=BBBBBB state=absent name={{ inventory_hostname }}" 14 | 15 | Note 16 | 17 | This module does not yet support boundary tags. 18 | 19 | MORE INFO *boundary_meter-moreinfo* 20 | > 21 | All arguments are omni-completed, but if you really want to see the online docs: 22 | http://docs.ansible.com/boundary_meter_module.html 23 | -------------------------------------------------------------------------------- /doc/mod.txt/bower.txt: -------------------------------------------------------------------------------- 1 | SYNOPSIS *bower* 2 | 3 | New in version 1.7. 4 | 5 | Manage bower packages with bower 6 | 7 | EXAMPLES *bower-examples* 8 | > 9 | description: Install "bootstrap" bower package. 10 | - bower: name=bootstrap 11 | 12 | description: Install "bootstrap" bower package on version 3.1.1. 13 | - bower: name=bootstrap version=3.1.1 14 | 15 | description: Remove the "bootstrap" bower package. 16 | - bower: name=bootstrap state=absent 17 | 18 | description: Install packages based on bower.json. 19 | - bower: path=/app/location 20 | 21 | description: Update packages based on bower.json to their latest version. 22 | - bower: path=/app/location state=latest 23 | 24 | MORE INFO *bower-moreinfo* 25 | > 26 | All arguments are omni-completed, but if you really want to see the online docs: 27 | http://docs.ansible.com/bower_module.html 28 | -------------------------------------------------------------------------------- /doc/mod.txt/bzr.txt: -------------------------------------------------------------------------------- 1 | SYNOPSIS *bzr* 2 | 3 | New in version 1.1. 4 | 5 | Manage bzr branches to deploy files or software. 6 | 7 | EXAMPLES *bzr-examples* 8 | > 9 | # Example bzr checkout from Ansible Playbooks 10 | - bzr: name=bzr+ssh://foosball.example.org/path/to/branch dest=/srv/checkout version=22 11 | 12 | MORE INFO *bzr-moreinfo* 13 | > 14 | All arguments are omni-completed, but if you really want to see the online docs: 15 | http://docs.ansible.com/bzr_module.html 16 | -------------------------------------------------------------------------------- /doc/mod.txt/campfire.txt: -------------------------------------------------------------------------------- 1 | SYNOPSIS *campfire* 2 | 3 | New in version 1.2. 4 | 5 | Send a message to Campfire. Messages with newlines will result in a “Paste” message being sent. 6 | 7 | EXAMPLES *campfire-examples* 8 | > 9 | - campfire: subscription=foo token=12345 room=123 msg="Task completed." 10 | 11 | - campfire: subscription=foo token=12345 room=123 notify=loggins 12 | msg="Task completed ... with feeling." 13 | 14 | MORE INFO *campfire-moreinfo* 15 | > 16 | All arguments are omni-completed, but if you really want to see the online docs: 17 | http://docs.ansible.com/campfire_module.html 18 | -------------------------------------------------------------------------------- /doc/mod.txt/capabilities.txt: -------------------------------------------------------------------------------- 1 | SYNOPSIS *capabilities* 2 | 3 | New in version 1.6. 4 | 5 | This module manipulates files privileges using the Linux capabilities(7) system. 6 | 7 | EXAMPLES *capabilities-examples* 8 | > 9 | # Set cap_sys_chroot+ep on /foo 10 | - capabilities: path=/foo capability=cap_sys_chroot+ep state=present 11 | 12 | # Remove cap_net_bind_service from /bar 13 | - capabilities: path=/bar capability=cap_net_bind_service state=absent 14 | 15 | Note 16 | 17 | The capabilities system will automatically transform operators and flags into the effective set, so (for example, cap_foo=ep will probably become cap_foo+ep). This module does not attempt to 18 | determine the final operator and flags to compare, so you will want to ensure that your capabilities argument matches the final capabilities. 19 | 20 | MORE INFO *capabilities-moreinfo* 21 | > 22 | All arguments are omni-completed, but if you really want to see the online docs: 23 | http://docs.ansible.com/capabilities_module.html 24 | -------------------------------------------------------------------------------- /doc/mod.txt/cloudformation.txt: -------------------------------------------------------------------------------- 1 | SYNOPSIS *cloudformation* 2 | 3 | New in version 1.1. 4 | 5 | Launches an AWS CloudFormation stack and waits for it complete. 6 | 7 | EXAMPLES *cloudformation-examples* 8 | > 9 | # Basic task example 10 | tasks: 11 | - name: launch ansible cloudformation example 12 | cloudformation: 13 | stack_name: "ansible-cloudformation" 14 | state: "present" 15 | region: "us-east-1" 16 | disable_rollback: true 17 | template: "files/cloudformation-example.json" 18 | template_parameters: 19 | KeyName: "jmartin" 20 | DiskType: "ephemeral" 21 | InstanceType: "m1.small" 22 | ClusterSize: 3 23 | tags: 24 | Stack: "ansible-cloudformation" 25 | 26 | MORE INFO *cloudformation-moreinfo* 27 | > 28 | All arguments are omni-completed, but if you really want to see the online docs: 29 | http://docs.ansible.com/cloudformation_module.html 30 | -------------------------------------------------------------------------------- /doc/mod.txt/command.txt: -------------------------------------------------------------------------------- 1 | SYNOPSIS *command* 2 | 3 | The command module takes the command name followed by a list of space-delimited arguments. The given command will be executed on all selected nodes. It will not be processed through the shell, 4 | so variables like $HOME and operations like "<", ">", "|", and "&" will not work (use the shell module if you need these features). 5 | 6 | EXAMPLES *command-examples* 7 | > 8 | # Example from Ansible Playbooks. 9 | - command: /sbin/shutdown -t now 10 | 11 | # Run the command if the specified file does not exist. 12 | - command: /usr/bin/make_database.sh arg1 arg2 creates=/path/to/database 13 | 14 | # You can also use the 'args' form to provide the options. This command 15 | # will change the working directory to somedir/ and will only run when 16 | # /path/to/database doesn't exist. 17 | - command: /usr/bin/make_database.sh arg1 arg2 18 | args: 19 | chdir: somedir/ 20 | creates: /path/to/database 21 | 22 | Note 23 | 24 | If you want to run a command through the shell (say you are using <, >, |, etc), you actually want the shell module instead. The command module is much more secure as it’s not affected by the 25 | user’s environment. 26 | 27 | Note 28 | 29 | creates, removes, and chdir can be specified after the command. For instance, if you only want to run a command if a certain file does not exist, use this. 30 | 31 | MORE INFO *command-moreinfo* 32 | > 33 | All arguments are omni-completed, but if you really want to see the online docs: 34 | http://docs.ansible.com/command_module.html 35 | -------------------------------------------------------------------------------- /doc/mod.txt/composer.txt: -------------------------------------------------------------------------------- 1 | SYNOPSIS *composer* 2 | 3 | New in version 1.6. 4 | 5 | Composer is a tool for dependency management in PHP. It allows you to declare the dependent libraries your project needs and it will install them in your project for you 6 | 7 | EXAMPLES *composer-examples* 8 | > 9 | # Downloads and installs all the libs and dependencies outlined in the /path/to/project/composer.lock 10 | - composer: command=install working_dir=/path/to/project 11 | 12 | Note 13 | 14 | Default options that are always appended in each execution are –no-ansi, –no-progress, and –no-interaction 15 | 16 | MORE INFO *composer-moreinfo* 17 | > 18 | All arguments are omni-completed, but if you really want to see the online docs: 19 | http://docs.ansible.com/composer_module.html 20 | -------------------------------------------------------------------------------- /doc/mod.txt/copy.txt: -------------------------------------------------------------------------------- 1 | SYNOPSIS *copy* 2 | 3 | The copy module copies a file on the local box to remote locations. Use the fetch module to copy files from remote locations to the local box. 4 | 5 | EXAMPLES *copy-examples* 6 | > 7 | # Example from Ansible Playbooks 8 | - copy: src=/srv/myfiles/foo.conf dest=/etc/foo.conf owner=foo group=foo mode=0644 9 | 10 | # The same example as above, but using a symbolic mode equivalent to 0644 11 | - copy: src=/srv/myfiles/foo.conf dest=/etc/foo.conf owner=foo group=foo mode="u=rw,g=r,o=r" 12 | 13 | # Another symbolic mode example, adding some permissions and removing others 14 | - copy: src=/srv/myfiles/foo.conf dest=/etc/foo.conf owner=foo group=foo mode="u+rw,g-wx,o-rwx" 15 | 16 | # Copy a new "ntp.conf file into place, backing up the original if it differs from the copied version 17 | - copy: src=/mine/ntp.conf dest=/etc/ntp.conf owner=root group=root mode=644 backup=yes 18 | 19 | # Copy a new "sudoers" file into place, after passing validation with visudo 20 | - copy: src=/mine/sudoers dest=/etc/sudoers validate='visudo -cf %s' 21 | 22 | Note 23 | 24 | The “copy” module recursively copy facility does not scale to lots (>hundreds) of files. For alternative, see synchronize module, which is a wrapper around rsync. 25 | 26 | MORE INFO *copy-moreinfo* 27 | > 28 | All arguments are omni-completed, but if you really want to see the online docs: 29 | http://docs.ansible.com/copy_module.html 30 | -------------------------------------------------------------------------------- /doc/mod.txt/cpanm.txt: -------------------------------------------------------------------------------- 1 | SYNOPSIS *cpanm* 2 | 3 | New in version 1.6. 4 | 5 | Manage Perl library dependencies. 6 | 7 | EXAMPLES *cpanm-examples* 8 | > 9 | Install Dancer perl package. 10 | 11 | cpanm: name=Dancer 12 | 13 | Install version 0.99_05 of the Plack perl package. 14 | 15 | cpanm: name=MIYAGAWA/Plack-0.99_05.tar.gz 16 | 17 | Install Dancer (http://perldancer.org/) into the specified locallib 18 | 19 | cpanm: name=Dancer locallib=/srv/webapps/my_app/extlib 20 | 21 | Install perl dependencies from local directory. 22 | 23 | cpanm: from_path=/srv/webapps/my_app/src/ 24 | 25 | Install Dancer perl package without running the unit tests in indicated locallib. 26 | 27 | cpanm: name=Dancer notest=True locallib=/srv/webapps/my_app/extlib 28 | 29 | Install Dancer perl package from a specific mirror 30 | 31 | cpanm: name=Dancer mirror=http://cpan.cpantesters.org/ 32 | 33 | Note 34 | 35 | Please note that http://search.cpan.org/dist/App-cpanminus/bin/cpanm, cpanm must be installed on the remote host. 36 | 37 | MORE INFO *cpanm-moreinfo* 38 | > 39 | All arguments are omni-completed, but if you really want to see the online docs: 40 | http://docs.ansible.com/cpanm_module.html 41 | -------------------------------------------------------------------------------- /doc/mod.txt/cron.txt: -------------------------------------------------------------------------------- 1 | SYNOPSIS *cron* 2 | 3 | Use this module to manage crontab entries. This module allows you to create named crontab entries, update, or delete them. The module includes one line with the description of the crontab entry 4 | "#Ansible: " corresponding to the “name” passed to the module, which is used by future ansible/module calls to find/check the state. The “name” parameter should be unique, and changing the 5 | “name” value will result in a new cron task being created (or a different one being removed) 6 | 7 | EXAMPLES *cron-examples* 8 | > 9 | # Ensure a job that runs at 2 and 5 exists. 10 | # Creates an entry like "0 5,2 * * ls -alh > /dev/null" 11 | - cron: name="check dirs" minute="0" hour="5,2" job="ls -alh > /dev/null" 12 | 13 | # Ensure an old job is no longer present. Removes any job that is prefixed 14 | # by "#Ansible: an old job" from the crontab 15 | - cron: name="an old job" state=absent 16 | 17 | # Creates an entry like "@reboot /some/job.sh" 18 | - cron: name="a job for reboot" special_time=reboot job="/some/job.sh" 19 | 20 | # Creates a cron file under /etc/cron.d 21 | - cron: name="yum autoupdate" weekday="2" minute=0 hour=12 22 | user="root" job="YUMINTERACTIVE=0 /usr/sbin/yum-autoupdate" 23 | cron_file=ansible_yum-autoupdate 24 | 25 | # Removes a cron file from under /etc/cron.d 26 | - cron: cron_file=ansible_yum-autoupdate state=absent 27 | 28 | MORE INFO *cron-moreinfo* 29 | > 30 | All arguments are omni-completed, but if you really want to see the online docs: 31 | http://docs.ansible.com/cron_module.html 32 | -------------------------------------------------------------------------------- /doc/mod.txt/crypttab.txt: -------------------------------------------------------------------------------- 1 | SYNOPSIS *crypttab* 2 | 3 | New in version 1.8. 4 | 5 | Control Linux encrypted block devices that are set up during system boot in /etc/crypttab. 6 | 7 | EXAMPLES *crypttab-examples* 8 | > 9 | - name: Set the options explicitly a deivce which must already exist 10 | crypttab: name=luks-home state=present opts=discard,cipher=aes-cbc-essiv:sha256 11 | 12 | - name: Add the 'discard' option to any existing options for all devices 13 | crypttab: name={{ item.device }} state=opts_present opts=discard 14 | with_items: ansible_mounts 15 | when: '/dev/mapper/luks-' in {{ item.device }} 16 | 17 | MORE INFO *crypttab-moreinfo* 18 | > 19 | All arguments are omni-completed, but if you really want to see the online docs: 20 | http://docs.ansible.com/crypttab_module.html 21 | -------------------------------------------------------------------------------- /doc/mod.txt/datadog_event.txt: -------------------------------------------------------------------------------- 1 | SYNOPSIS *datadog_event* 2 | 3 | New in version 1.3. 4 | 5 | Allows to post events to DataDog (www.datadoghq.com) service. Uses http://docs.datadoghq.com/api/#events API. 6 | 7 | EXAMPLES *datadog_event-examples* 8 | > 9 | # Post an event with low priority 10 | datadog_event: title="Testing from ansible" text="Test!" priority="low" 11 | api_key="6873258723457823548234234234" 12 | # Post an event with several tags 13 | datadog_event: title="Testing from ansible" text="Test!" 14 | api_key="6873258723457823548234234234" 15 | tags=aa,bb,cc 16 | 17 | MORE INFO *datadog_event-moreinfo* 18 | > 19 | All arguments are omni-completed, but if you really want to see the online docs: 20 | http://docs.ansible.com/datadog_event_module.html 21 | -------------------------------------------------------------------------------- /doc/mod.txt/debconf.txt: -------------------------------------------------------------------------------- 1 | SYNOPSIS *debconf* 2 | 3 | New in version 1.6. 4 | 5 | Configure a .deb package using debconf-set-selections. Or just query existing selections. 6 | 7 | EXAMPLES *debconf-examples* 8 | > 9 | # Set default locale to fr_FR.UTF-8 10 | debconf: name=locales question='locales/default_environment_locale' value=fr_FR.UTF-8 vtype='select' 11 | 12 | # set to generate locales: 13 | debconf: name=locales question='locales/locales_to_be_generated' value='en_US.UTF-8 UTF-8, fr_FR.UTF-8 UTF-8' vtype='multiselect' 14 | 15 | # Accept oracle license 16 | debconf: name='oracle-java7-installer' question='shared/accepted-oracle-license-v1-1' value='true' vtype='select' 17 | 18 | # Specifying package you can register/return the list of questions and current values 19 | debconf: name='tzdata' 20 | 21 | Note 22 | 23 | This module requires the command line debconf tools. 24 | 25 | Note 26 | 27 | A number of questions have to be answered (depending on the package). Use ‘debconf-show ’ on any Debian or derivative with the package installed to see questions/settings available. 28 | 29 | Note 30 | 31 | Some distros will always record tasks involving the setting of passwords as changed. This is due to debconf-get-selections masking passwords. 32 | 33 | MORE INFO *debconf-moreinfo* 34 | > 35 | All arguments are omni-completed, but if you really want to see the online docs: 36 | http://docs.ansible.com/debconf_module.html 37 | -------------------------------------------------------------------------------- /doc/mod.txt/debug.txt: -------------------------------------------------------------------------------- 1 | SYNOPSIS *debug* 2 | 3 | This module prints statements during execution and can be useful for debugging variables or expressions without necessarily halting the playbook. Useful for debugging together with the ‘when:’ 4 | directive. 5 | 6 | EXAMPLES *debug-examples* 7 | > 8 | # Example that prints the loopback address and gateway for each host 9 | - debug: msg="System {{ inventory_hostname }} has uuid {{ ansible_product_uuid }}" 10 | 11 | - debug: msg="System {{ inventory_hostname }} has gateway {{ ansible_default_ipv4.gateway }}" 12 | when: ansible_default_ipv4.gateway is defined 13 | 14 | - shell: /usr/bin/uptime 15 | register: result 16 | 17 | - debug: var=result 18 | 19 | - name: Display all variables/facts known for a host 20 | debug: var=hostvars[inventory_hostname] 21 | 22 | MORE INFO *debug-moreinfo* 23 | > 24 | All arguments are omni-completed, but if you really want to see the online docs: 25 | http://docs.ansible.com/debug_module.html 26 | -------------------------------------------------------------------------------- /doc/mod.txt/digital_ocean_domain.txt: -------------------------------------------------------------------------------- 1 | SYNOPSIS *digital_ocean_domain* 2 | 3 | New in version 1.6. 4 | 5 | Create/delete a DNS record in DigitalOcean. 6 | 7 | EXAMPLES *digital_ocean_domain-examples* 8 | > 9 | # Create a domain record 10 | 11 | - digital_ocean_domain: > 12 | state=present 13 | name=my.digitalocean.domain 14 | ip=127.0.0.1 15 | 16 | # Create a droplet and a corresponding domain record 17 | 18 | - digital_ocean: > 19 | state=present 20 | name=test_droplet 21 | size_id=1 22 | region_id=2 23 | image_id=3 24 | register: test_droplet 25 | 26 | - digital_ocean_domain: > 27 | state=present 28 | name={{ test_droplet.droplet.name }}.my.domain 29 | ip={{ test_droplet.droplet.ip_address }} 30 | 31 | Note 32 | 33 | Two environment variables can be used, DO_CLIENT_ID and DO_API_KEY. 34 | 35 | MORE INFO *digital_ocean_domain-moreinfo* 36 | > 37 | All arguments are omni-completed, but if you really want to see the online docs: 38 | http://docs.ansible.com/digital_ocean_domain_module.html 39 | -------------------------------------------------------------------------------- /doc/mod.txt/digital_ocean_sshkey.txt: -------------------------------------------------------------------------------- 1 | SYNOPSIS *digital_ocean_sshkey* 2 | 3 | New in version 1.6. 4 | 5 | Create/delete an SSH key. 6 | 7 | EXAMPLES *digital_ocean_sshkey-examples* 8 | > 9 | # Ensure a SSH key is present 10 | # If a key matches this name, will return the ssh key id and changed = False 11 | # If no existing key matches this name, a new key is created, the ssh key id is returned and changed = False 12 | 13 | - digital_ocean_sshkey: > 14 | state=present 15 | name=my_ssh_key 16 | ssh_pub_key='ssh-rsa AAAA...' 17 | client_id=XXX 18 | api_key=XXX 19 | 20 | Note 21 | 22 | Two environment variables can be used, DO_CLIENT_ID and DO_API_KEY. 23 | 24 | MORE INFO *digital_ocean_sshkey-moreinfo* 25 | > 26 | All arguments are omni-completed, but if you really want to see the online docs: 27 | http://docs.ansible.com/digital_ocean_sshkey_module.html 28 | -------------------------------------------------------------------------------- /doc/mod.txt/dnf.txt: -------------------------------------------------------------------------------- 1 | SYNOPSIS *dnf* 2 | 3 | Installs, upgrade, removes, and lists packages and groups with the dnf package manager. 4 | 5 | EXAMPLES *dnf-examples* 6 | > 7 | - name: install the latest version of Apache 8 | dnf: name=httpd state=latest 9 | 10 | - name: remove the Apache package 11 | dnf: name=httpd state=absent 12 | 13 | - name: install the latest version of Apache from the testing repo 14 | dnf: name=httpd enablerepo=testing state=present 15 | 16 | - name: upgrade all packages 17 | dnf: name=* state=latest 18 | 19 | - name: install the nginx rpm from a remote repo 20 | dnf: name=http://nginx.org/packages/centos/6/noarch/RPMS/nginx-release-centos-6-0.el6.ngx.noarch.rpm state=present 21 | 22 | - name: install nginx rpm from a local file 23 | dnf: name=/usr/local/src/nginx-release-centos-6-0.el6.ngx.noarch.rpm state=present 24 | 25 | - name: install the 'Development tools' package group 26 | dnf: name="@Development tools" state=present 27 | 28 | MORE INFO *dnf-moreinfo* 29 | > 30 | All arguments are omni-completed, but if you really want to see the online docs: 31 | http://docs.ansible.com/dnf_module.html 32 | -------------------------------------------------------------------------------- /doc/mod.txt/dnsimple.txt: -------------------------------------------------------------------------------- 1 | SYNOPSIS *dnsimple* 2 | 3 | New in version 1.6. 4 | 5 | Manages domains and records via the DNSimple API, see the docs: http://developer.dnsimple.com/ 6 | 7 | EXAMPLES *dnsimple-examples* 8 | > 9 | # authenticate using email and API token 10 | - local_action: dnsimple account_email=[email protected] account_api_token=dummyapitoken 11 | 12 | # fetch all domains 13 | - local_action dnsimple 14 | register: domains 15 | 16 | # fetch my.com domain records 17 | - local_action: dnsimple domain=my.com state=present 18 | register: records 19 | 20 | # delete a domain 21 | - local_action: dnsimple domain=my.com state=absent 22 | 23 | # create a test.my.com A record to point to 127.0.0.01 24 | - local_action: dnsimple domain=my.com record=test type=A value=127.0.0.1 25 | register: record 26 | 27 | # and then delete it 28 | - local_action: dnsimple domain=my.com record_ids={{ record['id'] }} 29 | 30 | # create a my.com CNAME record to example.com 31 | - local_action: dnsimple domain=my.com record= type=CNAME value=example.com state=present 32 | 33 | # change it's ttl 34 | - local_action: dnsimple domain=my.com record= type=CNAME value=example.com ttl=600 state=present 35 | 36 | # and delete the record 37 | - local_action: dnsimpledomain=my.com record= type=CNAME value=example.com state=absent 38 | 39 | MORE INFO *dnsimple-moreinfo* 40 | > 41 | All arguments are omni-completed, but if you really want to see the online docs: 42 | http://docs.ansible.com/dnsimple_module.html 43 | -------------------------------------------------------------------------------- /doc/mod.txt/easy_install.txt: -------------------------------------------------------------------------------- 1 | SYNOPSIS *easy_install* 2 | 3 | Installs Python libraries, optionally in a virtualenv 4 | 5 | EXAMPLES *easy_install-examples* 6 | > 7 | # Examples from Ansible Playbooks 8 | - easy_install: name=pip 9 | 10 | # Install Bottle into the specified virtualenv. 11 | - easy_install: name=bottle virtualenv=/webapps/myapp/venv 12 | 13 | Note 14 | 15 | Please note that the easy_install module can only install Python libraries. Thus this module is not able to remove libraries. It is generally recommended to use the pip module which you can 16 | first install using easy_install. 17 | 18 | Note 19 | 20 | Also note that virtualenv must be installed on the remote host if the virtualenv parameter is specified. 21 | 22 | MORE INFO *easy_install-moreinfo* 23 | > 24 | All arguments are omni-completed, but if you really want to see the online docs: 25 | http://docs.ansible.com/easy_install_module.html 26 | -------------------------------------------------------------------------------- /doc/mod.txt/ec2_ami_search.txt: -------------------------------------------------------------------------------- 1 | SYNOPSIS *ec2_ami_search* 2 | 3 | New in version 1.6. 4 | 5 | Look up the most recent AMI on AWS for a given operating system. Returns ami, aki, ari, serial, tag If there is no AKI or ARI associated with an image, these will be null. Only supports images 6 | from cloud-images.ubuntu.com Example output: {"ami": "ami-69f5a900", "changed": false, "aki": "aki-88aa75e1", "tag": "release", "ari": null, "serial": "20131024"} 7 | 8 | EXAMPLES *ec2_ami_search-examples* 9 | > 10 | - name: Launch an Ubuntu 12.04 (Precise Pangolin) EC2 instance 11 | hosts: 127.0.0.1 12 | connection: local 13 | tasks: 14 | - name: Get the Ubuntu precise AMI 15 | ec2_ami_search: distro=ubuntu release=precise region=us-west-1 store=instance-store 16 | register: ubuntu_image 17 | - name: Start the EC2 instance 18 | ec2: image={{ ubuntu_image.ami }} instance_type=m1.small key_name=mykey 19 | 20 | MORE INFO *ec2_ami_search-moreinfo* 21 | > 22 | All arguments are omni-completed, but if you really want to see the online docs: 23 | http://docs.ansible.com/ec2_ami_search_module.html 24 | -------------------------------------------------------------------------------- /doc/mod.txt/ec2_facts.txt: -------------------------------------------------------------------------------- 1 | SYNOPSIS *ec2_facts* 2 | 3 | New in version 1.0. 4 | 5 | This module fetches data from the metadata servers in ec2 (aws) as per http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-metadata.html. The module must be called from within the 6 | EC2 instance itself. 7 | 8 | EXAMPLES *ec2_facts-examples* 9 | > 10 | # Conditional example 11 | - name: Gather facts 12 | action: ec2_facts 13 | 14 | - name: Conditional 15 | action: debug msg="This instance is a t1.micro" 16 | when: ansible_ec2_instance_type == "t1.micro" 17 | 18 | Note 19 | 20 | Parameters to filter on ec2_facts may be added later. 21 | 22 | MORE INFO *ec2_facts-moreinfo* 23 | > 24 | All arguments are omni-completed, but if you really want to see the online docs: 25 | http://docs.ansible.com/ec2_facts_module.html 26 | -------------------------------------------------------------------------------- /doc/mod.txt/ec2_lc.txt: -------------------------------------------------------------------------------- 1 | SYNOPSIS *ec2_lc* 2 | 3 | New in version 1.6. 4 | 5 | Can create or delete AwS Autoscaling Configurations Works with the ec2_asg module to manage Autoscaling Groups 6 | 7 | EXAMPLES *ec2_lc-examples* 8 | > 9 | - ec2_lc: 10 | name: special 11 | image_id: ami-XXX 12 | key_name: default 13 | security_groups: ['group', 'group2' ] 14 | instance_type: t1.micro 15 | 16 | Note 17 | 18 | Amazon ASG Autoscaling Launch Configurations are immutable once created, so modifying the configuration after it is changed will not modify the launch configuration on AWS. You must create a new 19 | config and assign it to the ASG instead. 20 | 21 | Note 22 | 23 | The following environment variables can be used AWS_ACCESS_KEY or EC2_ACCESS_KEY or AWS_ACCESS_KEY_ID, AWS_SECRET_KEY or EC2_SECRET_KEY or AWS_SECRET_ACCESS_KEY, AWS_REGION or EC2_REGION, 24 | AWS_SECURITY_TOKEN 25 | 26 | Note 27 | 28 | Ansible uses the boto configuration file (typically ~/.boto) if no credentials are provided. See http://boto.readthedocs.org/en/latest/boto_config_tut.html 29 | 30 | Note 31 | 32 | AWS_REGION or EC2_REGION can be typically be used to specify the AWS region, when required, but this can also be configured in the boto config file 33 | 34 | MORE INFO *ec2_lc-moreinfo* 35 | > 36 | All arguments are omni-completed, but if you really want to see the online docs: 37 | http://docs.ansible.com/ec2_lc_module.html 38 | -------------------------------------------------------------------------------- /doc/mod.txt/ec2_metric_alarm.txt: -------------------------------------------------------------------------------- 1 | SYNOPSIS *ec2_metric_alarm* 2 | 3 | New in version 1.6. 4 | 5 | Can create or delete AWS metric alarms Metrics you wish to alarm on must already exist 6 | 7 | EXAMPLES *ec2_metric_alarm-examples* 8 | > 9 | - name: create alarm 10 | ec2_metric_alarm: 11 | state: present 12 | region: ap-southeast-2 13 | name: "cpu-low" 14 | metric: "CPUUtilization" 15 | namespace: "AWS/EC2" 16 | statistic: Average 17 | comparison: "<=" 18 | threshold: 5.0 19 | period: 300 20 | evaluation_periods: 3 21 | unit: "Percent" 22 | description: "This will alarm when a bamboo slave's cpu usage average is lower than 5% for 15 minutes " 23 | dimensions: {'InstanceId':'i-XXX'} 24 | alarm_actions: ["action1","action2"] 25 | 26 | Note 27 | 28 | The following environment variables can be used AWS_ACCESS_KEY or EC2_ACCESS_KEY or AWS_ACCESS_KEY_ID, AWS_SECRET_KEY or EC2_SECRET_KEY or AWS_SECRET_ACCESS_KEY, AWS_REGION or EC2_REGION, 29 | AWS_SECURITY_TOKEN 30 | 31 | Note 32 | 33 | Ansible uses the boto configuration file (typically ~/.boto) if no credentials are provided. See http://boto.readthedocs.org/en/latest/boto_config_tut.html 34 | 35 | Note 36 | 37 | AWS_REGION or EC2_REGION can be typically be used to specify the AWS region, when required, but this can also be configured in the boto config file 38 | 39 | MORE INFO *ec2_metric_alarm-moreinfo* 40 | > 41 | All arguments are omni-completed, but if you really want to see the online docs: 42 | http://docs.ansible.com/ec2_metric_alarm_module.html 43 | -------------------------------------------------------------------------------- /doc/mod.txt/ec2_scaling_policy.txt: -------------------------------------------------------------------------------- 1 | SYNOPSIS *ec2_scaling_policy* 2 | 3 | New in version 1.6. 4 | 5 | Can create or delete scaling policies for autoscaling groups Referenced autoscaling groups must already exist 6 | 7 | EXAMPLES *ec2_scaling_policy-examples* 8 | > 9 | - ec2_scaling_policy: 10 | state: present 11 | region: US-XXX 12 | name: "scaledown-policy" 13 | adjustment_type: "ChangeInCapacity" 14 | asg_name: "slave-pool" 15 | scaling_adjustment: -1 16 | min_adjustment_step: 1 17 | cooldown: 300 18 | 19 | Note 20 | 21 | The following environment variables can be used AWS_ACCESS_KEY or EC2_ACCESS_KEY or AWS_ACCESS_KEY_ID, AWS_SECRET_KEY or EC2_SECRET_KEY or AWS_SECRET_ACCESS_KEY, AWS_REGION or EC2_REGION, 22 | AWS_SECURITY_TOKEN 23 | 24 | Note 25 | 26 | Ansible uses the boto configuration file (typically ~/.boto) if no credentials are provided. See http://boto.readthedocs.org/en/latest/boto_config_tut.html 27 | 28 | Note 29 | 30 | AWS_REGION or EC2_REGION can be typically be used to specify the AWS region, when required, but this can also be configured in the boto config file 31 | 32 | MORE INFO *ec2_scaling_policy-moreinfo* 33 | > 34 | All arguments are omni-completed, but if you really want to see the online docs: 35 | http://docs.ansible.com/ec2_scaling_policy_module.html 36 | -------------------------------------------------------------------------------- /doc/mod.txt/ejabberd_user.txt: -------------------------------------------------------------------------------- 1 | SYNOPSIS *ejabberd_user* 2 | 3 | New in version 1.5. 4 | 5 | This module provides user management for ejabberd servers 6 | 7 | EXAMPLES *ejabberd_user-examples* 8 | > 9 | Example playbook entries using the ejabberd_user module to manage users state. 10 | 11 | tasks: 12 | 13 | - name: create a user if it does not exists 14 | action: ejabberd_user username=test host=server password=password 15 | 16 | - name: delete a user if it exists 17 | action: ejabberd_user username=test host=server state=absent 18 | 19 | Note 20 | 21 | Password parameter is required for state == present only 22 | 23 | Note 24 | 25 | Passwords must be stored in clear text for this release 26 | 27 | Note 28 | 29 | The ejabberd configuration file must include mod_admin_extra as a module. 30 | 31 | MORE INFO *ejabberd_user-moreinfo* 32 | > 33 | All arguments are omni-completed, but if you really want to see the online docs: 34 | http://docs.ansible.com/ejabberd_user_module.html 35 | -------------------------------------------------------------------------------- /doc/mod.txt/elasticache.txt: -------------------------------------------------------------------------------- 1 | SYNOPSIS *elasticache* 2 | 3 | New in version 1.4. 4 | 5 | Manage cache clusters in Amazon Elasticache. Returns information about the specified cache cluster. 6 | 7 | EXAMPLES *elasticache-examples* 8 | > 9 | # Note: None of these examples set aws_access_key, aws_secret_key, or region. 10 | # It is assumed that their matching environment variables are set. 11 | 12 | # Basic example 13 | - elasticache: 14 | name: "test-please-delete" 15 | state: present 16 | engine: memcached 17 | cache_engine_version: 1.4.14 18 | node_type: cache.m1.small 19 | num_nodes: 1 20 | cache_port: 11211 21 | cache_security_groups: 22 | - default 23 | zone: us-east-1d 24 | 25 | 26 | # Ensure cache cluster is gone 27 | - elasticache: 28 | name: "test-please-delete" 29 | state: absent 30 | 31 | # Reboot cache cluster 32 | - elasticache: 33 | name: "test-please-delete" 34 | state: rebooted 35 | 36 | MORE INFO *elasticache-moreinfo* 37 | > 38 | All arguments are omni-completed, but if you really want to see the online docs: 39 | http://docs.ansible.com/elasticache_module.html 40 | -------------------------------------------------------------------------------- /doc/mod.txt/fail.txt: -------------------------------------------------------------------------------- 1 | SYNOPSIS *fail* 2 | 3 | This module fails the progress with a custom message. It can be useful for bailing out when a certain condition is met using when. 4 | 5 | EXAMPLES *fail-examples* 6 | > 7 | # Example playbook using fail and when together 8 | - fail: msg="The system may not be provisioned according to the CMDB status." 9 | when: cmdb_status != "to-be-staged" 10 | 11 | MORE INFO *fail-moreinfo* 12 | > 13 | All arguments are omni-completed, but if you really want to see the online docs: 14 | http://docs.ansible.com/fail_module.html 15 | -------------------------------------------------------------------------------- /doc/mod.txt/fetch.txt: -------------------------------------------------------------------------------- 1 | SYNOPSIS *fetch* 2 | 3 | This module works like copy, but in reverse. It is used for fetching files from remote machines and storing them locally in a file tree, organized by hostname. Note that this module is written 4 | to transfer log files that might not be present, so a missing remote file won’t be an error unless fail_on_missing is set to ‘yes’. 5 | 6 | EXAMPLES *fetch-examples* 7 | > 8 | # Store file into /tmp/fetched/host.example.com/tmp/somefile 9 | - fetch: src=/tmp/somefile dest=/tmp/fetched 10 | 11 | # Specifying a path directly 12 | - fetch: src=/tmp/somefile dest=/tmp/prefix-{{ ansible_hostname }} flat=yes 13 | 14 | # Specifying a destination path 15 | - fetch: src=/tmp/uniquefile dest=/tmp/special/ flat=yes 16 | 17 | # Storing in a path relative to the playbook 18 | - fetch: src=/tmp/uniquefile dest=special/prefix-{{ ansible_hostname }} flat=yes 19 | 20 | MORE INFO *fetch-moreinfo* 21 | > 22 | All arguments are omni-completed, but if you really want to see the online docs: 23 | http://docs.ansible.com/fetch_module.html 24 | -------------------------------------------------------------------------------- /doc/mod.txt/file.txt: -------------------------------------------------------------------------------- 1 | SYNOPSIS *file* 2 | 3 | Sets attributes of files, symlinks, and directories, or removes files/symlinks/directories. Many other modules support the same options as the file module - including copy, template, and 4 | assemble. 5 | 6 | EXAMPLES *file-examples* 7 | > 8 | - file: path=/etc/foo.conf owner=foo group=foo mode=0644 9 | - file: src=/file/to/link/to dest=/path/to/symlink owner=foo group=foo state=link 10 | - file: src=/tmp/{{ item.path }} dest={{ item.dest }} state=link 11 | with_items: 12 | - { path: 'x', dest: 'y' } 13 | - { path: 'z', dest: 'k' } 14 | 15 | # touch a file, using symbolic modes to set the permissions (equivalent to 0644) 16 | - file: path=/etc/foo.conf state=touch mode="u=rw,g=r,o=r" 17 | 18 | # touch the same file, but add/remove some permissions 19 | - file: path=/etc/foo.conf state=touch mode="u+rw,g-wx,o-rwx" 20 | 21 | Note 22 | 23 | See also copy, template, assemble 24 | 25 | MORE INFO *file-moreinfo* 26 | > 27 | All arguments are omni-completed, but if you really want to see the online docs: 28 | http://docs.ansible.com/file_module.html 29 | -------------------------------------------------------------------------------- /doc/mod.txt/filesystem.txt: -------------------------------------------------------------------------------- 1 | SYNOPSIS *filesystem* 2 | 3 | New in version 1.2. 4 | 5 | This module creates file system. 6 | 7 | EXAMPLES *filesystem-examples* 8 | > 9 | # Create a ext2 filesystem on /dev/sdb1. 10 | - filesystem: fstype=ext2 dev=/dev/sdb1 11 | 12 | # Create a ext4 filesystem on /dev/sdb1 and check disk blocks. 13 | - filesystem: fstype=ext4 dev=/dev/sdb1 opts="-cc" 14 | 15 | Note 16 | 17 | uses mkfs command 18 | 19 | MORE INFO *filesystem-moreinfo* 20 | > 21 | All arguments are omni-completed, but if you really want to see the online docs: 22 | http://docs.ansible.com/filesystem_module.html 23 | -------------------------------------------------------------------------------- /doc/mod.txt/fireball.txt: -------------------------------------------------------------------------------- 1 | SYNOPSIS *fireball* 2 | 3 | This modules launches an ephemeral fireball ZeroMQ message bus daemon on the remote node which Ansible can use to communicate with nodes at high speed. The daemon listens on a configurable port 4 | for a configurable amount of time. Starting a new fireball as a given user terminates any existing user fireballs. Fireball mode is AES encrypted 5 | 6 | EXAMPLES *fireball-examples* 7 | > 8 | # This example playbook has two plays: the first launches 'fireball' mode on all hosts via SSH, and 9 | # the second actually starts using it for subsequent management over the fireball connection 10 | 11 | - hosts: devservers 12 | gather_facts: false 13 | connection: ssh 14 | sudo: yes 15 | tasks: 16 | - action: fireball 17 | 18 | - hosts: devservers 19 | connection: fireball 20 | tasks: 21 | - command: /usr/bin/anything 22 | 23 | Note 24 | 25 | See the advanced playbooks chapter for more about using fireball mode. 26 | 27 | MORE INFO *fireball-moreinfo* 28 | > 29 | All arguments are omni-completed, but if you really want to see the online docs: 30 | http://docs.ansible.com/fireball_module.html 31 | -------------------------------------------------------------------------------- /doc/mod.txt/firewalld.txt: -------------------------------------------------------------------------------- 1 | SYNOPSIS *firewalld* 2 | 3 | New in version 1.4. 4 | 5 | This module allows for addition or deletion of services and ports either tcp or udp in either running or permanent firewalld rules 6 | 7 | EXAMPLES *firewalld-examples* 8 | > 9 | - firewalld: service=https permanent=true state=enabled 10 | - firewalld: port=8081/tcp permanent=true state=disabled 11 | - firewalld: zone=dmz service=http permanent=true state=enabled 12 | - firewalld: rich_rule='rule service name="ftp" audit limit value="1/m" accept' permanent=true state=enabled 13 | 14 | Note 15 | 16 | Not tested on any debian based system 17 | 18 | MORE INFO *firewalld-moreinfo* 19 | > 20 | All arguments are omni-completed, but if you really want to see the online docs: 21 | http://docs.ansible.com/firewalld_module.html 22 | -------------------------------------------------------------------------------- /doc/mod.txt/flowdock.txt: -------------------------------------------------------------------------------- 1 | SYNOPSIS *flowdock* 2 | 3 | New in version 1.2. 4 | 5 | Send a message to a flowdock team inbox or chat using the push API (see https://www.flowdock.com/api/team-inbox and https://www.flowdock.com/api/chat) 6 | 7 | EXAMPLES *flowdock-examples* 8 | > 9 | - flowdock: type=inbox 10 | token=AAAAAA 11 | from_address=[email protected] 12 | source='my cool app' 13 | msg='test from ansible' 14 | subject='test subject' 15 | 16 | - flowdock: type=chat 17 | token=AAAAAA 18 | external_user_name=testuser 19 | msg='test from ansible' 20 | tags=tag1,tag2,tag3 21 | 22 | MORE INFO *flowdock-moreinfo* 23 | > 24 | All arguments are omni-completed, but if you really want to see the online docs: 25 | http://docs.ansible.com/flowdock_module.html 26 | -------------------------------------------------------------------------------- /doc/mod.txt/gc_storage.txt: -------------------------------------------------------------------------------- 1 | SYNOPSIS *gc_storage* 2 | 3 | New in version 1.4. 4 | 5 | This module allows users to manage their objects/buckets in Google Cloud Storage. It allows upload and download operations and can set some canned permissions. It also allows retrieval of URLs 6 | for objects for use in playbooks, and retrieval of string contents of objects. This module requires setting the default project in GCS prior to playbook usage. See 7 | https://developers.google.com/storage/docs/reference/v1/apiversion1 for information about setting the default project. 8 | 9 | EXAMPLES *gc_storage-examples* 10 | > 11 | # upload some content 12 | - gc_storage: bucket=mybucket object=key.txt src=/usr/local/myfile.txt mode=put permission=public-read 13 | 14 | # download some content 15 | - gc_storage: bucket=mybucket object=key.txt dest=/usr/local/myfile.txt mode=get 16 | 17 | # Download an object as a string to use else where in your playbook 18 | - gc_storage: bucket=mybucket object=key.txt mode=get_str 19 | 20 | # Create an empty bucket 21 | - gc_storage: bucket=mybucket mode=create 22 | 23 | # Create a bucket with key as directory 24 | - gc_storage: bucket=mybucket object=/my/directory/path mode=create 25 | 26 | # Delete a bucket and all contents 27 | - gc_storage: bucket=mybucket mode=delete 28 | 29 | MORE INFO *gc_storage-moreinfo* 30 | > 31 | All arguments are omni-completed, but if you really want to see the online docs: 32 | http://docs.ansible.com/gc_storage_module.html 33 | -------------------------------------------------------------------------------- /doc/mod.txt/gce_lb.txt: -------------------------------------------------------------------------------- 1 | SYNOPSIS *gce_lb* 2 | 3 | New in version 1.5. 4 | 5 | This module can create and destroy Google Compute Engine loadbalancer and httphealthcheck resources. The primary LB resource is the load_balancer resource and the health check parameters are all 6 | prefixed with httphealthcheck. The full documentation for Google Compute Engine load balancing is at https://developers.google.com/compute/docs/load-balancing/. However, the ansible module 7 | simplifies the configuration by following the libcloud model. Full install/configuration instructions for the gce* modules can be found in the comments of ansible/test/gce_tests.py. 8 | 9 | EXAMPLES *gce_lb-examples* 10 | > 11 | # Simple example of creating a new LB, adding members, and a health check 12 | - local_action: 13 | module: gce_lb 14 | name: testlb 15 | region: us-central1 16 | members: ["us-central1-a/www-a", "us-central1-b/www-b"] 17 | httphealthcheck_name: hc 18 | httphealthcheck_port: 80 19 | httphealthcheck_path: "/up" 20 | 21 | MORE INFO *gce_lb-moreinfo* 22 | > 23 | All arguments are omni-completed, but if you really want to see the online docs: 24 | http://docs.ansible.com/gce_lb_module.html 25 | -------------------------------------------------------------------------------- /doc/mod.txt/gce_net.txt: -------------------------------------------------------------------------------- 1 | SYNOPSIS *gce_net* 2 | 3 | New in version 1.5. 4 | 5 | This module can create and destroy Google Compue Engine networks and firewall rules https://developers.google.com/compute/docs/networking. The name parameter is reserved for referencing a 6 | network while the fwname parameter is used to reference firewall rules. IPv4 Address ranges must be specified using the CIDR http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing format. 7 | Full install/configuration instructions for the gce* modules can be found in the comments of ansible/test/gce_tests.py. 8 | 9 | EXAMPLES *gce_net-examples* 10 | > 11 | # Simple example of creating a new network 12 | - local_action: 13 | module: gce_net 14 | name: privatenet 15 | ipv4_range: '10.240.16.0/24' 16 | 17 | # Simple example of creating a new firewall rule 18 | - local_action: 19 | module: gce_net 20 | name: privatenet 21 | fwname: all-web-webproxy 22 | allowed: tcp:80,8080 23 | src_tags: ["web", "proxy"] 24 | 25 | MORE INFO *gce_net-moreinfo* 26 | > 27 | All arguments are omni-completed, but if you really want to see the online docs: 28 | http://docs.ansible.com/gce_net_module.html 29 | -------------------------------------------------------------------------------- /doc/mod.txt/gce_pd.txt: -------------------------------------------------------------------------------- 1 | SYNOPSIS *gce_pd* 2 | 3 | New in version 1.4. 4 | 5 | This module can create and destroy unformatted GCE persistent disks https://developers.google.com/compute/docs/disks#persistentdisks. It also supports attaching and detaching disks from running 6 | instances. Full install/configuration instructions for the gce* modules can be found in the comments of ansible/test/gce_tests.py. 7 | 8 | EXAMPLES *gce_pd-examples* 9 | > 10 | # Simple attachment action to an existing instance 11 | - local_action: 12 | module: gce_pd 13 | instance_name: notlocalhost 14 | size_gb: 5 15 | name: pd 16 | 17 | MORE INFO *gce_pd-moreinfo* 18 | > 19 | All arguments are omni-completed, but if you really want to see the online docs: 20 | http://docs.ansible.com/gce_pd_module.html 21 | -------------------------------------------------------------------------------- /doc/mod.txt/gem.txt: -------------------------------------------------------------------------------- 1 | SYNOPSIS *gem* 2 | 3 | New in version 1.1. 4 | 5 | Manage installation and uninstallation of Ruby gems. 6 | 7 | EXAMPLES *gem-examples* 8 | > 9 | # Installs version 1.0 of vagrant. 10 | - gem: name=vagrant version=1.0 state=present 11 | 12 | # Installs latest available version of rake. 13 | - gem: name=rake state=latest 14 | 15 | # Installs rake version 1.0 from a local gem on disk. 16 | - gem: name=rake gem_source=/path/to/gems/rake-1.0.gem state=present 17 | 18 | MORE INFO *gem-moreinfo* 19 | > 20 | All arguments are omni-completed, but if you really want to see the online docs: 21 | http://docs.ansible.com/gem_module.html 22 | -------------------------------------------------------------------------------- /doc/mod.txt/get_url.txt: -------------------------------------------------------------------------------- 1 | SYNOPSIS *get_url* 2 | 3 | Downloads files from HTTP, HTTPS, or FTP to the remote server. The remote server must have direct access to the remote resource. By default, if an environment variable _proxy is set on 4 | the target host, requests will be sent through that proxy. This behaviour can be overridden by setting a variable for this task (see setting the environment), or by using the use_proxy option. 5 | 6 | EXAMPLES *get_url-examples* 7 | > 8 | - name: download foo.conf 9 | get_url: url=http://example.com/path/file.conf dest=/etc/foo.conf mode=0440 10 | 11 | - name: download file with sha256 check 12 | get_url: url=http://example.com/path/file.conf dest=/etc/foo.conf sha256sum=b5bb9d8014a0f9b1d61e21e796d78dccdf1352f23cd32812f4850b878ae4944c 13 | 14 | Note 15 | 16 | This module doesn’t yet support configuration for proxies. 17 | 18 | MORE INFO *get_url-moreinfo* 19 | > 20 | All arguments are omni-completed, but if you really want to see the online docs: 21 | http://docs.ansible.com/get_url_module.html 22 | -------------------------------------------------------------------------------- /doc/mod.txt/getent.txt: -------------------------------------------------------------------------------- 1 | SYNOPSIS *getent* 2 | 3 | New in version 1.8. 4 | 5 | Runs getent against one of it’s various databases and returns information into the host’s facts, in a getent_ prefixed variable 6 | 7 | EXAMPLES *getent-examples* 8 | > 9 | # get root user info 10 | - getent: database=passwd key=root 11 | - debug: var=getent_passwd 12 | 13 | # get all groups 14 | - getent: database=group split=':' 15 | - debug: var=getent_group 16 | 17 | # get all hosts, split by tab 18 | - getent: database=hosts 19 | - debug: var=getent_hosts 20 | 21 | # get http service info, no error if missing 22 | - getent: database=services key=http fail_key=False 23 | - debug: var=getent_services 24 | 25 | # get user password hash (requires sudo/root) 26 | - getent: database=shadow key=www-data split=: 27 | - debug: var=getent_shadow 28 | 29 | Note 30 | 31 | Not all databases support enumeration, check system documentation for details 32 | 33 | MORE INFO *getent-moreinfo* 34 | > 35 | All arguments are omni-completed, but if you really want to see the online docs: 36 | http://docs.ansible.com/getent_module.html 37 | -------------------------------------------------------------------------------- /doc/mod.txt/git.txt: -------------------------------------------------------------------------------- 1 | SYNOPSIS *git* 2 | 3 | Manage git checkouts of repositories to deploy files or software. 4 | 5 | EXAMPLES *git-examples* 6 | > 7 | # Example git checkout from Ansible Playbooks 8 | - git: repo=git://foosball.example.org/path/to/repo.git 9 | dest=/srv/checkout 10 | version=release-0.22 11 | 12 | # Example read-write git checkout from github 13 | - git: repo=ssh://[email protected]/mylogin/hello.git dest=/home/mylogin/hello 14 | 15 | # Example just ensuring the repo checkout exists 16 | - git: repo=git://foosball.example.org/path/to/repo.git dest=/srv/checkout update=no 17 | 18 | # Example just get information about the repository whether or not it has 19 | # already been cloned locally. 20 | - git: repo=git://foosball.example.org/path/to/repo.git dest=/srv/checkout clone=no update=no 21 | 22 | # Example checkout a github repo and use refspec to fetch all pull requests 23 | - git: repo=https://github.com/ansible/ansible-examples.git dest=/src/ansible-examples refspec=+refs/pull/*:refs/heads/* 24 | 25 | Note 26 | 27 | If the task seems to be hanging, first verify remote host is in known_hosts. SSH will prompt user to authorize the first contact with a remote host. To avoid this prompt, one solution is to add 28 | the remote host public key in /etc/ssh/ssh_known_hosts before calling the git module, with the following command: ssh-keyscan -H remote_host.com >> /etc/ssh/ssh_known_hosts. 29 | 30 | MORE INFO *git-moreinfo* 31 | > 32 | All arguments are omni-completed, but if you really want to see the online docs: 33 | http://docs.ansible.com/git_module.html 34 | -------------------------------------------------------------------------------- /doc/mod.txt/github_hooks.txt: -------------------------------------------------------------------------------- 1 | SYNOPSIS *github_hooks* 2 | 3 | New in version 1.4. 4 | 5 | Adds service hooks and removes service hooks that have an error status. 6 | 7 | EXAMPLES *github_hooks-examples* 8 | > 9 | # Example creating a new service hook. It ignores duplicates. 10 | - github_hooks: action=create hookurl=http://11.111.111.111:2222 user={{ gituser }} oauthkey={{ oauthkey }} repo=https://api.github.com/repos/pcgentry/Github-Auto-Deploy 11 | 12 | # Cleaning all hooks for this repo that had an error on the last update. Since this works for all hooks in a repo it is probably best that this would be called from a handler. 13 | - local_action: github_hooks action=cleanall user={{ gituser }} oauthkey={{ oauthkey }} repo={{ repo }} 14 | 15 | MORE INFO *github_hooks-moreinfo* 16 | > 17 | All arguments are omni-completed, but if you really want to see the online docs: 18 | http://docs.ansible.com/github_hooks_module.html 19 | -------------------------------------------------------------------------------- /doc/mod.txt/glance_image.txt: -------------------------------------------------------------------------------- 1 | SYNOPSIS *glance_image* 2 | 3 | New in version 1.2. 4 | 5 | Add or Remove images from the glance repository. 6 | 7 | EXAMPLES *glance_image-examples* 8 | > 9 | # Upload an image from an HTTP URL 10 | - glance_image: login_username=admin 11 | login_password=passme 12 | login_tenant_name=admin 13 | name=cirros 14 | container_format=bare 15 | disk_format=qcow2 16 | state=present 17 | copy_from=http:launchpad.net/cirros/trunk/0.3.0/+download/cirros-0.3.0-x86_64-disk.img 18 | 19 | MORE INFO *glance_image-moreinfo* 20 | > 21 | All arguments are omni-completed, but if you really want to see the online docs: 22 | http://docs.ansible.com/glance_image_module.html 23 | -------------------------------------------------------------------------------- /doc/mod.txt/gluster_volume.txt: -------------------------------------------------------------------------------- 1 | SYNOPSIS *gluster_volume* 2 | 3 | New in version 1.9. 4 | 5 | Create, remove, start, stop and tune GlusterFS volumes 6 | 7 | EXAMPLES *gluster_volume-examples* 8 | > 9 | - name: create gluster volume 10 | gluster_volume: state=present name=test1 brick=/bricks/brick1/g1 rebalance=yes hosts:"{{ play_hosts }}" 11 | run_once: true 12 | 13 | - name: tune 14 | gluster_volume: state=present name=test1 options='{performance.cache-size: 256MB}' 15 | 16 | - name: start gluster volume 17 | gluster_volume: status=started name=test1 18 | 19 | - name: limit usage 20 | gluster_volume: state=present name=test1 directory=/foo quota=20.0MB 21 | 22 | - name: stop gluster volume 23 | gluster_volume: state=stopped name=test1 24 | 25 | - name: remove gluster volume 26 | gluster_volume: state=absent name=test1 27 | 28 | Note 29 | 30 | Requires cli tools for GlusterFS on servers 31 | 32 | Note 33 | 34 | Will add new bricks, but not remove them 35 | 36 | MORE INFO *gluster_volume-moreinfo* 37 | > 38 | All arguments are omni-completed, but if you really want to see the online docs: 39 | http://docs.ansible.com/gluster_volume_module.html 40 | -------------------------------------------------------------------------------- /doc/mod.txt/group.txt: -------------------------------------------------------------------------------- 1 | SYNOPSIS *group* 2 | 3 | Manage presence of groups on a host. 4 | 5 | EXAMPLES *group-examples* 6 | > 7 | # Example group command from Ansible Playbooks 8 | - group: name=somegroup state=present 9 | 10 | MORE INFO *group-moreinfo* 11 | > 12 | All arguments are omni-completed, but if you really want to see the online docs: 13 | http://docs.ansible.com/group_module.html 14 | -------------------------------------------------------------------------------- /doc/mod.txt/group_by.txt: -------------------------------------------------------------------------------- 1 | SYNOPSIS *group_by* 2 | 3 | Use facts to create ad-hoc groups that can be used later in a playbook. 4 | 5 | EXAMPLES *group_by-examples* 6 | > 7 | # Create groups based on the machine architecture 8 | - group_by: key=machine_{{ ansible_machine }} 9 | # Create groups like 'kvm-host' 10 | - group_by: key=virt_{{ ansible_virtualization_type }}_{{ ansible_virtualization_role }} 11 | 12 | Note 13 | 14 | Spaces in group names are converted to dashes ‘-‘. 15 | 16 | MORE INFO *group_by-moreinfo* 17 | > 18 | All arguments are omni-completed, but if you really want to see the online docs: 19 | http://docs.ansible.com/group_by_module.html 20 | -------------------------------------------------------------------------------- /doc/mod.txt/grove.txt: -------------------------------------------------------------------------------- 1 | SYNOPSIS *grove* 2 | 3 | New in version 1.4. 4 | 5 | The grove module sends a message for a service to a Grove.io channel. 6 | 7 | EXAMPLES *grove-examples* 8 | > 9 | - grove: > 10 | channel_token=6Ph62VBBJOccmtTPZbubiPzdrhipZXtg 11 | service=my-app 12 | message=deployed {{ target }} 13 | 14 | MORE INFO *grove-moreinfo* 15 | > 16 | All arguments are omni-completed, but if you really want to see the online docs: 17 | http://docs.ansible.com/grove_module.html 18 | -------------------------------------------------------------------------------- /doc/mod.txt/hg.txt: -------------------------------------------------------------------------------- 1 | SYNOPSIS *hg* 2 | 3 | New in version 1.0. 4 | 5 | Manages Mercurial (hg) repositories. Supports SSH, HTTP/S and local address. 6 | 7 | EXAMPLES *hg-examples* 8 | > 9 | # Ensure the current working copy is inside the stable branch and deletes untracked files if any. 10 | - hg: repo=https://bitbucket.org/user/repo1 dest=/home/user/repo1 revision=stable purge=yes 11 | 12 | Note 13 | 14 | If the task seems to be hanging, first verify remote host is in known_hosts. SSH will prompt user to authorize the first contact with a remote host. To avoid this prompt, one solution is to add 15 | the remote host public key in /etc/ssh/ssh_known_hosts before calling the hg module, with the following command: ssh-keyscan remote_host.com >> /etc/ssh/ssh_known_hosts. 16 | 17 | MORE INFO *hg-moreinfo* 18 | > 19 | All arguments are omni-completed, but if you really want to see the online docs: 20 | http://docs.ansible.com/hg_module.html 21 | -------------------------------------------------------------------------------- /doc/mod.txt/hipchat.txt: -------------------------------------------------------------------------------- 1 | SYNOPSIS *hipchat* 2 | 3 | New in version 1.2. 4 | 5 | Send a message to hipchat 6 | 7 | EXAMPLES *hipchat-examples* 8 | > 9 | - hipchat: token=AAAAAA room=notify msg="Ansible task finished" 10 | 11 | MORE INFO *hipchat-moreinfo* 12 | > 13 | All arguments are omni-completed, but if you really want to see the online docs: 14 | http://docs.ansible.com/hipchat_module.html 15 | -------------------------------------------------------------------------------- /doc/mod.txt/homebrew.txt: -------------------------------------------------------------------------------- 1 | SYNOPSIS *homebrew* 2 | 3 | New in version 1.1. 4 | 5 | Manages Homebrew packages 6 | 7 | EXAMPLES *homebrew-examples* 8 | > 9 | - homebrew: name=foo state=present 10 | - homebrew: name=foo state=present update_homebrew=yes 11 | - homebrew: name=foo state=latest update_homebrew=yes 12 | - homebrew: update_homebrew=yes upgrade_all=yes 13 | - homebrew: name=foo state=head 14 | - homebrew: name=foo state=linked 15 | - homebrew: name=foo state=absent 16 | - homebrew: name=foo,bar state=absent 17 | - homebrew: name=foo state=present install_options=with-baz,enable-debug 18 | 19 | MORE INFO *homebrew-moreinfo* 20 | > 21 | All arguments are omni-completed, but if you really want to see the online docs: 22 | http://docs.ansible.com/homebrew_module.html 23 | -------------------------------------------------------------------------------- /doc/mod.txt/homebrew_cask.txt: -------------------------------------------------------------------------------- 1 | SYNOPSIS *homebrew_cask* 2 | 3 | New in version 1.6. 4 | 5 | Manages Homebrew casks. 6 | 7 | EXAMPLES *homebrew_cask-examples* 8 | > 9 | - homebrew_cask: name=alfred state=present 10 | - homebrew_cask: name=alfred state=absent 11 | 12 | MORE INFO *homebrew_cask-moreinfo* 13 | > 14 | All arguments are omni-completed, but if you really want to see the online docs: 15 | http://docs.ansible.com/homebrew_cask_module.html 16 | -------------------------------------------------------------------------------- /doc/mod.txt/homebrew_tap.txt: -------------------------------------------------------------------------------- 1 | SYNOPSIS *homebrew_tap* 2 | 3 | New in version 1.6. 4 | 5 | Tap external Homebrew repositories. 6 | 7 | EXAMPLES *homebrew_tap-examples* 8 | > 9 | homebrew_tap: tap=homebrew/dupes state=present 10 | homebrew_tap: tap=homebrew/dupes state=absent 11 | homebrew_tap: tap=homebrew/dupes,homebrew/science state=present 12 | 13 | MORE INFO *homebrew_tap-moreinfo* 14 | > 15 | All arguments are omni-completed, but if you really want to see the online docs: 16 | http://docs.ansible.com/homebrew_tap_module.html 17 | -------------------------------------------------------------------------------- /doc/mod.txt/hostname.txt: -------------------------------------------------------------------------------- 1 | SYNOPSIS *hostname* 2 | 3 | New in version 1.4. 4 | 5 | Set system’s hostname Currently implemented on Debian, Ubuntu, Fedora, RedHat, openSUSE, Linaro, ScientificLinux, Arch, CentOS, AMI. 6 | 7 | EXAMPLES *hostname-examples* 8 | > 9 | - hostname: name=web01 10 | 11 | MORE INFO *hostname-moreinfo* 12 | > 13 | All arguments are omni-completed, but if you really want to see the online docs: 14 | http://docs.ansible.com/hostname_module.html 15 | -------------------------------------------------------------------------------- /doc/mod.txt/htpasswd.txt: -------------------------------------------------------------------------------- 1 | SYNOPSIS *htpasswd* 2 | 3 | New in version 1.3. 4 | 5 | Add and remove username/password entries in a password file using htpasswd. This is used by web servers such as Apache and Nginx for basic authentication. 6 | 7 | EXAMPLES *htpasswd-examples* 8 | > 9 | # Add a user to a password file and ensure permissions are set 10 | - htpasswd: path=/etc/nginx/passwdfile name=janedoe password=9s36?;fyNp owner=root group=www-data mode=0640 11 | # Remove a user from a password file 12 | - htpasswd: path=/etc/apache2/passwdfile name=foobar state=absent 13 | 14 | Note 15 | 16 | This module depends on the passlib Python library, which needs to be installed on all target systems. 17 | 18 | Note 19 | 20 | On Debian, Ubuntu, or Fedora: install python-passlib. 21 | 22 | Note 23 | 24 | On RHEL or CentOS: Enable EPEL, then install python-passlib. 25 | 26 | MORE INFO *htpasswd-moreinfo* 27 | > 28 | All arguments are omni-completed, but if you really want to see the online docs: 29 | http://docs.ansible.com/htpasswd_module.html 30 | -------------------------------------------------------------------------------- /doc/mod.txt/include_vars.txt: -------------------------------------------------------------------------------- 1 | SYNOPSIS *include_vars* 2 | 3 | New in version 1.4. 4 | 5 | Loads variables from a YAML file dynamically during task runtime. It can work with conditionals, or use host specific variables to determine the path name to load from. 6 | 7 | EXAMPLES *include_vars-examples* 8 | > 9 | # Conditionally decide to load in variables when x is 0, otherwise do not. 10 | - include_vars: contingency_plan.yml 11 | when: x == 0 12 | 13 | # Load a variable file based on the OS type, or a default if not found. 14 | - include_vars: "{{ item }}" 15 | with_first_found: 16 | - "{{ ansible_distribution }}.yml" 17 | - "{{ ansible_os_family }}.yml" 18 | - "default.yml" 19 | 20 | MORE INFO *include_vars-moreinfo* 21 | > 22 | All arguments are omni-completed, but if you really want to see the online docs: 23 | http://docs.ansible.com/include_vars_module.html 24 | -------------------------------------------------------------------------------- /doc/mod.txt/ini_file.txt: -------------------------------------------------------------------------------- 1 | SYNOPSIS *ini_file* 2 | 3 | Manage (add, remove, change) individual settings in an INI-style file without having to manage the file as a whole with, say, template or assemble. Adds missing sections if they don’t exist. 4 | Comments are discarded when the source file is read, and therefore will not show up in the destination file. 5 | 6 | EXAMPLES *ini_file-examples* 7 | > 8 | # Ensure "fav=lemonade is in section "[drinks]" in specified file 9 | - ini_file: dest=/etc/conf section=drinks option=fav value=lemonade mode=0600 backup=yes 10 | 11 | - ini_file: dest=/etc/anotherconf 12 | section=drinks 13 | option=temperature 14 | value=cold 15 | backup=yes 16 | 17 | Note 18 | 19 | While it is possible to add an option without specifying a value, this makes no sense. 20 | 21 | Note 22 | 23 | A section named default cannot be added by the module, but if it exists, individual options within the section can be updated. (This is a limitation of Python’s ConfigParser.) Either use 24 | template to create a base INI file with a [default] section, or use lineinfile to add the missing line. 25 | 26 | MORE INFO *ini_file-moreinfo* 27 | > 28 | All arguments are omni-completed, but if you really want to see the online docs: 29 | http://docs.ansible.com/ini_file_module.html 30 | -------------------------------------------------------------------------------- /doc/mod.txt/irc.txt: -------------------------------------------------------------------------------- 1 | SYNOPSIS *irc* 2 | 3 | New in version 1.2. 4 | 5 | Send a message to an IRC channel. This is a very simplistic implementation. 6 | 7 | EXAMPLES *irc-examples* 8 | > 9 | - irc: server=irc.example.net channel="#t1" msg="Hello world" 10 | 11 | - local_action: irc port=6669 12 | channel="#t1" 13 | msg="All finished at {{ ansible_date_time.iso8601 }}" 14 | color=red 15 | nick=ansibleIRC 16 | 17 | MORE INFO *irc-moreinfo* 18 | > 19 | All arguments are omni-completed, but if you really want to see the online docs: 20 | http://docs.ansible.com/irc_module.html 21 | -------------------------------------------------------------------------------- /doc/mod.txt/jabber.txt: -------------------------------------------------------------------------------- 1 | SYNOPSIS *jabber* 2 | 3 | New in version 1.2. 4 | 5 | Send a message to jabber 6 | 7 | EXAMPLES *jabber-examples* 8 | > 9 | # send a message to a user 10 | - jabber: user=[email protected] 11 | password=secret 12 | to=[email protected] 13 | msg="Ansible task finished" 14 | 15 | # send a message to a room 16 | - jabber: user=[email protected] 17 | password=secret 18 | to=[email protected]/ansiblebot 19 | msg="Ansible task finished" 20 | 21 | # send a message, specifying the host and port 22 | - jabber user=[email protected] 23 | host=talk.example.net 24 | port=5223 25 | password=secret 26 | to=[email protected] 27 | msg="Ansible task finished" 28 | 29 | MORE INFO *jabber-moreinfo* 30 | > 31 | All arguments are omni-completed, but if you really want to see the online docs: 32 | http://docs.ansible.com/jabber_module.html 33 | -------------------------------------------------------------------------------- /doc/mod.txt/jboss.txt: -------------------------------------------------------------------------------- 1 | SYNOPSIS *jboss* 2 | 3 | New in version 1.4. 4 | 5 | Deploy applications to JBoss standalone using the filesystem 6 | 7 | EXAMPLES *jboss-examples* 8 | > 9 | # Deploy a hello world application 10 | - jboss: src=/tmp/hello-1.0-SNAPSHOT.war deployment=hello.war state=present 11 | # Update the hello world application 12 | - jboss: src=/tmp/hello-1.1-SNAPSHOT.war deployment=hello.war state=present 13 | # Undeploy the hello world application 14 | - jboss: deployment=hello.war state=absent 15 | 16 | Note 17 | 18 | The JBoss standalone deployment-scanner has to be enabled in standalone.xml 19 | 20 | Note 21 | 22 | Ensure no identically named application is deployed through the JBoss CLI 23 | 24 | MORE INFO *jboss-moreinfo* 25 | > 26 | All arguments are omni-completed, but if you really want to see the online docs: 27 | http://docs.ansible.com/jboss_module.html 28 | -------------------------------------------------------------------------------- /doc/mod.txt/kernel_blacklist.txt: -------------------------------------------------------------------------------- 1 | SYNOPSIS *kernel_blacklist* 2 | 3 | New in version 1.4. 4 | 5 | Add or remove kernel modules from blacklist. 6 | 7 | EXAMPLES *kernel_blacklist-examples* 8 | > 9 | # Blacklist the nouveau driver module 10 | - kernel_blacklist: name=nouveau state=present 11 | 12 | MORE INFO *kernel_blacklist-moreinfo* 13 | > 14 | All arguments are omni-completed, but if you really want to see the online docs: 15 | http://docs.ansible.com/kernel_blacklist_module.html 16 | -------------------------------------------------------------------------------- /doc/mod.txt/keystone_user.txt: -------------------------------------------------------------------------------- 1 | SYNOPSIS *keystone_user* 2 | 3 | New in version 1.2. 4 | 5 | Manage users,tenants, roles from OpenStack. 6 | 7 | EXAMPLES *keystone_user-examples* 8 | > 9 | # Create a tenant 10 | - keystone_user: tenant=demo tenant_description="Default Tenant" 11 | 12 | # Create a user 13 | - keystone_user: user=john tenant=demo password=secrete 14 | 15 | # Apply the admin role to the john user in the demo tenant 16 | - keystone_user: role=admin user=john tenant=demo 17 | 18 | MORE INFO *keystone_user-moreinfo* 19 | > 20 | All arguments are omni-completed, but if you really want to see the online docs: 21 | http://docs.ansible.com/keystone_user_module.html 22 | -------------------------------------------------------------------------------- /doc/mod.txt/layman.txt: -------------------------------------------------------------------------------- 1 | SYNOPSIS *layman* 2 | 3 | New in version 1.6. 4 | 5 | Uses Layman to manage an additional repositories for the Portage package manager on Gentoo Linux. Please note that Layman must be installed on a managed node prior using this module. 6 | 7 | EXAMPLES *layman-examples* 8 | > 9 | # Install the overlay 'mozilla' which is on the central overlays list. 10 | - layman: name=mozilla 11 | 12 | # Install the overlay 'cvut' from the specified alternative list. 13 | - layman: name=cvut list_url=http://raw.github.com/cvut/gentoo-overlay/master/overlay.xml 14 | 15 | # Update (sync) the overlay 'cvut', or install if not installed yet. 16 | - layman: name=cvut list_url=http://raw.github.com/cvut/gentoo-overlay/master/overlay.xml state=updated 17 | 18 | # Update (sync) all of the installed overlays. 19 | - layman: name=ALL state=updated 20 | 21 | # Uninstall the overlay 'cvut'. 22 | - layman: name=cvut state=absent 23 | 24 | MORE INFO *layman-moreinfo* 25 | > 26 | All arguments are omni-completed, but if you really want to see the online docs: 27 | http://docs.ansible.com/layman_module.html 28 | -------------------------------------------------------------------------------- /doc/mod.txt/librato_annotation.txt: -------------------------------------------------------------------------------- 1 | SYNOPSIS *librato_annotation* 2 | 3 | New in version 1.6. 4 | 5 | Create an annotation event on the given annotation stream :name. If the annotation stream does not exist, it will be created automatically 6 | 7 | EXAMPLES *librato_annotation-examples* 8 | > 9 | # Create a simple annotation event with a source 10 | - librato_annotation: 11 | user: [email protected] 12 | api_key: XXXXXXXXXXXXXXXXX 13 | title: 'App Config Change' 14 | source: 'foo.bar' 15 | description: 'This is a detailed description of the config change' 16 | 17 | # Create an annotation that includes a link 18 | - librato_annotation: 19 | user: [email protected] 20 | api_key: XXXXXXXXXXXXXXXXXX 21 | name: 'code.deploy' 22 | title: 'app code deploy' 23 | description: 'this is a detailed description of a deployment' 24 | links: 25 | - { rel: 'example', href: 'http://www.example.com/deploy' } 26 | 27 | # Create an annotation with a start_time and end_time 28 | - librato_annotation: 29 | user: [email protected] 30 | api_key: XXXXXXXXXXXXXXXXXX 31 | name: 'maintenance' 32 | title: 'Maintenance window' 33 | description: 'This is a detailed description of maintenance' 34 | start_time: 1395940006 35 | end_time: 1395954406 36 | 37 | MORE INFO *librato_annotation-moreinfo* 38 | > 39 | All arguments are omni-completed, but if you really want to see the online docs: 40 | http://docs.ansible.com/librato_annotation_module.html 41 | -------------------------------------------------------------------------------- /doc/mod.txt/locale_gen.txt: -------------------------------------------------------------------------------- 1 | SYNOPSIS *locale_gen* 2 | 3 | New in version 1.6. 4 | 5 | Manages locales by editing /etc/locale.gen and invoking locale-gen. 6 | 7 | EXAMPLES *locale_gen-examples* 8 | > 9 | # Ensure a locale exists. 10 | - locale_gen: name=de_CH.UTF-8 state=present 11 | 12 | MORE INFO *locale_gen-moreinfo* 13 | > 14 | All arguments are omni-completed, but if you really want to see the online docs: 15 | http://docs.ansible.com/locale_gen_module.html 16 | -------------------------------------------------------------------------------- /doc/mod.txt/logentries.txt: -------------------------------------------------------------------------------- 1 | SYNOPSIS *logentries* 2 | 3 | New in version 1.6. 4 | 5 | Sends logs to LogEntries in realtime 6 | 7 | EXAMPLES *logentries-examples* 8 | > 9 | - logentries: path=/var/log/nginx/access.log state=present 10 | - logentries: path=/var/log/nginx/error.log state=absent 11 | 12 | Note 13 | 14 | Requires the LogEntries agent which can be installed following the instructions at logentries.com 15 | 16 | MORE INFO *logentries-moreinfo* 17 | > 18 | All arguments are omni-completed, but if you really want to see the online docs: 19 | http://docs.ansible.com/logentries_module.html 20 | -------------------------------------------------------------------------------- /doc/mod.txt/lvg.txt: -------------------------------------------------------------------------------- 1 | SYNOPSIS *lvg* 2 | 3 | New in version 1.1. 4 | 5 | This module creates, removes or resizes volume groups. 6 | 7 | EXAMPLES *lvg-examples* 8 | > 9 | # Create a volume group on top of /dev/sda1 with physical extent size = 32MB. 10 | - lvg: vg=vg.services pvs=/dev/sda1 pesize=32 11 | 12 | # Create or resize a volume group on top of /dev/sdb1 and /dev/sdc5. 13 | # If, for example, we already have VG vg.services on top of /dev/sdb1, 14 | # this VG will be extended by /dev/sdc5. Or if vg.services was created on 15 | # top of /dev/sda5, we first extend it with /dev/sdb1 and /dev/sdc5, 16 | # and then reduce by /dev/sda5. 17 | - lvg: vg=vg.services pvs=/dev/sdb1,/dev/sdc5 18 | 19 | # Remove a volume group with name vg.services. 20 | - lvg: vg=vg.services state=absent 21 | 22 | Note 23 | 24 | module does not modify PE size for already present volume group 25 | 26 | MORE INFO *lvg-moreinfo* 27 | > 28 | All arguments are omni-completed, but if you really want to see the online docs: 29 | http://docs.ansible.com/lvg_module.html 30 | -------------------------------------------------------------------------------- /doc/mod.txt/lvol.txt: -------------------------------------------------------------------------------- 1 | SYNOPSIS *lvol* 2 | 3 | New in version 1.1. 4 | 5 | This module creates, removes or resizes logical volumes. 6 | 7 | EXAMPLES *lvol-examples* 8 | > 9 | # Create a logical volume of 512m. 10 | - lvol: vg=firefly lv=test size=512 11 | 12 | # Create a logical volume of 512g. 13 | - lvol: vg=firefly lv=test size=512g 14 | 15 | # Create a logical volume the size of all remaining space in the volume group 16 | - lvol: vg=firefly lv=test size=100%FREE 17 | 18 | # Extend the logical volume to 1024m. 19 | - lvol: vg=firefly lv=test size=1024 20 | 21 | # Reduce the logical volume to 512m 22 | - lvol: vg=firefly lv=test size=512 force=yes 23 | 24 | # Remove the logical volume. 25 | - lvol: vg=firefly lv=test state=absent force=yes 26 | 27 | Note 28 | 29 | Filesystems on top of the volume are not resized. 30 | 31 | MORE INFO *lvol-moreinfo* 32 | > 33 | All arguments are omni-completed, but if you really want to see the online docs: 34 | http://docs.ansible.com/lvol_module.html 35 | -------------------------------------------------------------------------------- /doc/mod.txt/macports.txt: -------------------------------------------------------------------------------- 1 | SYNOPSIS *macports* 2 | 3 | New in version 1.1. 4 | 5 | Manages MacPorts packages 6 | 7 | EXAMPLES *macports-examples* 8 | > 9 | - macports: name=foo state=present 10 | - macports: name=foo state=present update_cache=yes 11 | - macports: name=foo state=absent 12 | - macports: name=foo state=active 13 | - macports: name=foo state=inactive 14 | 15 | MORE INFO *macports-moreinfo* 16 | > 17 | All arguments are omni-completed, but if you really want to see the online docs: 18 | http://docs.ansible.com/macports_module.html 19 | -------------------------------------------------------------------------------- /doc/mod.txt/modprobe.txt: -------------------------------------------------------------------------------- 1 | SYNOPSIS *modprobe* 2 | 3 | New in version 1.4. 4 | 5 | Add or remove kernel modules. 6 | 7 | EXAMPLES *modprobe-examples* 8 | > 9 | # Add the 802.1q module 10 | - modprobe: name=8021q state=present 11 | # Add the dummy module 12 | - modprobe: name=dummy state=present params="numdummies=2" 13 | 14 | MORE INFO *modprobe-moreinfo* 15 | > 16 | All arguments are omni-completed, but if you really want to see the online docs: 17 | http://docs.ansible.com/modprobe_module.html 18 | -------------------------------------------------------------------------------- /doc/mod.txt/monit.txt: -------------------------------------------------------------------------------- 1 | SYNOPSIS *monit* 2 | 3 | New in version 1.2. 4 | 5 | Manage the state of a program monitored via Monit 6 | 7 | EXAMPLES *monit-examples* 8 | > 9 | # Manage the state of program "httpd" to be in "started" state. 10 | - monit: name=httpd state=started 11 | 12 | MORE INFO *monit-moreinfo* 13 | > 14 | All arguments are omni-completed, but if you really want to see the online docs: 15 | http://docs.ansible.com/monit_module.html 16 | -------------------------------------------------------------------------------- /doc/mod.txt/mount.txt: -------------------------------------------------------------------------------- 1 | SYNOPSIS *mount* 2 | 3 | This module controls active and configured mount points in /etc/fstab. 4 | 5 | EXAMPLES *mount-examples* 6 | > 7 | # Mount DVD read-only 8 | - mount: name=/mnt/dvd src=/dev/sr0 fstype=iso9660 opts=ro state=present 9 | 10 | # Mount up device by label 11 | - mount: name=/srv/disk src='LABEL=SOME_LABEL' fstype=ext4 state=present 12 | 13 | # Mount up device by UUID 14 | - mount: name=/home src='UUID=b3e48f45-f933-4c8e-a700-22a159ec9077' fstype=xfs opts=noatime state=present 15 | 16 | MORE INFO *mount-moreinfo* 17 | > 18 | All arguments are omni-completed, but if you really want to see the online docs: 19 | http://docs.ansible.com/mount_module.html 20 | -------------------------------------------------------------------------------- /doc/mod.txt/mqtt.txt: -------------------------------------------------------------------------------- 1 | SYNOPSIS *mqtt* 2 | 3 | New in version 1.2. 4 | 5 | Publish a message on an MQTT topic. 6 | 7 | EXAMPLES *mqtt-examples* 8 | > 9 | - local_action: mqtt 10 | topic=service/ansible/{{ ansible_hostname }} 11 | payload="Hello at {{ ansible_date_time.iso8601 }}" 12 | qos=0 13 | retain=false 14 | client_id=ans001 15 | 16 | Note 17 | 18 | This module requires a connection to an MQTT broker such as Mosquitto http://mosquitto.org and the Paho mqtt Python client (https://pypi.python.org/pypi/paho-mqtt). 19 | 20 | MORE INFO *mqtt-moreinfo* 21 | > 22 | All arguments are omni-completed, but if you really want to see the online docs: 23 | http://docs.ansible.com/mqtt_module.html 24 | -------------------------------------------------------------------------------- /doc/mod.txt/mysql_db.txt: -------------------------------------------------------------------------------- 1 | SYNOPSIS *mysql_db* 2 | 3 | Add or remove MySQL databases from a remote host. 4 | 5 | EXAMPLES *mysql_db-examples* 6 | > 7 | # Create a new database with name 'bobdata' 8 | - mysql_db: name=bobdata state=present 9 | 10 | # Copy database dump file to remote host and restore it to database 'my_db' 11 | - copy: src=dump.sql.bz2 dest=/tmp 12 | - mysql_db: name=my_db state=import target=/tmp/dump.sql.bz2 13 | 14 | Note 15 | 16 | Requires the MySQLdb Python package on the remote host. For Ubuntu, this is as easy as apt-get install python-mysqldb. (See apt.) 17 | 18 | Note 19 | 20 | Both login_password and login_user are required when you are passing credentials. If none are present, the module will attempt to read the credentials from ~/.my.cnf, and finally fall back to 21 | using the MySQL default login of root with no password. 22 | 23 | MORE INFO *mysql_db-moreinfo* 24 | > 25 | All arguments are omni-completed, but if you really want to see the online docs: 26 | http://docs.ansible.com/mysql_db_module.html 27 | -------------------------------------------------------------------------------- /doc/mod.txt/mysql_replication.txt: -------------------------------------------------------------------------------- 1 | SYNOPSIS *mysql_replication* 2 | 3 | New in version 1.3. 4 | 5 | Manages MySQL server replication, slave, master status get and change master host. 6 | 7 | EXAMPLES *mysql_replication-examples* 8 | > 9 | # Stop mysql slave thread 10 | - mysql_replication: mode=stopslave 11 | 12 | # Get master binlog file name and binlog position 13 | - mysql_replication: mode=getmaster 14 | 15 | # Change master to master server 192.168.1.1 and use binary log 'mysql-bin.000009' with position 4578 16 | - mysql_replication: mode=changemaster master_host=192.168.1.1 master_log_file=mysql-bin.000009 master_log_pos=4578 17 | 18 | MORE INFO *mysql_replication-moreinfo* 19 | > 20 | All arguments are omni-completed, but if you really want to see the online docs: 21 | http://docs.ansible.com/mysql_replication_module.html 22 | -------------------------------------------------------------------------------- /doc/mod.txt/mysql_variables.txt: -------------------------------------------------------------------------------- 1 | SYNOPSIS *mysql_variables* 2 | 3 | New in version 1.3. 4 | 5 | Query / Set MySQL variables 6 | 7 | EXAMPLES *mysql_variables-examples* 8 | > 9 | # Check for sync_binlog setting 10 | - mysql_variables: variable=sync_binlog 11 | 12 | # Set read_only variable to 1 13 | - mysql_variables: variable=read_only value=1 14 | 15 | MORE INFO *mysql_variables-moreinfo* 16 | > 17 | All arguments are omni-completed, but if you really want to see the online docs: 18 | http://docs.ansible.com/mysql_variables_module.html 19 | -------------------------------------------------------------------------------- /doc/mod.txt/netscaler.txt: -------------------------------------------------------------------------------- 1 | SYNOPSIS *netscaler* 2 | 3 | New in version 1.1. 4 | 5 | Manages Citrix NetScaler server and service entities. 6 | 7 | EXAMPLES *netscaler-examples* 8 | > 9 | # Disable the server 10 | ansible host -m netscaler -a "nsc_host=nsc.example.com user=apiuser password=apipass" 11 | 12 | # Enable the server 13 | ansible host -m netscaler -a "nsc_host=nsc.example.com user=apiuser password=apipass action=enable" 14 | 15 | # Disable the service local:8080 16 | ansible host -m netscaler -a "nsc_host=nsc.example.com user=apiuser password=apipass name=local:8080 type=service action=disable" 17 | 18 | MORE INFO *netscaler-moreinfo* 19 | > 20 | All arguments are omni-completed, but if you really want to see the online docs: 21 | http://docs.ansible.com/netscaler_module.html 22 | -------------------------------------------------------------------------------- /doc/mod.txt/newrelic_deployment.txt: -------------------------------------------------------------------------------- 1 | SYNOPSIS *newrelic_deployment* 2 | 3 | New in version 1.2. 4 | 5 | Notify newrelic about app deployments (see http://newrelic.github.io/newrelic_api/NewRelicApi/Deployment.html) 6 | 7 | EXAMPLES *newrelic_deployment-examples* 8 | > 9 | - newrelic_deployment: token=AAAAAA 10 | app_name=myapp 11 | user='ansible deployment' 12 | revision=1.0 13 | 14 | MORE INFO *newrelic_deployment-moreinfo* 15 | > 16 | All arguments are omni-completed, but if you really want to see the online docs: 17 | http://docs.ansible.com/newrelic_deployment_module.html 18 | -------------------------------------------------------------------------------- /doc/mod.txt/nexmo.txt: -------------------------------------------------------------------------------- 1 | SYNOPSIS *nexmo* 2 | 3 | New in version 1.6. 4 | 5 | Send a SMS message via nexmo 6 | 7 | EXAMPLES *nexmo-examples* 8 | > 9 | - name: Send notification message via Nexmo 10 | local_action: 11 | module: nexmo 12 | api_key: 640c8a53 13 | api_secret: 0ce239a6 14 | src: 12345678901 15 | dest: 16 | - 10987654321 17 | - 16789012345 18 | msg: "{{ inventory_hostname }} completed" 19 | 20 | MORE INFO *nexmo-moreinfo* 21 | > 22 | All arguments are omni-completed, but if you really want to see the online docs: 23 | http://docs.ansible.com/nexmo_module.html 24 | -------------------------------------------------------------------------------- /doc/mod.txt/nova_keypair.txt: -------------------------------------------------------------------------------- 1 | SYNOPSIS *nova_keypair* 2 | 3 | New in version 1.2. 4 | 5 | Add or Remove key pair from nova . 6 | 7 | EXAMPLES *nova_keypair-examples* 8 | > 9 | # Creates a key pair with the running users public key 10 | - nova_keypair: state=present login_username=admin 11 | login_password=admin login_tenant_name=admin name=ansible_key 12 | public_key={{ lookup('file','~/.ssh/id_rsa.pub') }} 13 | 14 | # Creates a new key pair and the private key returned after the run. 15 | - nova_keypair: state=present login_username=admin login_password=admin 16 | login_tenant_name=admin name=ansible_key 17 | 18 | MORE INFO *nova_keypair-moreinfo* 19 | > 20 | All arguments are omni-completed, but if you really want to see the online docs: 21 | http://docs.ansible.com/nova_keypair_module.html 22 | -------------------------------------------------------------------------------- /doc/mod.txt/npm.txt: -------------------------------------------------------------------------------- 1 | SYNOPSIS *npm* 2 | 3 | New in version 1.2. 4 | 5 | Manage node.js packages with Node Package Manager (npm) 6 | 7 | EXAMPLES *npm-examples* 8 | > 9 | description: Install "coffee-script" node.js package. 10 | - npm: name=coffee-script path=/app/location 11 | 12 | description: Install "coffee-script" node.js package on version 1.6.1. 13 | - npm: name=coffee-script version=1.6.1 path=/app/location 14 | 15 | description: Install "coffee-script" node.js package globally. 16 | - npm: name=coffee-script global=yes 17 | 18 | description: Remove the globally package "coffee-script". 19 | - npm: name=coffee-script global=yes state=absent 20 | 21 | description: Install "coffee-script" node.js package from custom registry. 22 | - npm: name=coffee-script registry=http://registry.mysite.com 23 | 24 | description: Install packages based on package.json. 25 | - npm: path=/app/location 26 | 27 | description: Update packages based on package.json to their latest version. 28 | - npm: path=/app/location state=latest 29 | 30 | description: Install packages based on package.json using the npm installed with nvm v0.10.1. 31 | - npm: path=/app/location executable=/opt/nvm/v0.10.1/bin/npm state=present 32 | 33 | MORE INFO *npm-moreinfo* 34 | > 35 | All arguments are omni-completed, but if you really want to see the online docs: 36 | http://docs.ansible.com/npm_module.html 37 | -------------------------------------------------------------------------------- /doc/mod.txt/open_iscsi.txt: -------------------------------------------------------------------------------- 1 | SYNOPSIS *open_iscsi* 2 | 3 | New in version 1.4. 4 | 5 | Discover targets on given portal, (dis)connect targets, mark targets to manually or auto start, return device nodes of connected targets. 6 | 7 | EXAMPLES *open_iscsi-examples* 8 | > 9 | perform a discovery on 10.1.2.3 and show available target nodes 10 | 11 | open_iscsi: show_nodes=yes discover=yes portal=10.1.2.3 12 | 13 | discover targets on portal and login to the one available (only works if exactly one target is exported to the initiator) 14 | 15 | open_iscsi: portal={{iscsi_target}} login=yes discover=yes 16 | 17 | connect to the named target, after updating the local persistent database (cache) 18 | 19 | open_iscsi: login=yes target=iqn.1986-03.com.sun:02:f8c1f9e0-c3ec-ec84-c9c9-8bfb0cd5de3d 20 | 21 | discconnect from the cached named target 22 | 23 | open_iscsi: login=no target=iqn.1986-03.com.sun:02:f8c1f9e0-c3ec-ec84-c9c9-8bfb0cd5de3d" 24 | 25 | MORE INFO *open_iscsi-moreinfo* 26 | > 27 | All arguments are omni-completed, but if you really want to see the online docs: 28 | http://docs.ansible.com/open_iscsi_module.html 29 | -------------------------------------------------------------------------------- /doc/mod.txt/openbsd_pkg.txt: -------------------------------------------------------------------------------- 1 | SYNOPSIS *openbsd_pkg* 2 | 3 | New in version 1.1. 4 | 5 | Manage packages on OpenBSD using the pkg tools. 6 | 7 | EXAMPLES *openbsd_pkg-examples* 8 | > 9 | # Make sure nmap is installed 10 | - openbsd_pkg: name=nmap state=present 11 | 12 | # Make sure nmap is the latest version 13 | - openbsd_pkg: name=nmap state=latest 14 | 15 | # Make sure nmap is not installed 16 | - openbsd_pkg: name=nmap state=absent 17 | 18 | # Specify a pkg flavour with '--' 19 | - openbsd_pkg: name=vim--nox11 state=present 20 | 21 | # Specify the default flavour to avoid ambiguity errors 22 | - openbsd_pkg: name=vim-- state=present 23 | 24 | # Update all packages on the system 25 | - openbsd_pkg: name=* state=latest 26 | 27 | MORE INFO *openbsd_pkg-moreinfo* 28 | > 29 | All arguments are omni-completed, but if you really want to see the online docs: 30 | http://docs.ansible.com/openbsd_pkg_module.html 31 | -------------------------------------------------------------------------------- /doc/mod.txt/openvswitch_bridge.txt: -------------------------------------------------------------------------------- 1 | SYNOPSIS *openvswitch_bridge* 2 | 3 | New in version 1.4. 4 | 5 | Manage Open vSwitch bridges 6 | 7 | EXAMPLES *openvswitch_bridge-examples* 8 | > 9 | # Create a bridge named br-int 10 | - openvswitch_bridge: bridge=br-int state=present 11 | 12 | MORE INFO *openvswitch_bridge-moreinfo* 13 | > 14 | All arguments are omni-completed, but if you really want to see the online docs: 15 | http://docs.ansible.com/openvswitch_bridge_module.html 16 | -------------------------------------------------------------------------------- /doc/mod.txt/openvswitch_port.txt: -------------------------------------------------------------------------------- 1 | SYNOPSIS *openvswitch_port* 2 | 3 | New in version 1.4. 4 | 5 | Manage Open vSwitch ports 6 | 7 | EXAMPLES *openvswitch_port-examples* 8 | > 9 | # Creates port eth2 on bridge br-ex 10 | - openvswitch_port: bridge=br-ex port=eth2 state=present 11 | 12 | MORE INFO *openvswitch_port-moreinfo* 13 | > 14 | All arguments are omni-completed, but if you really want to see the online docs: 15 | http://docs.ansible.com/openvswitch_port_module.html 16 | -------------------------------------------------------------------------------- /doc/mod.txt/opkg.txt: -------------------------------------------------------------------------------- 1 | SYNOPSIS *opkg* 2 | 3 | New in version 1.1. 4 | 5 | Manages OpenWrt packages 6 | 7 | EXAMPLES *opkg-examples* 8 | > 9 | - opkg: name=foo state=present 10 | - opkg: name=foo state=present update_cache=yes 11 | - opkg: name=foo state=absent 12 | - opkg: name=foo,bar state=absent 13 | 14 | MORE INFO *opkg-moreinfo* 15 | > 16 | All arguments are omni-completed, but if you really want to see the online docs: 17 | http://docs.ansible.com/opkg_module.html 18 | -------------------------------------------------------------------------------- /doc/mod.txt/osx_say.txt: -------------------------------------------------------------------------------- 1 | SYNOPSIS *osx_say* 2 | 3 | New in version 1.2. 4 | 5 | makes an OS computer speak! Amuse your friends, annoy your coworkers! 6 | 7 | EXAMPLES *osx_say-examples* 8 | > 9 | - local_action: osx_say msg="{{inventory_hostname}} is all done" voice=Zarvox 10 | 11 | Note 12 | 13 | If you like this module, you may also be interested in the osx_say callback in the plugins/ directory of the source checkout. 14 | 15 | MORE INFO *osx_say-moreinfo* 16 | > 17 | All arguments are omni-completed, but if you really want to see the online docs: 18 | http://docs.ansible.com/osx_say_module.html 19 | -------------------------------------------------------------------------------- /doc/mod.txt/pacman.txt: -------------------------------------------------------------------------------- 1 | SYNOPSIS *pacman* 2 | 3 | New in version 1.0. 4 | 5 | Manage packages with the pacman package manager, which is used by Arch Linux and its variants. 6 | 7 | EXAMPLES *pacman-examples* 8 | > 9 | # Install package foo 10 | - pacman: name=foo state=present 11 | 12 | # Remove packages foo and bar 13 | - pacman: name=foo,bar state=absent 14 | 15 | # Recursively remove package baz 16 | - pacman: name=baz state=absent recurse=yes 17 | 18 | # Run the equivalent of "pacman -Syy" as a separate step 19 | - pacman: update_cache=yes 20 | 21 | MORE INFO *pacman-moreinfo* 22 | > 23 | All arguments are omni-completed, but if you really want to see the online docs: 24 | http://docs.ansible.com/pacman_module.html 25 | -------------------------------------------------------------------------------- /doc/mod.txt/pause.txt: -------------------------------------------------------------------------------- 1 | SYNOPSIS *pause* 2 | 3 | Pauses playbook execution for a set amount of time, or until a prompt is acknowledged. All parameters are optional. The default behavior is to pause with a prompt. You can use ctrl+c if you wish 4 | to advance a pause earlier than it is set to expire or if you need to abort a playbook run entirely. To continue early: press ctrl+c and then c. To abort a playbook: press ctrl+c and then a. The 5 | pause module integrates into async/parallelized playbooks without any special considerations (see also: Rolling Updates). When using pauses with the serial playbook parameter (as in rolling 6 | updates) you are only prompted once for the current group of hosts. 7 | 8 | EXAMPLES *pause-examples* 9 | > 10 | # Pause for 5 minutes to build app cache. 11 | - pause: minutes=5 12 | 13 | # Pause until you can verify updates to an application were successful. 14 | - pause: 15 | 16 | # A helpful reminder of what to look out for post-update. 17 | - pause: prompt="Make sure org.foo.FooOverload exception is not present" 18 | 19 | MORE INFO *pause-moreinfo* 20 | > 21 | All arguments are omni-completed, but if you really want to see the online docs: 22 | http://docs.ansible.com/pause_module.html 23 | -------------------------------------------------------------------------------- /doc/mod.txt/pingdom.txt: -------------------------------------------------------------------------------- 1 | SYNOPSIS *pingdom* 2 | 3 | New in version 1.2. 4 | 5 | This module will let you pause/unpause Pingdom alerts 6 | 7 | EXAMPLES *pingdom-examples* 8 | > 9 | # Pause the check with the ID of 12345. 10 | - pingdom: uid=[email protected] 11 | passwd=password123 12 | key=apipassword123 13 | checkid=12345 14 | state=paused 15 | 16 | # Unpause the check with the ID of 12345. 17 | - pingdom: uid=[email protected] 18 | passwd=password123 19 | key=apipassword123 20 | checkid=12345 21 | state=running 22 | 23 | Note 24 | 25 | This module does not yet have support to add/remove checks. 26 | 27 | MORE INFO *pingdom-moreinfo* 28 | > 29 | All arguments are omni-completed, but if you really want to see the online docs: 30 | http://docs.ansible.com/pingdom_module.html 31 | -------------------------------------------------------------------------------- /doc/mod.txt/pkgin.txt: -------------------------------------------------------------------------------- 1 | SYNOPSIS *pkgin* 2 | 3 | New in version 1.0. 4 | 5 | Manages SmartOS packages 6 | 7 | EXAMPLES *pkgin-examples* 8 | > 9 | # install package foo" 10 | - pkgin: name=foo state=present 11 | 12 | # remove package foo 13 | - pkgin: name=foo state=absent 14 | 15 | # remove packages foo and bar 16 | - pkgin: name=foo,bar state=absent 17 | 18 | MORE INFO *pkgin-moreinfo* 19 | > 20 | All arguments are omni-completed, but if you really want to see the online docs: 21 | http://docs.ansible.com/pkgin_module.html 22 | -------------------------------------------------------------------------------- /doc/mod.txt/pkgng.txt: -------------------------------------------------------------------------------- 1 | SYNOPSIS *pkgng* 2 | 3 | New in version 1.2. 4 | 5 | Manage binary packages for FreeBSD using ‘pkgng’ which is available in versions after 9.0. 6 | 7 | EXAMPLES *pkgng-examples* 8 | > 9 | # Install package foo 10 | - pkgng: name=foo state=present 11 | 12 | # Annotate package foo and bar 13 | - pkgng: name=foo,bar annotation=+test1=baz,-test2,:test3=foobar 14 | 15 | # Remove packages foo and bar 16 | - pkgng: name=foo,bar state=absent 17 | 18 | Note 19 | 20 | When using pkgsite, be careful that already in cache packages won’t be downloaded again. 21 | 22 | MORE INFO *pkgng-moreinfo* 23 | > 24 | All arguments are omni-completed, but if you really want to see the online docs: 25 | http://docs.ansible.com/pkgng_module.html 26 | -------------------------------------------------------------------------------- /doc/mod.txt/pkgutil.txt: -------------------------------------------------------------------------------- 1 | SYNOPSIS *pkgutil* 2 | 3 | New in version 1.3. 4 | 5 | Manages CSW packages (SVR4 format) on Solaris 10 and 11. These were the native packages on Solaris <= 10 and are available as a legacy feature in Solaris 11. Pkgutil is an advanced packaging 6 | system, which resolves dependency on installation. It is designed for CSW packages. 7 | 8 | EXAMPLES *pkgutil-examples* 9 | > 10 | # Install a package 11 | pkgutil: name=CSWcommon state=present 12 | 13 | # Install a package from a specific repository 14 | pkgutil: name=CSWnrpe site='ftp://myinternal.repo/opencsw/kiel state=latest' 15 | 16 | MORE INFO *pkgutil-moreinfo* 17 | > 18 | All arguments are omni-completed, but if you really want to see the online docs: 19 | http://docs.ansible.com/pkgutil_module.html 20 | -------------------------------------------------------------------------------- /doc/mod.txt/portage.txt: -------------------------------------------------------------------------------- 1 | SYNOPSIS *portage* 2 | 3 | New in version 1.6. 4 | 5 | Manages Gentoo packages 6 | 7 | EXAMPLES *portage-examples* 8 | > 9 | # Make sure package foo is installed 10 | - portage: package=foo state=present 11 | 12 | # Make sure package foo is not installed 13 | - portage: package=foo state=absent 14 | 15 | # Update package foo to the "best" version 16 | - portage: package=foo update=yes 17 | 18 | # Sync repositories and update world 19 | - portage: package=@world update=yes deep=yes sync=yes 20 | 21 | # Remove unneeded packages 22 | - portage: depclean=yes 23 | 24 | # Remove package foo if it is not explicitly needed 25 | - portage: package=foo state=absent depclean=yes 26 | 27 | MORE INFO *portage-moreinfo* 28 | > 29 | All arguments are omni-completed, but if you really want to see the online docs: 30 | http://docs.ansible.com/portage_module.html 31 | -------------------------------------------------------------------------------- /doc/mod.txt/portinstall.txt: -------------------------------------------------------------------------------- 1 | SYNOPSIS *portinstall* 2 | 3 | New in version 1.3. 4 | 5 | Manage packages for FreeBSD using ‘portinstall’. 6 | 7 | EXAMPLES *portinstall-examples* 8 | > 9 | # Install package foo 10 | - portinstall: name=foo state=present 11 | 12 | # Install package security/cyrus-sasl2-saslauthd 13 | - portinstall: name=security/cyrus-sasl2-saslauthd state=present 14 | 15 | # Remove packages foo and bar 16 | - portinstall: name=foo,bar state=absent 17 | 18 | MORE INFO *portinstall-moreinfo* 19 | > 20 | All arguments are omni-completed, but if you really want to see the online docs: 21 | http://docs.ansible.com/portinstall_module.html 22 | -------------------------------------------------------------------------------- /doc/mod.txt/postgresql_db.txt: -------------------------------------------------------------------------------- 1 | SYNOPSIS *postgresql_db* 2 | 3 | Add or remove PostgreSQL databases from a remote host. 4 | 5 | EXAMPLES *postgresql_db-examples* 6 | > 7 | # Create a new database with name "acme" 8 | - postgresql_db: name=acme 9 | 10 | # Create a new database with name "acme" and specific encoding and locale 11 | # settings. If a template different from "template0" is specified, encoding 12 | # and locale settings must match those of the template. 13 | - postgresql_db: name=acme 14 | encoding='UTF-8' 15 | lc_collate='de_DE.UTF-8' 16 | lc_ctype='de_DE.UTF-8' 17 | template='template0' 18 | 19 | Note 20 | 21 | The default authentication assumes that you are either logging in as or sudo’ing to the postgres account on the host. 22 | 23 | Note 24 | 25 | This module uses psycopg2, a Python PostgreSQL database adapter. You must ensure that psycopg2 is installed on the host before using this module. If the remote host is the PostgreSQL server 26 | (which is the default case), then PostgreSQL must also be installed on the remote host. For Ubuntu-based systems, install the postgresql, libpq-dev, and python-psycopg2 packages on the remote 27 | host before using this module. 28 | 29 | MORE INFO *postgresql_db-moreinfo* 30 | > 31 | All arguments are omni-completed, but if you really want to see the online docs: 32 | http://docs.ansible.com/postgresql_db_module.html 33 | -------------------------------------------------------------------------------- /doc/mod.txt/quantum_floating_ip.txt: -------------------------------------------------------------------------------- 1 | SYNOPSIS *quantum_floating_ip* 2 | 3 | New in version 1.2. 4 | 5 | Add or Remove a floating IP to an instance 6 | 7 | EXAMPLES *quantum_floating_ip-examples* 8 | > 9 | # Assign a floating ip to the instance from an external network 10 | - quantum_floating_ip: state=present login_username=admin login_password=admin 11 | login_tenant_name=admin network_name=external_network 12 | instance_name=vm1 internal_network_name=internal_network 13 | 14 | MORE INFO *quantum_floating_ip-moreinfo* 15 | > 16 | All arguments are omni-completed, but if you really want to see the online docs: 17 | http://docs.ansible.com/quantum_floating_ip_module.html 18 | -------------------------------------------------------------------------------- /doc/mod.txt/quantum_floating_ip_associate.txt: -------------------------------------------------------------------------------- 1 | SYNOPSIS *quantum_floating_ip_associate* 2 | 3 | New in version 1.2. 4 | 5 | Associates or disassociates a specific floating IP with a particular instance 6 | 7 | EXAMPLES *quantum_floating_ip_associate-examples* 8 | > 9 | # Associate a specific floating IP with an Instance 10 | - quantum_floating_ip_associate: 11 | state=present 12 | login_username=admin 13 | login_password=admin 14 | login_tenant_name=admin 15 | ip_address=1.1.1.1 16 | instance_name=vm1 17 | 18 | MORE INFO *quantum_floating_ip_associate-moreinfo* 19 | > 20 | All arguments are omni-completed, but if you really want to see the online docs: 21 | http://docs.ansible.com/quantum_floating_ip_associate_module.html 22 | -------------------------------------------------------------------------------- /doc/mod.txt/quantum_network.txt: -------------------------------------------------------------------------------- 1 | SYNOPSIS *quantum_network* 2 | 3 | New in version 1.4. 4 | 5 | Add or Remove network from OpenStack. 6 | 7 | EXAMPLES *quantum_network-examples* 8 | > 9 | # Create a GRE backed Quantum network with tunnel id 1 for tenant1 10 | - quantum_network: name=t1network tenant_name=tenant1 state=present 11 | provider_network_type=gre provider_segmentation_id=1 12 | login_username=admin login_password=admin login_tenant_name=admin 13 | 14 | # Create an external network 15 | - quantum_network: name=external_network state=present 16 | provider_network_type=local router_external=yes 17 | login_username=admin login_password=admin login_tenant_name=admin 18 | 19 | MORE INFO *quantum_network-moreinfo* 20 | > 21 | All arguments are omni-completed, but if you really want to see the online docs: 22 | http://docs.ansible.com/quantum_network_module.html 23 | -------------------------------------------------------------------------------- /doc/mod.txt/quantum_router.txt: -------------------------------------------------------------------------------- 1 | SYNOPSIS *quantum_router* 2 | 3 | New in version 1.2. 4 | 5 | Create or Delete routers from OpenStack 6 | 7 | EXAMPLES *quantum_router-examples* 8 | > 9 | # Creates a router for tenant admin 10 | - quantum_router: state=present 11 | login_username=admin 12 | login_password=admin 13 | login_tenant_name=admin 14 | name=router1" 15 | 16 | MORE INFO *quantum_router-moreinfo* 17 | > 18 | All arguments are omni-completed, but if you really want to see the online docs: 19 | http://docs.ansible.com/quantum_router_module.html 20 | -------------------------------------------------------------------------------- /doc/mod.txt/quantum_router_gateway.txt: -------------------------------------------------------------------------------- 1 | SYNOPSIS *quantum_router_gateway* 2 | 3 | New in version 1.2. 4 | 5 | Creates/Removes a gateway interface from the router, used to associate a external network with a router to route external traffic. 6 | 7 | EXAMPLES *quantum_router_gateway-examples* 8 | > 9 | # Attach an external network with a router to allow flow of external traffic 10 | - quantum_router_gateway: state=present login_username=admin login_password=admin 11 | login_tenant_name=admin router_name=external_router 12 | network_name=external_network 13 | 14 | MORE INFO *quantum_router_gateway-moreinfo* 15 | > 16 | All arguments are omni-completed, but if you really want to see the online docs: 17 | http://docs.ansible.com/quantum_router_gateway_module.html 18 | -------------------------------------------------------------------------------- /doc/mod.txt/quantum_router_interface.txt: -------------------------------------------------------------------------------- 1 | SYNOPSIS *quantum_router_interface* 2 | 3 | New in version 1.2. 4 | 5 | Attach/Dettach a subnet interface to a router, to provide a gateway for the subnet. 6 | 7 | EXAMPLES *quantum_router_interface-examples* 8 | > 9 | # Attach tenant1's subnet to the external router 10 | - quantum_router_interface: state=present login_username=admin 11 | login_password=admin 12 | login_tenant_name=admin 13 | tenant_name=tenant1 14 | router_name=external_route 15 | subnet_name=t1subnet 16 | 17 | MORE INFO *quantum_router_interface-moreinfo* 18 | > 19 | All arguments are omni-completed, but if you really want to see the online docs: 20 | http://docs.ansible.com/quantum_router_interface_module.html 21 | -------------------------------------------------------------------------------- /doc/mod.txt/quantum_subnet.txt: -------------------------------------------------------------------------------- 1 | SYNOPSIS *quantum_subnet* 2 | 3 | New in version 1.2. 4 | 5 | Add/remove subnet from a network 6 | 7 | EXAMPLES *quantum_subnet-examples* 8 | > 9 | # Create a subnet for a tenant with the specified subnet 10 | - quantum_subnet: state=present login_username=admin login_password=admin 11 | login_tenant_name=admin tenant_name=tenant1 12 | network_name=network1 name=net1subnet cidr=192.168.0.0/24" 13 | 14 | MORE INFO *quantum_subnet-moreinfo* 15 | > 16 | All arguments are omni-completed, but if you really want to see the online docs: 17 | http://docs.ansible.com/quantum_subnet_module.html 18 | -------------------------------------------------------------------------------- /doc/mod.txt/rabbitmq_parameter.txt: -------------------------------------------------------------------------------- 1 | SYNOPSIS *rabbitmq_parameter* 2 | 3 | New in version 1.1. 4 | 5 | Manage dynamic, cluster-wide parameters for RabbitMQ 6 | 7 | EXAMPLES *rabbitmq_parameter-examples* 8 | > 9 | # Set the federation parameter 'local_username' to a value of 'guest' (in quotes) 10 | - rabbitmq_parameter: component=federation 11 | name=local-username 12 | value='"guest"' 13 | state=present 14 | 15 | MORE INFO *rabbitmq_parameter-moreinfo* 16 | > 17 | All arguments are omni-completed, but if you really want to see the online docs: 18 | http://docs.ansible.com/rabbitmq_parameter_module.html 19 | -------------------------------------------------------------------------------- /doc/mod.txt/rabbitmq_plugin.txt: -------------------------------------------------------------------------------- 1 | SYNOPSIS *rabbitmq_plugin* 2 | 3 | New in version 1.1. 4 | 5 | Enables or disables RabbitMQ plugins 6 | 7 | EXAMPLES *rabbitmq_plugin-examples* 8 | > 9 | # Enables the rabbitmq_management plugin 10 | - rabbitmq_plugin: names=rabbitmq_management state=enabled 11 | 12 | MORE INFO *rabbitmq_plugin-moreinfo* 13 | > 14 | All arguments are omni-completed, but if you really want to see the online docs: 15 | http://docs.ansible.com/rabbitmq_plugin_module.html 16 | -------------------------------------------------------------------------------- /doc/mod.txt/rabbitmq_policy.txt: -------------------------------------------------------------------------------- 1 | SYNOPSIS *rabbitmq_policy* 2 | 3 | New in version 1.5. 4 | 5 | Manage the state of a virtual host in RabbitMQ. 6 | 7 | EXAMPLES *rabbitmq_policy-examples* 8 | > 9 | - name: ensure the default vhost contains the HA policy via a dict 10 | rabbitmq_policy: name=HA pattern='.*' 11 | args: 12 | tags: 13 | "ha-mode": all 14 | 15 | - name: ensure the default vhost contains the HA policy 16 | rabbitmq_policy: name=HA pattern='.*' tags="ha-mode=all" 17 | 18 | MORE INFO *rabbitmq_policy-moreinfo* 19 | > 20 | All arguments are omni-completed, but if you really want to see the online docs: 21 | http://docs.ansible.com/rabbitmq_policy_module.html 22 | -------------------------------------------------------------------------------- /doc/mod.txt/rabbitmq_user.txt: -------------------------------------------------------------------------------- 1 | SYNOPSIS *rabbitmq_user* 2 | 3 | New in version 1.1. 4 | 5 | Add or remove users to RabbitMQ and assign permissions 6 | 7 | EXAMPLES *rabbitmq_user-examples* 8 | > 9 | # Add user to server and assign full access control 10 | - rabbitmq_user: user=joe 11 | password=changeme 12 | vhost=/ 13 | configure_priv=.* 14 | read_priv=.* 15 | write_priv=.* 16 | state=present 17 | 18 | MORE INFO *rabbitmq_user-moreinfo* 19 | > 20 | All arguments are omni-completed, but if you really want to see the online docs: 21 | http://docs.ansible.com/rabbitmq_user_module.html 22 | -------------------------------------------------------------------------------- /doc/mod.txt/rabbitmq_vhost.txt: -------------------------------------------------------------------------------- 1 | SYNOPSIS *rabbitmq_vhost* 2 | 3 | New in version 1.1. 4 | 5 | Manage the state of a virtual host in RabbitMQ 6 | 7 | EXAMPLES *rabbitmq_vhost-examples* 8 | > 9 | # Ensure that the vhost /test exists. 10 | - rabbitmq_vhost: name=/test state=present 11 | 12 | MORE INFO *rabbitmq_vhost-moreinfo* 13 | > 14 | All arguments are omni-completed, but if you really want to see the online docs: 15 | http://docs.ansible.com/rabbitmq_vhost_module.html 16 | -------------------------------------------------------------------------------- /doc/mod.txt/raw.txt: -------------------------------------------------------------------------------- 1 | SYNOPSIS *raw* 2 | 3 | Executes a low-down and dirty SSH command, not going through the module subsystem. This is useful and should only be done in two cases. The first case is installing python-simplejson on older 4 | (Python 2.4 and before) hosts that need it as a dependency to run modules, since nearly all core modules require it. Another is speaking to any devices such as routers that do not have any 5 | Python installed. In any other case, using the shell or command module is much more appropriate. Arguments given to raw are run directly through the configured remote shell. Standard output, 6 | error output and return code are returned when available. There is no change handler support for this module. This module does not require python on the remote system, much like the script 7 | module. 8 | 9 | EXAMPLES *raw-examples* 10 | > 11 | # Bootstrap a legacy python 2.4 host 12 | - raw: yum -y install python-simplejson 13 | 14 | Note 15 | 16 | If you want to execute a command securely and predictably, it may be better to use the command module instead. Best practices when writing playbooks will follow the trend of using command unless 17 | shell is explicitly required. When running ad-hoc commands, use your best judgement. 18 | 19 | MORE INFO *raw-moreinfo* 20 | > 21 | All arguments are omni-completed, but if you really want to see the online docs: 22 | http://docs.ansible.com/raw_module.html 23 | -------------------------------------------------------------------------------- /doc/mod.txt/rax_cbs.txt: -------------------------------------------------------------------------------- 1 | SYNOPSIS *rax_cbs* 2 | 3 | New in version 1.6. 4 | 5 | Manipulate Rackspace Cloud Block Storage Volumes 6 | 7 | EXAMPLES *rax_cbs-examples* 8 | > 9 | - name: Build a Block Storage Volume 10 | gather_facts: False 11 | hosts: local 12 | connection: local 13 | tasks: 14 | - name: Storage volume create request 15 | local_action: 16 | module: rax_cbs 17 | credentials: ~/.raxpub 18 | name: my-volume 19 | description: My Volume 20 | volume_type: SSD 21 | size: 150 22 | region: DFW 23 | wait: yes 24 | state: present 25 | meta: 26 | app: my-cool-app 27 | register: my_volume 28 | 29 | Note 30 | 31 | The following environment variables can be used, RAX_USERNAME, RAX_API_KEY, RAX_CREDS_FILE, RAX_CREDENTIALS, RAX_REGION. 32 | 33 | Note 34 | 35 | RAX_CREDENTIALS and RAX_CREDS_FILE points to a credentials file appropriate for pyrax. See https://github.com/rackspace/pyrax/blob/master/docs/getting_started.md#authenticating 36 | 37 | Note 38 | 39 | RAX_USERNAME and RAX_API_KEY obviate the use of a credentials file 40 | 41 | Note 42 | 43 | RAX_REGION defines a Rackspace Public Cloud region (DFW, ORD, LON, ...) 44 | 45 | MORE INFO *rax_cbs-moreinfo* 46 | > 47 | All arguments are omni-completed, but if you really want to see the online docs: 48 | http://docs.ansible.com/rax_cbs_module.html 49 | -------------------------------------------------------------------------------- /doc/mod.txt/rax_cbs_attachments.txt: -------------------------------------------------------------------------------- 1 | SYNOPSIS *rax_cbs_attachments* 2 | 3 | New in version 1.6. 4 | 5 | Manipulate Rackspace Cloud Block Storage Volume Attachments 6 | 7 | EXAMPLES *rax_cbs_attachments-examples* 8 | > 9 | - name: Attach a Block Storage Volume 10 | gather_facts: False 11 | hosts: local 12 | connection: local 13 | tasks: 14 | - name: Storage volume attach request 15 | local_action: 16 | module: rax_cbs_attachments 17 | credentials: ~/.raxpub 18 | volume: my-volume 19 | server: my-server 20 | device: /dev/xvdd 21 | region: DFW 22 | wait: yes 23 | state: present 24 | register: my_volume 25 | 26 | Note 27 | 28 | The following environment variables can be used, RAX_USERNAME, RAX_API_KEY, RAX_CREDS_FILE, RAX_CREDENTIALS, RAX_REGION. 29 | 30 | Note 31 | 32 | RAX_CREDENTIALS and RAX_CREDS_FILE points to a credentials file appropriate for pyrax. See https://github.com/rackspace/pyrax/blob/master/docs/getting_started.md#authenticating 33 | 34 | Note 35 | 36 | RAX_USERNAME and RAX_API_KEY obviate the use of a credentials file 37 | 38 | Note 39 | 40 | RAX_REGION defines a Rackspace Public Cloud region (DFW, ORD, LON, ...) 41 | 42 | MORE INFO *rax_cbs_attachments-moreinfo* 43 | > 44 | All arguments are omni-completed, but if you really want to see the online docs: 45 | http://docs.ansible.com/rax_cbs_attachments_module.html 46 | -------------------------------------------------------------------------------- /doc/mod.txt/rax_cdb.txt: -------------------------------------------------------------------------------- 1 | SYNOPSIS *rax_cdb* 2 | 3 | New in version 1.8. 4 | 5 | creates / deletes or resize a Rackspace Cloud Databases instance and optionally waits for it to be ‘running’. The name option needs to be unique since it’s used to identify the instance. 6 | 7 | EXAMPLES *rax_cdb-examples* 8 | > 9 | - name: Build a Cloud Databases 10 | gather_facts: False 11 | tasks: 12 | - name: Server build request 13 | local_action: 14 | module: rax_cdb 15 | credentials: ~/.raxpub 16 | region: IAD 17 | name: db-server1 18 | flavor: 1 19 | volume: 2 20 | wait: yes 21 | state: present 22 | register: rax_db_server 23 | 24 | Note 25 | 26 | The following environment variables can be used, RAX_USERNAME, RAX_API_KEY, RAX_CREDS_FILE, RAX_CREDENTIALS, RAX_REGION. 27 | 28 | Note 29 | 30 | RAX_CREDENTIALS and RAX_CREDS_FILE points to a credentials file appropriate for pyrax. See https://github.com/rackspace/pyrax/blob/master/docs/getting_started.md#authenticating 31 | 32 | Note 33 | 34 | RAX_USERNAME and RAX_API_KEY obviate the use of a credentials file 35 | 36 | Note 37 | 38 | RAX_REGION defines a Rackspace Public Cloud region (DFW, ORD, LON, ...) 39 | 40 | MORE INFO *rax_cdb-moreinfo* 41 | > 42 | All arguments are omni-completed, but if you really want to see the online docs: 43 | http://docs.ansible.com/rax_cdb_module.html 44 | -------------------------------------------------------------------------------- /doc/mod.txt/rax_cdb_database.txt: -------------------------------------------------------------------------------- 1 | SYNOPSIS *rax_cdb_database* 2 | 3 | New in version 1.8. 4 | 5 | create / delete a database in the Cloud Databases. 6 | 7 | EXAMPLES *rax_cdb_database-examples* 8 | > 9 | - name: Build a database in Cloud Databases 10 | tasks: 11 | - name: Database build request 12 | local_action: 13 | module: rax_cdb_database 14 | credentials: ~/.raxpub 15 | region: IAD 16 | cdb_id: 323e7ce0-9cb0-11e3-a5e2-0800200c9a66 17 | name: db1 18 | state: present 19 | register: rax_db_database 20 | 21 | Note 22 | 23 | The following environment variables can be used, RAX_USERNAME, RAX_API_KEY, RAX_CREDS_FILE, RAX_CREDENTIALS, RAX_REGION. 24 | 25 | Note 26 | 27 | RAX_CREDENTIALS and RAX_CREDS_FILE points to a credentials file appropriate for pyrax. See https://github.com/rackspace/pyrax/blob/master/docs/getting_started.md#authenticating 28 | 29 | Note 30 | 31 | RAX_USERNAME and RAX_API_KEY obviate the use of a credentials file 32 | 33 | Note 34 | 35 | RAX_REGION defines a Rackspace Public Cloud region (DFW, ORD, LON, ...) 36 | 37 | MORE INFO *rax_cdb_database-moreinfo* 38 | > 39 | All arguments are omni-completed, but if you really want to see the online docs: 40 | http://docs.ansible.com/rax_cdb_database_module.html 41 | -------------------------------------------------------------------------------- /doc/mod.txt/rax_cdb_user.txt: -------------------------------------------------------------------------------- 1 | SYNOPSIS *rax_cdb_user* 2 | 3 | New in version 1.8. 4 | 5 | create / delete a database in the Cloud Databases. 6 | 7 | EXAMPLES *rax_cdb_user-examples* 8 | > 9 | - name: Build a user in Cloud Databases 10 | tasks: 11 | - name: User build request 12 | local_action: 13 | module: rax_cdb_user 14 | credentials: ~/.raxpub 15 | region: IAD 16 | cdb_id: 323e7ce0-9cb0-11e3-a5e2-0800200c9a66 17 | db_username: user1 18 | db_password: user1 19 | databases: ['db1'] 20 | state: present 21 | register: rax_db_user 22 | 23 | Note 24 | 25 | The following environment variables can be used, RAX_USERNAME, RAX_API_KEY, RAX_CREDS_FILE, RAX_CREDENTIALS, RAX_REGION. 26 | 27 | Note 28 | 29 | RAX_CREDENTIALS and RAX_CREDS_FILE points to a credentials file appropriate for pyrax. See https://github.com/rackspace/pyrax/blob/master/docs/getting_started.md#authenticating 30 | 31 | Note 32 | 33 | RAX_USERNAME and RAX_API_KEY obviate the use of a credentials file 34 | 35 | Note 36 | 37 | RAX_REGION defines a Rackspace Public Cloud region (DFW, ORD, LON, ...) 38 | 39 | MORE INFO *rax_cdb_user-moreinfo* 40 | > 41 | All arguments are omni-completed, but if you really want to see the online docs: 42 | http://docs.ansible.com/rax_cdb_user_module.html 43 | -------------------------------------------------------------------------------- /doc/mod.txt/rax_clb.txt: -------------------------------------------------------------------------------- 1 | SYNOPSIS *rax_clb* 2 | 3 | New in version 1.4. 4 | 5 | creates / deletes a Rackspace Public Cloud load balancer. 6 | 7 | EXAMPLES *rax_clb-examples* 8 | > 9 | - name: Build a Load Balancer 10 | gather_facts: False 11 | hosts: local 12 | connection: local 13 | tasks: 14 | - name: Load Balancer create request 15 | local_action: 16 | module: rax_clb 17 | credentials: ~/.raxpub 18 | name: my-lb 19 | port: 8080 20 | protocol: HTTP 21 | type: SERVICENET 22 | timeout: 30 23 | region: DFW 24 | wait: yes 25 | state: present 26 | meta: 27 | app: my-cool-app 28 | register: my_lb 29 | 30 | Note 31 | 32 | The following environment variables can be used, RAX_USERNAME, RAX_API_KEY, RAX_CREDS_FILE, RAX_CREDENTIALS, RAX_REGION. 33 | 34 | Note 35 | 36 | RAX_CREDENTIALS and RAX_CREDS_FILE points to a credentials file appropriate for pyrax. See https://github.com/rackspace/pyrax/blob/master/docs/getting_started.md#authenticating 37 | 38 | Note 39 | 40 | RAX_USERNAME and RAX_API_KEY obviate the use of a credentials file 41 | 42 | Note 43 | 44 | RAX_REGION defines a Rackspace Public Cloud region (DFW, ORD, LON, ...) 45 | 46 | MORE INFO *rax_clb-moreinfo* 47 | > 48 | All arguments are omni-completed, but if you really want to see the online docs: 49 | http://docs.ansible.com/rax_clb_module.html 50 | -------------------------------------------------------------------------------- /doc/mod.txt/rax_dns.txt: -------------------------------------------------------------------------------- 1 | SYNOPSIS *rax_dns* 2 | 3 | New in version 1.5. 4 | 5 | Manage domains on Rackspace Cloud DNS 6 | 7 | EXAMPLES *rax_dns-examples* 8 | > 9 | - name: Create domain 10 | hosts: all 11 | gather_facts: False 12 | tasks: 13 | - name: Domain create request 14 | local_action: 15 | module: rax_dns 16 | credentials: ~/.raxpub 17 | name: example.org 18 | email: [email protected] 19 | register: rax_dns 20 | 21 | Note 22 | 23 | It is recommended that plays utilizing this module be run with serial: 1 to avoid exceeding the API request limit imposed by the Rackspace CloudDNS API 24 | 25 | Note 26 | 27 | The following environment variables can be used, RAX_USERNAME, RAX_API_KEY, RAX_CREDS_FILE, RAX_CREDENTIALS, RAX_REGION. 28 | 29 | Note 30 | 31 | RAX_CREDENTIALS and RAX_CREDS_FILE points to a credentials file appropriate for pyrax. See https://github.com/rackspace/pyrax/blob/master/docs/getting_started.md#authenticating 32 | 33 | Note 34 | 35 | RAX_USERNAME and RAX_API_KEY obviate the use of a credentials file 36 | 37 | Note 38 | 39 | RAX_REGION defines a Rackspace Public Cloud region (DFW, ORD, LON, ...) 40 | 41 | MORE INFO *rax_dns-moreinfo* 42 | > 43 | All arguments are omni-completed, but if you really want to see the online docs: 44 | http://docs.ansible.com/rax_dns_module.html 45 | -------------------------------------------------------------------------------- /doc/mod.txt/rax_facts.txt: -------------------------------------------------------------------------------- 1 | SYNOPSIS *rax_facts* 2 | 3 | New in version 1.4. 4 | 5 | Gather facts for Rackspace Cloud Servers. 6 | 7 | EXAMPLES *rax_facts-examples* 8 | > 9 | - name: Gather info about servers 10 | hosts: all 11 | gather_facts: False 12 | tasks: 13 | - name: Get facts about servers 14 | local_action: 15 | module: rax_facts 16 | credentials: ~/.raxpub 17 | name: "{{ inventory_hostname }}" 18 | region: DFW 19 | - name: Map some facts 20 | set_fact: 21 | ansible_ssh_host: "{{ rax_accessipv4 }}" 22 | 23 | Note 24 | 25 | The following environment variables can be used, RAX_USERNAME, RAX_API_KEY, RAX_CREDS_FILE, RAX_CREDENTIALS, RAX_REGION. 26 | 27 | Note 28 | 29 | RAX_CREDENTIALS and RAX_CREDS_FILE points to a credentials file appropriate for pyrax. See https://github.com/rackspace/pyrax/blob/master/docs/getting_started.md#authenticating 30 | 31 | Note 32 | 33 | RAX_USERNAME and RAX_API_KEY obviate the use of a credentials file 34 | 35 | Note 36 | 37 | RAX_REGION defines a Rackspace Public Cloud region (DFW, ORD, LON, ...) 38 | 39 | MORE INFO *rax_facts-moreinfo* 40 | > 41 | All arguments are omni-completed, but if you really want to see the online docs: 42 | http://docs.ansible.com/rax_facts_module.html 43 | -------------------------------------------------------------------------------- /doc/mod.txt/rax_identity.txt: -------------------------------------------------------------------------------- 1 | SYNOPSIS *rax_identity* 2 | 3 | New in version 1.5. 4 | 5 | Verifies Rackspace Cloud credentials and returns identity information 6 | 7 | EXAMPLES *rax_identity-examples* 8 | > 9 | - name: Load Rackspace Cloud Identity 10 | gather_facts: False 11 | hosts: local 12 | connection: local 13 | tasks: 14 | - name: Load Identity 15 | local_action: 16 | module: rax_identity 17 | credentials: ~/.raxpub 18 | region: DFW 19 | register: rackspace_identity 20 | 21 | Note 22 | 23 | The following environment variables can be used, RAX_USERNAME, RAX_API_KEY, RAX_CREDS_FILE, RAX_CREDENTIALS, RAX_REGION. 24 | 25 | Note 26 | 27 | RAX_CREDENTIALS and RAX_CREDS_FILE points to a credentials file appropriate for pyrax. See https://github.com/rackspace/pyrax/blob/master/docs/getting_started.md#authenticating 28 | 29 | Note 30 | 31 | RAX_USERNAME and RAX_API_KEY obviate the use of a credentials file 32 | 33 | Note 34 | 35 | RAX_REGION defines a Rackspace Public Cloud region (DFW, ORD, LON, ...) 36 | 37 | MORE INFO *rax_identity-moreinfo* 38 | > 39 | All arguments are omni-completed, but if you really want to see the online docs: 40 | http://docs.ansible.com/rax_identity_module.html 41 | -------------------------------------------------------------------------------- /doc/mod.txt/rax_network.txt: -------------------------------------------------------------------------------- 1 | SYNOPSIS *rax_network* 2 | 3 | New in version 1.4. 4 | 5 | creates / deletes a Rackspace Public Cloud isolated network. 6 | 7 | EXAMPLES *rax_network-examples* 8 | > 9 | - name: Build an Isolated Network 10 | gather_facts: False 11 | 12 | tasks: 13 | - name: Network create request 14 | local_action: 15 | module: rax_network 16 | credentials: ~/.raxpub 17 | label: my-net 18 | cidr: 192.168.3.0/24 19 | state: present 20 | 21 | Note 22 | 23 | The following environment variables can be used, RAX_USERNAME, RAX_API_KEY, RAX_CREDS_FILE, RAX_CREDENTIALS, RAX_REGION. 24 | 25 | Note 26 | 27 | RAX_CREDENTIALS and RAX_CREDS_FILE points to a credentials file appropriate for pyrax. See https://github.com/rackspace/pyrax/blob/master/docs/getting_started.md#authenticating 28 | 29 | Note 30 | 31 | RAX_USERNAME and RAX_API_KEY obviate the use of a credentials file 32 | 33 | Note 34 | 35 | RAX_REGION defines a Rackspace Public Cloud region (DFW, ORD, LON, ...) 36 | 37 | MORE INFO *rax_network-moreinfo* 38 | > 39 | All arguments are omni-completed, but if you really want to see the online docs: 40 | http://docs.ansible.com/rax_network_module.html 41 | -------------------------------------------------------------------------------- /doc/mod.txt/rax_queue.txt: -------------------------------------------------------------------------------- 1 | SYNOPSIS *rax_queue* 2 | 3 | New in version 1.5. 4 | 5 | creates / deletes a Rackspace Public Cloud queue. 6 | 7 | EXAMPLES *rax_queue-examples* 8 | > 9 | - name: Build a Queue 10 | gather_facts: False 11 | hosts: local 12 | connection: local 13 | tasks: 14 | - name: Queue create request 15 | local_action: 16 | module: rax_queue 17 | credentials: ~/.raxpub 18 | name: my-queue 19 | region: DFW 20 | state: present 21 | register: my_queue 22 | 23 | Note 24 | 25 | The following environment variables can be used, RAX_USERNAME, RAX_API_KEY, RAX_CREDS_FILE, RAX_CREDENTIALS, RAX_REGION. 26 | 27 | Note 28 | 29 | RAX_CREDENTIALS and RAX_CREDS_FILE points to a credentials file appropriate for pyrax. See https://github.com/rackspace/pyrax/blob/master/docs/getting_started.md#authenticating 30 | 31 | Note 32 | 33 | RAX_USERNAME and RAX_API_KEY obviate the use of a credentials file 34 | 35 | Note 36 | 37 | RAX_REGION defines a Rackspace Public Cloud region (DFW, ORD, LON, ...) 38 | 39 | MORE INFO *rax_queue-moreinfo* 40 | > 41 | All arguments are omni-completed, but if you really want to see the online docs: 42 | http://docs.ansible.com/rax_queue_module.html 43 | -------------------------------------------------------------------------------- /doc/mod.txt/rax_scaling_group.txt: -------------------------------------------------------------------------------- 1 | SYNOPSIS *rax_scaling_group* 2 | 3 | New in version 1.7. 4 | 5 | Manipulate Rackspace Cloud Autoscale Groups 6 | 7 | EXAMPLES *rax_scaling_group-examples* 8 | > 9 | --- 10 | - hosts: localhost 11 | gather_facts: false 12 | connection: local 13 | tasks: 14 | - rax_scaling_group: 15 | credentials: ~/.raxpub 16 | region: ORD 17 | cooldown: 300 18 | flavor: performance1-1 19 | image: bb02b1a3-bc77-4d17-ab5b-421d89850fca 20 | min_entities: 5 21 | max_entities: 10 22 | name: ASG Test 23 | server_name: asgtest 24 | loadbalancers: 25 | - id: 228385 26 | port: 80 27 | register: asg 28 | 29 | Note 30 | 31 | The following environment variables can be used, RAX_USERNAME, RAX_API_KEY, RAX_CREDS_FILE, RAX_CREDENTIALS, RAX_REGION. 32 | 33 | Note 34 | 35 | RAX_CREDENTIALS and RAX_CREDS_FILE points to a credentials file appropriate for pyrax. See https://github.com/rackspace/pyrax/blob/master/docs/getting_started.md#authenticating 36 | 37 | Note 38 | 39 | RAX_USERNAME and RAX_API_KEY obviate the use of a credentials file 40 | 41 | Note 42 | 43 | RAX_REGION defines a Rackspace Public Cloud region (DFW, ORD, LON, ...) 44 | 45 | MORE INFO *rax_scaling_group-moreinfo* 46 | > 47 | All arguments are omni-completed, but if you really want to see the online docs: 48 | http://docs.ansible.com/rax_scaling_group_module.html 49 | -------------------------------------------------------------------------------- /doc/mod.txt/rds_param_group.txt: -------------------------------------------------------------------------------- 1 | SYNOPSIS *rds_param_group* 2 | 3 | New in version 1.5. 4 | 5 | Creates, modifies, and deletes RDS parameter groups. This module has a dependency on python-boto >= 2.5. 6 | 7 | EXAMPLES *rds_param_group-examples* 8 | > 9 | # Add or change a parameter group, in this case setting auto_increment_increment to 42 * 1024 10 | - rds_param_group: 11 | state: present 12 | name: norwegian_blue 13 | description: 'My Fancy Ex Parrot Group' 14 | engine: 'mysql5.6' 15 | params: 16 | auto_increment_increment: "42K" 17 | 18 | # Remove a parameter group 19 | - rds_param_group: 20 | state: absent 21 | name: norwegian_blue 22 | 23 | MORE INFO *rds_param_group-moreinfo* 24 | > 25 | All arguments are omni-completed, but if you really want to see the online docs: 26 | http://docs.ansible.com/rds_param_group_module.html 27 | -------------------------------------------------------------------------------- /doc/mod.txt/rds_subnet_group.txt: -------------------------------------------------------------------------------- 1 | SYNOPSIS *rds_subnet_group* 2 | 3 | New in version 1.5. 4 | 5 | Creates, modifies, and deletes RDS database subnet groups. This module has a dependency on python-boto >= 2.5. 6 | 7 | EXAMPLES *rds_subnet_group-examples* 8 | > 9 | # Add or change a subnet group 10 | - rds_subnet_group 11 | state: present 12 | name: norwegian-blue 13 | description: My Fancy Ex Parrot Subnet Group 14 | subnets: 15 | - subnet-aaaaaaaa 16 | - subnet-bbbbbbbb 17 | 18 | # Remove a parameter group 19 | - rds_param_group: 20 | state: absent 21 | name: norwegian-blue 22 | 23 | MORE INFO *rds_subnet_group-moreinfo* 24 | > 25 | All arguments are omni-completed, but if you really want to see the online docs: 26 | http://docs.ansible.com/rds_subnet_group_module.html 27 | -------------------------------------------------------------------------------- /doc/mod.txt/redhat_subscription.txt: -------------------------------------------------------------------------------- 1 | SYNOPSIS *redhat_subscription* 2 | 3 | New in version 1.2. 4 | 5 | Manage registration and subscription to the Red Hat Network entitlement platform. 6 | 7 | EXAMPLES *redhat_subscription-examples* 8 | > 9 | # Register as user (joe_user) with password (somepass) and auto-subscribe to available content. 10 | - redhat_subscription: state=present username=joe_user password=somepass autosubscribe=true 11 | 12 | # Register with activationkey (1-222333444) and consume subscriptions matching 13 | # the names (Red hat Enterprise Server) and (Red Hat Virtualization) 14 | - redhat_subscription: state=present 15 | activationkey=1-222333444 16 | pool='^(Red Hat Enterprise Server|Red Hat Virtualization)$' 17 | 18 | Note 19 | 20 | In order to register a system, subscription-manager requires either a username and password, or an activationkey. 21 | 22 | MORE INFO *redhat_subscription-moreinfo* 23 | > 24 | All arguments are omni-completed, but if you really want to see the online docs: 25 | http://docs.ansible.com/redhat_subscription_module.html 26 | -------------------------------------------------------------------------------- /doc/mod.txt/redis.txt: -------------------------------------------------------------------------------- 1 | SYNOPSIS *redis* 2 | 3 | New in version 1.3. 4 | 5 | Unified utility to interact with redis instances. ‘slave’ sets a redis instance in slave or master mode. ‘flush’ flushes all the instance or a specified db. ‘config’ (new in 1.6), ensures a 6 | configuration setting on an instance. 7 | 8 | EXAMPLES *redis-examples* 9 | > 10 | # Set local redis instance to be slave of melee.island on port 6377 11 | - redis: command=slave master_host=melee.island master_port=6377 12 | 13 | # Deactivate slave mode 14 | - redis: command=slave slave_mode=master 15 | 16 | # Flush all the redis db 17 | - redis: command=flush flush_mode=all 18 | 19 | # Flush only one db in a redis instance 20 | - redis: command=flush db=1 flush_mode=db 21 | 22 | # Configure local redis to have 10000 max clients 23 | - redis: command=config name=maxclients value=10000 24 | 25 | # Configure local redis to have lua time limit of 100 ms 26 | - redis: command=config name=lua-time-limit value=100 27 | 28 | Note 29 | 30 | Requires the redis-py Python package on the remote host. You can install it with pip (pip install redis) or with a package manager. https://github.com/andymccurdy/redis-py 31 | 32 | Note 33 | 34 | If the redis master instance we are making slave of is password protected this needs to be in the redis.conf in the masterauth variable 35 | 36 | MORE INFO *redis-moreinfo* 37 | > 38 | All arguments are omni-completed, but if you really want to see the online docs: 39 | http://docs.ansible.com/redis_module.html 40 | -------------------------------------------------------------------------------- /doc/mod.txt/replace.txt: -------------------------------------------------------------------------------- 1 | SYNOPSIS *replace* 2 | 3 | New in version 1.6. 4 | 5 | This module will replace all instances of a pattern within a file. It is up to the user to maintain idempotence by ensuring that the same pattern would never match any replacements made. 6 | 7 | EXAMPLES *replace-examples* 8 | > 9 | - replace: dest=/etc/hosts regexp='(\s+)old\.host\.name(\s+.*)?$' replace='\1new.host.name\2' backup=yes 10 | 11 | - replace: dest=/home/jdoe/.ssh/known_hosts regexp='^old\.host\.name[^\n]*\n' owner=jdoe group=jdoe mode=644 12 | 13 | - replace: dest=/etc/apache/ports regexp='^(NameVirtualHost|Listen)\s+80\s*$' replace='\1 127.0.0.1:8080' validate='/usr/sbin/apache2ctl -f %s -t' 14 | 15 | MORE INFO *replace-moreinfo* 16 | > 17 | All arguments are omni-completed, but if you really want to see the online docs: 18 | http://docs.ansible.com/replace_module.html 19 | -------------------------------------------------------------------------------- /doc/mod.txt/rhn_channel.txt: -------------------------------------------------------------------------------- 1 | SYNOPSIS *rhn_channel* 2 | 3 | New in version 1.1. 4 | 5 | Adds or removes Red Hat software channels 6 | 7 | EXAMPLES *rhn_channel-examples* 8 | > 9 | - rhn_channel: name=rhel-x86_64-server-v2vwin-6 sysname=server01 url=https://rhn.redhat.com/rpc/api user=rhnuser password=guessme 10 | 11 | Note 12 | 13 | this module fetches the system id from RHN. 14 | 15 | MORE INFO *rhn_channel-moreinfo* 16 | > 17 | All arguments are omni-completed, but if you really want to see the online docs: 18 | http://docs.ansible.com/rhn_channel_module.html 19 | -------------------------------------------------------------------------------- /doc/mod.txt/rhn_register.txt: -------------------------------------------------------------------------------- 1 | SYNOPSIS *rhn_register* 2 | 3 | New in version 1.2. 4 | 5 | Manage registration to the Red Hat Network. 6 | 7 | EXAMPLES *rhn_register-examples* 8 | > 9 | # Unregister system from RHN. 10 | - rhn_register: state=absent username=joe_user password=somepass 11 | 12 | # Register as user (joe_user) with password (somepass) and auto-subscribe to available content. 13 | - rhn_register: state=present username=joe_user password=somepass 14 | 15 | # Register with activationkey (1-222333444) and enable extended update support. 16 | - rhn_register: state=present activationkey=1-222333444 enable_eus=true 17 | 18 | # Register as user (joe_user) with password (somepass) against a satellite 19 | # server specified by (server_url). 20 | - rhn_register: > 21 | state=present 22 | username=joe_user 23 | password=somepass 24 | server_url=https://xmlrpc.my.satellite/XMLRPC 25 | 26 | # Register as user (joe_user) with password (somepass) and enable 27 | # channels (rhel-x86_64-server-6-foo-1) and (rhel-x86_64-server-6-bar-1). 28 | - rhn_register: state=present username=joe_user 29 | password=somepass 30 | channels=rhel-x86_64-server-6-foo-1,rhel-x86_64-server-6-bar-1 31 | 32 | Note 33 | 34 | In order to register a system, rhnreg_ks requires either a username and password, or an activationkey. 35 | 36 | MORE INFO *rhn_register-moreinfo* 37 | > 38 | All arguments are omni-completed, but if you really want to see the online docs: 39 | http://docs.ansible.com/rhn_register_module.html 40 | -------------------------------------------------------------------------------- /doc/mod.txt/riak.txt: -------------------------------------------------------------------------------- 1 | SYNOPSIS *riak* 2 | 3 | New in version 1.2. 4 | 5 | This module can be used to join nodes to a cluster, check the status of the cluster. 6 | 7 | EXAMPLES *riak-examples* 8 | > 9 | # Join's a Riak node to another node 10 | - riak: command=join target_node=[email protected] 11 | 12 | # Wait for handoffs to finish. Use with async and poll. 13 | - riak: wait_for_handoffs=yes 14 | 15 | # Wait for riak_kv service to startup 16 | - riak: wait_for_service=kv 17 | 18 | MORE INFO *riak-moreinfo* 19 | > 20 | All arguments are omni-completed, but if you really want to see the online docs: 21 | http://docs.ansible.com/riak_module.html 22 | -------------------------------------------------------------------------------- /doc/mod.txt/rollbar_deployment.txt: -------------------------------------------------------------------------------- 1 | SYNOPSIS *rollbar_deployment* 2 | 3 | New in version 1.6. 4 | 5 | Notify Rollbar about app deployments (see https://rollbar.com/docs/deploys_other/) 6 | 7 | EXAMPLES *rollbar_deployment-examples* 8 | > 9 | - rollbar_deployment: token=AAAAAA 10 | environment='staging' 11 | user='ansible' 12 | revision=4.2, 13 | rollbar_user='admin', 14 | comment='Test Deploy' 15 | 16 | MORE INFO *rollbar_deployment-moreinfo* 17 | > 18 | All arguments are omni-completed, but if you really want to see the online docs: 19 | http://docs.ansible.com/rollbar_deployment_module.html 20 | -------------------------------------------------------------------------------- /doc/mod.txt/rpm_key.txt: -------------------------------------------------------------------------------- 1 | SYNOPSIS *rpm_key* 2 | 3 | New in version 1.3. 4 | 5 | Adds or removes (rpm –import) a gpg key to your rpm database. 6 | 7 | EXAMPLES *rpm_key-examples* 8 | > 9 | # Example action to import a key from a url 10 | - rpm_key: state=present key=http://apt.sw.be/RPM-GPG-KEY.dag.txt 11 | 12 | # Example action to import a key from a file 13 | - rpm_key: state=present key=/path/to/key.gpg 14 | 15 | # Example action to ensure a key is not present in the db 16 | - rpm_key: state=absent key=DEADB33F 17 | 18 | MORE INFO *rpm_key-moreinfo* 19 | > 20 | All arguments are omni-completed, but if you really want to see the online docs: 21 | http://docs.ansible.com/rpm_key_module.html 22 | -------------------------------------------------------------------------------- /doc/mod.txt/s3.txt: -------------------------------------------------------------------------------- 1 | SYNOPSIS *s3* 2 | 3 | New in version 1.1. 4 | 5 | This module allows the user to dictate the presence of a given file in an S3 bucket. If or once the key (file) exists in the bucket, it returns a time-expired download URL. This module has a 6 | dependency on python-boto. 7 | 8 | EXAMPLES *s3-examples* 9 | > 10 | # Simple PUT operation 11 | - s3: bucket=mybucket object=/my/desired/key.txt src=/usr/local/myfile.txt mode=put 12 | 13 | # Simple GET operation 14 | - s3: bucket=mybucket object=/my/desired/key.txt dest=/usr/local/myfile.txt mode=get 15 | 16 | # PUT/upload with metadata 17 | - s3: bucket=mybucket object=/my/desired/key.txt src=/usr/local/myfile.txt mode=put metadata='Content-Encoding=gzip,Cache-Control=no-cache' 18 | 19 | # Create an empty bucket 20 | - s3: bucket=mybucket mode=create 21 | 22 | # Create a bucket with key as directory, in the EU region 23 | - s3: bucket=mybucket object=/my/directory/path mode=create region=eu-west-1 24 | 25 | # Delete a bucket and all contents 26 | - s3: bucket=mybucket mode=delete 27 | 28 | MORE INFO *s3-moreinfo* 29 | > 30 | All arguments are omni-completed, but if you really want to see the online docs: 31 | http://docs.ansible.com/s3_module.html 32 | -------------------------------------------------------------------------------- /doc/mod.txt/script.txt: -------------------------------------------------------------------------------- 1 | SYNOPSIS *script* 2 | 3 | The script module takes the script name followed by a list of space-delimited arguments. The local script at path will be transferred to the remote node and then executed. The given script will 4 | be processed through the shell environment on the remote node. This module does not require python on the remote system, much like the raw module. 5 | 6 | EXAMPLES *script-examples* 7 | > 8 | # Example from Ansible Playbooks 9 | - script: /some/local/script.sh --some-arguments 1234 10 | 11 | # Run a script that creates a file, but only if the file is not yet created 12 | - script: /some/local/create_file.sh --some-arguments 1234 creates=/the/created/file.txt 13 | 14 | # Run a script that removes a file, but only if the file is not yet removed 15 | - script: /some/local/remove_file.sh --some-arguments 1234 removes=/the/removed/file.txt 16 | 17 | Note 18 | 19 | It is usually preferable to write Ansible modules than pushing scripts. Convert your script to an Ansible module for bonus points! 20 | 21 | MORE INFO *script-moreinfo* 22 | > 23 | All arguments are omni-completed, but if you really want to see the online docs: 24 | http://docs.ansible.com/script_module.html 25 | -------------------------------------------------------------------------------- /doc/mod.txt/seboolean.txt: -------------------------------------------------------------------------------- 1 | SYNOPSIS *seboolean* 2 | 3 | Toggles SELinux booleans. 4 | 5 | EXAMPLES *seboolean-examples* 6 | > 7 | # Set (httpd_can_network_connect) flag on and keep it persistent across reboots 8 | - seboolean: name=httpd_can_network_connect state=yes persistent=yes 9 | 10 | Note 11 | 12 | Not tested on any debian based system 13 | 14 | MORE INFO *seboolean-moreinfo* 15 | > 16 | All arguments are omni-completed, but if you really want to see the online docs: 17 | http://docs.ansible.com/seboolean_module.html 18 | -------------------------------------------------------------------------------- /doc/mod.txt/selinux.txt: -------------------------------------------------------------------------------- 1 | SYNOPSIS *selinux* 2 | 3 | Configures the SELinux mode and policy. A reboot may be required after usage. Ansible will not issue this reboot but will let you know when it is required. 4 | 5 | EXAMPLES *selinux-examples* 6 | > 7 | - selinux: policy=targeted state=enforcing 8 | - selinux: policy=targeted state=permissive 9 | - selinux: state=disabled 10 | 11 | Note 12 | 13 | Not tested on any debian based system 14 | 15 | MORE INFO *selinux-moreinfo* 16 | > 17 | All arguments are omni-completed, but if you really want to see the online docs: 18 | http://docs.ansible.com/selinux_module.html 19 | -------------------------------------------------------------------------------- /doc/mod.txt/service.txt: -------------------------------------------------------------------------------- 1 | SYNOPSIS *service* 2 | 3 | Controls services on remote hosts. Supported init systems include BSD init, OpenRC, SysV, systemd, upstart. 4 | 5 | EXAMPLES *service-examples* 6 | > 7 | # Example action to start service httpd, if not running 8 | - service: name=httpd state=started 9 | 10 | # Example action to stop service httpd, if running 11 | - service: name=httpd state=stopped 12 | 13 | # Example action to restart service httpd, in all cases 14 | - service: name=httpd state=restarted 15 | 16 | # Example action to reload service httpd, in all cases 17 | - service: name=httpd state=reloaded 18 | 19 | # Example action to enable service httpd, and not touch the running state 20 | - service: name=httpd enabled=yes 21 | 22 | # Example action to start service foo, based on running process /usr/bin/foo 23 | - service: name=foo pattern=/usr/bin/foo state=started 24 | 25 | # Example action to restart network service for interface eth0 26 | - service: name=network state=restarted args=eth0 27 | 28 | MORE INFO *service-moreinfo* 29 | > 30 | All arguments are omni-completed, but if you really want to see the online docs: 31 | http://docs.ansible.com/service_module.html 32 | -------------------------------------------------------------------------------- /doc/mod.txt/set_fact.txt: -------------------------------------------------------------------------------- 1 | SYNOPSIS *set_fact* 2 | 3 | New in version 1.2. 4 | 5 | This module allows setting new variables. Variables are set on a host-by-host basis just like facts discovered by the setup module. These variables will survive between plays. 6 | 7 | EXAMPLES *set_fact-examples* 8 | > 9 | # Example setting host facts using key=value pairs 10 | - set_fact: one_fact="something" other_fact="{{ local_var * 2 }}" 11 | 12 | # Example setting host facts using complex arguments 13 | - set_fact: 14 | one_fact: something 15 | other_fact: "{{ local_var * 2 }}" 16 | 17 | # As of 1.8, Ansible will convert boolean strings ('true', 'false', 'yes', 'no') 18 | # to proper boolean values when using the key=value syntax, however it is still 19 | # recommended that booleans be set using the complex argument style: 20 | - set_fact: 21 | one_fact: true 22 | other_fact: false 23 | 24 | MORE INFO *set_fact-moreinfo* 25 | > 26 | All arguments are omni-completed, but if you really want to see the online docs: 27 | http://docs.ansible.com/set_fact_module.html 28 | -------------------------------------------------------------------------------- /doc/mod.txt/shell.txt: -------------------------------------------------------------------------------- 1 | SYNOPSIS *shell* 2 | 3 | The shell module takes the command name followed by a list of space-delimited arguments. It is almost exactly like the command module but runs the command through a shell (/bin/sh) on the remote 4 | node. 5 | 6 | EXAMPLES *shell-examples* 7 | > 8 | # Execute the command in remote shell; stdout goes to the specified 9 | # file on the remote. 10 | - shell: somescript.sh >> somelog.txt 11 | 12 | # Change the working directory to somedir/ before executing the command. 13 | - shell: somescript.sh >> somelog.txt chdir=somedir/ 14 | 15 | # You can also use the 'args' form to provide the options. This command 16 | # will change the working directory to somedir/ and will only run when 17 | # somedir/somelog.txt doesn't exist. 18 | - shell: somescript.sh >> somelog.txt 19 | args: 20 | chdir: somedir/ 21 | creates: somelog.txt 22 | 23 | Note 24 | 25 | If you want to execute a command securely and predictably, it may be better to use the command module instead. Best practices when writing playbooks will follow the trend of using command unless 26 | shell is explicitly required. When running ad-hoc commands, use your best judgement. 27 | 28 | Note 29 | 30 | To sanitize any variables passed to the shell module, you should use “{{ var | quote }}” instead of just “{{ var }}” to make sure they don’t include evil things like semicolons. 31 | 32 | MORE INFO *shell-moreinfo* 33 | > 34 | All arguments are omni-completed, but if you really want to see the online docs: 35 | http://docs.ansible.com/shell_module.html 36 | -------------------------------------------------------------------------------- /doc/mod.txt/slack.txt: -------------------------------------------------------------------------------- 1 | SYNOPSIS *slack* 2 | 3 | New in version 1.6. 4 | 5 | The slack module sends notifications to http://slack.com via the Incoming WebHook integration 6 | 7 | EXAMPLES *slack-examples* 8 | > 9 | - name: Send notification message via Slack 10 | local_action: 11 | module: slack 12 | domain: future500.slack.com 13 | token: thetokengeneratedbyslack 14 | msg: "{{ inventory_hostname }} completed" 15 | 16 | - name: Send notification message via Slack all options 17 | local_action: 18 | module: slack 19 | domain: future500.slack.com 20 | token: thetokengeneratedbyslack 21 | msg: "{{ inventory_hostname }} completed" 22 | channel: "#ansible" 23 | username: "Ansible on {{ inventory_hostname }}" 24 | icon_url: "http://www.example.com/some-image-file.png" 25 | link_names: 0 26 | parse: 'none' 27 | 28 | MORE INFO *slack-moreinfo* 29 | > 30 | All arguments are omni-completed, but if you really want to see the online docs: 31 | http://docs.ansible.com/slack_module.html 32 | -------------------------------------------------------------------------------- /doc/mod.txt/slurp.txt: -------------------------------------------------------------------------------- 1 | SYNOPSIS *slurp* 2 | 3 | This module works like fetch. It is used for fetching a base64- encoded blob containing the data in a remote file. 4 | 5 | EXAMPLES *slurp-examples* 6 | > 7 | ansible host -m slurp -a 'src=/tmp/xx' 8 | host | success >> { 9 | "content": "aGVsbG8gQW5zaWJsZSB3b3JsZAo=", 10 | "encoding": "base64" 11 | } 12 | 13 | Note 14 | 15 | See also: fetch 16 | 17 | MORE INFO *slurp-moreinfo* 18 | > 19 | All arguments are omni-completed, but if you really want to see the online docs: 20 | http://docs.ansible.com/slurp_module.html 21 | -------------------------------------------------------------------------------- /doc/mod.txt/snmp_facts.txt: -------------------------------------------------------------------------------- 1 | SYNOPSIS *snmp_facts* 2 | 3 | New in version 1.9. 4 | 5 | Retrieve facts for a device using SNMP, the facts will be inserted to the ansible_facts key. 6 | 7 | EXAMPLES *snmp_facts-examples* 8 | > 9 | # Gather facts with SNMP version 2 10 | - snmp_facts: host={{ inventory_hostname }} version=2c community=public 11 | connection: local 12 | 13 | # Gather facts using SNMP version 3 14 | - snmp_facts: 15 | host={{ inventory_hostname }} 16 | version=v3 17 | level=authPriv 18 | integrity=sha 19 | privacy=aes 20 | username=snmp-user 21 | authkey=abc12345 22 | privkey=def6789 23 | delegate_to: localhost 24 | 25 | MORE INFO *snmp_facts-moreinfo* 26 | > 27 | All arguments are omni-completed, but if you really want to see the online docs: 28 | http://docs.ansible.com/snmp_facts_module.html 29 | -------------------------------------------------------------------------------- /doc/mod.txt/sns.txt: -------------------------------------------------------------------------------- 1 | SYNOPSIS *sns* 2 | 3 | New in version 1.6. 4 | 5 | The sns module sends notifications to a topic on your Amazon SNS account 6 | 7 | EXAMPLES *sns-examples* 8 | > 9 | - name: Send default notification message via SNS 10 | local_action: 11 | module: sns 12 | msg: "{{ inventory_hostname }} has completed the play." 13 | subject: "Deploy complete!" 14 | topic: "deploy" 15 | 16 | - name: Send notification messages via SNS with short message for SMS 17 | local_action: 18 | module: sns 19 | msg: "{{ inventory_hostname }} has completed the play." 20 | sms: "deployed!" 21 | subject: "Deploy complete!" 22 | topic: "deploy" 23 | 24 | MORE INFO *sns-moreinfo* 25 | > 26 | All arguments are omni-completed, but if you really want to see the online docs: 27 | http://docs.ansible.com/sns_module.html 28 | -------------------------------------------------------------------------------- /doc/mod.txt/stackdriver.txt: -------------------------------------------------------------------------------- 1 | SYNOPSIS *stackdriver* 2 | 3 | New in version 1.6. 4 | 5 | Send code deploy and annotation events to Stackdriver 6 | 7 | EXAMPLES *stackdriver-examples* 8 | > 9 | - stackdriver: key=AAAAAA event=deploy deployed_to=production deployed_by=leeroyjenkins repository=MyWebApp revision_id=abcd123 10 | 11 | - stackdriver: key=AAAAAA event=annotation msg="Greetings from Ansible" annotated_by=leeroyjenkins level=WARN instance_id=i-abcd1234 12 | 13 | MORE INFO *stackdriver-moreinfo* 14 | > 15 | All arguments are omni-completed, but if you really want to see the online docs: 16 | http://docs.ansible.com/stackdriver_module.html 17 | -------------------------------------------------------------------------------- /doc/mod.txt/stat.txt: -------------------------------------------------------------------------------- 1 | SYNOPSIS *stat* 2 | 3 | New in version 1.3. 4 | 5 | Retrieves facts for a file similar to the linux/unix ‘stat’ command. 6 | 7 | EXAMPLES *stat-examples* 8 | > 9 | # Obtain the stats of /etc/foo.conf, and check that the file still belongs 10 | # to 'root'. Fail otherwise. 11 | - stat: path=/etc/foo.conf 12 | register: st 13 | - fail: msg="Whoops! file ownership has changed" 14 | when: st.stat.pw_name != 'root' 15 | 16 | # Determine if a path exists and is a directory. Note that we need to test 17 | # both that p.stat.isdir actually exists, and also that it's set to true. 18 | - stat: path=/path/to/something 19 | register: p 20 | - debug: msg="Path exists and is a directory" 21 | when: p.stat.isdir is defined and p.stat.isdir 22 | 23 | # Don't do md5 checksum 24 | - stat: path=/path/to/myhugefile get_md5=no 25 | 26 | MORE INFO *stat-moreinfo* 27 | > 28 | All arguments are omni-completed, but if you really want to see the online docs: 29 | http://docs.ansible.com/stat_module.html 30 | -------------------------------------------------------------------------------- /doc/mod.txt/subversion.txt: -------------------------------------------------------------------------------- 1 | SYNOPSIS *subversion* 2 | 3 | Deploy given repository URL / revision to dest. If dest exists, update to the specified revision, otherwise perform a checkout. 4 | 5 | EXAMPLES *subversion-examples* 6 | > 7 | # Checkout subversion repository to specified folder. 8 | - subversion: repo=svn+ssh://an.example.org/path/to/repo dest=/src/checkout 9 | 10 | # Export subversion directory to folder 11 | - subversion: repo=svn+ssh://an.example.org/path/to/repo dest=/src/export export=True 12 | 13 | Note 14 | 15 | Requires svn to be installed on the client. 16 | 17 | MORE INFO *subversion-moreinfo* 18 | > 19 | All arguments are omni-completed, but if you really want to see the online docs: 20 | http://docs.ansible.com/subversion_module.html 21 | -------------------------------------------------------------------------------- /doc/mod.txt/supervisorctl.txt: -------------------------------------------------------------------------------- 1 | SYNOPSIS *supervisorctl* 2 | 3 | Manage the state of a program or group of programs running via supervisord 4 | 5 | EXAMPLES *supervisorctl-examples* 6 | > 7 | # Manage the state of program to be in 'started' state. 8 | - supervisorctl: name=my_app state=started 9 | 10 | # Manage the state of program group to be in 'started' state. 11 | - supervisorctl: name='my_apps:' state=started 12 | 13 | # Restart my_app, reading supervisorctl configuration from a specified file. 14 | - supervisorctl: name=my_app state=restarted config=/var/opt/my_project/supervisord.conf 15 | 16 | # Restart my_app, connecting to supervisord with credentials and server URL. 17 | - supervisorctl: name=my_app state=restarted username=test password=testpass server_url=http://localhost:9001 18 | 19 | Note 20 | 21 | When state = present, the module will call supervisorctl reread then supervisorctl add if the program/group does not exist. 22 | 23 | Note 24 | 25 | When state = restarted, the module will call supervisorctl update then call supervisorctl restart. 26 | 27 | MORE INFO *supervisorctl-moreinfo* 28 | > 29 | All arguments are omni-completed, but if you really want to see the online docs: 30 | http://docs.ansible.com/supervisorctl_module.html 31 | -------------------------------------------------------------------------------- /doc/mod.txt/svr4pkg.txt: -------------------------------------------------------------------------------- 1 | SYNOPSIS *svr4pkg* 2 | 3 | Manages SVR4 packages on Solaris 10 and 11. These were the native packages on Solaris <= 10 and are available as a legacy feature in Solaris 11. Note that this is a very basic packaging system. 4 | It will not enforce dependencies on install or remove. 5 | 6 | EXAMPLES *svr4pkg-examples* 7 | > 8 | # Install a package from an already copied file 9 | - svr4pkg: name=CSWcommon src=/tmp/cswpkgs.pkg state=present 10 | 11 | # Install a package directly from an http site 12 | - svr4pkg: name=CSWpkgutil src=http://get.opencsw.org/now state=present zone=current 13 | 14 | # Install a package with a response file 15 | - svr4pkg: name=CSWggrep src=/tmp/third-party.pkg response_file=/tmp/ggrep.response state=present 16 | 17 | # Ensure that a package is not installed. 18 | - svr4pkg: name=SUNWgnome-sound-recorder state=absent 19 | 20 | # Ensure that a category is not installed. 21 | - svr4pkg: name=FIREFOX state=absent category=true 22 | 23 | MORE INFO *svr4pkg-moreinfo* 24 | > 25 | All arguments are omni-completed, but if you really want to see the online docs: 26 | http://docs.ansible.com/svr4pkg_module.html 27 | -------------------------------------------------------------------------------- /doc/mod.txt/swdepot.txt: -------------------------------------------------------------------------------- 1 | SYNOPSIS *swdepot* 2 | 3 | New in version 1.4. 4 | 5 | Will install, upgrade and remove packages with swdepot package manager (HP-UX) 6 | 7 | EXAMPLES *swdepot-examples* 8 | > 9 | - swdepot: name=unzip-6.0 state=installed depot=repository:/path 10 | - swdepot: name=unzip state=latest depot=repository:/path 11 | - swdepot: name=unzip state=absent 12 | 13 | MORE INFO *swdepot-moreinfo* 14 | > 15 | All arguments are omni-completed, but if you really want to see the online docs: 16 | http://docs.ansible.com/swdepot_module.html 17 | -------------------------------------------------------------------------------- /doc/mod.txt/sysctl.txt: -------------------------------------------------------------------------------- 1 | SYNOPSIS *sysctl* 2 | 3 | New in version 1.0. 4 | 5 | This module manipulates sysctl entries and optionally performs a /sbin/sysctl -p after changing them. 6 | 7 | EXAMPLES *sysctl-examples* 8 | > 9 | # Set vm.swappiness to 5 in /etc/sysctl.conf 10 | - sysctl: name=vm.swappiness value=5 state=present 11 | 12 | # Remove kernel.panic entry from /etc/sysctl.conf 13 | - sysctl: name=kernel.panic state=absent sysctl_file=/etc/sysctl.conf 14 | 15 | # Set kernel.panic to 3 in /tmp/test_sysctl.conf 16 | - sysctl: name=kernel.panic value=3 sysctl_file=/tmp/test_sysctl.conf reload=no 17 | 18 | # Set ip forwarding on in /proc and do not reload the sysctl file 19 | - sysctl: name="net.ipv4.ip_forward" value=1 sysctl_set=yes 20 | 21 | # Set ip forwarding on in /proc and in the sysctl file and reload if necessary 22 | - sysctl: name="net.ipv4.ip_forward" value=1 sysctl_set=yes state=present reload=yes 23 | 24 | MORE INFO *sysctl-moreinfo* 25 | > 26 | All arguments are omni-completed, but if you really want to see the online docs: 27 | http://docs.ansible.com/sysctl_module.html 28 | -------------------------------------------------------------------------------- /doc/mod.txt/tags: -------------------------------------------------------------------------------- 1 | ansible-a10_server a10_server.txt /*ansible-a10_server* 2 | ansible-a10_server-examples a10_server.txt /*ansible-a10_server-examples* 3 | -------------------------------------------------------------------------------- /doc/mod.txt/twilio.txt: -------------------------------------------------------------------------------- 1 | SYNOPSIS *twilio* 2 | 3 | New in version 1.6. 4 | 5 | Sends a text message to a phone number through an the Twilio SMS service. 6 | 7 | EXAMPLES *twilio-examples* 8 | > 9 | # send a text message from the local server about the build status to (555) 303 5681 10 | # note: you have to have purchased the 'from_number' on your Twilio account 11 | - local_action: text msg="All servers with webserver role are now configured." 12 | account_sid={{ twilio_account_sid }} 13 | auth_token={{ twilio_auth_token }} 14 | from_number=+15552014545 to_number=+15553035681 15 | 16 | # send a text message from a server to (555) 111 3232 17 | # note: you have to have purchased the 'from_number' on your Twilio account 18 | - text: msg="This server's configuration is now complete." 19 | account_sid={{ twilio_account_sid }} 20 | auth_token={{ twilio_auth_token }} 21 | from_number=+15553258899 to_number=+15551113232 22 | 23 | Note 24 | 25 | Like the other notification modules, this one requires an external dependency to work. In this case, you’ll need a Twilio account with a purchased or verified phone number to send the text 26 | message. 27 | 28 | MORE INFO *twilio-moreinfo* 29 | > 30 | All arguments are omni-completed, but if you really want to see the online docs: 31 | http://docs.ansible.com/twilio_module.html 32 | -------------------------------------------------------------------------------- /doc/mod.txt/typetalk.txt: -------------------------------------------------------------------------------- 1 | SYNOPSIS *typetalk* 2 | 3 | New in version 1.6. 4 | 5 | Send a message to typetalk using typetalk API ( http://developers.typetalk.in/ ) 6 | 7 | EXAMPLES *typetalk-examples* 8 | > 9 | - typetalk: client_id=12345 client_secret=12345 topic=1 msg="install completed" 10 | 11 | MORE INFO *typetalk-moreinfo* 12 | > 13 | All arguments are omni-completed, but if you really want to see the online docs: 14 | http://docs.ansible.com/typetalk_module.html 15 | -------------------------------------------------------------------------------- /doc/mod.txt/unarchive.txt: -------------------------------------------------------------------------------- 1 | SYNOPSIS *unarchive* 2 | 3 | New in version 1.4. 4 | 5 | The unarchive module copies an archive file from the local machine to a remote and unpacks it. 6 | 7 | EXAMPLES *unarchive-examples* 8 | > 9 | # Example from Ansible Playbooks 10 | - unarchive: src=foo.tgz dest=/var/lib/foo 11 | 12 | # Unarchive a file that is already on the remote machine 13 | - unarchive: src=/tmp/foo.zip dest=/usr/local/bin copy=no 14 | 15 | Note 16 | 17 | requires tar/unzip command on target host 18 | 19 | Note 20 | 21 | can handle gzip, bzip2 and xz compressed as well as uncompressed tar files 22 | 23 | Note 24 | 25 | detects type of archive automatically 26 | 27 | Note 28 | 29 | uses tar’s --diff arg to calculate if changed or not. If this arg is not supported, it will always unpack the archive 30 | 31 | Note 32 | 33 | does not detect if a .zip file is different from destination - always unzips 34 | 35 | Note 36 | 37 | existing files/directories in the destination which are not in the archive are not touched. This is the same behavior as a normal archive extraction 38 | 39 | Note 40 | 41 | existing files/directories in the destination which are not in the archive are ignored for purposes of deciding if the archive should be unpacked or not 42 | 43 | MORE INFO *unarchive-moreinfo* 44 | > 45 | All arguments are omni-completed, but if you really want to see the online docs: 46 | http://docs.ansible.com/unarchive_module.html 47 | -------------------------------------------------------------------------------- /doc/mod.txt/uptimerobot.txt: -------------------------------------------------------------------------------- 1 | SYNOPSIS *uptimerobot* 2 | 3 | New in version 1.9. 4 | 5 | This module will let you start and pause Uptime Robot Monitoring 6 | 7 | EXAMPLES *uptimerobot-examples* 8 | > 9 | # Pause the monitor with an ID of 12345. 10 | - uptimerobot: monitorid=12345 11 | apikey=12345-1234512345 12 | state=paused 13 | 14 | # Start the monitor with an ID of 12345. 15 | - uptimerobot: monitorid=12345 16 | apikey=12345-1234512345 17 | state=started 18 | 19 | Note 20 | 21 | Support for adding and removing monitors and alert contacts has not yet been implemented. 22 | 23 | MORE INFO *uptimerobot-moreinfo* 24 | > 25 | All arguments are omni-completed, but if you really want to see the online docs: 26 | http://docs.ansible.com/uptimerobot_module.html 27 | -------------------------------------------------------------------------------- /doc/mod.txt/urpmi.txt: -------------------------------------------------------------------------------- 1 | SYNOPSIS *urpmi* 2 | 3 | New in version 1.3.4. 4 | 5 | Manages packages with urpmi (such as for Mageia or Mandriva) 6 | 7 | EXAMPLES *urpmi-examples* 8 | > 9 | # install package foo 10 | - urpmi: pkg=foo state=present 11 | # remove package foo 12 | - urpmi: pkg=foo state=absent 13 | # description: remove packages foo and bar 14 | - urpmi: pkg=foo,bar state=absent 15 | # description: update the package database (urpmi.update -a -q) and install bar (bar will be the updated if a newer version exists) 16 | - urpmi: name=bar, state=present, update_cache=yes 17 | 18 | MORE INFO *urpmi-moreinfo* 19 | > 20 | All arguments are omni-completed, but if you really want to see the online docs: 21 | http://docs.ansible.com/urpmi_module.html 22 | -------------------------------------------------------------------------------- /doc/mod.txt/user.txt: -------------------------------------------------------------------------------- 1 | SYNOPSIS *user* 2 | 3 | Manage user accounts and user attributes. 4 | 5 | EXAMPLES *user-examples* 6 | > 7 | # Add the user 'johnd' with a specific uid and a primary group of 'admin' 8 | - user: name=johnd comment="John Doe" uid=1040 group=admin 9 | 10 | # Add the user 'james' with a bash shell, appending the group 'admins' and 'developers' to the user's groups 11 | - user: name=james shell=/bin/bash groups=admins,developers append=yes 12 | 13 | # Remove the user 'johnd' 14 | - user: name=johnd state=absent remove=yes 15 | 16 | # Create a 2048-bit SSH key for user jsmith in ~jsmith/.ssh/id_rsa 17 | - user: name=jsmith generate_ssh_key=yes ssh_key_bits=2048 ssh_key_file=.ssh/id_rsa 18 | 19 | MORE INFO *user-moreinfo* 20 | > 21 | All arguments are omni-completed, but if you really want to see the online docs: 22 | http://docs.ansible.com/user_module.html 23 | -------------------------------------------------------------------------------- /doc/mod.txt/virt.txt: -------------------------------------------------------------------------------- 1 | SYNOPSIS *virt* 2 | 3 | Manages virtual machines supported by libvirt. 4 | 5 | EXAMPLES *virt-examples* 6 | > 7 | # a playbook task line: 8 | - virt: name=alpha state=running 9 | 10 | # /usr/bin/ansible invocations 11 | ansible host -m virt -a "name=alpha command=status" 12 | ansible host -m virt -a "name=alpha command=get_xml" 13 | ansible host -m virt -a "name=alpha command=create uri=lxc:///" 14 | 15 | # a playbook example of defining and launching an LXC guest 16 | tasks: 17 | - name: define vm 18 | virt: name=foo 19 | command=define 20 | xml="{{ lookup('template', 'container-template.xml.j2') }}" 21 | uri=lxc:/// 22 | - name: start vm 23 | virt: name=foo state=running uri=lxc:/// 24 | 25 | MORE INFO *virt-moreinfo* 26 | > 27 | All arguments are omni-completed, but if you really want to see the online docs: 28 | http://docs.ansible.com/virt_module.html 29 | -------------------------------------------------------------------------------- /doc/mod.txt/win_chocolatey.txt: -------------------------------------------------------------------------------- 1 | SYNOPSIS *win_chocolatey* 2 | 3 | New in version 1.9. 4 | 5 | Installs packages using Chocolatey (http://chocolatey.org/). If Chocolatey is missing from the system, the module will install it. List of packages can be found at http://chocolatey.org/packages 6 | 7 | EXAMPLES *win_chocolatey-examples* 8 | > 9 | # Install git 10 | win_chocolatey: 11 | name: git 12 | 13 | # Install notepadplusplus version 6.6 14 | win_chocolatey: 15 | name: notepadplusplus.install 16 | version: 6.6 17 | 18 | # Uninstall git 19 | win_chocolatey: 20 | name: git 21 | state: absent 22 | 23 | # Install Application Request Routing v3 from webpi 24 | # Logically, this requires that you install IIS first (see win_feature) 25 | # To find a list of packages available via webpi source, `choco list -source webpi` 26 | win_chocolatey: 27 | name: ARRv3 28 | source: webpi 29 | 30 | MORE INFO *win_chocolatey-moreinfo* 31 | > 32 | All arguments are omni-completed, but if you really want to see the online docs: 33 | http://docs.ansible.com/win_chocolatey_module.html 34 | -------------------------------------------------------------------------------- /doc/mod.txt/win_feature.txt: -------------------------------------------------------------------------------- 1 | SYNOPSIS *win_feature* 2 | 3 | New in version 1.7. 4 | 5 | Installs or uninstalls Windows Roles or Features 6 | 7 | EXAMPLES *win_feature-examples* 8 | > 9 | # This installs IIS. 10 | # The names of features available for install can be run by running the following Powershell Command: 11 | # PS C:\Users\Administrator> Import-Module ServerManager; Get-WindowsFeature 12 | $ ansible -i hosts -m win_feature -a "name=Web-Server" all 13 | $ ansible -i hosts -m win_feature -a "name=Web-Server,Web-Common-Http" all 14 | 15 | 16 | # Playbook example 17 | --- 18 | - name: Install IIS 19 | hosts: all 20 | gather_facts: false 21 | tasks: 22 | - name: Install IIS 23 | win_feature: 24 | name: "Web-Server" 25 | state: absent 26 | restart: yes 27 | include_sub_features: yes 28 | include_management_tools: yes 29 | 30 | MORE INFO *win_feature-moreinfo* 31 | > 32 | All arguments are omni-completed, but if you really want to see the online docs: 33 | http://docs.ansible.com/win_feature_module.html 34 | -------------------------------------------------------------------------------- /doc/mod.txt/win_get_url.txt: -------------------------------------------------------------------------------- 1 | SYNOPSIS *win_get_url* 2 | 3 | New in version 1.7. 4 | 5 | Fetches a file from a URL and saves to locally 6 | 7 | EXAMPLES *win_get_url-examples* 8 | > 9 | # Downloading a JPEG and saving it to a file with the ansible command. 10 | # Note the "dest" is quoted rather instead of escaping the backslashes 11 | $ ansible -i hosts -c winrm -m win_get_url -a "url=http://www.example.com/earthrise.jpg dest='C:\Users\Administrator\earthrise.jpg'" all 12 | 13 | # Playbook example 14 | - name: Download earthrise.jpg to 'C:\Users\RandomUser\earthrise.jpg' 15 | win_get_url: 16 | url: 'http://www.example.com/earthrise.jpg' 17 | dest: 'C:\Users\RandomUser\earthrise.jpg' 18 | 19 | MORE INFO *win_get_url-moreinfo* 20 | > 21 | All arguments are omni-completed, but if you really want to see the online docs: 22 | http://docs.ansible.com/win_get_url_module.html 23 | -------------------------------------------------------------------------------- /doc/mod.txt/win_group.txt: -------------------------------------------------------------------------------- 1 | SYNOPSIS *win_group* 2 | 3 | New in version 1.7. 4 | 5 | Add and remove local groups 6 | 7 | EXAMPLES *win_group-examples* 8 | > 9 | # Create a new group 10 | win_group: 11 | name: deploy 12 | description: Deploy Group 13 | state: present 14 | 15 | # Remove a group 16 | win_group: 17 | name: deploy 18 | state: absent 19 | 20 | MORE INFO *win_group-moreinfo* 21 | > 22 | All arguments are omni-completed, but if you really want to see the online docs: 23 | http://docs.ansible.com/win_group_module.html 24 | -------------------------------------------------------------------------------- /doc/mod.txt/win_msi.txt: -------------------------------------------------------------------------------- 1 | SYNOPSIS *win_msi* 2 | 3 | New in version 1.7. 4 | 5 | Installs or uninstalls a Windows MSI file that is already located on the target server 6 | 7 | EXAMPLES *win_msi-examples* 8 | > 9 | # Install an MSI file 10 | - win_msi: path=C:\\7z920-x64.msi 11 | 12 | # Uninstall an MSI file 13 | - win_msi: path=C:\\7z920-x64.msi state=absent 14 | 15 | MORE INFO *win_msi-moreinfo* 16 | > 17 | All arguments are omni-completed, but if you really want to see the online docs: 18 | http://docs.ansible.com/win_msi_module.html 19 | -------------------------------------------------------------------------------- /doc/mod.txt/win_ping.txt: -------------------------------------------------------------------------------- 1 | SYNOPSIS *win_ping* 2 | 3 | New in version 1.7. 4 | 5 | Checks management connectivity of a windows host 6 | 7 | EXAMPLES *win_ping-examples* 8 | > 9 | # Test connectivity to a windows host 10 | ansible winserver -m win_ping 11 | 12 | # Example from an Ansible Playbook 13 | - action: win_ping 14 | 15 | MORE INFO *win_ping-moreinfo* 16 | > 17 | All arguments are omni-completed, but if you really want to see the online docs: 18 | http://docs.ansible.com/win_ping_module.html 19 | -------------------------------------------------------------------------------- /doc/mod.txt/win_service.txt: -------------------------------------------------------------------------------- 1 | SYNOPSIS *win_service* 2 | 3 | New in version 1.7. 4 | 5 | Manages Windows services 6 | 7 | EXAMPLES *win_service-examples* 8 | > 9 | # Restart a service 10 | win_service: 11 | name: spooler 12 | state: restarted 13 | 14 | # Set service startup mode to auto and ensure it is started 15 | win_service: 16 | name: spooler 17 | start_mode: auto 18 | state: started 19 | 20 | MORE INFO *win_service-moreinfo* 21 | > 22 | All arguments are omni-completed, but if you really want to see the online docs: 23 | http://docs.ansible.com/win_service_module.html 24 | -------------------------------------------------------------------------------- /doc/mod.txt/win_stat.txt: -------------------------------------------------------------------------------- 1 | SYNOPSIS *win_stat* 2 | 3 | New in version 1.7. 4 | 5 | Returns information about a Windows file 6 | 7 | EXAMPLES *win_stat-examples* 8 | > 9 | # Obtain information about a file 10 | 11 | - win_stat: path=C:\foo.ini 12 | register: file_info 13 | 14 | - debug: var=file_info 15 | 16 | MORE INFO *win_stat-moreinfo* 17 | > 18 | All arguments are omni-completed, but if you really want to see the online docs: 19 | http://docs.ansible.com/win_stat_module.html 20 | -------------------------------------------------------------------------------- /doc/mod.txt/win_updates.txt: -------------------------------------------------------------------------------- 1 | SYNOPSIS *win_updates* 2 | 3 | New in version 1.9. 4 | 5 | Installs windows updates using PSWindowsUpdate (http://gallery.technet.microsoft.com/scriptcenter/2d191bcd-3308-4edd-9de2-88dff796b0bc). PSWindowsUpdate needs to be installed first - use 6 | win_chocolatey. 7 | 8 | EXAMPLES *win_updates-examples* 9 | > 10 | # Install updates from security category 11 | win_updates: 12 | category: security 13 | 14 | MORE INFO *win_updates-moreinfo* 15 | > 16 | All arguments are omni-completed, but if you really want to see the online docs: 17 | http://docs.ansible.com/win_updates_module.html 18 | -------------------------------------------------------------------------------- /doc/mod.txt/win_user.txt: -------------------------------------------------------------------------------- 1 | SYNOPSIS *win_user* 2 | 3 | New in version 1.7. 4 | 5 | Manages local Windows user accounts 6 | 7 | EXAMPLES *win_user-examples* 8 | > 9 | # Ad-hoc example 10 | $ ansible -i hosts -m win_user -a "name=bob password=Password12345 groups=Users" all 11 | $ ansible -i hosts -m win_user -a "name=bob state=absent" all 12 | 13 | # Playbook example 14 | --- 15 | - name: Add a user 16 | hosts: all 17 | gather_facts: false 18 | tasks: 19 | - name: Add User 20 | win_user: 21 | name: ansible 22 | password: "@ns1bl3" 23 | groups: ["Users"] 24 | 25 | MORE INFO *win_user-moreinfo* 26 | > 27 | All arguments are omni-completed, but if you really want to see the online docs: 28 | http://docs.ansible.com/win_user_module.html 29 | -------------------------------------------------------------------------------- /doc/mod.txt/xattr.txt: -------------------------------------------------------------------------------- 1 | SYNOPSIS *xattr* 2 | 3 | New in version 1.3. 4 | 5 | Manages filesystem user defined extended attributes, requires that they are enabled on the target filesystem and that the setfattr/getfattr utilities are present. 6 | 7 | EXAMPLES *xattr-examples* 8 | > 9 | # Obtain the extended attributes of /etc/foo.conf 10 | - xattr: name=/etc/foo.conf 11 | 12 | # Sets the key 'foo' to value 'bar' 13 | - xattr: path=/etc/foo.conf key=user.foo value=bar 14 | 15 | # Removes the key 'foo' 16 | - xattr: name=/etc/foo.conf key=user.foo state=absent 17 | 18 | MORE INFO *xattr-moreinfo* 19 | > 20 | All arguments are omni-completed, but if you really want to see the online docs: 21 | http://docs.ansible.com/xattr_module.html 22 | -------------------------------------------------------------------------------- /doc/mod.txt/yum.txt: -------------------------------------------------------------------------------- 1 | SYNOPSIS *yum* 2 | 3 | Installs, upgrade, removes, and lists packages and groups with the yum package manager. 4 | 5 | EXAMPLES *yum-examples* 6 | > 7 | - name: install the latest version of Apache 8 | yum: name=httpd state=latest 9 | 10 | - name: remove the Apache package 11 | yum: name=httpd state=absent 12 | 13 | - name: install the latest version of Apache from the testing repo 14 | yum: name=httpd enablerepo=testing state=present 15 | 16 | - name: upgrade all packages 17 | yum: name=* state=latest 18 | 19 | - name: install the nginx rpm from a remote repo 20 | yum: name=http://nginx.org/packages/centos/6/noarch/RPMS/nginx-release-centos-6-0.el6.ngx.noarch.rpm state=present 21 | 22 | - name: install nginx rpm from a local file 23 | yum: name=/usr/local/src/nginx-release-centos-6-0.el6.ngx.noarch.rpm state=present 24 | 25 | - name: install the 'Development tools' package group 26 | yum: name="@Development tools" state=present 27 | 28 | MORE INFO *yum-moreinfo* 29 | > 30 | All arguments are omni-completed, but if you really want to see the online docs: 31 | http://docs.ansible.com/yum_module.html 32 | -------------------------------------------------------------------------------- /doc/mod.txt/zabbix_group.txt: -------------------------------------------------------------------------------- 1 | SYNOPSIS *zabbix_group* 2 | 3 | New in version 1.8. 4 | 5 | This module uses the Zabbix API to add and remove host groups. 6 | 7 | EXAMPLES *zabbix_group-examples* 8 | > 9 | --- 10 | # Add a new host group to Zabbix 11 | - zabbix_group: host_group='Linux servers' 12 | server_url=https://monitoring.example.com/zabbix 13 | login_user=ansible 14 | login_password=secure 15 | 16 | # Add a new host group, login data is provided by environment variables: 17 | # ZABBIX_LOGIN_USER, ZABBIX_LOGIN_PASSWORD, ZABBIX_SERVER_URL: 18 | - zabbix_group: host_group=Webservers 19 | 20 | # Remove a host group from Zabbix 21 | - zabbix_group: host_group='Linux servers' 22 | state=absent 23 | server_url=https://monitoring.example.com/zabbix 24 | login_user=ansible 25 | login_password=secure 26 | 27 | Note 28 | 29 | The module has been tested with Zabbix Server 2.2. 30 | 31 | MORE INFO *zabbix_group-moreinfo* 32 | > 33 | All arguments are omni-completed, but if you really want to see the online docs: 34 | http://docs.ansible.com/zabbix_group_module.html 35 | -------------------------------------------------------------------------------- /doc/mod.txt/zfs.txt: -------------------------------------------------------------------------------- 1 | SYNOPSIS *zfs* 2 | 3 | New in version 1.1. 4 | 5 | Manages ZFS file systems on Solaris and FreeBSD. Can manage file systems, volumes and snapshots. See zfs(1M) for more information about the properties. 6 | 7 | EXAMPLES *zfs-examples* 8 | > 9 | # Create a new file system called myfs in pool rpool 10 | - zfs: name=rpool/myfs state=present 11 | 12 | # Create a new volume called myvol in pool rpool. 13 | - zfs: name=rpool/myvol state=present volsize=10M 14 | 15 | # Create a snapshot of rpool/myfs file system. 16 | - zfs: name=rpool/myfs@mysnapshot state=present 17 | 18 | # Create a new file system called myfs2 with snapdir enabled 19 | - zfs: name=rpool/myfs2 state=present snapdir=enabled 20 | 21 | MORE INFO *zfs-moreinfo* 22 | > 23 | All arguments are omni-completed, but if you really want to see the online docs: 24 | http://docs.ansible.com/zfs_module.html 25 | -------------------------------------------------------------------------------- /doc/mod.txt/zypper.txt: -------------------------------------------------------------------------------- 1 | SYNOPSIS *zypper* 2 | 3 | New in version 1.2. 4 | 5 | Manage packages on SUSE and openSUSE using the zypper and rpm tools. 6 | 7 | EXAMPLES *zypper-examples* 8 | > 9 | # Install "nmap" 10 | - zypper: name=nmap state=present 11 | 12 | # Install apache2 with recommended packages 13 | - zypper: name=apache2 state=present disable_recommends=no 14 | 15 | # Remove the "nmap" package 16 | - zypper: name=nmap state=absent 17 | 18 | MORE INFO *zypper-moreinfo* 19 | > 20 | All arguments are omni-completed, but if you really want to see the online docs: 21 | http://docs.ansible.com/zypper_module.html 22 | -------------------------------------------------------------------------------- /doc/mod.txt/zypper_repository.txt: -------------------------------------------------------------------------------- 1 | SYNOPSIS *zypper_repository* 2 | 3 | New in version 1.4. 4 | 5 | Add or remove Zypper repositories on SUSE and openSUSE 6 | 7 | EXAMPLES *zypper_repository-examples* 8 | > 9 | # Add NVIDIA repository for graphics drivers 10 | - zypper_repository: name=nvidia-repo repo='ftp://download.nvidia.com/opensuse/12.2' state=present 11 | 12 | # Remove NVIDIA repository 13 | - zypper_repository: name=nvidia-repo repo='ftp://download.nvidia.com/opensuse/12.2' state=absent 14 | 15 | # Add python development repository 16 | - zypper_repository: repo=http://download.opensuse.org/repositories/devel:/languages:/python/SLE_11_SP3/devel:languages:python.repo 17 | 18 | MORE INFO *zypper_repository-moreinfo* 19 | > 20 | All arguments are omni-completed, but if you really want to see the online docs: 21 | http://docs.ansible.com/zypper_repository_module.html 22 | -------------------------------------------------------------------------------- /examples/demo.md: -------------------------------------------------------------------------------- 1 | ## Demo 2 | 3 | - open new file to show vanilla yaml ansible 4 | - add line: ---# vim:se ft=ansible: 5 | - reopen 6 | - set ft=ansible 7 | - open file with folds collapsed 8 | - open all folds 9 | - use commentary to uncomment a play (?) 10 | - create a new play: n: 11 | - full action line for yum/zsh, with state 12 | - another for pbzip? 13 | - pull up docs on yum 14 | - fold it 15 | -------------------------------------------------------------------------------- /examples/demo2.gif: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/MicahElliott/Rocannon/b0cb9bed1dddbb1b619b482ed04d41e0957e816e/examples/demo2.gif -------------------------------------------------------------------------------- /examples/demo4.gif: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/MicahElliott/Rocannon/b0cb9bed1dddbb1b619b482ed04d41e0957e816e/examples/demo4.gif -------------------------------------------------------------------------------- /examples/install.ans: -------------------------------------------------------------------------------- 1 | # Install Rocannon 2 | - vars: { rodest: ~/.vim/bundle/Rocannon/ } 3 | hosts: localhost 4 | tasks: 5 | - name: clone rocannon plugin 6 | # Notice the nice colors 7 | git: repo=https://github.com/MicahElliott/Rocannon dest={{rodest}} 8 | 9 | - name: stat for existing docs 10 | stat: path={{rodest}}/doc/tags 11 | register: docs_r 12 | 13 | - name: just testing the debug module 14 | debug: var=docs_r 15 | 16 | - name: generate rocannon documentation 17 | command: chdir={{rodest}} vim -c ":helptags {{rodest}}|q" 18 | when: not docs_r.stat.exists 19 | -------------------------------------------------------------------------------- /ftdetect/ansible.vim: -------------------------------------------------------------------------------- 1 | " Ansible only recognizes its files as .yml, .yaml, or suffix-less. 2 | 3 | autocmd BufNewFile,BufRead *.ans set filetype=ansible 4 | " HACK: YAML file are usually suffixed .yml, but for suffix .yaml we'll treat 5 | " the 'a' as meaning ansible! 6 | autocmd BufNewFile,BufRead *.yaml set filetype=ansible 7 | 8 | " Does not work in this file; needs to be in ../scripts.vim to see contents. 9 | "if getline(1) =~ '^---$' | setfiletype ansible | endif 10 | 11 | " Could get more sophisticated in detection if needed, like: 12 | " https://github.com/chase/vim-ansible-yaml/blob/master/ftdetect/ansible.vim 13 | -------------------------------------------------------------------------------- /img/rainbow.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/MicahElliott/Rocannon/b0cb9bed1dddbb1b619b482ed04d41e0957e816e/img/rainbow.jpg -------------------------------------------------------------------------------- /plugin/rocannon.vim: -------------------------------------------------------------------------------- 1 | " Very simple skeleton file for simplified starting 2 | 3 | " Hack using abs path since not sure how to reference otherwise 4 | au BufNewFile *.ans,*.yaml read ~/.vim/bundle/Rocannon/skel/skel.ans | 0 | del | 2 5 | -------------------------------------------------------------------------------- /scripts.vim: -------------------------------------------------------------------------------- 1 | " Want to use ftdetect/ansible.vim, but seems the only way to detect file 2 | " contents is to put the getline() into a scripts.vim file. 3 | 4 | " autocmd BufNewFile,BufRead *.ans set filetype=ansible 5 | 6 | " echom 'detecting if ansible filetype' 7 | " echom 'second line:' . getline(2) 8 | if did_filetype() 9 | finish 10 | endif 11 | if getline(1) =~ '^---$' 12 | setfiletype ansible 13 | endif 14 | -------------------------------------------------------------------------------- /skel/skel.ans: -------------------------------------------------------------------------------- 1 | --- 2 | ### TASKS: What does this playbook do?? 3 | 4 | - name: first task 5 | debug: msg='some message' 6 | 7 | # vim:ft=ansible: 8 | --------------------------------------------------------------------------------