diff --git a/cloud/amazon/cloudformation.py b/cloud/amazon/cloudformation.py index f95fbba00e2..e4ac80fcf5a 100644 --- a/cloud/amazon/cloudformation.py +++ b/cloud/amazon/cloudformation.py @@ -26,35 +26,28 @@ options: description: - name of the cloudformation stack required: true - default: null - aliases: [] disable_rollback: description: - If a stacks fails to form, rollback will remove the stack required: false default: "false" choices: [ "true", "false" ] - aliases: [] template_parameters: description: - a list of hashes of all the template variables for the stack required: false default: {} - aliases: [] state: description: - If state is "present", stack will be created. If state is "present" and if stack exists and template has changed, it will be updated. If state is "absent", stack will be removed. required: true - default: null - aliases: [] template: description: - The local path of the cloudformation template. This parameter is mutually exclusive with 'template_url'. Either one of them is required if "state" parameter is "present" Must give full path to the file, relative to the working directory. If using roles this may look like "roles/cloudformation/files/cloudformation-example.json" required: false default: null - aliases: [] notification_arns: description: - The Simple Notification Service (SNS) topic ARNs to publish stack related events. @@ -66,7 +59,6 @@ options: - the path of the cloudformation stack policy required: false default: null - aliases: [] version_added: "1.9" tags: description: @@ -74,13 +66,11 @@ options: Requires at least Boto version 2.6.0. required: false default: null - aliases: [] version_added: "1.4" region: description: - The AWS region to use. If not specified then the value of the AWS_REGION or EC2_REGION environment variable, if any, is used. required: true - default: null aliases: ['aws_region', 'ec2_region'] version_added: "1.5" template_url: diff --git a/cloud/amazon/ec2_ami_find.py b/cloud/amazon/ec2_ami_find.py index c8aa5d792df..f5ed91baab5 100644 --- a/cloud/amazon/ec2_ami_find.py +++ b/cloud/amazon/ec2_ami_find.py @@ -18,7 +18,7 @@ DOCUMENTATION = ''' --- module: ec2_ami_find -version_added: 2.0 +version_added: '2.0' short_description: Searches for AMIs to obtain the AMI ID and other information description: - Returns list of matching AMIs with AMI ID, along with other useful information diff --git a/cloud/amazon/ec2_eip.py b/cloud/amazon/ec2_eip.py index c3b764b2e63..c6a99a16782 100644 --- a/cloud/amazon/ec2_eip.py +++ b/cloud/amazon/ec2_eip.py @@ -5,7 +5,7 @@ module: ec2_eip short_description: associate an EC2 elastic IP with an instance. description: - This module associates AWS EC2 elastic IP addresses with instances -version_added: 1.4 +version_added: "1.4" options: instance_id: description: diff --git a/cloud/amazon/ec2_facts.py b/cloud/amazon/ec2_facts.py index 6bd587bf018..5147428f646 100644 --- a/cloud/amazon/ec2_facts.py +++ b/cloud/amazon/ec2_facts.py @@ -29,7 +29,7 @@ options: required: false default: 'yes' choices: ['yes', 'no'] - version_added: 1.5.1 + version_added: '1.5.1' description: - 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. diff --git a/cloud/amazon/route53.py b/cloud/amazon/route53.py index aca01193555..9b867fb1e72 100644 --- a/cloud/amazon/route53.py +++ b/cloud/amazon/route53.py @@ -24,75 +24,61 @@ description: options: command: description: - - Specifies the action to take. + - Specifies the action to take. required: true - default: null - aliases: [] choices: [ 'get', 'create', 'delete' ] zone: description: - The DNS zone to modify required: true - default: null - aliases: [] hosted_zone_id: description: - The Hosted Zone ID of the DNS zone to modify required: false - version_added: 2.0 + version_added: "2.0" default: null record: description: - The full DNS record to create or delete required: true - default: null - aliases: [] ttl: description: - The TTL to give the new record required: false default: 3600 (one hour) - aliases: [] type: description: - The type of DNS record to create required: true - default: null - aliases: [] choices: [ 'A', 'CNAME', 'MX', 'AAAA', 'TXT', 'PTR', 'SRV', 'SPF', 'NS' ] alias: description: - Indicates if this is an alias record. required: false - version_added: 1.9 + version_added: "1.9" default: False - aliases: [] choices: [ 'True', 'False' ] alias_hosted_zone_id: description: - The hosted zone identifier. required: false - version_added: 1.9 + version_added: "1.9" default: null - aliases: [] value: description: - The new value when creating a DNS record. Multiple comma-spaced values are allowed for non-alias records. When deleting a record all values for the record must be specified or Route53 will not delete it. required: false default: null - aliases: [] overwrite: description: - Whether an existing record should be overwritten on create if values do not match required: false default: null - aliases: [] retry_interval: description: - In the case that route53 is still servicing a prior request, this module will wait and try again after this many seconds. If you have many domain names, the default of 500 seconds may be too long. required: false default: 500 - aliases: [] private_zone: description: - If set to true, the private zone matching the requested name within the domain will be used if there are both public and private zones. The default is to use the public zone. diff --git a/cloud/google/gc_storage.py b/cloud/google/gc_storage.py index c1e6f5707a6..291d4ca0f4d 100644 --- a/cloud/google/gc_storage.py +++ b/cloud/google/gc_storage.py @@ -53,7 +53,7 @@ options: required: false default: private headers: - version_added: 2.0 + version_added: "2.0" description: - Headers to attach to object. required: false diff --git a/cloud/google/gce.py b/cloud/google/gce.py index 60287ad8b6e..1de351a12fb 100644 --- a/cloud/google/gce.py +++ b/cloud/google/gce.py @@ -32,77 +32,65 @@ options: - image string to use for the instance required: false default: "debian-7" - aliases: [] instance_names: description: - a comma-separated list of instance names to create or destroy required: false default: null - aliases: [] machine_type: description: - machine type to use for the instance, use 'n1-standard-1' by default required: false default: "n1-standard-1" - aliases: [] metadata: description: - a hash/dictionary of custom data for the instance; '{"key":"value",...}' required: false default: null - aliases: [] service_account_email: - version_added: 1.5.1 + version_added: "1.5.1" description: - service account email required: false default: null - aliases: [] service_account_permissions: - version_added: 2.0 + version_added: "2.0" description: - service account permissions (see U(https://cloud.google.com/sdk/gcloud/reference/compute/instances/create), --scopes section for detailed information) required: false default: null - aliases: [] choices: ["bigquery", "cloud-platform", "compute-ro", "compute-rw", "computeaccounts-ro", "computeaccounts-rw", "datastore", "logging-write", "monitoring", "sql", "sql-admin", "storage-full", "storage-ro", "storage-rw", "taskqueue", "userinfo-email"] pem_file: - version_added: 1.5.1 + version_added: "1.5.1" description: - path to the pem file associated with the service account email required: false default: null - aliases: [] project_id: - version_added: 1.5.1 + version_added: "1.5.1" description: - your GCE project ID required: false default: null - aliases: [] name: description: - identifier when working with a single instance required: false - aliases: [] network: description: - name of the network, 'default' will be used if not specified required: false default: "default" - aliases: [] persistent_boot_disk: description: - if set, create the instance with a persistent boot disk required: false default: "false" - aliases: [] disks: description: - a list of persistent disks to attach to the instance; a string value gives the name of the disk; alternatively, a dictionary value can define 'name' and 'mode' ('READ_ONLY' or 'READ_WRITE'). The first entry will be the boot disk (which must be READ_WRITE). required: false default: null - aliases: [] version_added: "1.7" state: description: @@ -110,40 +98,34 @@ options: required: false default: "present" choices: ["active", "present", "absent", "deleted"] - aliases: [] tags: description: - a comma-separated list of tags to associate with the instance required: false default: null - aliases: [] zone: description: - the GCE zone to use required: true default: "us-central1-a" - aliases: [] ip_forward: version_added: "1.9" description: - set to true if the instance can forward ip packets (useful for gateways) required: false default: "false" - aliases: [] external_ip: version_added: "1.9" description: - type of external ip, ephemeral by default required: false default: "ephemeral" - aliases: [] disk_auto_delete: version_added: "1.9" description: - if set boot disk will be removed after instance destruction required: false default: "true" - aliases: [] requirements: - "python >= 2.6" diff --git a/commands/command.py b/commands/command.py index b703c669b68..8107dd521e9 100644 --- a/commands/command.py +++ b/commands/command.py @@ -30,7 +30,6 @@ import os DOCUMENTATION = ''' --- module: command -version_added: historical short_description: Executes a command on a remote node description: - The M(command) module takes the command name followed by a list of space-delimited arguments. @@ -45,7 +44,6 @@ options: See the examples! required: true default: null - aliases: [] creates: description: - a filename or glob pattern, when it already exists, this step will B(not) be run. diff --git a/commands/raw.py b/commands/raw.py index 5305c978630..b6cf6c7b925 100644 --- a/commands/raw.py +++ b/commands/raw.py @@ -3,7 +3,6 @@ DOCUMENTATION = ''' --- module: raw -version_added: historical short_description: Executes a low-down and dirty SSH command options: free_form: @@ -15,7 +14,7 @@ options: - change the shell used to execute the command. Should be an absolute path to the executable. required: false version_added: "1.0" -description: +description: - 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 C(python-simplejson) on older (Python 2.4 and @@ -34,7 +33,7 @@ notes: playbooks will follow the trend of using M(command) unless M(shell) is explicitly required. When running ad-hoc commands, use your best judgement. -author: +author: - Ansible Core Team - Michael DeHaan '''