ansible/community.general
1
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2026-02-04 07:51:50 +00:00
Code Activity

remove required=false from docs (#11055)

Browse source
This commit is contained in:
Alexei Znamensky 2025-11-09 20:27:06 +13:00 • committed by GitHub
parent 49c7253f24
commit a9a4f89033
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
158 changed files with 0 additions and 743 deletions
Download patch file Download diff file Expand all files Collapse all files

10
plugins/modules/aerospike_migrations.py
View file

@ -32,32 +32,27 @@ options:
port:
description:
- Which port to connect to Aerospike on (service port).
required: false
type: int
default: 3000
connect_timeout:
description:
- How long to try to connect before giving up (milliseconds).
required: false
type: int
default: 1000
consecutive_good_checks:
description:
- How many times should the cluster report "no migrations" consecutively before returning OK back to ansible?
required: false
type: int
default: 3
sleep_between_checks:
description:
- How long to sleep between each check (seconds).
required: false
type: int
default: 60
tries_limit:
description:
- How many times do we poll before giving up and failing?
default: 300
required: false
type: int
local_only:
description:
@ -68,25 +63,21 @@ options:
min_cluster_size:
description:
- Check fails until cluster size is met or until tries is exhausted.
required: false
type: int
default: 1
fail_on_cluster_change:
description:
- Fail if the cluster key changes if something else is changing the cluster, we may want to fail.
required: false
type: bool
default: true
migrate_tx_key:
description:
- The metric key used to determine if we have tx migrations remaining. Changeable due to backwards compatibility.
required: false
type: str
default: migrate_tx_partitions_remaining
migrate_rx_key:
description:
- The metric key used to determine if we have rx migrations remaining. Changeable due to backwards compatibility.
required: false
type: str
default: migrate_rx_partitions_remaining
target_cluster_size:
@ -96,7 +87,6 @@ options:
You can still rely on O(min_cluster_size) if you do not want to use this option.
- If this option is specified on a cluster that has at least one host <4.3 then it is ignored until the min version
reaches 4.3.
required: false
type: int
"""

6
plugins/modules/airbrake_deployment.py
View file

@ -43,35 +43,29 @@ options:
user:
description:
- The username of the person doing the deployment.
required: false
type: str
repo:
description:
- URL of the project repository.
required: false
type: str
revision:
description:
- A hash, number, tag, or other identifier showing what revision from version control was deployed.
required: false
type: str
version:
description:
- A string identifying what version was deployed.
required: false
type: str
version_added: '1.0.0'
url:
description:
- Optional URL to submit the notification to. Use to send notifications to Airbrake-compliant tools like Errbit.
required: false
default: "https://api.airbrake.io/api/v4/projects/"
type: str
validate_certs:
description:
- If V(false), SSL certificates for the target URL is not validated. This should only be used on personally controlled
sites using self-signed certificates.
required: false
default: true
type: bool

2
plugins/modules/ali_instance.py
View file

@ -193,14 +193,12 @@ options:
key_name:
description:
- The name of key pair which is used to access ECS instance in SSH.
required: false
type: str
aliases: ['keypair']
user_data:
description:
- User-defined data to customize the startup behaviors of an ECS instance and to pass data into an ECS instance. It
only takes effect when launching the new ECS instances.
required: false
type: str
ram_role_name:
description:

2
plugins/modules/apache2_module.py
View file

@ -34,11 +34,9 @@ options:
description:
- Identifier of the module as listed by C(apache2ctl -M). This is optional and usually determined automatically by the
common convention of appending V(_module) to O(name) as well as custom exception for popular modules.
required: false
force:
description:
- Force disabling of default modules and override Debian warnings.
required: false
type: bool
default: false
state:

6
plugins/modules/bigpanda.py
View file

@ -48,34 +48,28 @@ options:
description:
- Name of affected host name. Can be a list.
- If not specified, it defaults to the remote system's hostname.
required: false
aliases: ['host']
env:
type: str
description:
- The environment name, typically V(production), V(staging), and so on.
required: false
owner:
type: str
description:
- The person responsible for the deployment.
required: false
description:
type: str
description:
- Free text description of the deployment.
required: false
url:
type: str
description:
- Base URL of the API server.
required: false
default: "https://api.bigpanda.io"
validate_certs:
description:
- If V(false), SSL certificates for the target URL are not validated. This should only be used on personally controlled
sites using self-signed certificates.
required: false
default: true
type: bool
deployment_message:

1
plugins/modules/bootc_manage.py
View file

@ -28,7 +28,6 @@ options:
description:
- The image to switch to.
- This is required when O(state=switch).
required: false
type: str
"""

1
plugins/modules/campfire.py
View file

@ -45,7 +45,6 @@ options:
type: str
description:
- Send a notification sound before the message.
required: false
choices:
- 56k
- bell

5
plugins/modules/cargo.py
View file

@ -41,19 +41,16 @@ options:
description: The version to install. If O(name) contains multiple values, the module tries to install all of them in this
version.
type: str
required: false
locked:
description:
- Install with locked dependencies.
- This is only used when installing packages.
required: false
type: bool
default: false
version_added: 7.5.0
state:
description:
- The state of the Rust package.
required: false
type: str
default: present
choices: ["present", "absent", "latest"]
@ -62,7 +59,6 @@ options:
- Path to the source directory to install the Rust package from.
- This is only used when installing packages.
type: path
required: false
version_added: 9.1.0
features:
description:
@ -70,7 +66,6 @@ options:
- This is only used when installing packages.
type: list
elements: str
required: false
default: []
version_added: 11.0.0
requirements:

2
plugins/modules/copr.py
View file

@ -51,13 +51,11 @@ options:
type: str
includepkgs:
description: List of packages to include.
required: false
type: list
elements: str
version_added: 9.4.0
excludepkgs:
description: List of packages to exclude.
required: false
type: list
elements: str
version_added: 9.4.0

2
plugins/modules/datadog_downtime.py
View file

@ -36,7 +36,6 @@ options:
description:
- The URL to the Datadog API.
- This value can also be set with the E(DATADOG_HOST) environment variable.
required: false
default: https://api.datadoghq.com
type: str
app_key:
@ -47,7 +46,6 @@ options:
state:
description:
- The designated state of the downtime.
required: false
choices: ["present", "absent"]
default: present
type: str

1
plugins/modules/datadog_monitor.py
View file

@ -32,7 +32,6 @@ options:
description:
- The URL to the Datadog API. Default value is V(https://api.datadoghq.com).
- This value can also be set with the E(DATADOG_HOST) environment variable.
required: false
type: str
version_added: '0.2.0'
app_key:

2
plugins/modules/dconf.py
View file

@ -55,7 +55,6 @@ options:
- A dconf key to modify or read from the dconf database.
value:
type: raw
required: false
description:
- Value to set for the specified dconf key. Value should be specified in GVariant format. Due to complexity of this
format, it is best to have a look at existing values in the dconf database.
@ -65,7 +64,6 @@ options:
is why the type of this parameter is "raw").
state:
type: str
required: false
default: present
choices: ['read', 'present', 'absent']
description:

1
plugins/modules/dimensiondata_network.py
View file

@ -41,7 +41,6 @@ options:
description:
description:
- Additional description of the network domain.
required: false
type: str
service_plan:
description:

12
plugins/modules/django_manage.py
View file

@ -48,14 +48,12 @@ options:
description:
- The Python path to the application's settings module, such as V(myapp.settings).
type: path
required: false
pythonpath:
description:
- A directory to add to the Python path. Typically used to include the settings module if it is located external to
the application directory.
- This would be equivalent to adding O(pythonpath)'s value to the E(PYTHONPATH) environment variable.
type: path
required: false
aliases: [python_path]
virtualenv:
description:
@ -67,28 +65,23 @@ options:
description:
- A list of space-delimited apps to target. Used by the V(test) command.
type: str
required: false
cache_table:
description:
- The name of the table used for database-backed caching. Used by the V(createcachetable) command.
type: str
required: false
clear:
description:
- Clear the existing files before trying to copy or link the original file.
- Used only with the V(collectstatic) command. The C(--noinput) argument is added automatically.
required: false
default: false
type: bool
database:
description:
- The database to target. Used by the V(createcachetable), V(flush), V(loaddata), V(syncdb), and V(migrate) commands.
type: str
required: false
failfast:
description:
- Fail the command immediately if a test fails. Used by the V(test) command.
required: false
default: false
type: bool
aliases: [fail_fast]
@ -96,29 +89,24 @@ options:
description:
- A space-delimited list of fixture file names to load in the database. B(Required) by the V(loaddata) command.
type: str
required: false
skip:
description:
- Skips over out-of-order missing migrations, you can only use this parameter with V(migrate) command.
required: false
type: bool
merge:
description:
- Runs out-of-order or missing migrations as they are not rollback migrations, you can only use this parameter with
V(migrate) command.
required: false
type: bool
link:
description:
- Creates links to the files instead of copying them, you can only use this parameter with V(collectstatic) command.
required: false
type: bool
testrunner:
description:
- Controls the test runner class that is used to execute tests.
- This parameter is passed as-is to C(manage.py).
type: str
required: false
aliases: [test_runner]
notes:

2
plugins/modules/dnf_config_manager.py
View file

@ -27,14 +27,12 @@ options:
description:
- Repository ID, for example V(crb).
default: []
required: false
type: list
elements: str
state:
description:
- Whether the repositories should be V(enabled) or V(disabled).
default: enabled
required: false
type: str
choices: [enabled, disabled]
notes:

1
plugins/modules/dnf_versionlock.py
View file

@ -33,7 +33,6 @@ options:
command.
- This parameter is mutually exclusive with O(state=clean).
type: list
required: false
elements: str
default: []
raw:

2
plugins/modules/dnsimple_info.py
View file

@ -42,12 +42,10 @@ options:
description:
- The record to find.
- If specified, only this record is returned instead of all records.
required: false
type: str
sandbox:
description: Whether or not to use sandbox environment.
required: false
default: false
type: bool

2
plugins/modules/ejabberd_user.py
View file

@ -37,12 +37,10 @@ options:
type: str
description:
- The password to assign to the username.
required: false
state:
type: str
description:
- Describe the desired state of the user to be managed.
required: false
default: 'present'
choices: ['present', 'absent']
notes:

2
plugins/modules/elasticsearch_plugin.py
View file

@ -42,13 +42,11 @@ options:
- Is only used if the state would change, which is solely checked based on the name parameter. If, for example, the
plugin is already installed, changing this has no effect.
- For ES 1.x use O(url).
required: false
type: str
url:
description:
- Set exact URL to download the plugin from (Only works for ES 1.x).
- For ES 2.x and higher, use src.
required: false
type: str
timeout:
description:

13
plugins/modules/gem.py
View file

@ -29,43 +29,36 @@ options:
type: str
description:
- The desired state of the gem. V(latest) ensures that the latest version is installed.
required: false
choices: [present, absent, latest]
default: present
gem_source:
type: path
description:
- The path to a local gem used as installation source.
required: false
include_dependencies:
description:
- Whether to include dependencies or not.
required: false
type: bool
default: true
repository:
type: str
description:
- The repository from which the gem is installed.
required: false
aliases: [source]
user_install:
description:
- Install gem in user's local gems cache or for all users.
required: false
type: bool
default: true
executable:
type: path
description:
- Override the path to the gem executable.
required: false
install_dir:
type: path
description:
- Install the gems into a specific directory. These gems are independent from the global installed ones. Specifying
this requires user_install to be false.
required: false
bindir:
type: path
description:
@ -81,35 +74,29 @@ options:
env_shebang:
description:
- Rewrite the shebang line on installed scripts to use /usr/bin/env.
required: false
default: false
type: bool
version:
type: str
description:
- Version of the gem to be installed/removed.
required: false
pre_release:
description:
- Allow installation of pre-release versions of the gem.
required: false
default: false
type: bool
include_doc:
description:
- Install with or without docs.
required: false
default: false
type: bool
build_flags:
type: str
description:
- Allow adding build flags for gem compilation.
required: false
force:
description:
- Force gem to (un-)install, bypassing dependency checks.
required: false
default: false
type: bool
author:

1
plugins/modules/github_deploy_key.py
View file

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

8
plugins/modules/github_repo.py
View file

@ -26,19 +26,16 @@ options:
- Username used for authentication.
- This is only needed when not using O(access_token).
type: str
required: false
password:
description:
- Password used for authentication.
- This is only needed when not using O(access_token).
type: str
required: false
access_token:
description:
- Token parameter for authentication.
- This is only needed when not using O(username) and O(password).
type: str
required: false
name:
description:
- Repository name.
@ -51,7 +48,6 @@ options:
- Defaults to empty if O(force_defaults=false) when creating a new repository.
- This is only used when O(state) is V(present).
type: str
required: false
private:
description:
- Whether the repository should be private or not.
@ -59,20 +55,17 @@ options:
- Defaults to V(false) if O(force_defaults=false) when creating a new repository.
- This is only used when O(state=present).
type: bool
required: false
state:
description:
- Whether the repository should exist or not.
type: str
default: present
choices: [absent, present]
required: false
organization:
description:
- Organization for the repository.
- When O(state=present), the repository is created in the current user profile.
type: str
required: false
api_url:
description:
- URL to the GitHub API if not using github.com but you own instance.
@ -84,7 +77,6 @@ options:
- If V(true), overwrite current O(description) and O(private) attributes with defaults.
- V(true) is deprecated for this option and will not be allowed starting in community.general 13.0.0. V(false) will be the default value then.
type: bool
required: false
version_added: 4.1.0
requirements:
- PyGithub>=1.54

9
plugins/modules/github_webhook.py
View file

@ -37,38 +37,32 @@ options:
description:
- The media type used to serialize the payloads.
type: str
required: false
choices: [form, json]
default: form
secret:
description:
- The shared secret between GitHub and the payload URL.
type: str
required: false
insecure_ssl:
description:
- Flag to indicate that GitHub should skip SSL verification when calling the hook.
required: false
type: bool
default: false
events:
description:
- A list of GitHub events the hook is triggered for. Events are listed at U(https://developer.github.com/v3/activity/events/types/).
Required unless O(state=absent).
required: false
type: list
elements: str
active:
description:
- Whether or not the hook is active.
required: false
type: bool
default: true
state:
description:
- Whether the hook should be present or absent.
type: str
required: false
choices: [absent, present]
default: present
user:
@ -80,17 +74,14 @@ options:
description:
- Password to authenticate to GitHub with.
type: str
required: false
token:
description:
- Token to authenticate to GitHub with.
type: str
required: false
github_url:
description:
- Base URL of the GitHub API.
type: str
required: false
default: https://api.github.com
author:

3
plugins/modules/github_webhook_info.py
View file

@ -33,17 +33,14 @@ options:
description:
- Password to authenticate to GitHub with.
type: str
required: false
token:
description:
- Token to authenticate to GitHub with.
type: str
required: false
github_url:
description:
- Base URL of the GitHub API.
type: str
required: false
default: https://api.github.com
author:

1
plugins/modules/gitlab_hook.py
View file

@ -110,7 +110,6 @@ options:
- Secret token to validate hook messages at the receiver.
- If this is present it always results in a change as it cannot be retrieved from GitLab.
- It shows up in the C(X-GitLab-Token) HTTP request header.
required: false
type: str
"""

5
plugins/modules/gitlab_label.py
View file

@ -40,23 +40,19 @@ options:
- When set to V(true), delete all labels which are not mentioned in the task.
default: false
type: bool
required: false
project:
description:
- The path and name of the project. Either this or O(group) is required.
required: false
type: str
group:
description:
- The path of the group. Either this or O(project) is required.
required: false
type: str
labels:
description:
- A list of dictionaries that represents gitlab project's or group's labels.
type: list
elements: dict
required: false
default: []
suboptions:
name:
@ -73,7 +69,6 @@ options:
description:
- Integer value to give priority to the label.
type: int
required: false
default:
description:
description:

6
plugins/modules/gitlab_milestone.py
View file

@ -40,23 +40,19 @@ options:
- When set to V(true), delete all milestone which are not mentioned in the task.
default: false
type: bool
required: false
project:
description:
- The path and name of the project. Either this or O(group) is required.
required: false
type: str
group:
description:
- The path of the group. Either this or O(project) is required.
required: false
type: str
milestones:
description:
- A list of dictionaries that represents gitlab project's or group's milestones.
type: list
elements: dict
required: false
default: []
suboptions:
title:
@ -68,13 +64,11 @@ options:
description:
- Milestone due date in YYYY-MM-DD format.
type: str
required: false
default: null
start_date:
description:
- Milestone start date in YYYY-MM-DD format.
type: str
required: false
default: null
description:
description:

2
plugins/modules/gitlab_project.py
View file

@ -148,7 +148,6 @@ options:
description:
- Git repository which is imported into gitlab.
- GitLab server needs read access to this git repository.
required: false
type: str
infrastructure_access_level:
description:
@ -184,7 +183,6 @@ options:
description:
- Enable Git large file systems to manages large files such as audio, video, and graphics files.
type: bool
required: false
default: false
version_added: "2.0.0"
merge_method:

9
plugins/modules/gitlab_runner.py
View file

@ -71,7 +71,6 @@ options:
description:
- Make sure that the runner with the same name exists with the same configuration or delete the runner with the same
name.
required: false
default: present
choices: ["present", "absent"]
type: str
@ -95,21 +94,18 @@ options:
description:
- Define if the runners is immediately active after creation.
- Mutually exclusive with O(paused).
required: false
default: true
type: bool
paused:
description:
- Define if the runners is active or paused after creation.
- Mutually exclusive with O(active).
required: false
default: false
type: bool
version_added: 8.1.0
locked:
description:
- Determines if the runner is locked or not.
required: false
default: false
type: bool
access_level:
@ -122,7 +118,6 @@ options:
- Before community.general 8.0.0 the default was V(ref_protected). This was changed to no default in community.general
8.0.0. If this option is not specified explicitly, GitLab uses V(not_protected) on creation, and the value set is
not changed on any updates.
required: false
choices: ["not_protected", "ref_protected"]
type: str
access_level_on_creation:
@ -131,25 +126,21 @@ options:
- If set to V(true), the value of O(access_level) is used for runner registration.
- If set to V(false), GitLab registers the runner with the default access level.
- The default of this option changed to V(true) in community.general 7.0.0. Before, it was V(false).
required: false
default: true
type: bool
version_added: 6.3.0
maximum_timeout:
description:
- The maximum time that a runner has to complete a specific job.
required: false
default: 3600
type: int
run_untagged:
description:
- Run untagged jobs or not.
required: false
default: true
type: bool
tag_list:
description: The tags that apply to the runner.
required: false
default: []
type: list
elements: str

3
plugins/modules/grove.py
View file

@ -29,7 +29,6 @@ options:
type: str
description:
- Name of the service (displayed as the "user" in the message).
required: false
default: ansible
message_content:
type: str
@ -41,12 +40,10 @@ options:
type: str
description:
- Service URL for the web client.
required: false
icon_url:
type: str
description:
- Icon for the service.
required: false
validate_certs:
description:
- If V(false), SSL certificates are not validated. This should only be used on personally controlled sites using self-signed

1
plugins/modules/homebrew_cask.py
View file

@ -46,7 +46,6 @@ options:
sudo_password:
description:
- The sudo password to be passed to E(SUDO_ASKPASS).
required: false
type: str
update_homebrew:
description:

2
plugins/modules/homebrew_tap.py
View file

@ -39,13 +39,11 @@ options:
- The optional git URL of the repository to tap. The URL is not assumed to be on GitHub, and the protocol does not have
to be HTTP. Any location and protocol that git can handle is fine.
- O(name) option may not be a list of multiple taps (but a single tap instead) when this option is provided.
required: false
type: str
state:
description:
- State of the repository.
choices: ['present', 'absent']
required: false
default: 'present'
type: str
path:

1
plugins/modules/hponcfg.py
View file

@ -30,7 +30,6 @@ options:
minfw:
description:
- The minimum firmware level needed.
required: false
type: str
executable:
description:

4
plugins/modules/htpasswd.py
View file

@ -33,13 +33,11 @@ options:
- User name to add or remove.
password:
type: str
required: false
description:
- Password associated with user.
- Must be specified if user does not exist yet.
hash_scheme:
type: str
required: false
default: "apr_md5_crypt"
description:
- Hashing scheme to be used. As well as the four choices listed here, you can also use any other hash supported by passlib,
@ -54,13 +52,11 @@ options:
aliases: [crypt_scheme]
state:
type: str
required: false
choices: [present, absent]
default: "present"
description:
- Whether the user entry should be present or not.
create:
required: false
type: bool
default: true
description:

14
plugins/modules/hwc_ecs_instance.py
View file

@ -116,12 +116,10 @@ options:
is not specified or is set to 0, the default system disk size is the minimum value of the system disk in the image
(min_disk attribute of the image).
type: int
required: false
snapshot_id:
description:
- Specifies the snapshot ID or ID of the original data disk contained in the full-ECS image.
type: str
required: false
vpc_id:
description:
- Specifies the ID of the VPC to which the ECS belongs.
@ -136,13 +134,11 @@ options:
username or the username in reverse. The Windows ECS password cannot contain the username, the username in reverse,
or more than two consecutive characters in the username.
type: str
required: false
data_volumes:
description:
- Specifies the data disks of ECS instance.
type: list
elements: dict
required: false
suboptions:
volume_id:
description:
@ -153,58 +149,48 @@ options:
description:
- Specifies the disk device name.
type: str
required: false
description:
description:
- Specifies the description of an ECS, which is a null string by default. Can contain a maximum of 85 characters. Cannot
contain special characters, such as V(<) and V(>).
type: str
required: false
eip_id:
description:
- Specifies the ID of the elastic IP address assigned to the ECS. Only elastic IP addresses in the DOWN state can be
assigned.
type: str
required: false
enable_auto_recovery:
description:
- Specifies whether automatic recovery is enabled on the ECS.
type: bool
required: false
enterprise_project_id:
description:
- Specifies the ID of the enterprise project to which the ECS belongs.
type: str
required: false
security_groups:
description:
- Specifies the security groups of the ECS. If this parameter is left blank, the default security group is bound to
the ECS by default.
type: list
elements: str
required: false
server_metadata:
description:
- Specifies the metadata of ECS to be created.
type: dict
required: false
server_tags:
description:
- Specifies the tags of an ECS. When you create ECSs, one ECS supports up to 10 tags.
type: dict
required: false
ssh_key_name:
description:
- Specifies the name of the SSH key used for logging in to the ECS.
type: str
required: false
user_data:
description:
- Specifies the user data to be injected during the ECS creation process. Text, text files, and gzip files can be injected.
The content to be injected must be encoded with base64. The maximum size of the content to be injected (before encoding)
is 32 KB. For Linux ECSs, this parameter does not take effect when adminPass is used.
type: str
required: false
extends_documentation_fragment:
- community.general.hwc
- community.general.attributes

10
plugins/modules/hwc_evs_disk.py
View file

@ -77,17 +77,14 @@ options:
- Specifies the ID of the backup that can be used to create a disk. This parameter is mandatory when you use a backup
to create the disk.
type: str
required: false
description:
description:
- Specifies the disk description. The value can contain a maximum of 255 bytes.
type: str
required: false
enable_full_clone:
description:
- If the disk is created from a snapshot and linked cloning needs to be used, set this parameter to True.
type: bool
required: false
enable_scsi:
description:
- If this parameter is set to V(true), the disk device type is SCSI, which allows ECS OSs to directly access underlying
@ -96,29 +93,24 @@ options:
- If parameter enable_share is set to True and this parameter is not specified, shared SCSI disks are created. SCSI
EVS disks cannot be created from backups, which means that this parameter cannot be True if backup_id has been specified.
type: bool
required: false
enable_share:
description:
- Specifies whether the disk is shareable. The default value is False.
type: bool
required: false
encryption_id:
description:
- Specifies the encryption ID. The length of it fixes at 36 bytes.
type: str
required: false
enterprise_project_id:
description:
- Specifies the enterprise project ID. This ID is associated with the disk during the disk creation. If it is not specified,
the disk is bound to the default enterprise project.
type: str
required: false
image_id:
description:
- Specifies the image ID. If this parameter is specified, the disk is created from an image. BMS system disks cannot
be created from BMS images.
type: str
required: false
size:
description:
- Specifies the disk size, in GB. Its values are as follows, System disk 1 GB to 1024 GB, Data disk 10 GB to 32768 GB.
@ -127,12 +119,10 @@ options:
This parameter is optional when you use a backup to create a disk. If this parameter is not specified, the disk size
is equal to the backup size.
type: int
required: false
snapshot_id:
description:
- Specifies the snapshot ID. If this parameter is specified, the disk is created from a snapshot.
type: str
required: false
extends_documentation_fragment:
- community.general.hwc
- community.general.attributes

1
plugins/modules/hwc_smn_topic.py
View file

@ -36,7 +36,6 @@ options:
- Topic display name, which is presented as the name of the email sender in an email message. The topic display name
contains a maximum of 192 bytes.
type: str
required: false
name:
description:
- Name of the topic to be created. The topic name is a string of 1 to 256 characters. It must contain upper- or lower-case

6
plugins/modules/hwc_vpc_eip.py
View file

@ -56,7 +56,6 @@ options:
description:
- Specifies the dedicated bandwidth object.
type: dict
required: false
suboptions:
charge_mode:
description:
@ -87,27 +86,22 @@ options:
description:
- Specifies the enterprise project ID.
type: str
required: false
ip_version:
description:
- The value can be 4 (IPv4 address) or 6 (IPv6 address). If this parameter is left blank, an IPv4 address is assigned.
type: int
required: false
ipv4_address:
description:
- Specifies the obtained IPv4 EIP. The system automatically assigns an EIP if you do not specify it.
type: str
required: false
port_id:
description:
- Specifies the port ID. This parameter is returned only when a private IP address is bound with the EIP.
type: str
required: false
shared_bandwidth_id:
description:
- Specifies the ID of shared bandwidth.
type: str
required: false
extends_documentation_fragment:
- community.general.hwc
- community.general.attributes

2
plugins/modules/hwc_vpc_peering_connect.py
View file

@ -68,12 +68,10 @@ options:
description:
- Specifies the ID of the project which the peering vpc belongs to.
type: str
required: false
description:
description:
- The description of vpc peering connection.
type: str
required: false
extends_documentation_fragment:
- community.general.hwc
- community.general.attributes

10
plugins/modules/hwc_vpc_port.py
View file

@ -51,11 +51,9 @@ options:
description:
- Specifies the administrative state of the port.
type: bool
required: false
allowed_address_pairs:
description:
- Specifies a set of zero or more allowed address pairs.
required: false
type: list
elements: dict
suboptions:
@ -64,45 +62,37 @@ options:
- Specifies the IP address. It cannot set it to 0.0.0.0. Configure an independent security group for the port if
a large CIDR block (subnet mask less than 24) is configured for parameter allowed_address_pairs.
type: str
required: false
mac_address:
description:
- Specifies the MAC address.
type: str
required: false
extra_dhcp_opts:
description:
- Specifies the extended option of DHCP.
type: list
elements: dict
required: false
suboptions:
name:
description:
- Specifies the option name.
type: str
required: false
value:
description:
- Specifies the option value.
type: str
required: false
ip_address:
description:
- Specifies the port IP address.
type: str
required: false
name:
description:
- Specifies the port name. The value can contain no more than 255 characters.
type: str
required: false
security_groups:
description:
- Specifies the ID of the security group.
type: list
elements: str
required: false
extends_documentation_fragment:
- community.general.hwc
- community.general.attributes

1
plugins/modules/hwc_vpc_private_ip.py
View file

@ -47,7 +47,6 @@ options:
- Specifies the target IP address. The value can be an available IP address in the subnet. If it is not specified, the
system automatically assigns an IP address. Cannot be changed after creating the private IP.
type: str
required: false
extends_documentation_fragment:
- community.general.hwc
- community.general.attributes

1
plugins/modules/hwc_vpc_route.py
View file

@ -55,7 +55,6 @@ options:
description:
- Specifies the type of route.
type: str
required: false
default: 'peering'
extends_documentation_fragment:
- community.general.hwc

2
plugins/modules/hwc_vpc_security_group.py
View file

@ -48,12 +48,10 @@ options:
- Specifies the enterprise project ID. When creating a security group, associate the enterprise project ID with the
security group.s.
type: str
required: false
vpc_id:
description:
- Specifies the resource ID of the VPC to which the security group belongs.
type: str
required: false
extends_documentation_fragment:
- community.general.hwc
- community.general.attributes

7
plugins/modules/hwc_vpc_security_group_rule.py
View file

@ -51,43 +51,36 @@ options:
- Provides supplementary information about the security group rule. The value is a string of no more than 255 characters
that can contain letters and digits.
type: str
required: false
ethertype:
description:
- Specifies the IP protocol version. The value can be IPv4 or IPv6. If you do not set this parameter, IPv4 is used by
default.
type: str
required: false
port_range_max:
description:
- Specifies the end port number. The value ranges from 1 to 65535. If the protocol is not icmp, the value cannot be
smaller than the port_range_min value. An empty value indicates all ports.
type: int
required: false
port_range_min:
description:
- Specifies the start port number. The value ranges from 1 to 65535. The value cannot be greater than the port_range_max
value. An empty value indicates all ports.
type: int
required: false
protocol:
description:
- Specifies the protocol type. The value can be icmp, tcp, or udp. If the parameter is left blank, the security group
supports all protocols.
type: str
required: false
remote_group_id:
description:
- Specifies the ID of the peer security group. The value is exclusive with parameter remote_ip_prefix.
type: str
required: false
remote_ip_prefix:
description:
- Specifies the remote IP address. If the access control direction is set to egress, the parameter specifies the source
IP address. If the access control direction is set to ingress, the parameter specifies the destination IP address.
The value can be in the CIDR format or IP addresses. The parameter is exclusive with parameter remote_group_id.
type: str
required: false
extends_documentation_fragment:
- community.general.hwc
- community.general.attributes

3
plugins/modules/hwc_vpc_subnet.py
View file

@ -74,20 +74,17 @@ options:
description:
- Specifies the AZ to which the subnet belongs. Cannot be changed after creating the subnet.
type: str
required: false
dhcp_enable:
description:
- Specifies whether DHCP is enabled for the subnet. The value can be true (enabled) or false(disabled), and default
value is true. If this parameter is set to false, newly created ECSs cannot obtain IP addresses, and usernames and
passwords cannot be injected using Cloud-init.
type: bool
required: false
dns_address:
description:
- Specifies the DNS server addresses for subnet. The address in the head is used first.
type: list
elements: str
required: false
extends_documentation_fragment:
- community.general.hwc
- community.general.attributes

10
plugins/modules/ibm_sa_domain.py
View file

@ -35,52 +35,42 @@ options:
ldap_id:
description:
- LDAP ID to add to the domain.
required: false
type: str
size:
description:
- Size of the domain.
required: false
type: str
hard_capacity:
description:
- Hard capacity of the domain.
required: false
type: str
soft_capacity:
description:
- Soft capacity of the domain.
required: false
type: str
max_cgs:
description:
- Number of max cgs.
required: false
type: str
max_dms:
description:
- Number of max dms.
required: false
type: str
max_mirrors:
description:
- Number of max_mirrors.
required: false
type: str
max_pools:
description:
- Number of max_pools.
required: false
type: str
max_volumes:
description:
- Number of max_volumes.
required: false
type: str
perf_class:
description:
- Add the domain to a performance class.
required: false
type: str
extends_documentation_fragment:

4
plugins/modules/ibm_sa_host.py
View file

@ -35,23 +35,19 @@ options:
cluster:
description:
- The name of the cluster to include the host.
required: false
type: str
domain:
description:
- The domains the cluster is attached to. To include more than one domain, separate domain names with commas. To include
all existing domains, use an asterisk (V(*)).
required: false
type: str
iscsi_chap_name:
description:
- The host's CHAP name identifier.
required: false
type: str
iscsi_chap_secret:
description:
- The password of the initiator used to authenticate to the system when CHAP is enable.
required: false
type: str
extends_documentation_fragment:

3
plugins/modules/ibm_sa_host_ports.py
View file

@ -35,17 +35,14 @@ options:
iscsi_name:
description:
- The iSCSI initiator name.
required: false
type: str
fcaddress:
description:
- Fiber channel address.
required: false
type: str
num_of_visible_targets:
description:
- Number of visible targets.
required: false
type: str
extends_documentation_fragment:

4
plugins/modules/ibm_sa_pool.py
View file

@ -35,22 +35,18 @@ options:
size:
description:
- Pool size in GB.
required: false
type: str
snapshot_size:
description:
- Pool snapshot size in GB.
required: false
type: str
domain:
description:
- Adds the pool to the specified domain.
required: false
type: str
perf_class:
description:
- Assigns a perf_class to the pool.
required: false
type: str
extends_documentation_fragment:

2
plugins/modules/ibm_sa_vol.py
View file

@ -29,7 +29,6 @@ options:
pool:
description:
- Volume pool.
required: false
type: str
state:
description:
@ -40,7 +39,6 @@ options:
size:
description:
- Volume size.
required: false
type: str
extends_documentation_fragment:

4
plugins/modules/ibm_sa_vol_map.py
View file

@ -36,22 +36,18 @@ options:
cluster:
description:
- Maps the volume to a cluster.
required: false
type: str
host:
description:
- Maps the volume to a host.
required: false
type: str
lun:
description:
- The LUN identifier.
required: false
type: str
override:
description:
- Overrides the existing volume mapping.
required: false
type: str
extends_documentation_fragment:

1
plugins/modules/idrac_redfish_command.py
View file

@ -56,7 +56,6 @@ options:
default: 10
type: int
resource_id:
required: false
description:
- ID of the System, Manager or Chassis to modify.
type: str

2
plugins/modules/idrac_redfish_config.py
View file

@ -53,7 +53,6 @@ options:
type: str
version_added: 2.3.0
manager_attributes:
required: false
description:
- Dictionary of iDRAC attribute name and value pairs to update.
default: {}
@ -65,7 +64,6 @@ options:
default: 10
type: int
resource_id:
required: false
description:
- ID of the System, Manager or Chassis to modify.
type: str

4
plugins/modules/ilo_redfish_command.py
View file

@ -37,22 +37,18 @@ options:
- Base URI of OOB controller.
type: str
username:
required: false
description:
- Username for authenticating to iLO.
type: str
password:
required: false
description:
- Password for authenticating to iLO.
type: str
auth_token:
required: false
description:
- Security token for authenticating to iLO.
type: str
timeout:
required: false
description:
- Timeout in seconds for HTTP requests to iLO.
default: 60

1
plugins/modules/ilo_redfish_config.py
View file

@ -60,7 +60,6 @@ options:
- Name of the attribute to be configured.
type: str
attribute_value:
required: false
description:
- Value of the attribute to be configured.
type: str

5
plugins/modules/imgadm.py
View file

@ -22,18 +22,15 @@ attributes:
support: none
options:
force:
required: false
type: bool
description:
- Force a given operation (where supported by imgadm(1M)).
pool:
required: false
default: zones
description:
- The zpool to import to or delete images from.
type: str
source:
required: false
description:
- URI for the image source.
type: str
@ -46,7 +43,6 @@ options:
type: str
type:
required: false
choices: [imgapi, docker, dsapi]
default: imgapi
description:
@ -54,7 +50,6 @@ options:
type: str
uuid:
required: false
description:
- Image UUID. Can either be a full UUID or V(*) for all images.
type: str

1
plugins/modules/influxdb_user.py
View file

@ -30,7 +30,6 @@ options:
user_password:
description:
- Password to be set for the user.
required: false
type: str
admin:
description:

1
plugins/modules/ini_file.py
View file

@ -43,7 +43,6 @@ options:
section_has_values:
type: list
elements: dict
required: false
suboptions:
option:
type: str

2
plugins/modules/ip_netns.py
View file

@ -21,12 +21,10 @@ attributes:
support: none
options:
name:
required: false
description:
- Name of the namespace.
type: str
state:
required: false
default: "present"
choices: [present, absent]
description:

3
plugins/modules/ipa_dnsrecord.py
View file

@ -34,7 +34,6 @@ options:
- The type of DNS record name.
- Support for V(NS) was added in comunity.general 8.2.0.
- Support for V(SSHFP) was added in community.general 9.1.0.
required: false
default: 'A'
choices: ['A', 'AAAA', 'A6', 'CNAME', 'DNAME', 'MX', 'NS', 'PTR', 'SRV', 'TXT', 'SSHFP']
type: str
@ -74,11 +73,9 @@ options:
description:
- Set the TTL for the record.
- Applies only when adding a new or changing the value of O(record_value) or O(record_values).
required: false
type: int
state:
description: State to ensure.
required: false
default: present
choices: ["absent", "present"]
type: str

1
plugins/modules/ipa_dnszone.py
View file

@ -25,7 +25,6 @@ options:
type: str
state:
description: State to ensure.
required: false
default: present
choices: ["absent", "present"]
type: str

1
plugins/modules/ipa_hbacrule.py
View file

@ -32,7 +32,6 @@ options:
- List of host names to assign.
- If an empty list is passed all hosts are removed from the rule.
- If option is omitted hosts are not checked or changed.
required: false
type: list
elements: str
hostcategory:

1
plugins/modules/ipa_host.py
View file

@ -36,7 +36,6 @@ options:
force:
description:
- Force host name even if not in DNS.
required: false
type: bool
ip_address:
description:

4
plugins/modules/ipa_service.py
View file

@ -27,25 +27,21 @@ options:
hosts:
description:
- Defines the list of C(ManagedBy) hosts.
required: false
type: list
elements: str
force:
description:
- Force principal name even if host is not in DNS.
required: false
type: bool
skip_host_check:
description:
- Force service to be created even when host object does not exist to manage it.
- This is only used on creation, not for updating existing services.
required: false
type: bool
default: false
version_added: 4.7.0
state:
description: State to ensure.
required: false
default: present
choices: ["absent", "present"]
type: str

1
plugins/modules/ipa_subca.py
View file

@ -36,7 +36,6 @@ options:
description:
- State to ensure.
- States V(disable) and V(enable) are available for FreeIPA 4.4.2 version and onwards.
required: false
default: present
choices: ["absent", "disabled", "enabled", "present"]
type: str

4
plugins/modules/ipbase_info.py
View file

@ -20,23 +20,19 @@ options:
ip:
description:
- The IP you want to get the info for. If not specified the API detects the IP automatically.
required: false
type: str
apikey:
description:
- The API key for the request if you need more requests.
required: false
type: str
hostname:
description:
- If the O(hostname) parameter is set to V(true), the API response contains the hostname of the IP.
required: false
type: bool
default: false
language:
description:
- An ISO Alpha 2 Language Code for localizing the IP data.
required: false
type: str
default: "en"
notes:

2
plugins/modules/ipinfoio_facts.py
View file

@ -21,13 +21,11 @@ options:
timeout:
description:
- HTTP connection timeout in seconds.
required: false
default: 10
type: int
http_agent:
description:
- Set http user agent.
required: false
default: "ansible-ipinfoio-module/0.0.1"
type: str
notes:

1
plugins/modules/ipmi_boot.py
View file

@ -43,7 +43,6 @@ options:
key:
description:
- Encryption key to connect to the BMC in hex format.
required: false
type: str
version_added: 4.1.0
bootdev:

2
plugins/modules/ipmi_power.py
View file

@ -43,7 +43,6 @@ options:
key:
description:
- Encryption key to connect to the BMC in hex format.
required: false
type: str
version_added: 4.1.0
state:
@ -67,7 +66,6 @@ options:
description:
- Provide a list of the remote target address for the bridge IPMI request, and the power status.
- Either this option or O(state) is required.
required: false
type: list
elements: dict
version_added: 4.3.0

2
plugins/modules/iso_customize.py
View file

@ -43,7 +43,6 @@ options:
description:
- Absolute paths for files inside the ISO file that should be removed.
type: list
required: false
elements: str
default: []
add_files:
@ -51,7 +50,6 @@ options:
- Allows to add and replace files in the ISO file.
- It creates intermediate folders inside the ISO file when they do not exist.
type: list
required: false
elements: dict
default: []
suboptions:

3
plugins/modules/java_keystore.py
View file

@ -77,15 +77,12 @@ options:
owner:
description:
- Name of the user that should own jks file.
required: false
group:
description:
- Name of the group that should own jks file.
required: false
mode:
description:
- Mode the file should be.
required: false
ssl_backend:
description:
- Backend for loading private keys and certificates.

7
plugins/modules/jenkins_job.py
View file

@ -29,14 +29,12 @@ options:
- Required if job does not yet exist.
- Mutually exclusive with O(enabled).
- Considered if O(state=present).
required: false
enabled:
description:
- Whether the job should be enabled or disabled.
- Mutually exclusive with O(config).
- Considered if O(state=present).
type: bool
required: false
name:
type: str
description:
@ -46,30 +44,25 @@ options:
type: str
description:
- Password to authenticate with the Jenkins server.
required: false
state:
type: str
description:
- Attribute that specifies if the job has to be created or deleted.
required: false
default: present
choices: ['present', 'absent']
token:
type: str
description:
- API token used to authenticate alternatively to password.
required: false
url:
type: str
description:
- URL where the Jenkins server is accessible.
required: false
default: http://localhost:8080
user:
type: str
description:
- User to authenticate with the Jenkins server.
required: false
validate_certs:
type: bool
default: true

17
plugins/modules/jira.py
View file

@ -72,36 +72,30 @@ options:
project:
type: str
required: false
description:
- The project for this operation. Required for issue creation.
summary:
type: str
required: false
description:
- The issue summary, where appropriate.
- Note that JIRA may not allow changing field values on specific transitions or states.
description:
type: str
required: false
description:
- The issue description, where appropriate.
- Note that JIRA may not allow changing field values on specific transitions or states.
issuetype:
type: str
required: false
description:
- The issue type, for issue creation.
issue:
type: str
required: false
description:
- An existing issue key to operate on.
aliases: ['ticket']
comment:
type: str
required: false
description:
- The comment text to add.
- Note that JIRA may not allow changing field values on specific transitions or states.
@ -128,20 +122,17 @@ options:
status:
type: str
required: false
description:
- Only used when O(operation) is V(transition), and a bit of a misnomer, it actually refers to the transition name.
- This is mutually exclusive with O(status_id).
status_id:
type: str
required: false
description:
- Only used when O(operation) is V(transition), and refers to the transition ID.
- This is mutually exclusive with O(status).
version_added: 10.3.0
assignee:
type: str
required: false
description:
- Sets the assignee when O(operation) is V(create), V(transition), or V(edit).
- Recent versions of JIRA no longer accept a user name as a user identifier. In that case, use O(account_id) instead.
@ -155,22 +146,18 @@ options:
linktype:
type: str
required: false
description:
- Set type of link, when action 'link' selected.
inwardissue:
type: str
required: false
description:
- Set issue from which link is created.
outwardissue:
type: str
required: false
description:
- Set issue to which link is created.
fields:
type: dict
required: false
description:
- This is a free-form data structure that can contain arbitrary data. This is passed directly to the JIRA REST API (possibly
after merging with other required data, as when passed to create). See examples for more information, and the JIRA
@ -180,14 +167,12 @@ options:
- Note that JIRA may not allow changing field values on specific transitions or states.
default: {}
jql:
required: false
description:
- Query JIRA in JQL Syntax, for example V("CMDB Hostname" = test.example.com).
type: str
version_added: '0.2.0'
maxresults:
required: false
description:
- Limit the result of O(operation=search). If no value is specified, the default JIRA limit is used.
- Used when O(operation=search) only, ignored otherwise.
@ -196,13 +181,11 @@ options:
timeout:
type: float
required: false
description:
- Set timeout, in seconds, on requests to JIRA API.
default: 10
validate_certs:
required: false
description:
- Require valid SSL certificates (set to V(false) if you would like to use self-signed certificates).
default: true

2
plugins/modules/keycloak_authz_authorization_scope.py
View file

@ -49,12 +49,10 @@ options:
description:
- The display name of the authorization scope.
type: str
required: false
icon_uri:
description:
- The icon URI for the authorization scope.
type: str
required: false
client_id:
description:
- The C(clientId) of the Keycloak client that should have the authorization scope.

5
plugins/modules/keycloak_authz_permission.py
View file

@ -55,7 +55,6 @@ options:
description:
- The description of the authorization permission.
type: str
required: false
permission_type:
description:
- The type of authorization permission.
@ -71,7 +70,6 @@ options:
- The decision strategy to use with this permission.
type: str
default: UNANIMOUS
required: false
choices:
- UNANIMOUS
- AFFIRMATIVE
@ -84,7 +82,6 @@ options:
type: list
elements: str
default: []
required: false
scopes:
description:
- Scope names to attach to this permission.
@ -92,14 +89,12 @@ options:
type: list
elements: str
default: []
required: false
policies:
description:
- Policy names to attach to this permission.
type: list
elements: str
default: []
required: false
client_id:
description:
- The clientId of the keycloak client that should have the authorization scope.

1
plugins/modules/keycloak_role.py
View file

@ -94,7 +94,6 @@ options:
- Client ID if the role is a client role. Do not include this option for a REALM role.
- Use the client ID you can see in the Keycloak console, not the technical ID of the client.
type: str
required: false
aliases:
- clientId
state:

9
plugins/modules/keycloak_user.py
View file

@ -44,33 +44,28 @@ options:
first_name:
description:
- The user's first name.
required: false
type: str
aliases:
- firstName
last_name:
description:
- The user's last name.
required: false
type: str
aliases:
- lastName
email:
description:
- User email.
required: false
type: str
federation_link:
description:
- Federation Link.
required: false
type: str
aliases:
- federationLink
service_account_client_id:
description:
- Description of the client Application.
required: false
type: str
aliases:
- serviceAccountClientId
@ -157,7 +152,6 @@ options:
attributes:
description:
- List of user attributes.
required: false
type: list
elements: dict
suboptions:
@ -179,7 +173,6 @@ options:
access:
description:
- List user access.
required: false
type: dict
disableable_credential_types:
description:
@ -192,12 +185,10 @@ options:
origin:
description:
- User origin.
required: false
type: str
self:
description:
- User self administration.
required: false
type: str
state:
description:

3
plugins/modules/keycloak_userprofile.py
View file

@ -70,7 +70,6 @@ options:
description:
- The configuration of the User Profile Provider.
type: dict
required: false
suboptions:
kc_user_profile_config:
description:
@ -242,13 +241,11 @@ options:
aliases:
- displayDescription
type: str
required: false
annotations:
description:
- The annotations included in the group.
type: dict
required: false
unmanaged_attribute_policy:
description:

2
plugins/modules/keyring.py
View file

@ -41,7 +41,6 @@ options:
type: str
user_password:
description: The password to set.
required: false
type: str
aliases:
- password
@ -51,7 +50,6 @@ options:
type: str
state:
description: Whether the password should exist.
required: false
default: present
type: str
choices:

2
plugins/modules/ldap_attrs.py
View file

@ -36,7 +36,6 @@ attributes:
version_added: 8.5.0
options:
state:
required: false
type: str
choices: [present, absent, exact]
default: present
@ -55,7 +54,6 @@ options:
- Note that when using values that YAML/ansible-core interprets as other types, like V(yes), V(no) (booleans), or V(2.10)
(float), make sure to quote them if these are meant to be strings. Otherwise the wrong values may be sent to LDAP.
ordered:
required: false
type: bool
default: false
description:

2
plugins/modules/ldap_inc.py
View file

@ -49,13 +49,11 @@ options:
description:
- The attribute to increment.
increment:
required: false
type: int
default: 1
description:
- The value of the increment to apply.
method:
required: false
type: str
default: auto
choices: [auto, rfc4525, legacy]

5
plugins/modules/librato_annotation.py
View file

@ -38,7 +38,6 @@ options:
description:
- The annotation stream name.
- If the annotation stream does not exist, it creates one automatically.
required: false
title:
type: str
description:
@ -50,25 +49,21 @@ options:
description:
- A string which describes the originating source of an annotation when that annotation is tracked across multiple members
of a population.
required: false
description:
type: str
description:
- The description contains extra metadata about a particular annotation.
- The description should contain specifics on the individual annotation for example V(Deployed 9b562b2 shipped new feature
foo!).
required: false
start_time:
type: int
description:
- The unix timestamp indicating the time at which the event referenced by this annotation started.
required: false
end_time:
type: int
description:
- The unix timestamp indicating the time at which the event referenced by this annotation ended.
- For events that have a duration, this is a useful way to annotate the duration of the event.
required: false
links:
type: list
elements: dict

1
plugins/modules/lldp.py
View file

@ -23,7 +23,6 @@ attributes:
options:
multivalues:
description: If lldpctl outputs an attribute multiple time represent all values as a list.
required: false
type: bool
default: false
author: "Andy Hill (@andyhky)"

3
plugins/modules/logentries.py
View file

@ -31,18 +31,15 @@ options:
description:
- Following state of the log.
choices: ['present', 'absent', 'followed', 'unfollowed']
required: false
default: present
name:
type: str
description:
- Name of the log.
required: false
logtype:
type: str
description:
- Type of the log.
required: false
aliases: [type]
notes:

1
plugins/modules/lxc_container.py
View file

@ -110,7 +110,6 @@ options:
description:
- Set the log level for a container where O(container_log) was set.
type: str
required: false
default: INFO
clone_name:
description:

18
plugins/modules/lxd_container.py
View file

@ -32,7 +32,6 @@ options:
description:
- Project of an instance.
- See U(https://documentation.ubuntu.com/lxd/en/latest/projects/).
required: false
type: str
version_added: 4.8.0
architecture:
@ -40,7 +39,6 @@ options:
- The architecture for the instance (for example V(x86_64) or V(i686)).
- See U(https://documentation.ubuntu.com/lxd/en/latest/api/#/instances/instance_get).
type: str
required: false
config:
description:
- 'The config for the instance (for example V({"limits.cpu": "2"})).'
@ -50,14 +48,12 @@ options:
are different, then this module tries to apply the configurations U(https://documentation.ubuntu.com/lxd/en/latest/api/#/instances/instance_put).
- The keys starting with C(volatile.) are ignored for this comparison when O(ignore_volatile_options=true).
type: dict
required: false
ignore_volatile_options:
description:
- If set to V(true), options starting with C(volatile.) are ignored. As a result, they are reapplied for each execution.
- This default behavior can be changed by setting this option to V(false).
- The default value changed from V(true) to V(false) in community.general 6.0.0.
type: bool
required: false
default: false
version_added: 3.7.0
profiles:
@ -70,12 +66,10 @@ options:
- 'The devices for the instance (for example V({ "rootfs": { "path": "/dev/kvm", "type": "unix-char" }})).'
- See U(https://documentation.ubuntu.com/lxd/en/latest/api/#/instances/instance_get).
type: dict
required: false
ephemeral:
description:
- Whether or not the instance is ephemeral (for example V(true) or V(false)).
- See U(https://documentation.ubuntu.com/lxd/en/latest/api/#/instances/instance_get).
required: false
type: bool
source:
description:
@ -83,7 +77,6 @@ options:
"protocol": "simplestreams", "alias": "22.04" })).'
- See U(https://documentation.ubuntu.com/lxd/en/latest/api/) for complete API documentation.
- 'Note that C(protocol) accepts two choices: V(lxd) or V(simplestreams).'
required: false
type: dict
state:
choices:
@ -94,7 +87,6 @@ options:
- frozen
description:
- Define the state of an instance.
required: false
default: started
type: str
target:
@ -103,20 +95,17 @@ options:
cluster, then it is not replaced nor moved. The name should respond to same name of the node you see in C(lxc cluster
list).
type: str
required: false
version_added: 1.0.0
timeout:
description:
- A timeout for changing the state of the instance.
- This is also used as a timeout for waiting until IPv4 addresses are set to the all network interfaces in the instance
after starting or restarting.
required: false
default: 30
type: int
type:
description:
- Instance type can be either V(virtual-machine) or V(container).
required: false
default: container
choices:
- container
@ -127,7 +116,6 @@ options:
description:
- If this is V(true), the C(lxd_container) waits until IPv4 addresses are set to the all network interfaces in the instance
after starting or restarting.
required: false
default: false
type: bool
wait_for_container:
@ -139,33 +127,28 @@ options:
force_stop:
description:
- If this is V(true), the C(lxd_container) forces to stop the instance when it stops or restarts the instance.
required: false
default: false
type: bool
url:
description:
- The unix domain socket path or the https URL for the LXD server.
required: false
default: unix:/var/lib/lxd/unix.socket
type: str
snap_url:
description:
- The unix domain socket path when LXD is installed by snap package manager.
required: false
default: unix:/var/snap/lxd/common/lxd/unix.socket
type: str
client_key:
description:
- The client certificate key file path.
- If not specified, it defaults to C(${HOME}/.config/lxc/client.key).
required: false
aliases: [key_file]
type: path
client_cert:
description:
- The client certificate file path.
- If not specified, it defaults to C(${HOME}/.config/lxc/client.crt).
required: false
aliases: [cert_file]
type: path
trust_password:
@ -174,7 +157,6 @@ options:
- 'You need to set this password on the LXD server before running this module using the following command: C(lxc config
set core.trust_password <some random password>). See U(https://www.stgraber.org/2016/04/18/lxd-api-direct-interaction/).'
- If trust_password is set, this module send a request for authentication before sending any requests.
required: false
type: str
notes:
- Instances can be a container or a virtual machine, both of them must have unique name. If you attempt to create an instance

11
plugins/modules/lxd_profile.py
View file

@ -30,7 +30,6 @@ options:
description:
- Project of a profile. See U(https://documentation.ubuntu.com/lxd/en/latest/projects/).
type: str
required: false
version_added: 4.8.0
description:
description:
@ -44,25 +43,21 @@ options:
U(https://documentation.ubuntu.com/lxd/en/latest/api/#/profiles/profile_get)
are different, then this module tries to apply the configurations U(https://documentation.ubuntu.com/lxd/en/latest/api/#/profiles/profile_put).
- Not all config values are supported to apply the existing profile. Maybe you need to delete and recreate a profile.
required: false
type: dict
devices:
description:
- 'The devices for the profile (for example V({"rootfs": {"path": "/dev/kvm", "type": "unix-char"})).'
- See U(https://documentation.ubuntu.com/lxd/en/latest/api/#/profiles/profile_get).
required: false
type: dict
new_name:
description:
- A new name of a profile.
- If this parameter is specified a profile is renamed to this name.
- See U(https://documentation.ubuntu.com/lxd/en/latest/api/#/profiles/profile_post).
required: false
type: str
merge_profile:
description:
- Merge the configuration of the present profile with the new desired configuration, instead of replacing it.
required: false
default: false
type: bool
version_added: 2.1.0
@ -72,33 +67,28 @@ options:
- absent
description:
- Define the state of a profile.
required: false
default: present
type: str
url:
description:
- The unix domain socket path or the https URL for the LXD server.
required: false
default: unix:/var/lib/lxd/unix.socket
type: str
snap_url:
description:
- The unix domain socket path when LXD is installed by snap package manager.
required: false
default: unix:/var/snap/lxd/common/lxd/unix.socket
type: str
client_key:
description:
- The client certificate key file path.
- If not specified, it defaults to C($HOME/.config/lxc/client.key).
required: false
aliases: [key_file]
type: path
client_cert:
description:
- The client certificate file path.
- If not specified, it defaults to C($HOME/.config/lxc/client.crt).
required: false
aliases: [cert_file]
type: path
trust_password:
@ -107,7 +97,6 @@ options:
- 'You need to set this password on the LXD server before running this module using the following command: C(lxc config
set core.trust_password <some random password>). See U(https://www.stgraber.org/2016/04/18/lxd-api-direct-interaction/).'
- If O(trust_password) is set, this module send a request for authentication before sending any requests.
required: false
type: str
notes:
- Profiles must have a unique name. If you attempt to create a profile with a name that already existed in the users namespace

8
plugins/modules/lxd_project.py
View file

@ -42,13 +42,11 @@ options:
- A new name of a project.
- If this parameter is specified a project is renamed to this name.
- See U(https://documentation.ubuntu.com/lxd/en/latest/api/#/projects/project_post).
required: false
type: str
merge_project:
description:
- Merge the configuration of the present project with the new desired configuration, instead of replacing it. If configuration
is the same after merged, no change is made.
required: false
default: false
type: bool
state:
@ -57,33 +55,28 @@ options:
- absent
description:
- Define the state of a project.
required: false
default: present
type: str
url:
description:
- The Unix domain socket path or the https URL for the LXD server.
required: false
default: unix:/var/lib/lxd/unix.socket
type: str
snap_url:
description:
- The Unix domain socket path when LXD is installed by snap package manager.
required: false
default: unix:/var/snap/lxd/common/lxd/unix.socket
type: str
client_key:
description:
- The client certificate key file path.
- If not specified, it defaults to C($HOME/.config/lxc/client.key).
required: false
aliases: [key_file]
type: path
client_cert:
description:
- The client certificate file path.
- If not specified, it defaults to C($HOME/.config/lxc/client.crt).
required: false
aliases: [cert_file]
type: path
trust_password:
@ -92,7 +85,6 @@ options:
- 'You need to set this password on the LXD server before running this module using the following command: C(lxc config
set core.trust_password <some random password>) See U(https://www.stgraber.org/2016/04/18/lxd-api-direct-interaction/).'
- If O(trust_password) is set, this module send a request for authentication before sending any requests.
required: false
type: str
notes:
- Projects must have a unique name. If you attempt to create a project with a name that already existed in the users namespace

1
plugins/modules/manageiq_alerts.py
View file

@ -29,7 +29,6 @@ options:
description:
- V(absent) - alert should not exist,
- V(present) - alert should exist.
required: false
choices: ['absent', 'present']
default: 'present'
description:

6
plugins/modules/manageiq_group.py
View file

@ -43,19 +43,16 @@ options:
type: int
description:
- The the group role ID.
required: false
role:
type: str
description:
- The the group role name.
- The O(role_id) has precedence over the O(role) when supplied.
required: false
default:
tenant_id:
type: int
description:
- The tenant for the group identified by the tenant ID.
required: false
default:
tenant:
type: str
@ -63,12 +60,10 @@ options:
- The tenant for the group identified by the tenant name.
- The O(tenant_id) has precedence over the O(tenant) when supplied.
- Tenant names are case sensitive.
required: false
default:
managed_filters:
description: The tag values per category.
type: dict
required: false
default:
managed_filters_merge_mode:
type: str
@ -81,7 +76,6 @@ options:
description: A list of strings with a reference to the allowed host, cluster or folder.
type: list
elements: str
required: false
default:
belongsto_filters_merge_mode:
type: str

3
plugins/modules/manageiq_tenant.py
View file

@ -49,13 +49,11 @@ options:
description:
- The ID of the parent tenant. If not supplied the root tenant is used.
- The O(parent_id) takes president over O(parent) when supplied.
required: false
default:
parent:
type: str
description:
- The name of the parent tenant. If not supplied and no O(parent_id) is supplied the root tenant is used.
required: false
default:
quotas:
type: dict
@ -68,7 +66,6 @@ options:
- '- V(storage_allocated) (GB): use null to remove the quota.'
- '- V(vms_allocated) (int): use null to remove the quota.'
- '- V(templates_allocated) (int): use null to remove the quota.'
required: false
default: {}
"""

1
plugins/modules/maven_artifact.py
View file

@ -140,7 +140,6 @@ options:
cached yet, it may fail unexpectedly. If you still need it, you should consider using V(always) instead - if you deal
with a checksum, it is better to use it to verify integrity after download.
- V(always) combines V(download) and V(change).
required: false
default: 'download'
choices: ['never', 'download', 'change', 'always']
checksum_alg:

1
plugins/modules/memset_zone.py
View file

@ -48,7 +48,6 @@ options:
default: 0
choices: [0, 300, 600, 900, 1800, 3600, 7200, 10800, 21600, 43200, 86400]
force:
required: false
default: false
type: bool
description:

1
plugins/modules/memset_zone_record.py
View file

@ -48,7 +48,6 @@ options:
type: int
default: 0
record:
required: false
description:
- The subdomain to create.
type: str

2
plugins/modules/netcup_dns.py
View file

@ -70,12 +70,10 @@ options:
priority:
description:
- Record priority. Required for O(type=MX).
required: false
type: int
state:
description:
- Whether the record should exist or not.
required: false
default: present
choices: ['present', 'absent']
type: str

7
plugins/modules/newrelic_deployment.py
View file

@ -31,23 +31,19 @@ options:
description:
- The value of C(app_name) in the C(newrelic.yml) file used by the application.
- One of O(app_name) or O(application_id) is required.
required: false
application_id:
type: str
description:
- The application ID found in the metadata of the application in APM.
- One of O(app_name) or O(application_id) is required.
required: false
changelog:
type: str
description:
- A list of changes for this deployment.
required: false
description:
type: str
description:
- Text annotation for the deployment - notes for you.
required: false
revision:
type: str
description:
@ -57,12 +53,10 @@ options:
type: str
description:
- The name of the user/process that triggered this deployment.
required: false
validate_certs:
description:
- If V(false), SSL certificates are not validated. This should only be used on personally controlled sites using self-signed
certificates.
required: false
default: true
type: bool
app_name_exact_match:
@ -70,7 +64,6 @@ options:
description:
- If this flag is set to V(true) then the application ID lookup by name would only work for an exact match. If set to
V(false) it returns the first result.
required: false
default: false
version_added: 7.5.0
requirements: []

1
plugins/modules/nginx_status_info.py
View file

@ -26,7 +26,6 @@ options:
type: int
description:
- HTTP connection timeout in seconds.
required: false
default: 10
notes:

1
plugins/modules/nmcli.py
View file

@ -63,7 +63,6 @@ options:
description:
- Whether the connection should be reloaded if it was modified.
type: bool
required: false
default: false
version_added: 9.5.0
ifname:

4
plugins/modules/nosh.py
View file

@ -30,7 +30,6 @@ options:
- Name of the service to manage.
state:
type: str
required: false
choices: [started, stopped, reset, restarted, reloaded]
description:
- V(started)/V(stopped) are idempotent actions that do not run commands unless necessary.
@ -38,19 +37,16 @@ options:
- V(reloaded) sends a SIGHUP or starts the service.
- V(reset) starts or stops the service according to whether it is enabled or not.
enabled:
required: false
type: bool
description:
- Enable or disable the service, independently of C(*.preset) file preference or running state. Mutually exclusive with
O(preset). It takes effect prior to O(state=reset).
preset:
required: false
type: bool
description:
- Enable or disable the service according to local preferences in C(*.preset) files. Mutually exclusive with O(enabled).
Only has an effect if set to true. It takes effect prior to O(state=reset).
user:
required: false
default: false
type: bool
description:

9
plugins/modules/npm.py
View file

@ -24,23 +24,19 @@ options:
description:
- The name of a node.js library to install.
type: str
required: false
path:
description:
- The base path where to install the node.js libraries.
- When O(global=true), then O(path) is not used to install the packages.
type: path
required: false
version:
description:
- The version to be installed.
type: str
required: false
global:
description:
- Install the node.js library globally.
- When O(global=true), then O(path) is not used to install the packages.
required: false
default: false
type: bool
executable:
@ -48,11 +44,9 @@ options:
- The executable location for npm.
- This is useful if you are using a version manager, such as nvm.
type: path
required: false
ignore_scripts:
description:
- Use the C(--ignore-scripts) flag when installing.
required: false
type: bool
default: false
unsafe_perm:
@ -68,18 +62,15 @@ options:
production:
description:
- Install dependencies in production mode, excluding devDependencies.
required: false
type: bool
default: false
registry:
description:
- The registry to install modules from.
required: false
type: str
state:
description:
- The state of the node.js library.
required: false
type: str
default: present
choices: ["present", "absent", "latest"]

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