Commit 50b7964f by Dag Wieers

Fix the documentation booleans so they use "yes" and "no"

Both modules seboolean and zfs have not been adapted since they defer from the default (either by having a 'null' or special state, or prefering "on"/"off" for state indication.
parent 77198b09
......@@ -32,7 +32,8 @@ options:
description:
- If a stacks fails to form, rollback will remove the stack
required: false
default: false
default: "no"
choices: [ "yes", "no" ]
aliases: []
template_parameters:
description:
......@@ -63,7 +64,8 @@ options:
description:
- Wait while the stack is being created/updated/deleted.
required: false
default: true
default: "yes"
choices: [ "yes", "no" ]
aliases: []
examples:
......@@ -72,7 +74,7 @@ examples:
- name: launch ansible cloudformation example
cloudformation: >
stack_name="ansible-cloudformation" state=present
region=us-east-1 disable_rollback=true
region=us-east-1 disable_rollback=yes
template=files/cloudformation-example.json
args:
template_parameters:
......
......@@ -111,7 +111,8 @@ options:
- If the job should be run at reboot, will ignore minute, hour, day, and month settings in favour of C(@reboot)
version_added: "1.0"
required: false
default: False
default: "no"
choices: [ "yes", "no" ]
aliases: []
examples:
......@@ -119,7 +120,7 @@ examples:
description: Ensure a job that runs at 2 and 5 exists. Creates an entry like "* 5,2 * * ls -alh > /dev/null"
- code: 'cron: name="an old job" cron job="/some/dir/job.sh" state=absent'
description: 'Ensure an old job is no longer present. Removes any job that is preceded by "#Ansible: an old job" in the crontab'
- code: 'cron: name="a job for reboot" reboot=True job="/some/job.sh"'
- code: 'cron: name="a job for reboot" reboot=yes job="/some/job.sh"'
description: 'Creates an entry like "@reboot /some/job.sh"'
- code: 'cron: name="yum autoupdate" weekday="2" minute=0 hour=12 user="root" job="YUMINTERACTIVE=0 /usr/sbin/yum-autoupdate" cron_file=ansible_yum-autoupdate'
......
......@@ -42,6 +42,7 @@ options:
- A boolean that indicates whether the debug module should fail or not.
required: false
default: "no"
choices: [ "yes", "no" ]
examples:
- code: |
- action: debug msg="System $inventory_hostname has uuid $ansible_product_uuid"
......
......@@ -64,6 +64,8 @@ options:
description:
- Fail the command immediately if a test fails. Used by the 'test' command.
required: false
default: "no"
choices: [ "yes", "no" ]
fixtures:
description:
- A space-delimited list of fixture file names to load in the database. B(Required) by the 'loaddata' command.
......
......@@ -48,7 +48,8 @@ options:
have any effect, the environment must be deleted and newly
created.
required: false
default: no
default: "no"
choices: [ "yes", "no" ]
virtualenv_command:
version_added: 1.1
description:
......
......@@ -69,7 +69,8 @@ options:
description:
- wait for the instance to be in state 'running' before returning
required: false
default: false
default: "no"
choices: [ "yes", "no" ]
aliases: []
wait_timeout:
description:
......@@ -129,7 +130,7 @@ options:
default: null
aliases: []
examples:
- code: 'local_action: ec2 keypair=admin instance_type=m1.large image=emi-40603AD1 wait=true group=webserver count=3 group=webservers'
- code: 'local_action: ec2 keypair=admin instance_type=m1.large image=emi-40603AD1 wait=yes group=webserver count=3 group=webservers'
description: "Examples from Ansible Playbooks"
requirements: [ "boto" ]
author: Seth Vidal, Tim Gerla, Lester Wade
......
......@@ -51,7 +51,7 @@ examples:
description: "Simple playbook example"
- code: |
- name: Launch instances
local_action: ec2 keypair=$keypair image=$image wait=true count=3
local_action: ec2 keypair=$keypair image=$image wait=yes count=3
register: ec2
- name: Create volumes and attach
local_action: ec2_vol instance=${item.id} volume_size=5
......
......@@ -115,7 +115,7 @@ options:
in the policy. Does nothing if no default value is available.
recurse:
required: false
default: no
default: "no"
choices: [ "yes", "no" ]
version_added: "1.1"
description:
......
......@@ -41,8 +41,8 @@ options:
include_dependencies:
description: Wheter to include dependencies or not.
required: false
choices: [true, false]
default: true
choices: [ "yes", "no" ]
default: "yes"
repository:
description: The repository from which the gem will be installed
required: false
......
......@@ -50,7 +50,7 @@ options:
force:
required: false
default: "yes"
choices: [ yes, no ]
choices: [ "yes", "no" ]
version_added: "0.7"
description:
- If C(yes), any modified files in the working
......
......@@ -45,7 +45,7 @@ options:
system:
required: false
default: "no"
choices: [ yes, no ]
choices: [ "yes", "no" ]
description:
- If I(yes), indicates that the group created is a system group.
examples:
......
......@@ -57,7 +57,7 @@ options:
- Discards uncommited changes. Runs C(hg update -C).
required: false
default: "yes"
choices: [ yes, no ]
choices: [ "yes", "no" ]
purge:
description:
- Delets untracked files. Runs C(hg purge). Note this requires C(purge) extension to
......@@ -65,7 +65,7 @@ options:
and undo the changes before exiting the task.
required: false
default: "no"
choices: [ yes, no ]
choices: [ "yes", "no" ]
notes:
- If the task seems to be hanging, first verify remote host is in C(known_hosts).
SSH will prompt user to authorize the first contact with a remote host. One solution is to add
......
......@@ -56,7 +56,7 @@ options:
- Create a backup file including the timestamp information so you can get
the original file back if you somehow clobbered it incorrectly.
required: false
default: no
default: "no"
choices: [ "yes", "no" ]
others:
description:
......
......@@ -75,15 +75,16 @@ options:
choices: [ 'BOF', '*regex*' ]
create:
required: false
choices: [ yes, no ]
default: no
choices: [ "yes", "no" ]
default: "no"
description:
- Used with C(state=present). If specified, the file will be created
if it does not already exist. By default it will fail if the file
is missing.
backup:
required: false
default: no
default: "no"
choices: [ "yes", "no" ]
description:
- Create a backup file including the timestamp information so you can
get the original file back if you somehow clobbered it incorrectly.
......
......@@ -41,6 +41,8 @@ options:
description:
- update the package db first
required: false
default: "no"
choices: [ "yes", "no" ]
notes: []
'''
EXAMPLES = '''
......
......@@ -40,6 +40,8 @@ options:
description:
- update the package db first
required: false
default: "no"
choices: [ "yes", "no" ]
notes: []
'''
EXAMPLES = '''
......
......@@ -42,6 +42,8 @@ options:
description:
- update the package db first (pacman -Syy)
required: false
default: "no"
choices: [ "yes", "no" ]
author: Afterburn
notes: []
......
......@@ -56,7 +56,8 @@ options:
have any effect, the environment must be deleted and newly
created.
required: false
default: no
default: "no"
choices: [ "yes", "no" ]
virtualenv_command:
version_aded: 1.1
description:
......@@ -70,7 +71,7 @@ options:
an older version of pip (< 1.0), you should set this to no because
older versions of pip do not support I(--use-mirrors).
required: false
default: yes
default: "yes"
choices: [ "yes", "no" ]
version_added: "1.0"
state:
......
......@@ -38,8 +38,8 @@ options:
- Only enable missing plugins
- Does not disable plugins that are not in the names list
required: false
default: no
choices: [yes, no]
default: "no"
choices: [ "yes", "no" ]
state:
description:
- Specify if pluginss are to be enabled or disabled
......
......@@ -73,8 +73,8 @@ options:
description:
- Deletes and recreates the user.
required: false
default: no
choices: [yes, no]
default: "no"
choices: [ "yes", "no" ]
state:
description:
- Specify if user is to be added or removed
......
......@@ -37,8 +37,8 @@ options:
tracing:
description:
Enable/disable tracing for a vhost
default: no
choices: [yes, no]
default: "no"
choices: [ "yes", "no" ]
aliases: [trace]
state:
description:
......
......@@ -41,7 +41,7 @@ options:
- Desired boolean value
required: true
default: null
choices: [ "true", "false" ]
choices: [ true, false ]
examples:
- code: "seboolean: name=httpd_can_network_connect state=true persistent=yes"
description: Set I(httpd_can_network_connect) SELinux flag to I(true) and I(persistent)
......
......@@ -49,7 +49,7 @@ options:
description:
- If C(yes), modified files will be discarded. If C(no), module will fail if it encounters modified files.
required: false
default: yes
default: "yes"
choices: [ "yes", "no" ]
username:
description:
......
......@@ -56,8 +56,8 @@ options:
description:
- if C(reload=yes), performs a I(/sbin/sysctl -p) if the C(sysctl_file) is updated
- if C(reload=no), does not reload I(sysctl) even if the C(sysctl_file) is updated
choices: [ yes, no ]
default: yes
choices: [ "yes", "no" ]
default: "yes"
sysctl_file:
description:
- specifies the absolute path to C(sysctl.conf), if not /etc/sysctl.conf
......
......@@ -80,35 +80,35 @@ options:
createhome:
required: false
default: "yes"
choices: [ yes, no ]
choices: [ "yes", "no" ]
description:
- Unless set to C(no), a home directory will be made for the user
when the account is created.
system:
required: false
default: "no"
choices: [ yes, no ]
choices: [ "yes", "no" ]
description:
- When creating an account, setting this to C(yes) makes the user a
system account. This setting cannot be changed on existing users.
force:
required: false
default: "no"
choices: [ yes, no ]
choices: [ "yes", "no" ]
description:
- When used with C(state=absent), behavior is as with
C(userdel --force).
remove:
required: false
default: "no"
choices: [ yes, no ]
choices: [ "yes", "no" ]
description:
- When used with C(state=absent), behavior is as with
C(userdel --remove).
generate_ssh_key:
required: false
default: "no"
choices: [ yes, no ]
choices: [ "yes", "no" ]
version_added: "0.9"
description:
- Whether to generate a SSH key for the user in question.
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment