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

Add version_added for all new features (#214)

Browse source 
* Add version_added: 1.0.0 for all new features added before pre-ansible-base.

* Add version_added: 1.0.0 for all new features.

* Next release will be 0.2.0

* Fix error.

* Remove unnecessary warnings.
This commit is contained in:
Felix Fontein 2020-06-13 15:01:19 +02:00 committed by GitHub
parent c081bb6c9c
commit f9589d78a8
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
102 changed files with 220 additions and 10 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
changelogs/fragments/68374_rhn_channel.yml
View file

@ -1,2 +1,2 @@
bugfixes:
- Add validate_certs in rhn_channel module (https://github.com/ansible/ansible/issues/68374).
minor_changes:
- "rhn_channel - Added ``validate_certs`` option (https://github.com/ansible/ansible/issues/68374)."

2
galaxy.yml
View file

@ -1,6 +1,6 @@
namespace: community
name: general
version: 0.1.1
version: 0.2.0
readme: README.md
authors:
- Ansible (https://github.com/ansible)

1
plugins/doc_fragments/influxdb.py
View file

@ -38,6 +38,7 @@ options:
description:
- The path on which InfluxDB server is accessible
type: str
version_added: '0.2.0'
validate_certs:
description:
- If set to C(no), the SSL certificates will not be validated.

1
plugins/doc_fragments/kubevirt_common_options.py
View file

@ -36,6 +36,7 @@ options:
description:
- Number of seconds to sleep between checks.
default: 5
version_added: '0.2.0'
memory:
description:
- The amount of memory to be requested by virtual machine.

1
plugins/lookup/etcd3.py
View file

@ -9,6 +9,7 @@ __metaclass__ = type
DOCUMENTATION = '''
author:
- Eric Belhomme <ebelhomme@fr.scc.com>
version_added: '0.2.0'
lookup: etcd3
short_description: Get key values from etcd3 server
description:

11
plugins/lookup/hashi_vault.py
View file

@ -42,12 +42,14 @@ DOCUMENTATION = """
ini:
- section: lookup_hashi_vault
key: token_path
version_added: '0.2.0'
token_file:
description: If no token is specified, will try to read the token from this file in C(token_path).
ini:
- section: lookup_hashi_vault
key: token_file
default: '.vault-token'
version_added: '0.2.0'
url:
description: URL to vault service.
env:
@ -55,6 +57,7 @@ DOCUMENTATION = """
ini:
- section: lookup_hashi_vault
key: url
version_added: '0.2.0'
default: 'http://127.0.0.1:8200'
username:
description: Authentication user name.
@ -67,6 +70,7 @@ DOCUMENTATION = """
ini:
- section: lookup_hashi_vault
key: role_id
version_added: '0.2.0'
secret_id:
description: Secret id for a vault AppRole auth.
env:
@ -81,6 +85,7 @@ DOCUMENTATION = """
ini:
- section: lookup_hashi_vault
key: auth_method
version_added: '0.2.0'
choices:
- token
- userpass
@ -100,6 +105,7 @@ DOCUMENTATION = """
- raw
default: dict
aliases: [ as ]
version_added: '0.2.0'
mount_point:
description: Vault mount point, only required if you have a custom mount point.
ca_cert:
@ -118,6 +124,7 @@ DOCUMENTATION = """
env:
- name: AWS_DEFAULT_PROFILE
- name: AWS_PROFILE
version_added: '0.2.0'
aws_access_key:
description: The AWS access key to use.
type: str
@ -126,6 +133,7 @@ DOCUMENTATION = """
- name: EC2_ACCESS_KEY
- name: AWS_ACCESS_KEY
- name: AWS_ACCESS_KEY_ID
version_added: '0.2.0'
aws_secret_key:
description: The AWS secret key that corresponds to the access key.
type: str
@ -134,6 +142,7 @@ DOCUMENTATION = """
- name: EC2_SECRET_KEY
- name: AWS_SECRET_KEY
- name: AWS_SECRET_ACCESS_KEY
version_added: '0.2.0'
aws_security_token:
description: The AWS security token if using temporary access and secret keys.
type: str
@ -141,12 +150,14 @@ DOCUMENTATION = """
- name: EC2_SECURITY_TOKEN
- name: AWS_SESSION_TOKEN
- name: AWS_SECURITY_TOKEN
version_added: '0.2.0'
region:
description: The AWS region for which to create the connection.
type: str
env:
- name: EC2_REGION
- name: AWS_REGION
version_added: '0.2.0'
"""
EXAMPLES = """

1
plugins/lookup/lmdb_kv.py
View file

@ -8,6 +8,7 @@ DOCUMENTATION = '''
lookup: lmdb_kv
author:
- Jan-Piet Mens (@jpmens)
version_added: '0.2.0'
short_description: fetch data from LMDB
description:
- This lookup returns a list of results from an LMDB DB corresponding to a list of items given to it

1
plugins/lookup/sops.py
View file

@ -34,6 +34,7 @@ DOCUMENTATION = """
lookup: sops
author: Edoardo Tenani (@endorama) <e.tenani@arduino.cc>
short_description: Read sops encrypted file contents
version_added: '0.2.0'
description:
- This lookup returns the contents from a file on the Ansible controller's file system.
- This lookup requires the C(sops) executable to be available in the controller PATH.

9
plugins/modules/cloud/alicloud/ali_instance.py
View file

@ -102,6 +102,7 @@ options:
The sequential suffix ranges from 001 to 999.
default: False
type: bool
version_added: '0.2.0'
password:
description:
- The password to login instance. After rebooting instances, modified password will take effect.
@ -182,12 +183,14 @@ options:
- A hash/dictionaries of instance tags, to add to the new instance or for starting/stopping instance by tag. C({"key":"value"})
aliases: ["instance_tags"]
type: dict
version_added: '0.2.0'
purge_tags:
description:
- Delete any tags not specified in the task that are on the instance.
If True, it means you have to specify all the desired tags on each task affecting an instance.
default: False
type: bool
version_added: '0.2.0'
key_name:
description:
- The name of key pair which is used to access ECS instance in SSH.
@ -204,23 +207,27 @@ options:
description:
- The name of the instance RAM role.
type: str
version_added: '0.2.0'
spot_price_limit:
description:
- The maximum hourly price for the preemptible instance. This parameter supports a maximum of three decimal
places and takes effect when the SpotStrategy parameter is set to SpotWithPriceLimit.
type: float
version_added: '0.2.0'
spot_strategy:
description:
- The bidding mode of the pay-as-you-go instance. This parameter is valid when InstanceChargeType is set to PostPaid.
choices: ['NoSpot', 'SpotWithPriceLimit', 'SpotAsPriceGo']
default: 'NoSpot'
type: str
version_added: '0.2.0'
period_unit:
description:
- The duration unit that you will buy the resource. It is valid when C(instance_charge_type=PrePaid)
choices: ['Month', 'Week']
default: 'Month'
type: str
version_added: '0.2.0'
dry_run:
description:
- Specifies whether to send a dry-run request.
@ -230,11 +237,13 @@ options:
- If I(dry_run=False), A request is sent. If the validation succeeds, the instance is created.
default: False
type: bool
version_added: '0.2.0'
include_data_disks:
description:
- Whether to change instance disks charge type when changing instance charge type.
default: True
type: bool
version_added: '0.2.0'
author:
- "He Guimin (@xiaozhu36)"
requirements:

2
plugins/modules/cloud/alicloud/ali_instance_info.py
View file

@ -54,6 +54,7 @@ options:
description:
- Use a instance name prefix to filter ecs instances.
type: str
version_added: '0.2.0'
tags:
description:
- A hash/dictionaries of instance tags. C({"key":"value"})
@ -67,6 +68,7 @@ options:
connect different words in one parameter. 'InstanceIds' should be a list and it will be appended to
I(instance_ids) automatically. 'Tag.n.Key' and 'Tag.n.Value' should be a dict and using I(tags) instead.
type: dict
version_added: '0.2.0'
author:
- "He Guimin (@xiaozhu36)"
requirements:

2
plugins/modules/cloud/cloudscale/cloudscale_floating_ip.py
View file

@ -58,6 +58,7 @@ options:
If omitted, the region of the project default zone is used.
This parameter must be omitted if I(type) is set to C(global).
type: str
version_added: '0.2.0'
prefix_length:
description:
- Only valid if I(ip_version) is 6.
@ -153,6 +154,7 @@ region:
returned: success when state == present
type: dict
sample: {'slug': 'lpg'}
version_added: '0.2.0'
state:
description: The current status of the floating IP.
returned: success

2
plugins/modules/cloud/cloudscale/cloudscale_server.py
View file

@ -54,6 +54,7 @@ options:
description:
- Zone in which the server resides (e.g. C(lgp1) or C(rma1)).
type: str
version_added: '0.2.0'
volume_size_gb:
description:
- Size of the root volume in GB.
@ -220,6 +221,7 @@ zone:
returned: success when not state == absent
type: dict
sample: { 'slug': 'lpg1' }
version_added: '0.2.0'
volumes:
description: List of volumes attached to the server
returned: success when not state == absent

2
plugins/modules/cloud/cloudscale/cloudscale_server_group.py
View file

@ -37,6 +37,7 @@ options:
description:
- Zone slug of the server group (e.g. C(lgp1) or C(rma1)).
type: str
version_added: '0.2.0'
state:
description:
- State of the server group.
@ -101,6 +102,7 @@ zone:
returned: success
type: dict
sample: { 'slug': 'rma1' }
version_added: '0.2.0'
servers:
description: A list of servers that are part of the server group.
returned: if available

2
plugins/modules/cloud/cloudscale/cloudscale_volume.py
View file

@ -56,6 +56,7 @@ options:
- Zone in which the volume resides (e.g. C(lgp1) or C(rma1)). Cannot be
changed after creating the volume. Defaults to the project default zone.
type: str
version_added: '0.2.0'
server_uuids:
description:
- UUIDs of the servers this volume is attached to. Set this to C([]) to
@ -146,6 +147,7 @@ zone:
returned: state == present
type: dict
sample: {'slug': 'lpg1'}
version_added: '0.2.0'
server_uuids:
description: The UUIDs of the servers this volume is attached to.
returned: state == present

3
plugins/modules/cloud/docker/docker_container.py
View file

@ -98,6 +98,7 @@ options:
choices:
- compatibility
- no_defaults
version_added: '0.2.0'
cpu_period:
description:
- Limit CPU CFS (Completely Fair Scheduler) period.
@ -113,6 +114,7 @@ options:
- Specify how much of the available CPU resources a container can use.
- A value of C(1.5) means that at most one and a half CPU (core) will be used.
type: float
version_added: '0.2.0'
cpuset_cpus:
description:
- CPUs in which to allow execution C(1,3) or C(1-3).
@ -669,6 +671,7 @@ options:
removed. If the container is still in the removal phase after this many seconds, the module will
fail.
type: float
version_added: '0.2.0'
restart:
description:
- Use with started state to force a matching container to be stopped and restarted.

1
plugins/modules/cloud/docker/docker_swarm_service.py
View file

@ -190,6 +190,7 @@ options:
- Corresponds to the C(--init) option of C(docker service create).
- Requires API version >= 1.37.
type: bool
version_added: '0.2.0'
labels:
description:
- Dictionary of key value pairs.

1
plugins/modules/cloud/huawei/hwc_ecs_instance.py
View file

@ -18,6 +18,7 @@ module: hwc_ecs_instance
description:
- instance management.
short_description: Creates a resource of Ecs/Instance in Huawei Cloud
version_added: '0.2.0'
author: Huawei Inc. (@huaweicloud)
requirements:
- keystoneauth1 >= 3.6.0

1
plugins/modules/cloud/huawei/hwc_evs_disk.py
View file

@ -18,6 +18,7 @@ module: hwc_evs_disk
description:
- block storage management.
short_description: Creates a resource of Evs/Disk in Huawei Cloud
version_added: '0.2.0'
author: Huawei Inc. (@huaweicloud)
requirements:
- keystoneauth1 >= 3.6.0

1
plugins/modules/cloud/huawei/hwc_vpc_eip.py
View file

@ -18,6 +18,7 @@ module: hwc_vpc_eip
description:
- elastic ip management.
short_description: Creates a resource of Vpc/EIP in Huawei Cloud
version_added: '0.2.0'
author: Huawei Inc. (@huaweicloud)
requirements:
- keystoneauth1 >= 3.6.0

1
plugins/modules/cloud/huawei/hwc_vpc_peering_connect.py
View file

@ -19,6 +19,7 @@ module: hwc_vpc_peering_connect
description:
- vpc peering management.
short_description: Creates a resource of Vpc/PeeringConnect in Huawei Cloud
version_added: '0.2.0'
author: Huawei Inc. (@huaweicloud)
requirements:
- keystoneauth1 >= 3.6.0

1
plugins/modules/cloud/huawei/hwc_vpc_port.py
View file

@ -18,6 +18,7 @@ module: hwc_vpc_port
description:
- vpc port management.
short_description: Creates a resource of Vpc/Port in Huawei Cloud
version_added: '0.2.0'
author: Huawei Inc. (@huaweicloud)
requirements:
- keystoneauth1 >= 3.6.0

1
plugins/modules/cloud/huawei/hwc_vpc_private_ip.py
View file

@ -22,6 +22,7 @@ notes:
- If I(id) option is provided, it takes precedence over I(subnet_id), I(ip_address) for private ip selection.
- I(subnet_id), I(ip_address) are used for private ip selection. If more than one private ip with this options exists, execution is aborted.
- No parameter support updating. If one of option is changed, the module will create a new resource.
version_added: '0.2.0'
author: Huawei Inc. (@huaweicloud)
requirements:
- keystoneauth1 >= 3.6.0

1
plugins/modules/cloud/huawei/hwc_vpc_route.py
View file

@ -22,6 +22,7 @@ notes:
- If I(id) option is provided, it takes precedence over I(destination), I(vpc_id), I(type) and I(next_hop) for route selection.
- I(destination), I(vpc_id), I(type) and I(next_hop) are used for route selection. If more than one route with this options exists, execution is aborted.
- No parameter support updating. If one of option is changed, the module will create a new resource.
version_added: '0.2.0'
author: Huawei Inc. (@huaweicloud)
requirements:
- keystoneauth1 >= 3.6.0

1
plugins/modules/cloud/huawei/hwc_vpc_security_group.py
View file

@ -26,6 +26,7 @@ notes:
execution is aborted.
- No parameter support updating. If one of option is changed, the module
will create a new resource.
version_added: '0.2.0'
author: Huawei Inc. (@huaweicloud)
requirements:
- keystoneauth1 >= 3.6.0

1
plugins/modules/cloud/huawei/hwc_vpc_security_group_rule.py
View file

@ -26,6 +26,7 @@ notes:
aborted.
- No parameter support updating. If one of option is changed, the module
will create a new resource.
version_added: '0.2.0'
author: Huawei Inc. (@huaweicloud)
requirements:
- keystoneauth1 >= 3.6.0

1
plugins/modules/cloud/huawei/hwc_vpc_subnet.py
View file

@ -18,6 +18,7 @@ module: hwc_vpc_subnet
description:
- subnet management.
short_description: Creates a resource of Vpc/Subnet in Huawei Cloud
version_added: '0.2.0'
author: Huawei Inc. (@huaweicloud)
requirements:
- keystoneauth1 >= 3.6.0

2
plugins/modules/cloud/misc/proxmox.py
View file

@ -134,10 +134,12 @@ options:
- Specify the description for the container. Only used on the configuration web interface.
- This is saved as a comment inside the configuration file.
type: str
version_added: '0.2.0'
hookscript:
description:
- Script that will be executed during various steps in the containers lifetime.
type: str
version_added: '0.2.0'
notes:
- Requires proxmoxer and requests modules on host. This modules can be installed with pip.

2
plugins/modules/cloud/misc/terraform.py
View file

@ -55,6 +55,7 @@ options:
description:
- The path to a variables file for Terraform to fill into the TF
configurations. This can accept a list of paths to multiple variables files.
- Up until Ansible 2.9, this option was usable as I(variables_file).
type: list
elements: path
aliases: [ 'variables_file' ]
@ -91,6 +92,7 @@ options:
This can accept a list of paths to multiple configuration files.
type: list
elements: path
version_added: '0.2.0'
notes:
- To just run a `terraform plan`, use check mode.
requirements: [ "terraform" ]

3
plugins/modules/cloud/opennebula/one_vm.py
View file

@ -172,12 +172,15 @@ options:
- Create a private persistent copy of the template plus any image defined in DISK, and instantiate that copy.
default: NO
type: bool
version_added: '0.2.0'
datastore_id:
description:
- Name of Datastore to use to create a new instace
version_added: '0.2.0'
datastore_name:
description:
- Name of Datastore to use to create a new instace
version_added: '0.2.0'
author:
- "Milan Ilic (@ilicmilan)"
- "Jan Meerkamp (@meerkampdvv)"

1
plugins/modules/cloud/ovh/ovh_monthly_billing.py
View file

@ -12,6 +12,7 @@ DOCUMENTATION = '''
---
module: ovh_monthly_billing
author: Francois Lallart (@fraff)
version_added: '0.2.0'
short_description: Manage OVH monthly billing
description:
- Enable monthly billing on OVH cloud intances (be aware OVH does not allow to disable it).

1
plugins/modules/cloud/packet/packet_device.py
View file

@ -52,6 +52,7 @@ options:
- Currently implemented only for device creation.
type: list
elements: str
version_added: '0.2.0'
facility:
description:

1
plugins/modules/cloud/packet/packet_ip_subnet.py
View file

@ -21,6 +21,7 @@ description:
- IPv6 subnets must come from publicly routable /56 block from your project.
- See U(https://support.packet.com/kb/articles/elastic-ips) for more info on IP block reservation.
version_added: '0.2.0'
author:
- Tomas Karasek (@t0mk) <tom.to.the.k@gmail.com>

1
plugins/modules/cloud/packet/packet_project.py
View file

@ -19,6 +19,7 @@ description:
- Create/delete a project in Packet host.
- API is documented at U(https://www.packet.com/developers/api/#projects).
version_added: '0.2.0'
author:
- Tomas Karasek (@t0mk) <tom.to.the.k@gmail.com>

1
plugins/modules/cloud/packet/packet_volume.py
View file

@ -18,6 +18,7 @@ description:
- Create/delete a volume in Packet host.
- API is documented at U(https://www.packet.com/developers/api/#volumes).
version_added: '0.2.0'
author:
- Tomas Karasek (@t0mk) <tom.to.the.k@gmail.com>

1
plugins/modules/cloud/packet/packet_volume_attachment.py
View file

@ -22,6 +22,7 @@ description:
the block devices on the server, you have to run the Attach Scripts,
as documented at U(https://help.packet.net/technical/storage/packet-block-storage-linux)."
version_added: '0.2.0'
author:
- Tomas Karasek (@t0mk) <tom.to.the.k@gmail.com>

1
plugins/modules/cloud/softlayer/sl_vm.py
View file

@ -61,6 +61,7 @@ options:
flavor:
description:
- Specify which SoftLayer flavor template to use instead of cpus and memory.
version_added: '0.2.0'
disks:
description:
- List of disk sizes to be assigned to new virtual instance.

1
plugins/modules/database/misc/redis_info.py
View file

@ -12,6 +12,7 @@ DOCUMENTATION = r'''
---
module: redis_info
short_description: Gather information about Redis servers
version_added: '0.2.0'
description:
- Gathers information and statistics about Redis servers.
options:

10
plugins/modules/database/mysql/mysql_db.py
View file

@ -73,6 +73,7 @@ options:
required: no
default: no
type: bool
version_added: '0.2.0'
force:
description:
- Continue dump or import even if we get an SQL error.
@ -80,6 +81,7 @@ options:
required: no
type: bool
default: no
version_added: '0.2.0'
master_data:
description:
- Option to dump a master replication server to produce a dump file
@ -93,18 +95,21 @@ options:
type: int
choices: [0, 1, 2]
default: 0
version_added: '0.2.0'
skip_lock_tables:
description:
- Skip locking tables for read. Used when I(state=dump), ignored otherwise.
required: no
type: bool
default: no
version_added: '0.2.0'
dump_extra_args:
description:
- Provide additional arguments for mysqldump.
Used when I(state=dump) only, ignored otherwise.
required: no
type: str
version_added: '0.2.0'
use_shell:
description:
- Used to prevent C(Broken pipe) errors when the imported I(target) file is compressed.
@ -113,6 +118,7 @@ options:
required: no
type: bool
default: no
version_added: '0.2.0'
unsafe_login_password:
description:
- If C(no), the module will safely use a shell-escaped version of the I(login_password) value.
@ -120,6 +126,7 @@ options:
- Used only when I(state) is C(import) or C(dump) and I(login_password) is passed, ignored otherwise.
type: bool
default: no
version_added: '0.2.0'
restrict_config_file:
description:
- Read only passed I(config_file).
@ -129,12 +136,14 @@ options:
- If this behavior is undesirable, use C(yes) to read only named option file.
type: bool
default: no
version_added: '0.2.0'
check_implicit_admin:
description:
- Check if mysql allows login as root/nopassword before trying supplied credentials.
- If success, passed I(login_user)/I(login_password) will be ignored.
type: bool
default: no
version_added: '0.2.0'
seealso:
- module: mysql_info
@ -291,6 +300,7 @@ executed_commands:
returned: if executed
type: list
sample: ["CREATE DATABASE acme"]
version_added: '0.2.0'
'''
import os

1
plugins/modules/database/mysql/mysql_info.py
View file

@ -37,6 +37,7 @@ options:
- "Supports elements: C(db_size). Unsupported elements will be ignored"
type: list
elements: str
version_added: '0.2.0'
return_empty_dbs:
description:
- Includes names of empty databases to returned dictionary.

1
plugins/modules/database/mysql/mysql_query.py
View file

@ -15,6 +15,7 @@ description:
- Runs arbitrary MySQL queries.
- Pay attention, the module does not support check mode!
All queries will be executed in autocommit mode.
version_added: '0.2.0'
options:
query:
description:

6
plugins/modules/database/mysql/mysql_replication.py
View file

@ -115,12 +115,14 @@ options:
- Available since MariaDB 10.0.2.
choices: [current_pos, slave_pos, disabled]
type: str
version_added: '0.2.0'
master_delay:
description:
- Time lag behind the master's state (in seconds).
- Available from MySQL 5.6.
- For more information see U(https://dev.mysql.com/doc/refman/8.0/en/replication-delayed.html).
type: int
version_added: '0.2.0'
connection_name:
description:
- Name of the master connection.
@ -128,6 +130,7 @@ options:
- Mutually exclusive with I(channel).
- For more information see U(https://mariadb.com/kb/en/library/multi-source-replication/).
type: str
version_added: '0.2.0'
channel:
description:
- Name of replication channel.
@ -135,11 +138,13 @@ options:
- Mutually exclusive with I(connection_name).
- For more information see U(https://dev.mysql.com/doc/refman/8.0/en/replication-multi-source.html).
type: str
version_added: '0.2.0'
fail_on_error:
description:
- Fails on error when calling mysql.
type: bool
default: False
version_added: '0.2.0'
notes:
- If an empty value for the parameter of string type is needed, use an empty string.
@ -226,6 +231,7 @@ queries:
returned: always
type: list
sample: ["CHANGE MASTER TO MASTER_HOST='master2.example.com',MASTER_PORT=3306"]
version_added: '0.2.0'
'''
import os

4
plugins/modules/database/mysql/mysql_user.py
View file

@ -89,14 +89,17 @@ options:
description:
- User's plugin to authenticate (``CREATE USER user IDENTIFIED WITH plugin``).
type: str
version_added: '0.2.0'
plugin_hash_string:
description:
- User's plugin hash string (``CREATE USER user IDENTIFIED WITH plugin AS plugin_hash_string``).
type: str
version_added: '0.2.0'
plugin_auth_string:
description:
- User's plugin auth_string (``CREATE USER user IDENTIFIED WITH plugin BY plugin_auth_string``).
type: str
version_added: '0.2.0'
resource_limits:
description:
- Limit the user for certain server resources. Provided since MySQL 5.6 / MariaDB 10.2.
@ -104,6 +107,7 @@ options:
C(MAX_CONNECTIONS_PER_HOUR: num), C(MAX_USER_CONNECTIONS: num)."
- Used when I(state=present), ignored otherwise.
type: dict
version_added: '0.2.0'
notes:
- "MySQL server installs with default login_user of 'root' and no password. To secure this user

2
plugins/modules/database/mysql/mysql_variables.py
View file

@ -42,6 +42,7 @@ options:
type: str
choices: ['global', 'persist', 'persist_only']
default: global
version_added: '0.2.0'
seealso:
- module: mysql_info
@ -72,6 +73,7 @@ queries:
returned: if executed
type: list
sample: ["SET GLOBAL `read_only` = 1"]
version_added: '0.2.0'
'''
import os

1
plugins/modules/database/postgresql/postgresql_copy.py
View file

@ -75,6 +75,7 @@ options:
- It makes sense to use C(yes) only when SQL injections are possible.
type: bool
default: yes
version_added: '0.2.0'
notes:
- Supports PostgreSQL version 9.4+.
- COPY command is only allowed to database superusers.

3
plugins/modules/database/postgresql/postgresql_db.py
View file

@ -101,6 +101,7 @@ options:
- Provides additional arguments when I(state) is C(dump).
- Cannot be used with dump-file-format-related arguments like ``--format=d``.
type: str
version_added: '0.2.0'
trust_input:
description:
- If C(no), check whether values of parameters I(owner), I(conn_limit), I(encoding),
@ -108,6 +109,7 @@ options:
- It makes sense to use C(yes) only when SQL injections via the parameters are possible.
type: bool
default: yes
version_added: '0.2.0'
seealso:
- name: CREATE DATABASE reference
description: Complete reference of the CREATE DATABASE command documentation.
@ -200,6 +202,7 @@ executed_commands:
returned: always
type: list
sample: ["CREATE DATABASE acme"]
version_added: '0.2.0'
'''

1
plugins/modules/database/postgresql/postgresql_ext.py
View file

@ -83,6 +83,7 @@ options:
- It makes sense to use C(yes) only when SQL injections via the parameters are possible.
type: bool
default: yes
version_added: '0.2.0'
seealso:
- name: PostgreSQL extensions
description: General information about PostgreSQL extensions.

2
plugins/modules/database/postgresql/postgresql_idx.py
View file

@ -88,6 +88,7 @@ options:
- Only btree currently supports unique indexes.
type: bool
default: no
version_added: '0.2.0'
tablespace:
description:
- Set a tablespace for the index.
@ -116,6 +117,7 @@ options:
- It makes sense to use C(yes) only when SQL injections via the parameters are possible.
type: bool
default: yes
version_added: '0.2.0'
seealso:
- module: postgresql_table

3
plugins/modules/database/postgresql/postgresql_info.py
View file

@ -46,6 +46,7 @@ options:
- It makes sense to use C(yes) only when SQL injections via I(session_role) are possible.
type: bool
default: yes
version_added: '0.2.0'
seealso:
- module: postgresql_ping
author:
@ -244,6 +245,7 @@ databases:
returned: if configured
type: dict
sample: { "pub1": { "ownername": "postgres", "puballtables": true, "pubinsert": true, "pubupdate": true } }
version_added: '0.2.0'
subscriptions:
description:
- Information about replication subscriptions (available for PostgreSQL 10 and higher)
@ -253,6 +255,7 @@ databases:
type: dict
sample:
- { "my_subscription": {"ownername": "postgres", "subenabled": true, "subpublications": ["first_publication"] } }
version_added: '0.2.0'
repl_slots:
description:
- Replication slots (available in 9.4 and later)

2
plugins/modules/database/postgresql/postgresql_lang.py
View file

@ -101,6 +101,7 @@ options:
- Set an owner for the language.
- Ignored when I(state=absent).
type: str
version_added: '0.2.0'
trust_input:
description:
- If C(no), check whether values of parameters I(lang), I(session_role),
@ -108,6 +109,7 @@ options:
- It makes sense to use C(yes) only when SQL injections via the parameters are possible.
type: bool
default: yes
version_added: '0.2.0'
seealso:
- name: PostgreSQL languages
description: General information about PostgreSQL languages.

1
plugins/modules/database/postgresql/postgresql_membership.py
View file

@ -73,6 +73,7 @@ options:
- It makes sense to use C(yes) only when SQL injections via the parameters are possible.
type: bool
default: yes
version_added: '0.2.0'
seealso:
- module: postgresql_user
- module: postgresql_privs

1
plugins/modules/database/postgresql/postgresql_owner.py
View file

@ -71,6 +71,7 @@ options:
- It makes sense to use C(yes) only when SQL injections via the parameters are possible.
type: bool
default: yes
version_added: '0.2.0'
seealso:
- module: postgresql_user
- module: postgresql_privs

2
plugins/modules/database/postgresql/postgresql_ping.py
View file

@ -27,12 +27,14 @@ options:
- Permissions checking for SQL commands is carried out as though
the session_role were the one that had logged in originally.
type: str
version_added: '0.2.0'
trust_input:
description:
- If C(no), check whether a value of I(session_role) is potentially dangerous.
- It does make sense to use C(yes) only when SQL injections via I(session_role) are possible.
type: bool
default: yes
version_added: '0.2.0'
seealso:
- module: postgresql_info
author:

1
plugins/modules/database/postgresql/postgresql_privs.py
View file

@ -160,6 +160,7 @@ options:
- It makes sense to use C(yes) only when SQL injections via the parameters are possible.
type: bool
default: yes
version_added: '0.2.0'
notes:
- Parameters that accept comma separated lists (I(privs), I(objs), I(roles))

2
plugins/modules/database/postgresql/postgresql_publication.py
View file

@ -64,6 +64,7 @@ options:
- Permissions checking for SQL commands is carried out as though
the session_role were the one that had logged in originally.
type: str
version_added: '0.2.0'
trust_input:
description:
- If C(no), check whether values of parameters I(name), I(tables), I(owner),
@ -71,6 +72,7 @@ options:
- It makes sense to use C(yes) only when SQL injections via the parameters are possible.
type: bool
default: yes
version_added: '0.2.0'
notes:
- PostgreSQL version must be 10 or greater.
seealso:

2
plugins/modules/database/postgresql/postgresql_query.py
View file

@ -67,12 +67,14 @@ options:
- Set the client encoding for the current session (e.g. C(UTF-8)).
- The default is the encoding defined by the database.
type: str
version_added: '0.2.0'
trust_input:
description:
- If C(no), check whether a value of I(session_role) is potentially dangerous.
- It does make sense to use C(yes) only when SQL injections via I(session_role) are possible.
type: bool
default: yes
version_added: '0.2.0'
seealso:
- module: postgresql_db
author:

1
plugins/modules/database/postgresql/postgresql_schema.py
View file

@ -71,6 +71,7 @@ options:
- It makes sense to use C(yes) only when SQL injections via the parameters are possible.
type: bool
default: yes
version_added: '0.2.0'
seealso:
- name: PostgreSQL schemas
description: General information about PostgreSQL schemas.

1
plugins/modules/database/postgresql/postgresql_sequence.py
View file

@ -136,6 +136,7 @@ options:
- It makes sense to use C(yes) only when SQL injections via the parameters are possible.
type: bool
default: yes
version_added: '0.2.0'
notes:
- If you do not pass db parameter, sequence will be created in the database
named postgres.

1
plugins/modules/database/postgresql/postgresql_set.py
View file

@ -59,6 +59,7 @@ options:
- It does make sense to use C(yes) only when SQL injections are possible.
type: bool
default: yes
version_added: '0.2.0'
notes:
- Supported version of PostgreSQL is 9.4 and later.
- Pay attention, change setting with 'postmaster' context can return changed is true

1
plugins/modules/database/postgresql/postgresql_slot.py
View file

@ -72,6 +72,7 @@ options:
- It sense to use C(no) only when SQL injections via I(session_role) are possible.
type: bool
default: yes
version_added: '0.2.0'
notes:
- Physical replication slots were introduced to PostgreSQL with version 9.4,

3
plugins/modules/database/postgresql/postgresql_subscription.py
View file

@ -14,6 +14,7 @@ module: postgresql_subscription
short_description: Add, update, or remove PostgreSQL subscription
description:
- Add, update, or remove PostgreSQL subscription.
version_added: '0.2.0'
options:
name:
@ -82,6 +83,7 @@ options:
- Permissions checking for SQL commands is carried out as though
the session_role were the one that had logged in originally.
type: str
version_added: '0.2.0'
trust_input:
description:
- If C(no), check whether values of parameters I(name), I(publications), I(owner),
@ -89,6 +91,7 @@ options:
- It makes sense to use C(yes) only when SQL injections via the parameters are possible.
type: bool
default: yes
version_added: '0.2.0'
notes:
- PostgreSQL version must be 10 or greater.

1
plugins/modules/database/postgresql/postgresql_table.py
View file

@ -99,6 +99,7 @@ options:
- It makes sense to use C(yes) only when SQL injections are possible.
type: bool
default: yes
version_added: '0.2.0'
notes:
- If you do not pass db parameter, tables will be created in the database
named postgres.

1
plugins/modules/database/postgresql/postgresql_tablespace.py
View file

@ -76,6 +76,7 @@ options:
- It makes sense to use C(yes) only when SQL injections via the parameters are possible.
type: bool
default: yes
version_added: '0.2.0'
notes:
- I(state=absent) and I(state=present) (the second one if the tablespace doesn't exist) do not

2
plugins/modules/database/postgresql/postgresql_user.py
View file

@ -141,6 +141,7 @@ options:
description:
- Add a comment on the user (equal to the COMMENT ON ROLE statement result).
type: str
version_added: '0.2.0'
trust_input:
description:
- If C(no), check whether values of parameters I(name), I(password), I(privs), I(expires),
@ -148,6 +149,7 @@ options:
- It makes sense to use C(yes) only when SQL injections via the parameters are possible.
type: bool
default: yes
version_added: '0.2.0'
notes:
- The module creates a user (role) with login privilege by default.
Use NOLOGIN role_attr_flags to change this behaviour.

2
plugins/modules/database/postgresql/postgresql_user_obj_stat_info.py
View file

@ -13,6 +13,7 @@ module: postgresql_user_obj_stat_info
short_description: Gather statistics about PostgreSQL user objects
description:
- Gathers statistics about PostgreSQL user objects.
version_added: '0.2.0'
options:
filter:
description:
@ -45,6 +46,7 @@ options:
- It only makes sense to use C(no) only when SQL injections via I(session_role) are possible.
type: bool
default: yes
version_added: '0.2.0'
notes:
- C(size) and C(total_size) returned values are presented in bytes.

3
plugins/modules/files/iso_create.py
View file

@ -15,8 +15,9 @@ short_description: Generate ISO file with specified files or folders
description:
- This module is used to generate ISO file with specified path of files.
author:
- Diane Wang(@Tomorrow9) <dianew@vmware.com>
- Diane Wang (@Tomorrow9) <dianew@vmware.com>
requirements: ["pycdlib", "python >= 2.7"]
version_added: '0.2.0'
options:
src_files:

1
plugins/modules/identity/ipa/ipa_user.py
View file

@ -89,6 +89,7 @@ options:
description:
- Default home directory of the user.
type: str
version_added: '0.2.0'
extends_documentation_fragment:
- community.general.ipa.documentation

2
plugins/modules/monitoring/airbrake_deployment.py
View file

@ -24,11 +24,13 @@ options:
- Airbrake PROJECT_ID
required: false
type: str
version_added: '0.2.0'
project_key:
description:
- Airbrake PROJECT_KEY.
required: false
type: str
version_added: '0.2.0'
environment:
description:
- The airbrake environment name, typically 'production', 'staging', etc.

1
plugins/modules/monitoring/bigpanda.py
View file

@ -68,6 +68,7 @@ options:
- Message about the deployment.
- C(message) alias is deprecated in Ansible 2.10, since it is used internally by Ansible Core Engine.
aliases: ['message']
version_added: '0.2.0'
# informational: requirements for nodes
requirements: [ ]

1
plugins/modules/monitoring/datadog/datadog_monitor.py
View file

@ -29,6 +29,7 @@ options:
- This value can also be set with the C(DATADOG_HOST) environment variable.
required: false
type: str
version_added: '0.2.0'
app_key:
description:
- Your Datadog app key.

1
plugins/modules/monitoring/nagios.py
View file

@ -57,6 +57,7 @@ options:
start:
description:
- When downtime should start, in time_t format (epoch seconds).
version_added: '0.2.0'
minutes:
description:
- Minutes to schedule downtime for.

1
plugins/modules/net_tools/cloudflare_dns.py
View file

@ -25,6 +25,7 @@ options:
- "You can obtain your API token from the bottom of the Cloudflare 'My Account' page, found here: U(https://dash.cloudflare.com/)"
type: str
required: false
version_added: '0.2.0'
account_api_key:
description:
- Account API key.

1
plugins/modules/net_tools/hetzner_firewall.py
View file

@ -11,6 +11,7 @@ __metaclass__ = type
DOCUMENTATION = r'''
---
module: hetzner_firewall
version_added: '0.2.0'
short_description: Manage Hetzner's dedicated server firewall
author:
- Felix Fontein (@felixfontein)

1
plugins/modules/net_tools/hetzner_firewall_info.py
View file

@ -11,6 +11,7 @@ __metaclass__ = type
DOCUMENTATION = r'''
---
module: hetzner_firewall_info
version_added: '0.2.0'
short_description: Manage Hetzner's dedicated server firewall
author:
- Felix Fontein (@felixfontein)

1
plugins/modules/net_tools/ipwcli_dns.py
View file

@ -12,6 +12,7 @@ module: ipwcli_dns
short_description: Manage DNS Records for Ericsson IPWorks via ipwcli
version_added: '0.2.0'
description:
- "Manage DNS records for the Ericsson IPWorks DNS server. The module will use the ipwcli to deploy the DNS records."

1
plugins/modules/net_tools/ldap/ldap_attrs.py
View file

@ -32,6 +32,7 @@ notes:
rules. This should work out in most cases, but it is theoretically
possible to see spurious changes when target and actual values are
semantically identical but lexically distinct.
version_added: '0.2.0'
author:
- Jiri Tyr (@jtyr)
- Alexander Korinek (@noles)

1
plugins/modules/net_tools/ldap/ldap_search.py
View file

@ -11,6 +11,7 @@ __metaclass__ = type
DOCUMENTATION = r"""
---
module: ldap_search
version_added: '0.2.0'
short_description: Search for entries in a LDAP server
description:
- Return the results of an LDAP search.

2
plugins/modules/net_tools/nios/nios_host_record.py
View file

@ -84,6 +84,7 @@ options:
required: false
aliases:
- add
version_added: '0.2.0'
remove:
description:
- If user wants to remove the ipv4 address from an existing host record.
@ -93,6 +94,7 @@ options:
required: false
aliases:
- remove
version_added: '0.2.0'
ipv6addrs:
description:
- Configures the IPv6 addresses for the host record. This argument

2
plugins/modules/notification/syslogger.py
View file

@ -38,6 +38,7 @@ options:
- Specify the name of application name which is sending the log to syslog.
type: str
default: 'ansible_syslogger'
version_added: '0.2.0'
author:
- Tim Rightnour (@garbled1)
'''
@ -67,6 +68,7 @@ ident:
returned: always
type: str
sample: "ansible_syslogger"
version_added: '0.2.0'
priority:
description: Priority level
returned: always

2
plugins/modules/packaging/language/maven_artifact.py
View file

@ -41,6 +41,7 @@ options:
- See supported version ranges on U(https://cwiki.apache.org/confluence/display/MAVENOLD/Dependency+Mediation+and+Conflict+Resolution)
- The range type "(,1.0],[1.2,)" and "(,1.1),(1.1,)" is not supported.
- Mutually exclusive with I(version).
version_added: '0.2.0'
classifier:
description:
- The maven classifier coordinate
@ -74,6 +75,7 @@ options:
upon initial request.
default: 'no'
type: bool
version_added: '0.2.0'
dest:
description:
- The path where the artifact should be written to

5
plugins/modules/packaging/os/homebrew.py
View file

@ -69,6 +69,7 @@ options:
- Option flags to upgrade.
type: list
elements: str
version_added: '0.2.0'
notes:
- When used with a `loop:` each package will be processed individually,
it is much more efficient to pass the list directly to the `name` option.
@ -140,17 +141,17 @@ msg:
unchanged_pkgs:
description:
- List of package names which are unchanged after module run
- "Added in version 2.10"
returned: success
type: list
sample: ["awscli", "ag"]
version_added: '0.2.0'
changed_pkgs:
description:
- List of package names which are changed after module run
- "Added in version 2.10"
returned: success
type: list
sample: ['git', 'git-cola']
version_added: '0.2.0'
'''
import os.path

1
plugins/modules/packaging/os/mas.py
View file

@ -14,6 +14,7 @@ module: mas
short_description: Manage Mac App Store applications with mas-cli
description:
- Installs, uninstalls and updates macOS applications from the Mac App Store using the C(mas-cli).
version_added: '0.2.0'
author:
- Michael Heap (@mheap)
- Lukas Bestle (@lukasbestle)

1
plugins/modules/packaging/os/rhn_channel.py
View file

@ -50,6 +50,7 @@ options:
can modify traffic between the module and the site.
type: bool
default: true
version_added: '0.2.0'
'''
EXAMPLES = '''

1
plugins/modules/packaging/os/xbps.py
View file

@ -54,6 +54,7 @@ options:
upgrades and installations will fail when xbps is not up to date.
type: bool
default: 'yes'
version_added: '0.2.0'
'''
EXAMPLES = '''

3
plugins/modules/packaging/os/zypper.py
View file

@ -87,6 +87,7 @@ options:
required: false
default: "no"
type: bool
version_added: '0.2.0'
update_cache:
description:
- Run the equivalent of C(zypper refresh) before the operation. Disabled in check mode.
@ -112,12 +113,14 @@ options:
default: false
description:
- Adds C(--allow_vendor_change) option to I(zypper) dist-upgrade command.
version_added: '0.2.0'
replacefiles:
type: bool
required: false
default: false
description:
- Adds C(--replacefiles) option to I(zypper) install/update command.
version_added: '0.2.0'
notes:
- When used with a `loop:` each package will be processed individually,
it is much more efficient to pass the list directly to the `name` option.

1
plugins/modules/remote_management/redfish/idrac_redfish_command.py
View file

@ -51,6 +51,7 @@ options:
description:
- The ID of the System, Manager or Chassis to modify
type: str
version_added: '0.2.0'
author: "Jose Delarosa (@jose-delarosa)"
'''

2
plugins/modules/remote_management/redfish/idrac_redfish_config.py
View file

@ -60,6 +60,7 @@ options:
- dictionary of iDRAC attribute name and value pairs to update
default: {}
type: 'dict'
version_added: '0.2.0'
timeout:
description:
- Timeout in seconds for URL requests to iDRAC controller
@ -70,6 +71,7 @@ options:
description:
- The ID of the System, Manager or Chassis to modify
type: str
version_added: '0.2.0'
author: "Jose Delarosa (@jose-delarosa)"
'''

8
plugins/modules/remote_management/redfish/redfish_command.py
View file

@ -93,37 +93,44 @@ options:
description:
- new update user name for account_username
type: str
version_added: '0.2.0'
account_properties:
required: false
description:
- properties of account service to update
type: dict
version_added: '0.2.0'
resource_id:
required: false
description:
- The ID of the System, Manager or Chassis to modify
type: str
version_added: '0.2.0'
update_image_uri:
required: false
description:
- The URI of the image for the update
type: str
version_added: '0.2.0'
update_protocol:
required: false
description:
- The protocol for the update
type: str
version_added: '0.2.0'
update_targets:
required: false
description:
- The list of target resource URIs to apply the update to
type: list
elements: str
version_added: '0.2.0'
update_creds:
required: false
description:
- The credentials for retrieving the update image
type: dict
version_added: '0.2.0'
suboptions:
username:
required: false
@ -140,6 +147,7 @@ options:
description:
- The options for VirtualMedia commands
type: dict
version_added: '0.2.0'
suboptions:
media_types:
required: false

6
plugins/modules/remote_management/redfish/redfish_config.py
View file

@ -60,6 +60,7 @@ options:
- dictionary of BIOS attributes to update
default: {}
type: dict
version_added: '0.2.0'
timeout:
description:
- Timeout in seconds for URL requests to OOB controller
@ -71,27 +72,32 @@ options:
- list of BootOptionReference strings specifying the BootOrder
default: []
type: list
version_added: '0.2.0'
network_protocols:
required: false
description:
- setting dict of manager services to update
type: dict
version_added: '0.2.0'
resource_id:
required: false
description:
- The ID of the System, Manager or Chassis to modify
type: str
version_added: '0.2.0'
nic_addr:
required: false
description:
- EthernetInterface Address string on OOB controller
default: 'null'
type: str
version_added: '0.2.0'
nic_config:
required: false
description:
- setting dict of EthernetInterface on OOB controller
type: dict
version_added: '0.2.0'
author: "Jose Delarosa (@jose-delarosa)"
'''

1
plugins/modules/source_control/github/github_deploy_key.py
View file

@ -22,6 +22,7 @@ options:
- The base URL of the GitHub API
required: false
type: str
version_added: '0.2.0'
default: https://api.github.com
owner:
description:

1
plugins/modules/source_control/gitlab/gitlab_hook.py
View file

@ -57,6 +57,7 @@ options:
description:
- Branch name of wildcard to trigger hook on push events
type: str
version_added: '0.2.0'
issues_events:
description:
- Trigger hook on issues events.

1
plugins/modules/system/dpkg_divert.py
View file

@ -12,6 +12,7 @@ DOCUMENTATION = r'''
---
module: dpkg_divert
short_description: Override a debian package's version of a file
version_added: '0.2.0'
author:
- quidame (@quidame)
description:

1
plugins/modules/system/java_cert.py
View file

@ -41,6 +41,7 @@ options:
- Trust imported cert as CAcert.
type: bool
default: False
version_added: '0.2.0'
pkcs12_path:
description:
- Local path to load PKCS12 keystore from.

2
plugins/modules/system/java_keystore.py
View file

@ -32,7 +32,7 @@ options:
- Pass phrase for reading the private key, if required.
type: str
required: false
version_added: "2.10"
version_added: '0.2.0'
password:
description:
- Password that should be used to secure the key store.

1
plugins/modules/system/lbu.py
View file

@ -12,6 +12,7 @@ module: lbu
short_description: Local Backup Utility for Alpine Linux
version_added: '0.2.0'
description:
- Manage Local Backup Utility of Alpine Linux in run-from-RAM mode

1
plugins/modules/system/lvg.py
View file

@ -45,6 +45,7 @@ options:
- If C(yes), resize the physical volume to the maximum available size.
type: bool
default: false
version_added: '0.2.0'
vg_options:
description:
- Additional options to pass to C(vgcreate) when creating the volume group.

1
plugins/modules/system/make.py
View file

@ -39,6 +39,7 @@ options:
description:
- Use a specific make binary.
type: path
version_added: '0.2.0'
'''
EXAMPLES = r'''

2
plugins/modules/system/parted.py
View file

@ -94,7 +94,7 @@ options:
description:
- If specified and the partition does not exist, will set filesystem type to given partition.
type: str
version_added: '2.10'
version_added: '0.2.0'
notes:
- When fetching information about a new disk and when the version of parted
installed on the system is before version 3.1, the module queries the kernel

2
plugins/modules/system/ufw.py
View file

@ -136,6 +136,7 @@ options:
compatible with I(interface_out) for routed rules.
type: str
aliases: [ if_in ]
version_added: '0.2.0'
interface_out:
description:
- Specify output interface for the rule. This is mutually
@ -143,6 +144,7 @@ options:
compatible with I(interface_in) for routed rules.
type: str
aliases: [ if_out ]
version_added: '0.2.0'
route:
description:
- Apply the rule to routed/forwarded packets.

2
plugins/modules/web_infrastructure/jira.py
View file

@ -108,6 +108,7 @@ options:
description:
- Query JIRA in JQL Syntax, e.g. 'CMDB Hostname'='test.example.com'.
type: str
version_added: '0.2.0'
maxresults:
required: false
@ -115,6 +116,7 @@ options:
- Limit the result of I(operation=search). If no value is specified, the default jira limit will be used.
- Used when I(operation=search) only, ignored otherwise.
type: int
version_added: '0.2.0'
timeout:
required: false

18
plugins/modules/web_infrastructure/rundeck_acl_policy.py
View file

@ -50,6 +50,24 @@ options:
- Sets the ACL policy content.
- ACL policy content is a YAML object as described in http://rundeck.org/docs/man5/aclpolicy.html.
- It can be a YAML string or a pure Ansible inventory YAML object.
client_cert:
version_added: '0.2.0'
client_key:
version_added: '0.2.0'
force:
version_added: '0.2.0'
force_basic_auth:
version_added: '0.2.0'
http_agent:
version_added: '0.2.0'
url_password:
version_added: '0.2.0'
url_username:
version_added: '0.2.0'
use_proxy:
version_added: '0.2.0'
validate_certs:
version_added: '0.2.0'
extends_documentation_fragment: url
'''

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