1
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2024-09-14 20:13:21 +02:00

Fix invalid fields in module DOCUMENATION (#22297)

* fix module doc fields

* More module docs corrections

* More module docs corrections

* More module docs corrections

* More module docs corrections

* correct aliases

* Review comments

* Must quote ':'

* More authors

* Use suboptions:

* restore type: bool

* type should be in the same place

* More tidyups

* authors

* Use suboptions

* revert

* remove duplicate author

* More issues post rebase
This commit is contained in:
John R Barker 2017-03-09 16:20:25 +00:00 committed by GitHub
parent 000ca2a2bc
commit e5b990a55a
138 changed files with 176 additions and 256 deletions

View file

@ -32,7 +32,7 @@ deprecated: >-
options:
cidr_block:
description:
- "The cidr block representing the VPC, e.g. 10.0.0.0/16, required when I(state) is 'present'."
- "The cidr block representing the VPC, e.g. C(10.0.0.0/16), required when I(state=present)."
required: false
instance_tenancy:
description:
@ -42,56 +42,61 @@ options:
choices: [ "default", "dedicated" ]
dns_support:
description:
- toggles the "Enable DNS resolution" flag
- Toggles the "Enable DNS resolution" flag.
required: false
default: "yes"
choices: [ "yes", "no" ]
dns_hostnames:
description:
- toggles the "Enable DNS hostname support for instances" flag
- Toggles the "Enable DNS hostname support for instances" flag.
required: false
default: "yes"
choices: [ "yes", "no" ]
subnets:
description:
- 'A dictionary array of subnets to add of the form: { cidr: ..., az: ... , resource_tags: ... }. Where az is the desired availability zone of the subnet, but it is not required. Tags (i.e.: resource_tags) is also optional and use dictionary form: { "Environment":"Dev", "Tier":"Web", ...}. All VPC subnets not in this list will be removed as well. As of 1.8, if the subnets parameter is not specified, no existing subnets will be modified.'
- 'A dictionary array of subnets to add of the form C({ cidr: ..., az: ... , resource_tags: ... }).'
- Where C(az) is the desired availability zone of the subnet, optional.
- 'Tags C(resource_tags) use dictionary form C({ "Environment":"Dev", "Tier":"Web", ...}), optional.'
- C(resource_tags) see resource_tags for VPC below. The main difference is subnet tags not specified here will be deleted.
- All VPC subnets not in this list will be removed as well.
- As of 1.8, if the subnets parameter is not specified, no existing subnets will be modified.'
required: false
default: null
resource_tags: See resource_tags for VPC below. The main difference is subnet tags not specified here will be deleted.
vpc_id:
description:
- A VPC id to terminate when state=absent
- A VPC id to terminate when I(state=absent).
required: false
default: null
resource_tags:
description:
- 'A dictionary array of resource tags of the form: { tag1: value1, tag2: value2 }. Tags in this list are used in conjunction with CIDR block to uniquely identify a VPC in lieu of vpc_id. Therefore, if CIDR/Tag combination does not exist, a new VPC will be created. VPC tags not on this list will be ignored. Prior to 1.7, specifying a resource tag was optional.'
- 'A dictionary array of resource tags of the form C({ tag1: value1, tag2: value2 }).
- Tags in this list are used in conjunction with CIDR block to uniquely identify a VPC in lieu of vpc_id. Therefore, if CIDR/Tag combination does not exist, a new VPC will be created. VPC tags not on this list will be ignored. Prior to 1.7, specifying a resource tag was optional.'
required: true
version_added: "1.6"
internet_gateway:
description:
- Toggle whether there should be an Internet gateway attached to the VPC
- Toggle whether there should be an Internet gateway attached to the VPC.
required: false
default: "no"
choices: [ "yes", "no" ]
route_tables:
description:
- 'A dictionary array of route tables to add of the form: { subnets: [172.22.2.0/24, 172.22.3.0/24,], routes: [{ dest: 0.0.0.0/0, gw: igw},], resource_tags: ... }. Where the subnets list is those subnets the route table should be associated with, and the routes list is a list of routes to be in the table. The special keyword for the gw of igw specifies that you should the route should go through the internet gateway attached to the VPC. gw also accepts instance-ids, interface-ids, and vpc-peering-connection-ids in addition igw. resource_tags is optional and uses dictionary form: { "Name": "public", ... }. This module is currently unable to affect the "main" route table due to some limitations in boto, so you must explicitly define the associated subnets or they will be attached to the main table implicitly. As of 1.8, if the route_tables parameter is not specified, no existing routes will be modified.'
- 'A dictionary array of route tables to add of the form: C({ subnets: [172.22.2.0/24, 172.22.3.0/24,], routes: [{ dest: 0.0.0.0/0, gw: igw},], resource_tags: ... }). Where the subnets list is those subnets the route table should be associated with, and the routes list is a list of routes to be in the table. The special keyword for the gw of igw specifies that you should the route should go through the internet gateway attached to the VPC. gw also accepts instance-ids, interface-ids, and vpc-peering-connection-ids in addition igw. resource_tags is optional and uses dictionary form: C({ "Name": "public", ... }). This module is currently unable to affect the "main" route table due to some limitations in boto, so you must explicitly define the associated subnets or they will be attached to the main table implicitly. As of 1.8, if the route_tables parameter is not specified, no existing routes will be modified.'
required: false
default: null
wait:
description:
- wait for the VPC to be in state 'available' before returning
- Wait for the VPC to be in state 'available' before returning.
required: false
default: "no"
choices: [ "yes", "no" ]
wait_timeout:
description:
- how long before wait gives up, in seconds
- How long before wait gives up, in seconds.
default: 300
state:
description:
- Create or terminate the VPC
- Create or terminate the VPC.
required: true
choices: [ "present", "absent" ]
author: "Carson Gee (@carsongee)"

View file

@ -104,7 +104,7 @@ author: "James S. Martin (@jsmartin)"
extends_documentation_fragment:
- aws
- ec2
requires: [ botocore>=1.4.57 ]
requirements: [ botocore>=1.4.57 ]
'''
EXAMPLES = '''

View file

@ -71,24 +71,24 @@ options:
security_group_ids:
description:
- A list of security groups to apply to the elb
require: false
required: false
default: None
version_added: "1.6"
security_group_names:
description:
- A list of security group names to apply to the elb
require: false
required: false
default: None
version_added: "2.0"
health_check:
description:
- An associative array of health check configuration settings (see example)
require: false
required: false
default: None
access_logs:
description:
- An associative array of access logs configuration settings (see example)
require: false
required: false
default: None
version_added: "2.0"
subnets:

View file

@ -118,7 +118,7 @@ options:
extends_documentation_fragment:
- aws
- ec2
requires:
requirements:
- "boto >= 2.39.0"
"""

View file

@ -50,12 +50,12 @@ options:
- Operation applied to the metric
- Works in conjunction with period and evaluation_periods to determine the comparison value
required: false
options: ['SampleCount','Average','Sum','Minimum','Maximum']
choices: ['SampleCount','Average','Sum','Minimum','Maximum']
comparison:
description:
- Determines how the threshold value is compared
required: false
options: ['<=','<','>','>=']
choices: ['<=','<','>','>=']
threshold:
description:
- Sets the min/max bound for triggering the alarm
@ -72,7 +72,7 @@ options:
description:
- The threshold's unit of measurement
required: false
options: ['Seconds','Microseconds','Milliseconds','Bytes','Kilobytes','Megabytes','Gigabytes','Terabytes','Bits','Kilobits','Megabits','Gigabits','Terabits','Percent','Count','Bytes/Second','Kilobytes/Second','Megabytes/Second','Gigabytes/Second','Terabytes/Second','Bits/Second','Kilobits/Second','Megabits/Second','Gigabits/Second','Terabits/Second','Count/Second','None']
choices: ['Seconds','Microseconds','Milliseconds','Bytes','Kilobytes','Megabytes','Gigabytes','Terabytes','Bits','Kilobits','Megabits','Gigabits','Terabits','Percent','Count','Bytes/Second','Kilobytes/Second','Megabytes/Second','Gigabytes/Second','Terabytes/Second','Bits/Second','Kilobits/Second','Megabits/Second','Gigabits/Second','Terabits/Second','Count/Second','None']
description:
description:
- A longer description of the alarm

View file

@ -114,7 +114,6 @@ options:
tags:
description:
- tag:value pairs to add to the volume after creation
type: dict
required: false
default: {}
version_added: "2.3"

View file

@ -26,7 +26,7 @@ description:
- Gather facts about Network ACLs in an AWS VPC
version_added: "2.2"
author: "Brad Davidson (@brandond)"
requires: [ boto3 ]
requirements: [ boto3 ]
options:
nacl_ids:
description:

View file

@ -27,8 +27,7 @@ description:
notes:
- the service role specified must be assumable (i.e. have a trust relationship for the ecs service, ecs.amazonaws.com)
- for details of the parameters and returns see U(http://boto3.readthedocs.org/en/latest/reference/services/ecs.html)
dependencies:
- An IAM role must have been created
- An IAM role must have been previously created
version_added: "2.1"
author:
- "Mark Chance (@java1guy)"

View file

@ -45,12 +45,10 @@ options:
description:
- A revision number for the task definition
required: False
type: int
containers:
description:
- A list of containers definitions
required: False
type: list of dicts with container definitions
network_mode:
description:
- The Docker networking mode to use for the containers in the task.
@ -67,7 +65,6 @@ options:
description:
- A list of names of volumes to be attached
required: False
type: list of name
extends_documentation_fragment:
- aws
- ec2

View file

@ -33,12 +33,10 @@ options:
- The name of the cache parameter group family that the cache parameter group can be used with.
choices: ['memcached1.4', 'redis2.6', 'redis2.8', 'redis3.2']
required: yes
type: string
name:
description:
- A user-specified name for the cache parameter group.
required: yes
type: string
description:
description:
- A user-specified description for the cache parameter group.
@ -51,7 +49,6 @@ options:
description:
- A user-specified list of parameters to reset or modify for the cache parameter group.
required: no
type: dict
default: None
"""

View file

@ -31,7 +31,6 @@ options:
name:
description:
- The name of the snapshot we want to create, copy, delete
type: string
required: yes
state:
description:
@ -40,25 +39,21 @@ options:
replication_id:
description:
- The name of the existing replication group to make the snapshot.
type: string
required: no
default: null
cluster_id:
description:
- The name of an existing cache cluster in the replication group to make the snapshot.
type: string
required: no
default: null
target:
description:
- The name of a snapshot copy
type: string
required: no
default: null
bucket:
description:
- The s3 bucket to which the snapshot is exported
type: string
required: no
default: null
"""

View file

@ -62,10 +62,8 @@ options:
choices: [ '', private, public-read, public-read-write, authenticated-read, aws-exec-read, bucket-owner-read, bucket-owner-full-control ]
mime_map:
description:
- Dict entry from extension to MIME type. This will override any default/sniffed MIME type.
type: dict
- 'Dict entry from extension to MIME type. This will override any default/sniffed MIME type. For example C({".txt": "application/text", ".yml": "appication/text"})'
required: false
sample: {".txt": "application/text", ".yml": "appication/text"}
include:
description:
- Shell pattern-style file matching.

View file

@ -137,7 +137,6 @@ options:
- When a default security group is created for a Linux host a rule will be added allowing inbound TCP
connections to the default SSH port 22, and for a Windows host rules will be added allowing inbound
access to RDP ports 3389 and 5986. Override the default ports by providing a list of open ports.
type: list
required: false
default: null
extends_documentation_fragment:

View file

@ -69,10 +69,9 @@ options:
rules:
description:
- Set of rules shaping traffic flow to or from a subnet or NIC. Each rule is a dictionary.
type: complex
required: false
default: null
contains:
suboptions:
name:
description: Unique name for the rule.
required: true

View file

@ -54,7 +54,7 @@ options:
extends_documentation_fragment:
- azure
authors:
author:
- "Chris Houseknecht house@redhat.com"
- "Matt Davis mdavis@redhat.com"

View file

@ -49,7 +49,6 @@ options:
description:
- List of VMs to assign to or remove from the rule.
required: true
type: list
aliases: [ 'vm' ]
state:
description:

View file

@ -25,6 +25,7 @@ module: digital_ocean_tag
short_description: Create and remove tag(s) to DigitalOcean resource.
description:
- Create and remove tag(s) to DigitalOcean resource.
author: "Victor Volle (@kontrafiktion)"
version_added: "2.2"
options:
name:

View file

@ -185,7 +185,7 @@ options:
kill_signal:
description:
- Override default signal used to kill a running container.
default null:
default: null
required: false
kernel_memory:
description:

View file

@ -134,7 +134,6 @@ options:
- Provide a dictionary of C(key:value) build arguments that map to Dockerfile ARG directive.
- Docker expects the value to be a string. For convenience any non-string values will be converted to strings.
- Requires Docker API >= 1.21 and docker-py >= 1.7.0.
type: complex
required: false
version_added: "2.2"
container_limits:
@ -142,20 +141,15 @@ options:
- A dictionary of limits applied to each container created by the build process.
required: false
version_added: "2.1"
type: complex
contains:
suboptions:
memory:
description: Set memory limit for build
type: int
memswap:
description: Total memory (memory + swap), -1 to disable swap
type: int
cpushares:
description: CPU shares (relative weight)
type: int
cpusetcpus:
description: CPUs in which to allow execution, e.g., "0-3", "0,1"
type: str
use_tls:
description:
- "DEPRECATED. Whether to use tls to connect to the docker server. Set to C(no) when TLS will not be used. Set to
@ -177,7 +171,7 @@ requirements:
- "docker-py >= 1.7.0"
- "Docker API >= 1.20"
authors:
author:
- Pavel Antonov (@softzilla)
- Chris Houseknecht (@chouseknecht)
- James Tanner (@jctanner)

View file

@ -48,7 +48,7 @@ requirements:
- "docker-py >= 1.7.0"
- "Docker API >= 1.20"
authors:
author:
- Chris Houseknecht (@chouseknecht)
- James Tanner (@jctanner)

View file

@ -93,7 +93,7 @@ requirements:
- "docker-py >= 1.7.0"
- "Docker API >= 1.20"
- 'Only to be able to logout (state=absent): the docker command line utility'
authors:
author:
- "Olaf Kilian <olaf.kilian@symanex.com>"
- "Chris Houseknecht (@chouseknecht)"
- "James Tanner (@jctanner)"

View file

@ -100,7 +100,7 @@ options:
extends_documentation_fragment:
- docker
authors:
author:
- "Ben Keith (@keitwb)"
- "Chris Houseknecht (@chouseknecht)"

View file

@ -44,19 +44,16 @@ options:
- Path to a directory containing a docker-compose.yml or docker-compose.yaml file.
- Mutually exclusive with C(definition).
- Required when no C(definition) is provided.
type: path
required: false
project_name:
description:
- Provide a project name. If not provided, the project name is taken from the basename of C(project_src).
- Required when no C(definition) is provided.
type: str
required: false
files:
description:
- List of file names relative to C(project_src). Overrides docker-compose.yml or docker-compose.yaml.
- Files are loaded and merged in the order given.
type: list
required: false
state:
description:
@ -67,18 +64,15 @@ options:
- absent
- present
default: present
type: str
required: false
services:
description:
- When C(state) is I(present) run I(docker-compose up) on a subset of services.
type: list
required: false
scale:
description:
- When C(state) is I(present) scale services. Provide a dictionary of key/value pairs where the key
is the name of the service and the value is an integer count for the number of containers.
type: complex
required: false
dependencies:
description:
@ -90,7 +84,6 @@ options:
description:
- Provide docker-compose yaml describing one or more services, networks and volumes.
- Mutually exclusive with C(project_src) and C(files).
type: complex
required: false
hostname_check:
description:
@ -103,7 +96,6 @@ options:
- By default containers will be recreated when their configuration differs from the service definition.
- Setting to I(never) ignores configuration differences and leaves existing containers unchanged.
- Setting to I(always) forces recreation of all existing containers.
type: str
required: false
choices:
- always
@ -139,7 +131,6 @@ options:
remove_images:
description:
- Use with state I(absent) to remove the all images or only local images.
type: str
required: false
default: null
remove_volumes:

View file

@ -40,19 +40,16 @@ options:
- Name to give the instance (alphanumeric, dashes, underscore)
- To keep sanity on the Linode Web Console, name is prepended with LinodeID_
default: null
type: string
displaygroup:
description:
- Add the instance to a Display Group in Linode Manager
default: null
type: string
version_added: "2.3"
linode_id:
description:
- Unique ID of a linode server
aliases: [ 'lid' ]
default: null
type: integer
additional_disks:
description: >
List of dictionaries for creating additional disks that are added to the Linode configuration settings.
@ -69,7 +66,6 @@ options:
description:
- Set threshold in MB of bandwidth in alerts.
default: null
type: integer
version_added: "2.3"
alert_bwout_enabled:
description:
@ -81,7 +77,6 @@ options:
description:
- Set threshold in MB of bandwidth out alerts.
default: null
type: integer
version_added: "2.3"
alert_bwquota_enabled:
description:
@ -93,7 +88,6 @@ options:
description:
- Set threshold in MB of bandwidth quota alerts.
default: null
type: integer
version_added: "2.3"
alert_cpu_enabled:
description:
@ -105,7 +99,6 @@ options:
description:
- Set percentage threshold for receiving CPU usage alerts. Each CPU core adds 100% to total.
default: null
type: integer
version_added: "2.3"
alert_diskio_enabled:
description:
@ -117,30 +110,25 @@ options:
description:
- Set threshold for average IO ops/sec over 2 hour period.
default: null
type: integer
version_added: "2.3"
backupweeklyday:
description:
- Integer value for what day of the week to store weekly backups.
default: null
type: integer
version_added: "2.3"
plan:
description:
- plan to use for the instance (Linode plan)
default: null
type: integer
payment_term:
description:
- payment term to use for the instance (payment term in months)
default: 1
type: integer
choices: [1, 12, 24]
password:
description:
- root password to apply to a new server (auto generated if missing)
default: null
type: string
private_ip:
description:
- Add private IPv4 address when Linode is created.
@ -151,22 +139,18 @@ options:
description:
- SSH public key applied to root user
default: null
type: string
swap:
description:
- swap size in MB
default: 512
type: integer
distribution:
description:
- distribution to use for the instance (Linode Distribution)
default: null
type: integer
datacenter:
description:
- datacenter to create an instance in (Linode Datacenter)
default: null
type: integer
wait:
description:
- wait for the instance to be in state 'running' before returning

View file

@ -53,7 +53,7 @@ options:
- enable / disable https certificate verification
default: false
required: false
type: boolean
type: bool
node:
description:
- Proxmox VE node, when new VM will be created
@ -108,59 +108,50 @@ options:
required: false
netif:
description:
- specifies network interfaces for the container
- specifies network interfaces for the container. As a hash/dictionary defining interfaces.
default: null
required: false
type: A hash/dictionary defining interfaces
mounts:
description:
- specifies additional mounts (separate disks) for the container
- specifies additional mounts (separate disks) for the container. As a hash/dictionary defining mount points
default: null
required: false
type: A hash/dictionary defining mount points
version_added: "2.2"
ip_address:
description:
- specifies the address the container will be assigned
default: null
required: false
type: string
onboot:
description:
- specifies whether a VM will be started during system bootup
default: false
required: false
type: boolean
storage:
description:
- target storage
default: 'local'
required: false
type: string
cpuunits:
description:
- CPU weight for a VM
default: 1000
required: false
type: integer
nameserver:
description:
- sets DNS server IP address for a container
default: null
required: false
type: string
searchdomain:
description:
- sets DNS search domain for a container
default: null
required: false
type: string
timeout:
description:
- timeout for operations
default: 30
required: false
type: integer
force:
description:
- forcing operations
@ -169,7 +160,7 @@ options:
- with states C(stopped) , C(restarted) allow to force stop instance
default: false
required: false
type: boolean
type: bool
state:
description:
- Indicate desired state of the instance

View file

@ -491,8 +491,6 @@ options:
- Creates a virtual hardware watchdog device.
required: false
default: null
Notes:
- Requires proxmoxer and requests modules on host. This modules can be installed with pip.
requirements: [ "proxmoxer", "requests" ]
'''

View file

@ -45,7 +45,7 @@ options:
- enable / disable https certificate verification
default: false
required: false
type: boolean
type: bool
node:
description:
- Proxmox VE node, when you will operate with template
@ -76,19 +76,17 @@ options:
- target storage
default: 'local'
required: false
type: string
timeout:
description:
- timeout for operations
default: 30
required: false
type: integer
force:
description:
- can be used only with C(state=present), exists template will be overwritten
default: false
required: false
type: boolean
type: bool
state:
description:
- Indicate desired state of the template

View file

@ -59,7 +59,7 @@ options:
description:
- libvirt connection uri
required: false
defaults: qemu:///system
default: qemu:///system
xml:
description:
- XML document used with the define command

View file

@ -23,6 +23,7 @@ ANSIBLE_METADATA = {'status': ['deprecated'],
DOCUMENTATION = '''
---
module: glance_image
author: "Benno Joy (@bennojoy)"
version_added: "1.2"
deprecated: Deprecated in 1.10. Use M(os_image) instead.
short_description: Add/Delete images from glance

View file

@ -25,6 +25,7 @@ DOCUMENTATION = '''
---
module: nova_compute
version_added: "1.2"
author: "Benno Joy (@bennojoy)"
deprecated: Deprecated in 2.0. Use M(os_server) instead.
short_description: Create/Delete VMs from OpenStack
description:

View file

@ -24,6 +24,7 @@ DOCUMENTATION = '''
---
module: quantum_network
version_added: "1.4"
author: "Benno Joy (@bennojoy)"
deprecated: Deprecated in 2.0. Use M(os_network) instead.
short_description: Creates/Removes networks from OpenStack
description:

View file

@ -23,6 +23,7 @@ ANSIBLE_METADATA = {'status': ['deprecated'],
DOCUMENTATION = '''
---
module: quantum_subnet
author: "Benno Joy (@bennojoy)"
deprecated: Deprecated in 2.0. Use M(os_subnet) instead.
version_added: "1.2"
short_description: Add/remove subnet from a network

View file

@ -23,6 +23,7 @@ DOCUMENTATION = '''
---
module: os_floating_ip
version_added: "2.0"
author: "Davide Guerri <davide.guerri@hp.com>"
short_description: Add/Remove floating IP from an instance
extends_documentation_fragment: openstack
description:

View file

@ -25,6 +25,7 @@ DOCUMENTATION = '''
---
module: os_keypair
short_description: Add/Delete a keypair from OpenStack
author: "Benno Joy (@bennojoy)"
extends_documentation_fragment: openstack
version_added: "2.0"
description:

View file

@ -22,6 +22,9 @@ DOCUMENTATION = '''
---
module: os_keystone_domain
short_description: Manage OpenStack Identity Domains
author:
- Monty
- Haneef Ali
extends_documentation_fragment: openstack
version_added: "2.1"
description:

View file

@ -52,13 +52,11 @@ options:
description:
- Unique name or ID of the external gateway network.
- required I(interfaces) or I(enable_snat) are provided.
type: string
required: false
default: None
project:
description:
- Unique name or ID of the project.
type: string
required: false
default: None
version_added: "2.2"

View file

@ -24,6 +24,7 @@ DOCUMENTATION = '''
---
module: os_security_group_rule
short_description: Add/Delete rule from an existing security group
author: "Benno Joy (@bennojoy)"
extends_documentation_fragment: openstack
version_added: "2.0"
description:

View file

@ -23,6 +23,7 @@ DOCUMENTATION = '''
---
module: os_server_facts
short_description: Retrieve facts about one or more compute instances
author: Monty
version_added: "2.0"
description:
- Retrieve facts about server instances from OpenStack.

View file

@ -23,6 +23,7 @@ DOCUMENTATION = '''
module: os_user
short_description: Manage OpenStack Identity Users
extends_documentation_fragment: openstack
author: David Shrewsbury
version_added: "2.0"
description:
- Manage OpenStack Identity users. Users can be created,

View file

@ -76,11 +76,10 @@ options:
- The consumer key to use
timeout:
required: false
type: "int"
default: 120
description:
- The timeout in seconds used to wait for a task to be
completed. Default is 120 seconds.
completed.
'''

View file

@ -27,6 +27,7 @@ DOCUMENTATION = '''
---
module: ovirt_external_providers_facts
short_description: Retrieve facts about one or more oVirt external providers
author: "Ondra Machacek (@machacekondra)"
version_added: "2.3"
description:
- "Retrieve facts about one or more oVirt external providers."

View file

@ -28,6 +28,7 @@ DOCUMENTATION = '''
module: ovirt_quotas_facts
short_description: Retrieve facts about one or more oVirt quotas
version_added: "2.3"
author: "Red Hat"
description:
- "Retrieve facts about one or more oVirt quotas."
notes:

View file

@ -43,17 +43,14 @@ options:
balancer
load_balancer_id:
required: true
type: integer
description:
- Load balancer id
node_id:
required: false
type: integer
description:
- Node id
port:
required: false
type: integer
description:
- Port number of the load balanced service on the node
state:
@ -81,7 +78,6 @@ options:
- Wait for the load balancer to become active before returning
wait_timeout:
required: false
type: integer
default: 30
description:
- How long to wait before giving up and returning an error

View file

@ -39,46 +39,37 @@ options:
- The command you would like to perform against the cluster.
required: false
default: null
aliases: []
choices: ['ping', 'kv_test', 'join', 'plan', 'commit']
config_dir:
description:
- The path to the riak configuration directory
required: false
default: /etc/riak
aliases: []
http_conn:
description:
- The ip address and port that is listening for Riak HTTP queries
required: false
default: 127.0.0.1:8098
aliases: []
target_node:
description:
- The target node for certain operations (join, ping)
required: false
default: riak@127.0.0.1
aliases: []
wait_for_handoffs:
description:
- Number of seconds to wait for handoffs to complete.
required: false
default: null
aliases: []
type: 'int'
wait_for_ring:
description:
- Number of seconds to wait for all nodes to agree on the ring.
required: false
default: null
aliases: []
type: 'int'
wait_for_service:
description:
- Waits for a riak service to come online before continuing.
required: false
default: None
aliases: []
choices: ['kv']
validate_certs:
description:

View file

@ -98,7 +98,6 @@ options:
- "This param requires pymongo 2.5+. If it is a string, mongodb 2.4+ is also required. If it is a dictionary, mongo 2.6+ is required."
required: false
default: "readWrite"
state:
state:
description:
- The database user state

View file

@ -67,7 +67,6 @@ options:
that will be stripped from each file name found in the patch file.
For more information see the strip parameter of the GNU patch tool.
required: false
type: "int"
default: "0"
backup:
version_added: "2.0"
@ -83,9 +82,8 @@ options:
line endings into LF. Line endings of src and dest must match. If set to
C(no), patch will replace CRLF in src files on POSIX.
required: false
type: "bool"
default: "no"
note:
notes:
- This module requires GNU I(patch) utility to be installed on the remote host.
'''

View file

@ -33,7 +33,7 @@ options:
description:
- "The name of the component being deployed. Ex: billing"
required: true
alias: name
aliases: ['name']
version:
description:
- The deployment version.
@ -52,7 +52,7 @@ options:
- Name of affected host name. Can be a list.
required: false
default: machine's hostname
alias: host
aliases: ['host']
env:
description:
- The environment name, typically 'production', 'staging', etc.

View file

@ -26,6 +26,7 @@ ANSIBLE_METADATA = {'status': ['preview'],
DOCUMENTATION = '''
---
module: bigmon_chain
author: "Ted (@tedelhourani)"
short_description: Create and remove a bigmon inline service chain.
description:
- Create and remove a bigmon inline service chain.

View file

@ -26,6 +26,7 @@ ANSIBLE_METADATA = {'status': ['preview'],
DOCUMENTATION = '''
---
module: bigmon_policy
author: "Ted (@tedelhourani)"
short_description: Create and remove a bigmon out-of-band policy.
description:
- Create and remove a bigmon out-of-band policy.

View file

@ -35,32 +35,28 @@ options:
link:
description:
- Link interface name.
type: str
required: true
aliases: [ "nic", "interface" ]
property:
description:
- Specifies the name of the property we want to manage.
type: str
required: true
aliases: [ "name" ]
value:
description:
- Specifies the value we want to set for the link property.
type: str
required: false
temporary:
description:
- Specifies that lin property configuration is temporary. Temporary
link property configuration does not persist across reboots.
required: false
type: boolean
type: bool
default: false
state:
description:
- Set or reset the property value.
required: false
type: str
default: "present"
choices: [ "present", "absent", "reset" ]
'''

View file

@ -29,6 +29,7 @@ ANSIBLE_METADATA = {'status': ['preview'],
DOCUMENTATION = '''
---
module: cnos_backup
author: "Dave Kasberg (@dkasberg)"
short_description: Backup the current running or startup configuration to a remote server on devices running Lenovo CNOS
description:
- This module allows you to work with switch configurations. It provides a

View file

@ -28,6 +28,7 @@ ANSIBLE_METADATA = {'status': ['preview'],
DOCUMENTATION = '''
---
module: cnos_bgp
author: "Dave Kasberg (@dkasberg)"
short_description: Manage BGP resources and attributes on devices running Lenovo CNOS
description:
- This module allows you to work with Border Gateway Protocol (BGP) related configurations.

View file

@ -30,6 +30,7 @@ ANSIBLE_METADATA = {'status': ['preview'],
DOCUMENTATION = '''
---
module: cnos_command
author: "Dave Kasberg (@dkasberg)"
short_description: Execute a single command on devices running Lenovo CNOS
description:
- This module allows you to modify the switch running configuration. It provides a way to

View file

@ -29,6 +29,7 @@ ANSIBLE_METADATA = {'status': ['preview'],
DOCUMENTATION = '''
---
module: cnos_conditional_command
author: "Dave Kasberg (@dkasberg)"
short_description: Execute a single command based on condition on devices running Lenovo CNOS
description:
- This module allows you to modify the running configuration of a switch. It provides a way to

View file

@ -29,6 +29,7 @@ ANSIBLE_METADATA = {'status': ['preview'],
DOCUMENTATION = '''
---
module: cnos_conditional_template
author: "Dave Kasberg (@dkasberg)"
short_description: Manage switch configuration using templates based on condition on devices running Lenovo CNOS
description:
- This module allows you to work with the running configuration of a switch. It provides a way to

View file

@ -29,6 +29,7 @@ ANSIBLE_METADATA = {'status': ['preview'],
DOCUMENTATION = '''
---
module: cnos_factory
author: "Dave Kasberg (@dkasberg)"
short_description: Reset the switch's startup configuration to default (factory) on devices running Lenovo CNOS
description:
- This module allows you to reset a switchs startup configuration. The method provides a way to reset the

View file

@ -29,6 +29,7 @@ ANSIBLE_METADATA = {'status': ['preview'],
DOCUMENTATION = '''
---
module: cnos_facts
author: "Dave Kasberg (@dkasberg)"
short_description: Collect facts on devices running Lenovo CNOS
description:
- This module allows you to view the switch information. It executes the show sysinfo CLI command on a switch

View file

@ -29,6 +29,7 @@ ANSIBLE_METADATA = {'status': ['preview'],
DOCUMENTATION = '''
---
module: cnos_image
author: "Dave Kasberg (@dkasberg)"
short_description: Perform firmware upgrade/download from a remote server on devices running Lenovo CNOS
description:
- This module allows you to work with switch firmware images. It provides a way to download a firmware image

View file

@ -28,6 +28,7 @@ ANSIBLE_METADATA = {'status': ['preview'],
DOCUMENTATION = '''
---
module: cnos_interface
author: "Dave Kasberg (@dkasberg)"
short_description: Manage interface configuration on devices running Lenovo CNOS
description:
- This module allows you to work with interface related configurations. The operators used are

View file

@ -28,6 +28,7 @@ ANSIBLE_METADATA = {'status': ['preview'],
DOCUMENTATION = '''
---
module: cnos_portchannel
author: "Dave Kasberg (@dkasberg)"
short_description: Manage portchannel (port aggregation) configuration on devices running Lenovo CNOS
description:
- This module allows you to work with port aggregation related configurations. The operators

View file

@ -29,6 +29,7 @@ ANSIBLE_METADATA = {'status': ['preview'],
DOCUMENTATION = '''
---
module: cnos_reload
author: "Dave Kasberg (@dkasberg)"
short_description: Perform switch restart on devices running Lenovo CNOS
description:
- This module allows you to restart the switch using the current startup configuration.

View file

@ -30,6 +30,7 @@ ANSIBLE_METADATA = {'status': ['preview'],
DOCUMENTATION = '''
---
module: cnos_rollback
author: "Dave Kasberg (@dkasberg)"
short_description: Roll back the running or startup configuration from a remote server on devices running Lenovo CNOS
description:
- This module allows you to work with switch configurations. It provides a way to roll back configurations

View file

@ -29,6 +29,7 @@ ANSIBLE_METADATA = {'status': ['preview'],
DOCUMENTATION = '''
---
module: cnos_save
author: "Dave Kasberg (@dkasberg)"
short_description: Save the running configuration as the startup configuration on devices running Lenovo CNOS
description:
- This module allows you to copy the running configuration of a switch over its startup configuration.

View file

@ -29,6 +29,7 @@ ANSIBLE_METADATA = {'status': ['preview'],
DOCUMENTATION = '''
---
module: cnos_showrun
author: "Dave Kasberg (@dkasberg)"
short_description: Collect the current running configuration on devices running Lenovo CNOS
description:
- This module allows you to view the switch running configuration. It executes the display running-config CLI

View file

@ -29,6 +29,7 @@ ANSIBLE_METADATA = {'status': ['preview'],
DOCUMENTATION = '''
---
module: cnos_template
author: "Dave Kasberg (@dkasberg)"
short_description: Manage switch configuration using templates on devices running Lenovo CNOS
description:
- This module allows you to work with the running configuration of a switch. It provides a way

View file

@ -29,6 +29,7 @@ ANSIBLE_METADATA = {'status': ['preview'],
DOCUMENTATION = '''
---
module: cnos_vlag
author: "Dave Kasberg (@dkasberg)"
short_description: Manage VLAG resources and attributes on devices running Lenovo CNOS
description:
- This module allows you to work with virtual Link Aggregation Groups

View file

@ -30,6 +30,7 @@ ANSIBLE_METADATA = {'status': ['preview'],
DOCUMENTATION = '''
---
module: cnos_vlan
author: "Dave Kasberg (@dkasberg)"
short_description: Manage VLAN resources and attributes on devices running Lenovo CNOS
description:
- This module allows you to work with VLAN related configurations. The

View file

@ -27,7 +27,6 @@ DOCUMENTATION = """
module: pn_cluster
author: "Pluribus Networks (@amitsi)"
version_added: "2.2"
version: 1.0
short_description: CLI command to create/delete a cluster.
description:
- Execute cluster-create or cluster-delete command.

View file

@ -27,7 +27,6 @@ DOCUMENTATION = """
module: pn_ospf
author: "Pluribus Networks (@amitsi)"
version_added: "2.2"
version: 1.0
short_description: CLI command to add/remove ospf protocol to a vRouter.
description:
- Execute vrouter-ospf-add, vrouter-ospf-remove command.

View file

@ -27,7 +27,6 @@ DOCUMENTATION = """
module: pn_ospfarea
author: "Pluribus Networks (@amitsi)"
version_added: "2.2"
version: 1.0
short_description: CLI command to add/remove ospf area to/from a vrouter.
description:
- Execute vrouter-ospf-add, vrouter-ospf-remove command.

View file

@ -27,7 +27,6 @@ DOCUMENTATION = """
module: pn_show
author: "Pluribus Networks (@amitsi)"
version_added: "2.2"
version: 1.0
short_description: Run show commands on nvOS device.
description:
- Execute show command in the nodes and returns the results

View file

@ -27,7 +27,6 @@ DOCUMENTATION = """
module: pn_trunk
author: "Pluribus Networks (@amitsi)"
version_added: "2.2"
version: 1.0
short_description: CLI command to create/delete/modify a trunk.
description:
- Execute trunk-create or trunk-delete command.

View file

@ -27,7 +27,6 @@ DOCUMENTATION = """
module: pn_vlag
author: "Pluribus Networks (@amitsi)"
version_added: "2.2"
version: 1.0
short_description: CLI command to create/delete/modify vlag.
description:
- Execute vlag-create/vlag-delete/vlag-modify command.

View file

@ -27,7 +27,6 @@ DOCUMENTATION = """
module: pn_vlan
author: "Pluribus Networks (@amitsi)"
version_added: "2.2"
version: 1.0
short_description: CLI command to create/delete a VLAN.
description:
- Execute vlan-create or vlan-delete command.

View file

@ -27,7 +27,6 @@ DOCUMENTATION = """
module: pn_vrouter
author: "Pluribus Networks (@amitsi)"
version_added: "2.2"
version: 1
short_description: CLI command to create/delete/modify a vrouter.
description:
- Execute vrouter-create, vrouter-delete, vrouter-modify command.

View file

@ -27,7 +27,6 @@ DOCUMENTATION = """
module: pn_vrouterbgp
author: "Pluribus Networks (@amitsi)"
version_added: "2.2"
version: 1.0
short_description: CLI command to add/remove/modify vrouter-bgp.
description:
- Execute vrouter-bgp-add, vrouter-bgp-remove, vrouter-bgp-modify command.

View file

@ -27,7 +27,6 @@ DOCUMENTATION = """
module: pn_vrouterif
author: "Pluribus Networks (@amitsi)"
version_added: "2.2"
version: 1.0
short_description: CLI command to add/remove/modify vrouter-interface.
description:
- Execute vrouter-interface-add, vrouter-interface-remove,

View file

@ -27,7 +27,6 @@ DOCUMENTATION = """
module: pn_vrouterlbif
author: "Pluribus Networks (@amitsi)"
version_added: "2.2"
version: 1.0
short_description: CLI command to add/remove vrouter-loopback-interface.
description:
- Execute vrouter-loopback-interface-add, vrouter-loopback-interface-remove

View file

@ -33,7 +33,7 @@ author: "Luigi Mori (@jtschichold), Ivan Bojer (@ivanbojer)"
version_added: "2.3"
requirements:
- pan-python can be obtained from PyPi U(https://pypi.python.org/pypi/pan-python)
note:
notes:
- Checkmode is not supported.
options:
ip_address:

View file

@ -39,7 +39,7 @@ options:
recipient_type:
description:
- The request parametmer you would like to send the message to.
- The request parameter you would like to send the message to.
- Messages can be sent to either a room or individual (by ID or E-Mail).
required: True
choices: ['roomId', 'toPersonEmail', 'toPersonId']
@ -59,7 +59,7 @@ options:
personal_token:
description:
- Your personal access token required to validate the Spark API.
require: true
required: true
aliases: ['token']
message:

View file

@ -28,6 +28,7 @@ module: apk
short_description: Manages apk packages
description:
- Manages I(apk) packages for Alpine Linux.
author: "Kevin Brebanov (@kbrebanov)"
version_added: "2.0"
options:
name:

View file

@ -46,11 +46,10 @@ options:
- The optional git URL of the repository to tap. The URL is not
assumed to be on GitHub, and the protocol doesn't have to be HTTP.
Any location and protocol that git can handle is fine.
required: false
version_added: "2.2"
note:
- I(name) option may not be a list of multiple taps (but a single
tap instead) when this option is provided.
required: false
version_added: "2.2"
state:
description:
- state of the repository.

View file

@ -29,8 +29,6 @@ module: package
version_added: 2.0
author:
- Ansible Inc
maintainers:
- Ansible Core Team
short_description: Generic OS package manager
description:
- Installs, upgrade and removes packages using the underlying OS package manager.

View file

@ -165,7 +165,6 @@ options:
- Specifies the number of packages to build simultaneously.
required: false
default: None
type: int
version_added: 2.3
loadavg:
@ -174,7 +173,6 @@ options:
- other builds running and the load average is at least LOAD
required: false
default: None
type: float
version_added: 2.3
requirements: [ gentoolkit ]

View file

@ -36,7 +36,6 @@ options:
description:
- Remote RMCP port.
required: false
type: int
default: 623
user:
description:
@ -70,7 +69,7 @@ options:
- If set, ask that system firmware uses this device beyond next boot.
Be aware many systems do not honor this.
required: false
type: boolean
type: bool
default: false
uefiboot:
description:
@ -78,7 +77,7 @@ options:
Strictly speaking, the spec suggests that if not set, the system should BIOS boot and offers no "don't care" option.
In practice, this flag not being set does not preclude UEFI boot on any system I've encountered.
required: false
type: boolean
type: bool
default: false
requirements:
- "python >= 2.6"

View file

@ -36,7 +36,6 @@ options:
description:
- Remote RMCP port.
required: false
type: int
default: 623
user:
description:
@ -61,7 +60,6 @@ options:
description:
- Maximum number of seconds before interrupt request.
required: false
type: int
default: 300
requirements:
- "python >= 2.6"

View file

@ -62,7 +62,7 @@ options:
force_install:
description:
- Set value to True to force node into install state if it already exists in stacki.
requiored: False
required: False
author: "Hugh Ma <Hugh.Ma@flextronics.com>"
'''

View file

@ -57,21 +57,35 @@ options:
description:
- List of licenses to add or remove.
- Please note that trying to remove a non-existent license will throw an error.
valid_options:
- base : Cluster Base License,
- nfs : NFS License,
- cifs : CIFS License,
- iscsi : iSCSI License,
- fcp : FCP License,
- cdmi : CDMI License,
- snaprestore : SnapRestore License,
- snapmirror : SnapMirror License,
- flexclone : FlexClone License,
- snapvault : SnapVault License,
- snaplock : SnapLock License,
- snapmanagersuite : SnapManagerSuite License,
- snapprotectapps : SnapProtectApp License,
- v_storageattach : Virtual Attached Storage License
suboptions:
base:
description: Cluster Base License
nfs:
description: NFS License
cifs:
description: CIFS License
iscsi:
description: iSCSI License
fcp:
description: FCP License
cdmi:
description: CDMI License
snaprestore:
description: SnapRestore License
snapmirror:
description: SnapMirror License
flexclone:
description: FlexClone License
snapvault:
description: SnapVault License
snaplock:
description: SnapLock License
snapmanagersuite:
description: SnapManagerSuite License
snapprotectapps:
description: SnapProtectApp License
v_storageattach:
description: Virtual Attached Storage License
'''

View file

@ -49,8 +49,7 @@ options:
flexvol_name:
description:
- The name of the FlexVol the Qtree should exist on.
note: required when C(state=present)
- The name of the FlexVol the Qtree should exist on. Required when C(state=present).
vserver:
description:

View file

@ -49,13 +49,12 @@ options:
root_volume:
description:
- Root volume of the SVM.
note: required when C(state=present)
- Root volume of the SVM. Required when C(state=present).
root_volume_aggregate:
description:
- The aggregate on which the root volume will be created.
note: required when C(state=present)
- Required when C(state=present).
root_volume_security_style:
description:
@ -65,7 +64,7 @@ options:
- Possible values are 'unix', 'ntfs', 'mixed'.
- The 'unified' security style, which applies only to Infinite Volumes, cannot be applied to a Vserver's root volume.
- Valid options are "unix" for NFS, "ntfs" for CIFS, "mixed" for Mixed, "unified" for Unified.
note: required when C(state=present)
- Required when C(state=present)
choices: ['unix', 'ntfs', 'mixed', 'unified']
'''

View file

@ -58,7 +58,6 @@ options:
- Authentication method for the application.
- Not all authentication methods are valid for an application.
- Valid authentication methods for each application are as denoted in I(authentication_choices_description).
authentication_choices_description:
- password for console application
- password, domain, nsswitch, cert for http application.
- password, domain, nsswitch, cert for ontapi application.
@ -80,8 +79,7 @@ options:
role_name:
description:
- The name of the role.
note: required when C(state=present)
- The name of the role. Required when C(state=present)
vserver:

View file

@ -61,13 +61,11 @@ options:
aggregate_name:
description:
- The name of the aggregate the flexvol should exist on.
note: required when C(state=present)
- The name of the aggregate the flexvol should exist on. Required when C(state=present).
size:
description:
- The size of the volume in (size_unit).
note: required when C(state=present)
- The size of the volume in (size_unit). Required when C(state=present).
size_unit:
description:

View file

@ -42,8 +42,6 @@ options:
required: true
description:
- The url to the SANtricity WebServices Proxy or embedded REST API.
example:
- https://prod-1.wahoo.acme.com/devmgr/v2
validate_certs:
required: false
default: true

View file

@ -42,8 +42,6 @@ options:
required: true
description:
- The url to the SANtricity WebServices Proxy or embedded REST API.
example:
- https://prod-1.wahoo.acme.com/devmgr/v2
validate_certs:
required: false
default: true

View file

@ -38,8 +38,6 @@ options:
required: true
description:
- The url to the SANtricity WebServices Proxy or embedded REST API.
example:
- https://prod-1.wahoo.acme.com/devmgr/v2
validate_certs:
required: false
default: true

View file

@ -41,8 +41,6 @@ options:
required: true
description:
- The url to the SANtricity WebServices Proxy or embedded REST API.
example:
- https://prod-1.wahoo.acme.com/devmgr/v2
validate_certs:
required: false
default: true

View file

@ -41,9 +41,7 @@ options:
api_url:
required: true
description:
- The url to the SANtricity WebServices Proxy or embedded REST API.
example:
- https://prod-1.wahoo.acme.com/devmgr/v2
- The url to the SANtricity WebServices Proxy or embedded REST API, for example C(https://prod-1.wahoo.acme.com/devmgr/v2).
validate_certs:
required: false
default: true

View file

@ -44,8 +44,6 @@ options:
required: true
description:
- The url to the SANtricity WebServices Proxy or embedded REST API.
example:
- https://prod-1.wahoo.acme.com/devmgr/v2
validate_certs:
required: false
default: true

View file

@ -42,8 +42,6 @@ options:
required: true
description:
- The url to the SANtricity WebServices Proxy or embedded REST API.
example:
- https://prod-1.wahoo.acme.com/devmgr/v2
validate_certs:
required: false
default: true

View file

@ -44,8 +44,6 @@ options:
required: true
description:
- The url to the SANtricity WebServices Proxy or embedded REST API.
example:
- https://prod-1.wahoo.acme.com/devmgr/v2
validate_certs:
required: false
default: true

Some files were not shown because too many files have changed in this diff Show more