diff --git a/plugins/modules/aerospike_migrations.py b/plugins/modules/aerospike_migrations.py index 393ddac7d1..a32935e24f 100644 --- a/plugins/modules/aerospike_migrations.py +++ b/plugins/modules/aerospike_migrations.py @@ -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 """ diff --git a/plugins/modules/airbrake_deployment.py b/plugins/modules/airbrake_deployment.py index 2a7bc4abfc..322d518c26 100644 --- a/plugins/modules/airbrake_deployment.py +++ b/plugins/modules/airbrake_deployment.py @@ -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 diff --git a/plugins/modules/ali_instance.py b/plugins/modules/ali_instance.py index 4c0fc43a2e..aa714c456f 100644 --- a/plugins/modules/ali_instance.py +++ b/plugins/modules/ali_instance.py @@ -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: diff --git a/plugins/modules/apache2_module.py b/plugins/modules/apache2_module.py index c71a8a2ba4..bd3926ee81 100644 --- a/plugins/modules/apache2_module.py +++ b/plugins/modules/apache2_module.py @@ -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: diff --git a/plugins/modules/bigpanda.py b/plugins/modules/bigpanda.py index 1762fa2d5e..67091fcd74 100644 --- a/plugins/modules/bigpanda.py +++ b/plugins/modules/bigpanda.py @@ -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: diff --git a/plugins/modules/bootc_manage.py b/plugins/modules/bootc_manage.py index 2ecca2ef9f..3db1a88e91 100644 --- a/plugins/modules/bootc_manage.py +++ b/plugins/modules/bootc_manage.py @@ -28,7 +28,6 @@ options: description: - The image to switch to. - This is required when O(state=switch). - required: false type: str """ diff --git a/plugins/modules/campfire.py b/plugins/modules/campfire.py index e0e25cb811..d35044d4a1 100644 --- a/plugins/modules/campfire.py +++ b/plugins/modules/campfire.py @@ -45,7 +45,6 @@ options: type: str description: - Send a notification sound before the message. - required: false choices: - 56k - bell diff --git a/plugins/modules/cargo.py b/plugins/modules/cargo.py index 474fcb2640..2d7709ce15 100644 --- a/plugins/modules/cargo.py +++ b/plugins/modules/cargo.py @@ -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: diff --git a/plugins/modules/copr.py b/plugins/modules/copr.py index 63dd7e2548..e1b4e5be8b 100644 --- a/plugins/modules/copr.py +++ b/plugins/modules/copr.py @@ -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 diff --git a/plugins/modules/datadog_downtime.py b/plugins/modules/datadog_downtime.py index ea62fd2fa3..fab60e4ea8 100644 --- a/plugins/modules/datadog_downtime.py +++ b/plugins/modules/datadog_downtime.py @@ -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 diff --git a/plugins/modules/datadog_monitor.py b/plugins/modules/datadog_monitor.py index db197fad3e..21ecfee5d5 100644 --- a/plugins/modules/datadog_monitor.py +++ b/plugins/modules/datadog_monitor.py @@ -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: diff --git a/plugins/modules/dconf.py b/plugins/modules/dconf.py index 88f48fb37e..44add1dfc5 100644 --- a/plugins/modules/dconf.py +++ b/plugins/modules/dconf.py @@ -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: diff --git a/plugins/modules/dimensiondata_network.py b/plugins/modules/dimensiondata_network.py index 73d23cf08a..01af072e55 100644 --- a/plugins/modules/dimensiondata_network.py +++ b/plugins/modules/dimensiondata_network.py @@ -41,7 +41,6 @@ options: description: description: - Additional description of the network domain. - required: false type: str service_plan: description: diff --git a/plugins/modules/django_manage.py b/plugins/modules/django_manage.py index 4d963fccde..44152c01b3 100644 --- a/plugins/modules/django_manage.py +++ b/plugins/modules/django_manage.py @@ -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: diff --git a/plugins/modules/dnf_config_manager.py b/plugins/modules/dnf_config_manager.py index 84c7c1da9c..9c6dd10a5a 100644 --- a/plugins/modules/dnf_config_manager.py +++ b/plugins/modules/dnf_config_manager.py @@ -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: diff --git a/plugins/modules/dnf_versionlock.py b/plugins/modules/dnf_versionlock.py index 4c0db79bc4..a2fdf33a3b 100644 --- a/plugins/modules/dnf_versionlock.py +++ b/plugins/modules/dnf_versionlock.py @@ -33,7 +33,6 @@ options: command. - This parameter is mutually exclusive with O(state=clean). type: list - required: false elements: str default: [] raw: diff --git a/plugins/modules/dnsimple_info.py b/plugins/modules/dnsimple_info.py index 1b18a9d62b..2fade3dd56 100644 --- a/plugins/modules/dnsimple_info.py +++ b/plugins/modules/dnsimple_info.py @@ -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 diff --git a/plugins/modules/ejabberd_user.py b/plugins/modules/ejabberd_user.py index b265eaf0f8..751740270f 100644 --- a/plugins/modules/ejabberd_user.py +++ b/plugins/modules/ejabberd_user.py @@ -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: diff --git a/plugins/modules/elasticsearch_plugin.py b/plugins/modules/elasticsearch_plugin.py index f8800f85c6..2ad2fa227d 100644 --- a/plugins/modules/elasticsearch_plugin.py +++ b/plugins/modules/elasticsearch_plugin.py @@ -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: diff --git a/plugins/modules/gem.py b/plugins/modules/gem.py index cd5d15f725..a3c015e74c 100644 --- a/plugins/modules/gem.py +++ b/plugins/modules/gem.py @@ -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: diff --git a/plugins/modules/github_deploy_key.py b/plugins/modules/github_deploy_key.py index be004273da..9710c68d25 100644 --- a/plugins/modules/github_deploy_key.py +++ b/plugins/modules/github_deploy_key.py @@ -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 diff --git a/plugins/modules/github_repo.py b/plugins/modules/github_repo.py index cca1d77da1..4cd4682a0d 100644 --- a/plugins/modules/github_repo.py +++ b/plugins/modules/github_repo.py @@ -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 diff --git a/plugins/modules/github_webhook.py b/plugins/modules/github_webhook.py index dcb3d2cc95..accee7380a 100644 --- a/plugins/modules/github_webhook.py +++ b/plugins/modules/github_webhook.py @@ -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: diff --git a/plugins/modules/github_webhook_info.py b/plugins/modules/github_webhook_info.py index e7b6a01c83..f6b93738be 100644 --- a/plugins/modules/github_webhook_info.py +++ b/plugins/modules/github_webhook_info.py @@ -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: diff --git a/plugins/modules/gitlab_hook.py b/plugins/modules/gitlab_hook.py index 9b8ab8efef..2ab43e5959 100644 --- a/plugins/modules/gitlab_hook.py +++ b/plugins/modules/gitlab_hook.py @@ -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 """ diff --git a/plugins/modules/gitlab_label.py b/plugins/modules/gitlab_label.py index ffd017ab91..3c2ff9a092 100644 --- a/plugins/modules/gitlab_label.py +++ b/plugins/modules/gitlab_label.py @@ -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: diff --git a/plugins/modules/gitlab_milestone.py b/plugins/modules/gitlab_milestone.py index 07de63fd88..b96e549ff0 100644 --- a/plugins/modules/gitlab_milestone.py +++ b/plugins/modules/gitlab_milestone.py @@ -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: diff --git a/plugins/modules/gitlab_project.py b/plugins/modules/gitlab_project.py index 4cdf2e91e7..e6002188e3 100644 --- a/plugins/modules/gitlab_project.py +++ b/plugins/modules/gitlab_project.py @@ -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: diff --git a/plugins/modules/gitlab_runner.py b/plugins/modules/gitlab_runner.py index 69eea8dbee..58519de8c0 100644 --- a/plugins/modules/gitlab_runner.py +++ b/plugins/modules/gitlab_runner.py @@ -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 diff --git a/plugins/modules/grove.py b/plugins/modules/grove.py index a5b5568f88..0e626b8658 100644 --- a/plugins/modules/grove.py +++ b/plugins/modules/grove.py @@ -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 diff --git a/plugins/modules/homebrew_cask.py b/plugins/modules/homebrew_cask.py index 48964fd2ee..1ec85dd651 100644 --- a/plugins/modules/homebrew_cask.py +++ b/plugins/modules/homebrew_cask.py @@ -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: diff --git a/plugins/modules/homebrew_tap.py b/plugins/modules/homebrew_tap.py index d7855e3317..d59c5ec112 100644 --- a/plugins/modules/homebrew_tap.py +++ b/plugins/modules/homebrew_tap.py @@ -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: diff --git a/plugins/modules/hponcfg.py b/plugins/modules/hponcfg.py index 00ccb2b1af..7664658025 100644 --- a/plugins/modules/hponcfg.py +++ b/plugins/modules/hponcfg.py @@ -30,7 +30,6 @@ options: minfw: description: - The minimum firmware level needed. - required: false type: str executable: description: diff --git a/plugins/modules/htpasswd.py b/plugins/modules/htpasswd.py index e13dbdef56..5be2244e8a 100644 --- a/plugins/modules/htpasswd.py +++ b/plugins/modules/htpasswd.py @@ -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: diff --git a/plugins/modules/hwc_ecs_instance.py b/plugins/modules/hwc_ecs_instance.py index e2ba681b34..146fc4c8d2 100644 --- a/plugins/modules/hwc_ecs_instance.py +++ b/plugins/modules/hwc_ecs_instance.py @@ -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 diff --git a/plugins/modules/hwc_evs_disk.py b/plugins/modules/hwc_evs_disk.py index 6f131f0f48..56d52f7b96 100644 --- a/plugins/modules/hwc_evs_disk.py +++ b/plugins/modules/hwc_evs_disk.py @@ -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 diff --git a/plugins/modules/hwc_smn_topic.py b/plugins/modules/hwc_smn_topic.py index 33bbf478e2..b2597f8142 100644 --- a/plugins/modules/hwc_smn_topic.py +++ b/plugins/modules/hwc_smn_topic.py @@ -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 diff --git a/plugins/modules/hwc_vpc_eip.py b/plugins/modules/hwc_vpc_eip.py index a3dcb7e718..b981fc4e7f 100644 --- a/plugins/modules/hwc_vpc_eip.py +++ b/plugins/modules/hwc_vpc_eip.py @@ -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 diff --git a/plugins/modules/hwc_vpc_peering_connect.py b/plugins/modules/hwc_vpc_peering_connect.py index 019f7ec58f..5c5583b1fb 100644 --- a/plugins/modules/hwc_vpc_peering_connect.py +++ b/plugins/modules/hwc_vpc_peering_connect.py @@ -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 diff --git a/plugins/modules/hwc_vpc_port.py b/plugins/modules/hwc_vpc_port.py index 926fc3c05c..189435a547 100644 --- a/plugins/modules/hwc_vpc_port.py +++ b/plugins/modules/hwc_vpc_port.py @@ -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 diff --git a/plugins/modules/hwc_vpc_private_ip.py b/plugins/modules/hwc_vpc_private_ip.py index f451c133e0..f8b9cf5b5f 100644 --- a/plugins/modules/hwc_vpc_private_ip.py +++ b/plugins/modules/hwc_vpc_private_ip.py @@ -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 diff --git a/plugins/modules/hwc_vpc_route.py b/plugins/modules/hwc_vpc_route.py index 7040318a5b..44126ec5ba 100644 --- a/plugins/modules/hwc_vpc_route.py +++ b/plugins/modules/hwc_vpc_route.py @@ -55,7 +55,6 @@ options: description: - Specifies the type of route. type: str - required: false default: 'peering' extends_documentation_fragment: - community.general.hwc diff --git a/plugins/modules/hwc_vpc_security_group.py b/plugins/modules/hwc_vpc_security_group.py index 87be2a663b..9a405b3675 100644 --- a/plugins/modules/hwc_vpc_security_group.py +++ b/plugins/modules/hwc_vpc_security_group.py @@ -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 diff --git a/plugins/modules/hwc_vpc_security_group_rule.py b/plugins/modules/hwc_vpc_security_group_rule.py index 3aae7fe2be..24d986d22d 100644 --- a/plugins/modules/hwc_vpc_security_group_rule.py +++ b/plugins/modules/hwc_vpc_security_group_rule.py @@ -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 diff --git a/plugins/modules/hwc_vpc_subnet.py b/plugins/modules/hwc_vpc_subnet.py index 0aa8751f1a..45ccee9bad 100644 --- a/plugins/modules/hwc_vpc_subnet.py +++ b/plugins/modules/hwc_vpc_subnet.py @@ -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 diff --git a/plugins/modules/ibm_sa_domain.py b/plugins/modules/ibm_sa_domain.py index ad3ad2378b..c901e7c52f 100644 --- a/plugins/modules/ibm_sa_domain.py +++ b/plugins/modules/ibm_sa_domain.py @@ -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: diff --git a/plugins/modules/ibm_sa_host.py b/plugins/modules/ibm_sa_host.py index 3b4d6e153f..bf122e96b3 100644 --- a/plugins/modules/ibm_sa_host.py +++ b/plugins/modules/ibm_sa_host.py @@ -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: diff --git a/plugins/modules/ibm_sa_host_ports.py b/plugins/modules/ibm_sa_host_ports.py index ee47c7c7fb..1c973ddb4f 100644 --- a/plugins/modules/ibm_sa_host_ports.py +++ b/plugins/modules/ibm_sa_host_ports.py @@ -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: diff --git a/plugins/modules/ibm_sa_pool.py b/plugins/modules/ibm_sa_pool.py index bf967b81a3..1bb14342bf 100644 --- a/plugins/modules/ibm_sa_pool.py +++ b/plugins/modules/ibm_sa_pool.py @@ -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: diff --git a/plugins/modules/ibm_sa_vol.py b/plugins/modules/ibm_sa_vol.py index e6a3b32b55..52bc2d124c 100644 --- a/plugins/modules/ibm_sa_vol.py +++ b/plugins/modules/ibm_sa_vol.py @@ -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: diff --git a/plugins/modules/ibm_sa_vol_map.py b/plugins/modules/ibm_sa_vol_map.py index 74219f9ad6..74174b9344 100644 --- a/plugins/modules/ibm_sa_vol_map.py +++ b/plugins/modules/ibm_sa_vol_map.py @@ -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: diff --git a/plugins/modules/idrac_redfish_command.py b/plugins/modules/idrac_redfish_command.py index dc022400ae..7f9a408d53 100644 --- a/plugins/modules/idrac_redfish_command.py +++ b/plugins/modules/idrac_redfish_command.py @@ -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 diff --git a/plugins/modules/idrac_redfish_config.py b/plugins/modules/idrac_redfish_config.py index 16d2584603..038ff8b0e1 100644 --- a/plugins/modules/idrac_redfish_config.py +++ b/plugins/modules/idrac_redfish_config.py @@ -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 diff --git a/plugins/modules/ilo_redfish_command.py b/plugins/modules/ilo_redfish_command.py index 03b503847b..23cbf6cd5a 100644 --- a/plugins/modules/ilo_redfish_command.py +++ b/plugins/modules/ilo_redfish_command.py @@ -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 diff --git a/plugins/modules/ilo_redfish_config.py b/plugins/modules/ilo_redfish_config.py index 5547514613..5ebfec955e 100644 --- a/plugins/modules/ilo_redfish_config.py +++ b/plugins/modules/ilo_redfish_config.py @@ -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 diff --git a/plugins/modules/imgadm.py b/plugins/modules/imgadm.py index c01c226d1a..ec2d7b1185 100644 --- a/plugins/modules/imgadm.py +++ b/plugins/modules/imgadm.py @@ -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 diff --git a/plugins/modules/influxdb_user.py b/plugins/modules/influxdb_user.py index 05013d218b..2e4339acf3 100644 --- a/plugins/modules/influxdb_user.py +++ b/plugins/modules/influxdb_user.py @@ -30,7 +30,6 @@ options: user_password: description: - Password to be set for the user. - required: false type: str admin: description: diff --git a/plugins/modules/ini_file.py b/plugins/modules/ini_file.py index f69ffda5f6..f41a1f9482 100644 --- a/plugins/modules/ini_file.py +++ b/plugins/modules/ini_file.py @@ -43,7 +43,6 @@ options: section_has_values: type: list elements: dict - required: false suboptions: option: type: str diff --git a/plugins/modules/ip_netns.py b/plugins/modules/ip_netns.py index f5e4e0c653..0666e8670f 100644 --- a/plugins/modules/ip_netns.py +++ b/plugins/modules/ip_netns.py @@ -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: diff --git a/plugins/modules/ipa_dnsrecord.py b/plugins/modules/ipa_dnsrecord.py index a415ac625c..16a94693e4 100644 --- a/plugins/modules/ipa_dnsrecord.py +++ b/plugins/modules/ipa_dnsrecord.py @@ -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 diff --git a/plugins/modules/ipa_dnszone.py b/plugins/modules/ipa_dnszone.py index edbc5505ec..fbf3fdfcf9 100644 --- a/plugins/modules/ipa_dnszone.py +++ b/plugins/modules/ipa_dnszone.py @@ -25,7 +25,6 @@ options: type: str state: description: State to ensure. - required: false default: present choices: ["absent", "present"] type: str diff --git a/plugins/modules/ipa_hbacrule.py b/plugins/modules/ipa_hbacrule.py index 3bf0877ffb..2db08b7ed8 100644 --- a/plugins/modules/ipa_hbacrule.py +++ b/plugins/modules/ipa_hbacrule.py @@ -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: diff --git a/plugins/modules/ipa_host.py b/plugins/modules/ipa_host.py index 07775df2fa..39e620d7fc 100644 --- a/plugins/modules/ipa_host.py +++ b/plugins/modules/ipa_host.py @@ -36,7 +36,6 @@ options: force: description: - Force host name even if not in DNS. - required: false type: bool ip_address: description: diff --git a/plugins/modules/ipa_service.py b/plugins/modules/ipa_service.py index 71ad06d473..c1d95c0564 100644 --- a/plugins/modules/ipa_service.py +++ b/plugins/modules/ipa_service.py @@ -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 diff --git a/plugins/modules/ipa_subca.py b/plugins/modules/ipa_subca.py index f45edcf119..68d26e6fa1 100644 --- a/plugins/modules/ipa_subca.py +++ b/plugins/modules/ipa_subca.py @@ -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 diff --git a/plugins/modules/ipbase_info.py b/plugins/modules/ipbase_info.py index f87c6c5cb4..ae0e649ca0 100644 --- a/plugins/modules/ipbase_info.py +++ b/plugins/modules/ipbase_info.py @@ -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: diff --git a/plugins/modules/ipinfoio_facts.py b/plugins/modules/ipinfoio_facts.py index f3170a84ce..a233611438 100644 --- a/plugins/modules/ipinfoio_facts.py +++ b/plugins/modules/ipinfoio_facts.py @@ -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: diff --git a/plugins/modules/ipmi_boot.py b/plugins/modules/ipmi_boot.py index 380b2477c1..630aacb4ce 100644 --- a/plugins/modules/ipmi_boot.py +++ b/plugins/modules/ipmi_boot.py @@ -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: diff --git a/plugins/modules/ipmi_power.py b/plugins/modules/ipmi_power.py index f7fe4e066f..680e19dc6a 100644 --- a/plugins/modules/ipmi_power.py +++ b/plugins/modules/ipmi_power.py @@ -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 diff --git a/plugins/modules/iso_customize.py b/plugins/modules/iso_customize.py index ae307f319b..d5ba06f4db 100644 --- a/plugins/modules/iso_customize.py +++ b/plugins/modules/iso_customize.py @@ -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: diff --git a/plugins/modules/java_keystore.py b/plugins/modules/java_keystore.py index 32167ab87e..72244aead0 100644 --- a/plugins/modules/java_keystore.py +++ b/plugins/modules/java_keystore.py @@ -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. diff --git a/plugins/modules/jenkins_job.py b/plugins/modules/jenkins_job.py index 770ac35233..9c8838fab4 100644 --- a/plugins/modules/jenkins_job.py +++ b/plugins/modules/jenkins_job.py @@ -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 diff --git a/plugins/modules/jira.py b/plugins/modules/jira.py index e39f76120d..f1e56a65d7 100644 --- a/plugins/modules/jira.py +++ b/plugins/modules/jira.py @@ -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 diff --git a/plugins/modules/keycloak_authz_authorization_scope.py b/plugins/modules/keycloak_authz_authorization_scope.py index 26513a40e9..06b638e3d9 100644 --- a/plugins/modules/keycloak_authz_authorization_scope.py +++ b/plugins/modules/keycloak_authz_authorization_scope.py @@ -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. diff --git a/plugins/modules/keycloak_authz_permission.py b/plugins/modules/keycloak_authz_permission.py index a24abf1ceb..e1a155507a 100644 --- a/plugins/modules/keycloak_authz_permission.py +++ b/plugins/modules/keycloak_authz_permission.py @@ -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. diff --git a/plugins/modules/keycloak_role.py b/plugins/modules/keycloak_role.py index ded6e080b8..5251858efb 100644 --- a/plugins/modules/keycloak_role.py +++ b/plugins/modules/keycloak_role.py @@ -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: diff --git a/plugins/modules/keycloak_user.py b/plugins/modules/keycloak_user.py index 83825ac05f..086a7f944c 100644 --- a/plugins/modules/keycloak_user.py +++ b/plugins/modules/keycloak_user.py @@ -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: diff --git a/plugins/modules/keycloak_userprofile.py b/plugins/modules/keycloak_userprofile.py index 90462ea193..ecff05bfbf 100644 --- a/plugins/modules/keycloak_userprofile.py +++ b/plugins/modules/keycloak_userprofile.py @@ -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: diff --git a/plugins/modules/keyring.py b/plugins/modules/keyring.py index c753c52e46..434ce3de39 100644 --- a/plugins/modules/keyring.py +++ b/plugins/modules/keyring.py @@ -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: diff --git a/plugins/modules/ldap_attrs.py b/plugins/modules/ldap_attrs.py index 386263ad98..3ae14da4d6 100644 --- a/plugins/modules/ldap_attrs.py +++ b/plugins/modules/ldap_attrs.py @@ -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: diff --git a/plugins/modules/ldap_inc.py b/plugins/modules/ldap_inc.py index db2c6cb7c7..0aff1f5434 100644 --- a/plugins/modules/ldap_inc.py +++ b/plugins/modules/ldap_inc.py @@ -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] diff --git a/plugins/modules/librato_annotation.py b/plugins/modules/librato_annotation.py index c3ac6fa0b5..972ffe0fba 100644 --- a/plugins/modules/librato_annotation.py +++ b/plugins/modules/librato_annotation.py @@ -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 diff --git a/plugins/modules/lldp.py b/plugins/modules/lldp.py index c8030fd550..95fe12dade 100644 --- a/plugins/modules/lldp.py +++ b/plugins/modules/lldp.py @@ -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)" diff --git a/plugins/modules/logentries.py b/plugins/modules/logentries.py index 85d7124338..853bd59591 100644 --- a/plugins/modules/logentries.py +++ b/plugins/modules/logentries.py @@ -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: diff --git a/plugins/modules/lxc_container.py b/plugins/modules/lxc_container.py index b0e97c86f5..ee24ce89cf 100644 --- a/plugins/modules/lxc_container.py +++ b/plugins/modules/lxc_container.py @@ -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: diff --git a/plugins/modules/lxd_container.py b/plugins/modules/lxd_container.py index 93bbcf1e36..fea7771e47 100644 --- a/plugins/modules/lxd_container.py +++ b/plugins/modules/lxd_container.py @@ -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 ). 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 diff --git a/plugins/modules/lxd_profile.py b/plugins/modules/lxd_profile.py index 69e60d149e..e878d73c8b 100644 --- a/plugins/modules/lxd_profile.py +++ b/plugins/modules/lxd_profile.py @@ -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 ). 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 diff --git a/plugins/modules/lxd_project.py b/plugins/modules/lxd_project.py index a592cb45a6..56ea74722a 100644 --- a/plugins/modules/lxd_project.py +++ b/plugins/modules/lxd_project.py @@ -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 ) 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 diff --git a/plugins/modules/manageiq_alerts.py b/plugins/modules/manageiq_alerts.py index 3ec8dc6a73..32ac129488 100644 --- a/plugins/modules/manageiq_alerts.py +++ b/plugins/modules/manageiq_alerts.py @@ -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: diff --git a/plugins/modules/manageiq_group.py b/plugins/modules/manageiq_group.py index 1cd24cc871..040275c181 100644 --- a/plugins/modules/manageiq_group.py +++ b/plugins/modules/manageiq_group.py @@ -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 diff --git a/plugins/modules/manageiq_tenant.py b/plugins/modules/manageiq_tenant.py index 0800c08eee..fe85c00d7f 100644 --- a/plugins/modules/manageiq_tenant.py +++ b/plugins/modules/manageiq_tenant.py @@ -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: {} """ diff --git a/plugins/modules/maven_artifact.py b/plugins/modules/maven_artifact.py index 8453467bb9..8353a770f4 100644 --- a/plugins/modules/maven_artifact.py +++ b/plugins/modules/maven_artifact.py @@ -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: diff --git a/plugins/modules/memset_zone.py b/plugins/modules/memset_zone.py index 89fee2b4de..3ff43679e8 100644 --- a/plugins/modules/memset_zone.py +++ b/plugins/modules/memset_zone.py @@ -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: diff --git a/plugins/modules/memset_zone_record.py b/plugins/modules/memset_zone_record.py index e728093c61..2b5c28e53c 100644 --- a/plugins/modules/memset_zone_record.py +++ b/plugins/modules/memset_zone_record.py @@ -48,7 +48,6 @@ options: type: int default: 0 record: - required: false description: - The subdomain to create. type: str diff --git a/plugins/modules/netcup_dns.py b/plugins/modules/netcup_dns.py index a3763f360c..bcf24a7292 100644 --- a/plugins/modules/netcup_dns.py +++ b/plugins/modules/netcup_dns.py @@ -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 diff --git a/plugins/modules/newrelic_deployment.py b/plugins/modules/newrelic_deployment.py index 0e1cd881b9..2c7db2544a 100644 --- a/plugins/modules/newrelic_deployment.py +++ b/plugins/modules/newrelic_deployment.py @@ -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: [] diff --git a/plugins/modules/nginx_status_info.py b/plugins/modules/nginx_status_info.py index 707deebc56..ceb5c48780 100644 --- a/plugins/modules/nginx_status_info.py +++ b/plugins/modules/nginx_status_info.py @@ -26,7 +26,6 @@ options: type: int description: - HTTP connection timeout in seconds. - required: false default: 10 notes: diff --git a/plugins/modules/nmcli.py b/plugins/modules/nmcli.py index d6a92a1f74..58519578c5 100644 --- a/plugins/modules/nmcli.py +++ b/plugins/modules/nmcli.py @@ -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: diff --git a/plugins/modules/nosh.py b/plugins/modules/nosh.py index 6335ad3054..0a628c9fe3 100644 --- a/plugins/modules/nosh.py +++ b/plugins/modules/nosh.py @@ -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: diff --git a/plugins/modules/npm.py b/plugins/modules/npm.py index 3290cd5be4..9d180d1e9c 100644 --- a/plugins/modules/npm.py +++ b/plugins/modules/npm.py @@ -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"] diff --git a/plugins/modules/ocapi_command.py b/plugins/modules/ocapi_command.py index 8e78d611b3..6ed55dff28 100644 --- a/plugins/modules/ocapi_command.py +++ b/plugins/modules/ocapi_command.py @@ -40,12 +40,10 @@ options: description: For proxied inband requests, the slot number of the IOM. Only applies if O(baseuri) is a proxy server. type: int update_image_path: - required: false description: - For O(command=FWUpload), the path on the local filesystem of the firmware update image. type: str job_name: - required: false description: - For O(command=DeleteJob) command, the name of the job to delete. type: str diff --git a/plugins/modules/oci_vcn.py b/plugins/modules/oci_vcn.py index e9e3cb14d1..4eb7c30a5f 100644 --- a/plugins/modules/oci_vcn.py +++ b/plugins/modules/oci_vcn.py @@ -25,7 +25,6 @@ options: cidr_block: description: The CIDR IP address block of the VCN. Required when creating a VCN with O(state=present). type: str - required: false compartment_id: description: The OCID of the compartment to contain the VCN. Required when creating a VCN with O(state=present). This option is mutually exclusive with O(vcn_id). diff --git a/plugins/modules/oneandone_firewall_policy.py b/plugins/modules/oneandone_firewall_policy.py index eeee60e7a9..f2b9135559 100644 --- a/plugins/modules/oneandone_firewall_policy.py +++ b/plugins/modules/oneandone_firewall_policy.py @@ -25,7 +25,6 @@ options: state: description: - Define a firewall policy state to create, remove, or update. - required: false type: str default: 'present' choices: ["present", "absent", "update"] @@ -37,7 +36,6 @@ options: description: - Custom API URL. Overrides the E(ONEANDONE_API_URL) environment variable. type: str - required: false name: description: - Firewall policy name used with present state. Used as identifier (id or name) when used with absent state. maxLength=128. @@ -58,14 +56,12 @@ options: - A list of server identifiers (ID or name) to be assigned to a firewall policy. Used in combination with update state. type: list elements: str - required: false default: [] remove_server_ips: description: - A list of server IP IDs to be unassigned from a firewall policy. Used in combination with update state. type: list elements: str - required: false default: [] add_rules: description: @@ -73,24 +69,20 @@ options: Used in combination with update state. type: list elements: dict - required: false default: [] remove_rules: description: - List of rule IDs that are removed from an existing firewall policy. Used in combination with update state. type: list elements: str - required: false default: [] description: description: - Firewall policy description. maxLength=256. type: str - required: false wait: description: - Wait for the instance to be in state 'running' before returning. - required: false default: true type: bool wait_timeout: diff --git a/plugins/modules/oneandone_load_balancer.py b/plugins/modules/oneandone_load_balancer.py index 48f9468694..1619491609 100644 --- a/plugins/modules/oneandone_load_balancer.py +++ b/plugins/modules/oneandone_load_balancer.py @@ -26,7 +26,6 @@ options: description: - Define a load balancer state to create, remove, or update. type: str - required: false default: 'present' choices: ["present", "absent", "update"] auth_token: @@ -41,7 +40,6 @@ options: description: - Custom API URL. Overrides the E(ONEANDONE_API_URL) environment variable. type: str - required: false name: description: - Load balancer name used with present state. Used as identifier (ID or name) when used with absent state. maxLength=128. @@ -59,12 +57,10 @@ options: description: - URL to call for checking. Required for HTTP health check. maxLength=1000. type: str - required: false health_check_parse: description: - Regular expression to check. Required for HTTP health check. maxLength=64. type: str - required: false persistence: description: - Persistence. @@ -84,7 +80,6 @@ options: - If not specified, it defaults to V(US). type: str choices: ["US", "ES", "DE", "GB"] - required: false rules: description: - A list of rule objects that are set for the load balancer. Each rule must contain protocol, port_balancer, and port_server @@ -96,20 +91,17 @@ options: description: - Description of the load balancer. maxLength=256. type: str - required: false add_server_ips: description: - A list of server identifiers (id or name) to be assigned to a load balancer. Used in combination with O(state=update). type: list elements: str - required: false default: [] remove_server_ips: description: - A list of server IP IDs to be unassigned from a load balancer. Used in combination with O(state=update). type: list elements: str - required: false default: [] add_rules: description: @@ -117,19 +109,16 @@ options: Used in combination with O(state=update). type: list elements: dict - required: false default: [] remove_rules: description: - A list of rule IDs that are removed from an existing load balancer. Used in combination with O(state=update). type: list elements: str - required: false default: [] wait: description: - Wait for the instance to be in state 'running' before returning. - required: false default: true type: bool wait_timeout: diff --git a/plugins/modules/oneandone_monitoring_policy.py b/plugins/modules/oneandone_monitoring_policy.py index 5a2622ace9..701b3803a8 100644 --- a/plugins/modules/oneandone_monitoring_policy.py +++ b/plugins/modules/oneandone_monitoring_policy.py @@ -27,7 +27,6 @@ options: description: - Define a monitoring policy's state to create, remove, update. type: str - required: false default: present choices: ["present", "absent", "update"] auth_token: @@ -38,7 +37,6 @@ options: description: - Custom API URL. Overrides the E(ONEANDONE_API_URL) environment variable. type: str - required: false name: description: - Monitoring policy name used with present state. Used as identifier (id or name) when used with absent state. maxLength=128. @@ -59,7 +57,6 @@ options: description: - Monitoring policy description. maxLength=256. type: str - required: false thresholds: description: - Monitoring policy thresholds. Each of the suboptions have warning and critical, which both have alert and value suboptions. @@ -135,61 +132,52 @@ options: - Ports to add to the monitoring policy. type: list elements: dict - required: false default: [] add_processes: description: - Processes to add to the monitoring policy. type: list elements: dict - required: false default: [] add_servers: description: - Servers to add to the monitoring policy. type: list elements: str - required: false default: [] remove_ports: description: - Ports to remove from the monitoring policy. type: list elements: str - required: false default: [] remove_processes: description: - Processes to remove from the monitoring policy. type: list elements: str - required: false default: [] remove_servers: description: - Servers to remove from the monitoring policy. type: list elements: str - required: false default: [] update_ports: description: - Ports to be updated on the monitoring policy. type: list elements: dict - required: false default: [] update_processes: description: - Processes to be updated on the monitoring policy. type: list elements: dict - required: false default: [] wait: description: - Wait for the instance to be in state 'running' before returning. - required: false default: true type: bool wait_timeout: diff --git a/plugins/modules/oneandone_private_network.py b/plugins/modules/oneandone_private_network.py index f7959090cf..05c9f70d7a 100644 --- a/plugins/modules/oneandone_private_network.py +++ b/plugins/modules/oneandone_private_network.py @@ -26,7 +26,6 @@ options: description: - Define a network's state to create, remove, or update. type: str - required: false default: 'present' choices: ["present", "absent", "update"] auth_token: @@ -41,7 +40,6 @@ options: description: - Custom API URL. Overrides the E(ONEANDONE_API_URL) environment variable. type: str - required: false name: description: - Private network name used with present state. Used as identifier (id or name) when used with absent state. @@ -78,7 +76,6 @@ options: wait: description: - Wait for the instance to be in state 'running' before returning. - required: false default: true type: bool wait_timeout: diff --git a/plugins/modules/oneandone_public_ip.py b/plugins/modules/oneandone_public_ip.py index 7ab46d389f..1f26b37b10 100644 --- a/plugins/modules/oneandone_public_ip.py +++ b/plugins/modules/oneandone_public_ip.py @@ -26,7 +26,6 @@ options: description: - Define a public IP state to create, remove, or update. type: str - required: false default: 'present' choices: ["present", "absent", "update"] auth_token: @@ -37,26 +36,22 @@ options: description: - Custom API URL. Overrides the E(ONEANDONE_API_URL) environment variable. type: str - required: false reverse_dns: description: - Reverse DNS name. maxLength=256. type: str - required: false datacenter: description: - ID of the datacenter where the IP is created (only for unassigned IPs). type: str choices: [US, ES, DE, GB] default: US - required: false type: description: - Type of IP. Currently, only IPV4 is available. type: str choices: ["IPV4", "IPV6"] default: 'IPV4' - required: false public_ip_id: description: - The ID of the public IP used with update and delete states. @@ -64,7 +59,6 @@ options: wait: description: - Wait for the instance to be in state 'running' before returning. - required: false default: true type: bool wait_timeout: diff --git a/plugins/modules/onepassword_info.py b/plugins/modules/onepassword_info.py index 9873d29f32..42ea0d4e83 100644 --- a/plugins/modules/onepassword_info.py +++ b/plugins/modules/onepassword_info.py @@ -86,11 +86,9 @@ options: description: - The secret key for your subdomain. - Only required for initial sign in. - required: false cli_path: type: path description: Used to specify the exact path to the C(op) command line interface. - required: false default: 'op' """ diff --git a/plugins/modules/ovh_ip_failover.py b/plugins/modules/ovh_ip_failover.py index afd470f497..944a83e7c3 100644 --- a/plugins/modules/ovh_ip_failover.py +++ b/plugins/modules/ovh_ip_failover.py @@ -43,14 +43,12 @@ options: - The endpoint to use (for instance V(ovh-eu)). type: str wait_completion: - required: false default: true type: bool description: - If V(true), the module waits for the IP address to be moved. If false, exit without waiting. The C(taskId) is returned in module output. wait_task_completion: - required: false default: 0 description: - If not V(0), the module waits for this task ID to be completed. Use O(wait_task_completion) if you want to wait for @@ -73,7 +71,6 @@ options: - The consumer key to use. type: str timeout: - required: false default: 120 description: - The timeout in seconds used to wait for a task to be completed. Default is 120 seconds. diff --git a/plugins/modules/packet_ip_subnet.py b/plugins/modules/packet_ip_subnet.py index 9f557a2119..52248e5baf 100644 --- a/plugins/modules/packet_ip_subnet.py +++ b/plugins/modules/packet_ip_subnet.py @@ -42,13 +42,11 @@ options: hostname: description: - A hostname of a device to/from which to assign/remove a subnet. - required: false type: str device_id: description: - UUID of a device to/from which to assign/remove a subnet. - required: false type: str project_id: diff --git a/plugins/modules/pagerduty_change.py b/plugins/modules/pagerduty_change.py index 8447821a51..6207f40283 100644 --- a/plugins/modules/pagerduty_change.py +++ b/plugins/modules/pagerduty_change.py @@ -50,39 +50,32 @@ options: repo: description: - The URL of the project repository. - required: false type: str revision: description: - An identifier of the revision being deployed, typically a number or SHA from a version control system. - required: false type: str environment: description: - The environment name, typically V(production), V(staging), and so on. - required: false type: str link_url: description: - A URL where more information about the deployment can be obtained. - required: false type: str link_text: description: - Descriptive text for a URL where more information about the deployment can be obtained. - required: false type: str url: description: - URL to submit the change event to. - required: false default: https://events.pagerduty.com/v2/change/enqueue type: str 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 """ diff --git a/plugins/modules/pam_limits.py b/plugins/modules/pam_limits.py index 0b93ade811..85a0784424 100644 --- a/plugins/modules/pam_limits.py +++ b/plugins/modules/pam_limits.py @@ -73,7 +73,6 @@ options: description: - Create a backup file including the timestamp information so you can get the original file back if you somehow clobbered it incorrectly. - required: false type: bool default: false use_min: @@ -81,7 +80,6 @@ options: - If set to V(true), the minimal value is used or conserved. - If the specified value is inferior to the value in the file, file content is replaced with the new value, else content is not modified. - required: false type: bool default: false use_max: @@ -89,20 +87,17 @@ options: - If set to V(true), the maximal value is used or conserved. - If the specified value is superior to the value in the file, file content is replaced with the new value, else content is not modified. - required: false type: bool default: false dest: type: str description: - Modify the limits.conf path. - required: false default: "/etc/security/limits.conf" comment: type: str description: - Comment associated with the limit. - required: false default: '' notes: - If O(dest) file does not exist, it is created. diff --git a/plugins/modules/pip_package_info.py b/plugins/modules/pip_package_info.py index f4105d4788..672038ca50 100644 --- a/plugins/modules/pip_package_info.py +++ b/plugins/modules/pip_package_info.py @@ -21,7 +21,6 @@ options: - A list of the pip executables that are used to get the packages. They can be supplied with the full path or just the executable name, for example V(pip3.7). default: ['pip'] - required: false type: list elements: path requirements: diff --git a/plugins/modules/pkgng.py b/plugins/modules/pkgng.py index ad1eb9ba75..e4091e5106 100644 --- a/plugins/modules/pkgng.py +++ b/plugins/modules/pkgng.py @@ -37,21 +37,18 @@ options: description: - State of the package. choices: ['present', 'latest', 'absent'] - required: false default: present type: str cached: description: - Use local package base instead of fetching an updated one. type: bool - required: false default: false annotation: description: - A list of keyvalue-pairs of the form C(<+/-/:>[=]). A V(+) denotes adding an annotation, a V(-) denotes removing an annotation, and V(:) denotes modifying an annotation. If setting or modifying annotations, a value must be provided. - required: false type: list elements: str pkgsite: @@ -59,19 +56,16 @@ options: - For C(pkgng) versions before 1.1.4, specify C(packagesite) to use for downloading packages. If not specified, use settings from C(/usr/local/etc/pkg.conf). - For newer C(pkgng) versions, specify a the name of a repository configured in C(/usr/local/etc/pkg/repos). - required: false type: str rootdir: description: - For C(pkgng) versions 1.5 and later, pkg installs all packages within the specified root directory. - Can not be used together with O(chroot) or O(jail) options. - required: false type: path chroot: description: - Pkg chroots in the specified environment. - Can not be used together with O(rootdir) or O(jail) options. - required: false type: path jail: description: @@ -81,21 +75,18 @@ options: autoremove: description: - Remove automatically installed packages which are no longer needed. - required: false type: bool default: false ignore_osver: description: - Ignore FreeBSD OS version check, useful on C(-STABLE) and C(-CURRENT) branches. - Defines the E(IGNORE_OSVERSION) environment variable. - required: false type: bool default: false version_added: 1.3.0 use_globs: description: - Treat the package names as shell glob patterns. - required: false type: bool default: true version_added: 9.3.0 diff --git a/plugins/modules/pkgutil.py b/plugins/modules/pkgutil.py index 2fb72a4df3..131f824d04 100644 --- a/plugins/modules/pkgutil.py +++ b/plugins/modules/pkgutil.py @@ -43,7 +43,6 @@ options: description: - The repository path to install the package from. - Its global definition is in C(/etc/opt/csw/pkgutil.conf). - required: false type: str state: description: diff --git a/plugins/modules/pmem.py b/plugins/modules/pmem.py index b7c14d307c..6ea0ee4a85 100644 --- a/plugins/modules/pmem.py +++ b/plugins/modules/pmem.py @@ -36,7 +36,6 @@ options: description: - Create AppDirect capacity that is interleaved any other PMem modules. type: bool - required: false default: true memorymode: description: @@ -48,7 +47,6 @@ options: and is presented as reserved capacity with Show Device and Show Memory Resources Commands. - O(reserved) is set automatically if this is not configured. type: int - required: false socket: description: - This enables to set the configuration for each socket by using the socket ID. @@ -69,7 +67,6 @@ options: description: - Create AppDirect capacity that is interleaved any other PMem modules within the socket ID. type: bool - required: false default: true memorymode: description: @@ -96,7 +93,6 @@ options: description: - The type of namespace. The detail of the type is in the man page of ndctl-create-namespace. type: str - required: false choices: ['pmem', 'blk'] size: description: @@ -105,14 +101,12 @@ options: - This option is required if multiple namespaces are configured. - If this option is not set, all of the available space of a region is configured. type: str - required: false namespace_append: description: - Enable to append the new namespaces to the system. - The default is V(false) so the all existing namespaces not listed in O(namespace) are removed. type: bool default: false - required: false """ RETURN = r""" diff --git a/plugins/modules/pnpm.py b/plugins/modules/pnpm.py index 262c33a2ee..c60b3c6831 100644 --- a/plugins/modules/pnpm.py +++ b/plugins/modules/pnpm.py @@ -29,26 +29,21 @@ options: - The name of a Node.js library to install. - All packages in C(package.json) are installed if not provided. type: str - required: false alias: description: - Alias of the Node.js library. type: str - required: false path: description: - The base path to install the Node.js libraries. type: path - required: false version: description: - The version of the library to be installed, in semver format. type: str - required: false global: description: - Install the Node.js library globally. - required: false default: false type: bool executable: @@ -56,37 +51,31 @@ options: - The executable location for pnpm. - The default location it searches for is E(PATH), fails if not set. type: path - required: false ignore_scripts: description: - Use the C(--ignore-scripts) flag when installing. - required: false type: bool default: false no_optional: description: - Do not install optional packages, equivalent to C(--no-optional). - required: false type: bool default: false production: description: - Install dependencies in production mode. - Pnpm ignores any dependencies under C(devDependencies) in package.json. - required: false type: bool default: false dev: description: - Install dependencies in development mode. - Pnpm ignores any regular dependencies in C(package.json). - required: false default: false type: bool optional: description: - Install dependencies in optional mode. - required: false default: false type: bool state: @@ -94,7 +83,6 @@ options: - Installation state of the named Node.js library. - If V(absent) is selected, a name option must be provided. type: str - required: false default: present choices: ["present", "absent", "latest"] requirements: diff --git a/plugins/modules/portinstall.py b/plugins/modules/portinstall.py index a663f241c3..eee83292be 100644 --- a/plugins/modules/portinstall.py +++ b/plugins/modules/portinstall.py @@ -33,14 +33,12 @@ options: description: - State of the package. choices: ['present', 'absent'] - required: false default: present type: str use_packages: description: - Use packages instead of ports whenever available. type: bool - required: false default: true author: "berenddeboer (@berenddeboer)" """ diff --git a/plugins/modules/pritunl_org_info.py b/plugins/modules/pritunl_org_info.py index 616b62834e..b282e67f1c 100644 --- a/plugins/modules/pritunl_org_info.py +++ b/plugins/modules/pritunl_org_info.py @@ -20,7 +20,6 @@ extends_documentation_fragment: options: organization: type: str - required: false aliases: - org default: null diff --git a/plugins/modules/pritunl_user.py b/plugins/modules/pritunl_user.py index 7908004323..99a521e7ab 100644 --- a/plugins/modules/pritunl_user.py +++ b/plugins/modules/pritunl_user.py @@ -46,13 +46,11 @@ options: - Name of the user to create or delete from Pritunl. user_email: type: str - required: false default: description: - Email address associated with the user O(user_name). user_type: type: str - required: false default: client choices: - client @@ -62,19 +60,16 @@ options: user_groups: type: list elements: str - required: false default: description: - List of groups associated with the user O(user_name). user_disabled: type: bool - required: false default: description: - Enable/Disable the user O(user_name). user_gravatar: type: bool - required: false default: description: - Enable/Disable Gravatar usage for the user O(user_name). diff --git a/plugins/modules/pritunl_user_info.py b/plugins/modules/pritunl_user_info.py index a89886a041..7276570975 100644 --- a/plugins/modules/pritunl_user_info.py +++ b/plugins/modules/pritunl_user_info.py @@ -27,12 +27,10 @@ options: - The name of the organization the user is part of. user_name: type: str - required: false description: - Name of the user to filter on Pritunl. user_type: type: str - required: false default: client choices: - client diff --git a/plugins/modules/pubnub_blocks.py b/plugins/modules/pubnub_blocks.py index 8b669834d5..58cba5e7d5 100644 --- a/plugins/modules/pubnub_blocks.py +++ b/plugins/modules/pubnub_blocks.py @@ -35,21 +35,18 @@ options: description: - Email from account for which new session should be started. - Not required if O(cache) contains result of previous module call (in same play). - required: false type: str default: '' password: description: - Password which match to account to which specified O(email) belong. - Not required if O(cache) contains result of previous module call (in same play). - required: false type: str default: '' cache: description: >- In case if single play use blocks management module few times it is preferred to enabled 'caching' by making previous module to share gathered artifacts and pass them to this parameter. - required: false type: dict default: {} account: @@ -71,7 +68,6 @@ options: state: description: - Intended block state after event handlers creation / update process is completed. - required: false default: 'present' choices: ['started', 'stopped', 'present', 'absent'] type: str @@ -84,7 +80,6 @@ options: description: - Short block description which is later visible on U(https://admin.pubnub.com). - Used only if block does not exists and does not change description for existing block. - required: false type: str event_handlers: description: @@ -99,7 +94,6 @@ options: - It is possible to rename event handler by adding C(changes) key to event handler payload and pass dictionary, which contains single key C(name), where new name should be passed. - To remove particular event handler it is possible to set C(state) for it to C(absent) and it is removed. - required: false default: [] type: list elements: dict @@ -107,7 +101,6 @@ options: description: - List of fields which should be changed by block itself (does not affect any event handlers). - 'Possible options for change is: O(name).' - required: false default: {} type: dict validate_certs: @@ -115,7 +108,6 @@ options: - This key allow to try skip certificates check when performing REST API calls. Sometimes host may have issues with certificates on it and this causes problems to call PubNub REST API. - If check should be ignored V(false) should be passed to this parameter. - required: false default: true type: bool """ diff --git a/plugins/modules/pulp_repo.py b/plugins/modules/pulp_repo.py index c4c214899e..a9f934788a 100644 --- a/plugins/modules/pulp_repo.py +++ b/plugins/modules/pulp_repo.py @@ -40,7 +40,6 @@ options: generate_sqlite: description: - Boolean flag to indicate whether sqlite files should be generated during a repository publish. - required: false type: bool default: false feed_ca_cert: @@ -72,25 +71,21 @@ options: proxy_host: description: - Proxy URL setting for the pulp repository importer. This is in the format V(scheme://host). - required: false default: type: str proxy_port: description: - Proxy port setting for the pulp repository importer. - required: false default: type: str proxy_username: description: - Proxy username for the pulp repository importer. - required: false default: type: str proxy_password: description: - Proxy password for the pulp repository importer. - required: false default: type: str publish_distributor: @@ -114,7 +109,6 @@ options: repoview: description: - Whether to generate repoview files for a published repository. Setting this to V(true) automatically activates O(generate_sqlite). - required: false type: bool default: false serve_http: diff --git a/plugins/modules/pushover.py b/plugins/modules/pushover.py index 5d1df47b8a..56891b77d5 100644 --- a/plugins/modules/pushover.py +++ b/plugins/modules/pushover.py @@ -41,19 +41,16 @@ options: type: str description: - Message title. - required: false pri: type: str description: - Message priority (see U(https://pushover.net) for details). - required: false default: '0' choices: ['-2', '-1', '0', '1', '2'] device: type: str description: - A device the message should be sent to. Multiple devices can be specified, separated by a comma. - required: false version_added: 1.2.0 author: diff --git a/plugins/modules/redfish_command.py b/plugins/modules/redfish_command.py index 58005d1bc5..1b3e5c444e 100644 --- a/plugins/modules/redfish_command.py +++ b/plugins/modules/redfish_command.py @@ -58,7 +58,6 @@ options: type: str version_added: 2.3.0 id: - required: false aliases: [account_id] description: - ID of account to delete/modify. @@ -66,25 +65,21 @@ options: POST request. type: str new_username: - required: false aliases: [account_username] description: - Username of account to add/delete/modify. type: str new_password: - required: false aliases: [account_password] description: - New password of account to add/modify. type: str roleid: - required: false aliases: [account_roleid] description: - Role of account to add/modify. type: str account_types: - required: false aliases: [account_accounttypes] description: - Array of account types to apply to a user account. @@ -92,7 +87,6 @@ options: elements: str version_added: '7.2.0' oem_account_types: - required: false aliases: [account_oemaccounttypes] description: - Array of OEM account types to apply to a user account. @@ -100,7 +94,6 @@ options: elements: str version_added: '7.2.0' bootdevice: - required: false description: - Boot device when setting boot configuration. type: str @@ -117,55 +110,46 @@ options: choices: [Legacy, UEFI] version_added: 3.5.0 uefi_target: - required: false description: - UEFI boot target when bootdevice is "UefiTarget". type: str boot_next: - required: false description: - BootNext target when bootdevice is "UefiBootNext". type: str update_username: - required: false aliases: [account_updatename] description: - New user name for updating account_username. type: str version_added: '0.2.0' account_properties: - required: false description: - Properties of account service to update. type: dict default: {} version_added: '0.2.0' resource_id: - required: false description: - ID of the System, Manager or Chassis to modify. type: str version_added: '0.2.0' update_image_uri: - required: false description: - URI of the image for the update. type: str version_added: '0.2.0' update_image_file: - required: false description: - Filename, with optional path, of the image for the update. type: path version_added: '7.1.0' update_protocol: - required: false description: - Protocol for the update. type: str version_added: '0.2.0' update_targets: - required: false description: - List of target resource URIs to apply the update to. type: list @@ -173,24 +157,20 @@ options: default: [] version_added: '0.2.0' update_creds: - required: false description: - Credentials for retrieving the update image. type: dict version_added: '0.2.0' suboptions: username: - required: false description: - Username for retrieving the update image. type: str password: - required: false description: - Password for retrieving the update image. type: str update_apply_time: - required: false description: - Time when to apply the update. type: str @@ -202,19 +182,16 @@ options: - OnStartUpdateRequest version_added: '6.1.0' update_oem_params: - required: false description: - Properties for HTTP Multipart Push Updates. type: dict version_added: '7.5.0' update_handle: - required: false description: - Handle to check the status of an update in progress. type: str version_added: '6.1.0' update_custom_oem_header: - required: false description: - Optional OEM header, sent as separate form-data for the Multipart HTTP push update. - The header shall start with "Oem" according to DMTF Redfish spec 12.6.2.2. @@ -223,7 +200,6 @@ options: type: str version_added: '10.1.0' update_custom_oem_params: - required: false description: - Custom OEM properties for HTTP Multipart Push updates. - If set, then O(update_custom_oem_header) is required too. @@ -233,59 +209,49 @@ options: type: raw version_added: '10.1.0' update_custom_oem_mime_type: - required: false description: - MIME Type for custom OEM properties for HTTP Multipart Push updates. type: str version_added: '10.1.0' virtual_media: - required: false description: - Options for VirtualMedia commands. type: dict version_added: '0.2.0' suboptions: media_types: - required: false description: - List of media types appropriate for the image. type: list elements: str default: [] image_url: - required: false description: - URL of the image to insert or eject. type: str inserted: - required: false description: - Indicates that the image is treated as inserted on command completion. type: bool default: true write_protected: - required: false description: - Indicates that the media is treated as write-protected. type: bool default: true username: - required: false description: - Username for accessing the image URL. type: str password: - required: false description: - Password for accessing the image URL. type: str transfer_protocol_type: - required: false description: - Network protocol to use with the image. type: str transfer_method: - required: false description: - Transfer method to use with the image. type: str @@ -297,7 +263,6 @@ options: default: false version_added: 3.7.0 bios_attributes: - required: false description: - BIOS attributes that needs to be verified in the given server. type: dict @@ -309,14 +274,12 @@ options: choices: [ResetAll, PreserveNetworkAndUsers, PreserveNetwork] version_added: 8.6.0 wait: - required: false description: - Block until the service is ready again. type: bool default: false version_added: 9.1.0 wait_timeout: - required: false description: - How long to block until the service is ready again before giving up. type: int diff --git a/plugins/modules/redfish_config.py b/plugins/modules/redfish_config.py index fac604618f..58b63f8314 100644 --- a/plugins/modules/redfish_config.py +++ b/plugins/modules/redfish_config.py @@ -52,7 +52,6 @@ options: type: str version_added: 2.3.0 bios_attributes: - required: false description: - Dictionary of BIOS attributes to update. default: {} @@ -65,7 +64,6 @@ options: type: int default: 60 boot_order: - required: false description: - List of BootOptionReference strings specifying the BootOrder. default: [] @@ -73,33 +71,28 @@ options: elements: str version_added: '0.2.0' network_protocols: - required: false description: - Setting dict of manager services to update. type: dict default: {} version_added: '0.2.0' resource_id: - required: false description: - ID of the System, Manager or Chassis to modify. type: str version_added: '0.2.0' service_id: - required: false description: - ID of the manager to update. type: str version_added: '8.4.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 @@ -113,41 +106,35 @@ options: default: false version_added: 3.7.0 hostinterface_config: - required: false description: - Setting dict of HostInterface on OOB controller. type: dict default: {} version_added: '4.1.0' hostinterface_id: - required: false description: - Redfish HostInterface instance ID if multiple HostInterfaces are present. type: str version_added: '4.1.0' sessions_config: - required: false description: - Setting dict of Sessions. type: dict default: {} version_added: '5.7.0' storage_subsystem_id: - required: false description: - ID of the Storage Subsystem on which the volume is to be created. type: str default: '' version_added: '7.3.0' storage_none_volume_deletion: - required: false description: - Indicates if all non-RAID volumes are automatically deleted prior to creating the new volume. type: bool default: false version_added: '9.5.0' volume_ids: - required: false description: - List of IDs of volumes to be deleted. type: list @@ -155,14 +142,12 @@ options: elements: str version_added: '7.3.0' secure_boot_enable: - required: false description: - Setting parameter to enable or disable SecureBoot. type: bool default: true version_added: '7.5.0' volume_details: - required: false description: - Setting dictionary of volume to be created. - If C(CapacityBytes) key is not specified in this dictionary, the size of the volume is determined by the Redfish service. diff --git a/plugins/modules/redfish_info.py b/plugins/modules/redfish_info.py index 361e7dfa99..a89a266920 100644 --- a/plugins/modules/redfish_info.py +++ b/plugins/modules/redfish_info.py @@ -22,14 +22,12 @@ attributes: # This was backported to 2.5.4 and 1.3.11 as well, since this was a bugfix options: category: - required: false description: - List of categories to execute on OOB controller. default: ['Systems'] type: list elements: str command: - required: false description: - List of commands to execute on OOB controller. type: list @@ -64,7 +62,6 @@ options: type: int default: 60 update_handle: - required: false description: - Handle to check the status of an update in progress. type: str diff --git a/plugins/modules/redis_data.py b/plugins/modules/redis_data.py index aeb8a5da43..abb39531d8 100644 --- a/plugins/modules/redis_data.py +++ b/plugins/modules/redis_data.py @@ -27,27 +27,22 @@ options: value: description: - Value that key should be set to. - required: false type: str expiration: description: - Expiration time in milliseconds. Setting this option always results in a change in the database. - required: false type: int non_existing: description: - Only set key if it does not already exist. - required: false type: bool existing: description: - Only set key if it already exists. - required: false type: bool keep_ttl: description: - Retain the time to live associated with the key. - required: false type: bool state: description: diff --git a/plugins/modules/redis_data_incr.py b/plugins/modules/redis_data_incr.py index 58fd80d488..1136a1e5c6 100644 --- a/plugins/modules/redis_data_incr.py +++ b/plugins/modules/redis_data_incr.py @@ -33,14 +33,12 @@ options: increment_int: description: - Integer amount to increment the key by. - required: false type: int increment_float: description: - Float amount to increment the key by. - This only works with keys that contain float values in their string representation. type: float - required: false extends_documentation_fragment: diff --git a/plugins/modules/rollbar_deployment.py b/plugins/modules/rollbar_deployment.py index 4dab9dc42b..873aff4f9b 100644 --- a/plugins/modules/rollbar_deployment.py +++ b/plugins/modules/rollbar_deployment.py @@ -40,28 +40,23 @@ options: type: str description: - User who deployed. - required: false rollbar_user: type: str description: - Rollbar username of the user who deployed. - required: false comment: type: str description: - Deploy comment (for example what is being deployed). - required: false url: type: str description: - Optional URL to submit the notification to. - required: false default: 'https://api.rollbar.com/api/1/deploy/' 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 """ diff --git a/plugins/modules/say.py b/plugins/modules/say.py index 4a896038dd..0a6f9a3287 100644 --- a/plugins/modules/say.py +++ b/plugins/modules/say.py @@ -34,7 +34,6 @@ options: type: str description: - What voice to use. - required: false requirements: [say or espeak or espeak-ng] author: - "Ansible Core Team" diff --git a/plugins/modules/scaleway_compute.py b/plugins/modules/scaleway_compute.py index 0c1bdcb805..2276fb9af7 100644 --- a/plugins/modules/scaleway_compute.py +++ b/plugins/modules/scaleway_compute.py @@ -86,7 +86,6 @@ options: elements: str description: - List of tags to apply to the instance (5 max). - required: false default: [] region: @@ -125,14 +124,12 @@ options: type: int description: - Time to wait for the server to reach the expected state. - required: false default: 300 wait_sleep_time: type: int description: - Time to wait before every attempt to check the state of the server. - required: false default: 3 security_group: @@ -140,7 +137,6 @@ options: description: - Security group unique identifier. - If no value provided, the default security group or current security group is used. - required: false """ EXAMPLES = r""" diff --git a/plugins/modules/scaleway_database_backup.py b/plugins/modules/scaleway_database_backup.py index 03cd75cac9..9ec386cd12 100644 --- a/plugins/modules/scaleway_database_backup.py +++ b/plugins/modules/scaleway_database_backup.py @@ -67,7 +67,6 @@ options: - Required for V(present) state. - Ignored when O(state=absent), O(state=exported) or O(state=restored). type: str - required: false database_name: description: @@ -75,7 +74,6 @@ options: - Required for V(present) and V(restored) states. - Ignored when O(state=absent) or O(state=exported). type: str - required: false instance_id: description: @@ -83,14 +81,12 @@ options: - Required for V(present) and V(restored) states. - Ignored when O(state=absent) or O(state=exported). type: str - required: false expires_at: description: - Expiration datetime of the database backup (ISO 8601 format). - Ignored when O(state=absent), O(state=exported) or O(state=restored). type: str - required: false wait: description: @@ -102,14 +98,12 @@ options: description: - Time to wait for the backup to reach the expected state. type: int - required: false default: 300 wait_sleep_time: description: - Time to wait before every attempt to check the state of the backup. type: int - required: false default: 3 """ diff --git a/plugins/modules/scaleway_lb.py b/plugins/modules/scaleway_lb.py index f90c2811f8..1fd5fd0b18 100644 --- a/plugins/modules/scaleway_lb.py +++ b/plugins/modules/scaleway_lb.py @@ -85,14 +85,12 @@ options: type: int description: - Time to wait for the load-balancer to reach the expected state. - required: false default: 300 wait_sleep_time: type: int description: - Time to wait before every attempt to check the state of the load-balancer. - required: false default: 3 """ diff --git a/plugins/modules/scaleway_user_data.py b/plugins/modules/scaleway_user_data.py index 674ac649d8..508f42d66b 100644 --- a/plugins/modules/scaleway_user_data.py +++ b/plugins/modules/scaleway_user_data.py @@ -44,7 +44,6 @@ options: description: - User defined data. Typically used with C(cloud-init). - Pass your C(cloud-init) script here as a string. - required: false region: type: str diff --git a/plugins/modules/sensu_silence.py b/plugins/modules/sensu_silence.py index 9e4fa7e1af..b8e809cf1c 100644 --- a/plugins/modules/sensu_silence.py +++ b/plugins/modules/sensu_silence.py @@ -62,7 +62,6 @@ options: type: str description: - Specifies the URL of the Sensu monitoring host server. - required: false default: http://127.0.01:4567 """ diff --git a/plugins/modules/sensu_subscription.py b/plugins/modules/sensu_subscription.py index 3ac22bced1..909f9724ba 100644 --- a/plugins/modules/sensu_subscription.py +++ b/plugins/modules/sensu_subscription.py @@ -34,20 +34,17 @@ options: description: - Whether the machine should subscribe or unsubscribe from the channel. choices: ['present', 'absent'] - required: false default: present path: type: str description: - Path to the subscriptions JSON file. - required: false default: /etc/sensu/conf.d/subscriptions.json backup: description: - Create a backup file (if yes), including the timestamp information so you can get the original file back if you somehow clobbered it incorrectly. type: bool - required: false default: false requirements: [] author: Anders Ingemann (@andsens) diff --git a/plugins/modules/simpleinit_msb.py b/plugins/modules/simpleinit_msb.py index 328acafa7d..a370b99d58 100644 --- a/plugins/modules/simpleinit_msb.py +++ b/plugins/modules/simpleinit_msb.py @@ -30,7 +30,6 @@ options: aliases: ['service'] state: type: str - required: false choices: [running, started, stopped, restarted, reloaded] description: - V(started)/V(stopped) are idempotent actions that do not run commands unless necessary. V(restarted) always bounces @@ -39,7 +38,6 @@ options: - Note that V(reloaded) starts the service if it is not already started, even if your chosen init system would not normally. enabled: type: bool - required: false description: - Whether the service should start on boot. - At least one of O(state) and O(enabled) are required. diff --git a/plugins/modules/slackpkg.py b/plugins/modules/slackpkg.py index a2c1474290..5dbed482ff 100644 --- a/plugins/modules/slackpkg.py +++ b/plugins/modules/slackpkg.py @@ -38,14 +38,12 @@ options: description: - State of the package, you can use V(installed) as an alias for V(present) and V(removed) as one for V(absent). choices: ['present', 'absent', 'latest', 'installed', 'removed'] - required: false default: present type: str update_cache: description: - Update the package database first. - required: false default: false type: bool diff --git a/plugins/modules/snap.py b/plugins/modules/snap.py index c957351091..6499a47f89 100644 --- a/plugins/modules/snap.py +++ b/plugins/modules/snap.py @@ -48,7 +48,6 @@ options: that do not use sandboxing mechanisms. This option can only be specified when the task involves a single snap. - See U(https://snapcraft.io/docs/snap-confinement) for more details about classic confinement and confinement levels. type: bool - required: false default: false channel: description: @@ -59,7 +58,6 @@ options: module assumes the channel to be V(latest/edge). - See U(https://snapcraft.io/docs/channels) for more details about snap channels. type: str - required: false options: description: - Set options with pattern C(key=value) or C(snap:key=value). If a snap name is given, the option is applied to that @@ -68,7 +66,6 @@ options: - Options are only applied when C(state) is set to V(present). This is done after the necessary installation or refresh (upgrade/downgrade) of all the snaps listed in O(name). - See U(https://snapcraft.io/docs/configuration-in-snaps) for more details about snap configuration options. - required: false type: list elements: str version_added: 4.4.0 @@ -78,7 +75,6 @@ options: - This is useful when installing local snaps that are either unsigned or have signatures that have not been acknowledged. - See U(https://snapcraft.io/docs/install-modes) for more details about installation modes. type: bool - required: false default: false version_added: 7.2.0 notes: diff --git a/plugins/modules/spectrum_device.py b/plugins/modules/spectrum_device.py index 6e8861ca34..b83f1a6a85 100644 --- a/plugins/modules/spectrum_device.py +++ b/plugins/modules/spectrum_device.py @@ -78,7 +78,6 @@ options: type: bool agentport: type: int - required: false description: - UDP port used for SNMP discovery. default: 161 diff --git a/plugins/modules/spectrum_model_attrs.py b/plugins/modules/spectrum_model_attrs.py index 82b78c2a00..b3b0a66cd4 100644 --- a/plugins/modules/spectrum_model_attrs.py +++ b/plugins/modules/spectrum_model_attrs.py @@ -47,7 +47,6 @@ options: description: - If V(false), it does not use a proxy, even if one is defined in an environment variable on the target hosts. default: true - required: false type: bool name: description: @@ -65,7 +64,6 @@ options: and there is no man-in-the-middle attack happening. type: bool default: true - required: false attributes: description: - A list of attribute names and values to enforce. diff --git a/plugins/modules/supervisorctl.py b/plugins/modules/supervisorctl.py index eeacb5a881..d13c08bb22 100644 --- a/plugins/modules/supervisorctl.py +++ b/plugins/modules/supervisorctl.py @@ -53,7 +53,6 @@ options: type: bool description: - Use O(stop_before_removing=true) to stop the program/group before removing it. - required: false default: false version_added: 7.5.0 signal: diff --git a/plugins/modules/svr4pkg.py b/plugins/modules/svr4pkg.py index 82a91cab59..9f1eb163fa 100644 --- a/plugins/modules/svr4pkg.py +++ b/plugins/modules/svr4pkg.py @@ -55,20 +55,17 @@ options: response_file: description: - Specifies the location of a response file to be used if package expects input on install. - required: false type: str zone: description: - Whether to install the package only in the current zone, or install it into all zones. - The installation into all zones works only if you are working with the global zone. - required: false default: "all" choices: ["current", "all"] type: str category: description: - Install/Remove category instead of a single package. - required: false type: bool default: false """ diff --git a/plugins/modules/systemd_creds_decrypt.py b/plugins/modules/systemd_creds_decrypt.py index 067f34f775..3b0e49c297 100644 --- a/plugins/modules/systemd_creds_decrypt.py +++ b/plugins/modules/systemd_creds_decrypt.py @@ -31,12 +31,10 @@ options: description: - The credential name to validate the embedded credential name. type: str - required: false newline: description: - Whether to add a trailing newline character to the end of the output, if not present. type: bool - required: false default: false secret: description: @@ -48,20 +46,17 @@ options: - The timestamp to use to validate the V(not-after) timestamp that was used during encryption. - Takes a timestamp specification in the format described in V(systemd.time(7\)). type: str - required: false transcode: description: - Whether to transcode the output before returning it. type: str choices: [base64, unbase64, hex, unhex] - required: false user: description: - A user name or numeric UID when decrypting from a specific user context. - If set to the special string V(self) it sets the user to the user of the calling process. - Requires C(systemd) 256 or later. type: str - required: false notes: - C(systemd-creds) requires C(systemd) 250 or later. """ diff --git a/plugins/modules/systemd_creds_encrypt.py b/plugins/modules/systemd_creds_encrypt.py index 2f262f1656..13f60832b6 100644 --- a/plugins/modules/systemd_creds_encrypt.py +++ b/plugins/modules/systemd_creds_encrypt.py @@ -30,18 +30,15 @@ options: description: - The credential name to embed in the encrypted credential data. type: str - required: false not_after: description: - The time when the credential shall not be used anymore. - Takes a timestamp specification in the format described in V(systemd.time(7\)). type: str - required: false pretty: description: - Pretty print the output so that it may be pasted directly into a unit file. type: bool - required: false default: false secret: description: @@ -53,14 +50,12 @@ options: - The timestamp to embed into the encrypted credential. - Takes a timestamp specification in the format described in V(systemd.time(7\)). type: str - required: false user: description: - A user name or numeric UID to encrypt the credential for. - If set to the special string V(self) it sets the user to the user of the calling process. - Requires C(systemd) 256 or later. type: str - required: false notes: - C(systemd-creds) requires C(systemd) 250 or later. """ diff --git a/plugins/modules/twilio.py b/plugins/modules/twilio.py index 816626712f..41f0703fd4 100644 --- a/plugins/modules/twilio.py +++ b/plugins/modules/twilio.py @@ -56,7 +56,6 @@ options: type: str description: - A URL with a picture, video or sound clip to send with an MMS (multimedia message) instead of a plain SMS. - required: false author: "Matt Makai (@makaimc)" """ diff --git a/plugins/modules/udm_group.py b/plugins/modules/udm_group.py index 696857f04e..dc36d8a59c 100644 --- a/plugins/modules/udm_group.py +++ b/plugins/modules/udm_group.py @@ -25,7 +25,6 @@ attributes: support: partial options: state: - required: false default: "present" choices: [present, absent] description: @@ -37,24 +36,20 @@ options: - Name of the POSIX group. type: str description: - required: false description: - Group description. type: str position: - required: false description: - Define the whole LDAP position of the group, for example V(cn=g123m-1A,cn=classes,cn=schueler,cn=groups,ou=schule,dc=example,dc=com). type: str default: '' ou: - required: false description: - LDAP OU, for example V(school) for LDAP OU V(ou=school,dc=example,dc=com). type: str default: '' subpath: - required: false description: - Subpath inside the OU, for example V(cn=classes,cn=students,cn=groups). type: str diff --git a/plugins/modules/udm_share.py b/plugins/modules/udm_share.py index 109ccb8b11..ad5a54326a 100644 --- a/plugins/modules/udm_share.py +++ b/plugins/modules/udm_share.py @@ -36,17 +36,14 @@ options: - Name. type: str host: - required: false description: - Host FQDN (server which provides the share), for example V({{ ansible_fqdn }}). Required if O(state=present). type: str path: - required: false description: - Directory on the providing server, for example V(/home). Required if O(state=present). type: path sambaName: - required: false description: - Windows name. Required if O(state=present). type: str diff --git a/plugins/modules/utm_network_interface_address.py b/plugins/modules/utm_network_interface_address.py index f367fe6e66..a36279f374 100644 --- a/plugins/modules/utm_network_interface_address.py +++ b/plugins/modules/utm_network_interface_address.py @@ -38,7 +38,6 @@ options: type: str description: - The ip6 address of the network/interface_address object. - required: false comment: type: str description: diff --git a/plugins/modules/utm_proxy_exception.py b/plugins/modules/utm_proxy_exception.py index 9d4c80a133..55331250fa 100644 --- a/plugins/modules/utm_proxy_exception.py +++ b/plugins/modules/utm_proxy_exception.py @@ -37,7 +37,6 @@ options: choices: - 'AND' - 'OR' - required: false type: str path: description: @@ -45,82 +44,69 @@ options: type: list elements: str default: [] - required: false skip_custom_threats_filters: description: - A list of threats to be skipped. type: list elements: str default: [] - required: false skip_threats_filter_categories: description: - Define which categories of threats are skipped. type: list elements: str default: [] - required: false skipav: description: - Skip the Antivirus Scanning. default: false type: bool - required: false skipbadclients: description: - Block clients with bad reputation. default: false type: bool - required: false skipcookie: description: - Skip the Cookie Signing check. default: false type: bool - required: false skipform: description: - Enable form hardening. default: false type: bool - required: false skipform_missingtoken: description: - Enable form hardening with missing tokens. default: false type: bool - required: false skiphtmlrewrite: description: - Protection against SQL. default: false type: bool - required: false skiptft: description: - Enable true file type control. default: false type: bool - required: false skipurl: description: - Enable static URL hardening. default: false type: bool - required: false source: description: - Define which categories of threats are skipped. type: list elements: str default: [] - required: false status: description: - Status of the exception rule set. default: true type: bool - required: false extends_documentation_fragment: - community.general.utm diff --git a/plugins/modules/vmadm.py b/plugins/modules/vmadm.py index 832090857f..cecd589ed1 100644 --- a/plugins/modules/vmadm.py +++ b/plugins/modules/vmadm.py @@ -22,12 +22,10 @@ attributes: support: none options: archive_on_delete: - required: false description: - When enabled, the zone dataset is mounted on C(/zones/archive) upon removal. type: bool autoboot: - required: false description: - Whether or not a VM is booted when the system is rebooted. type: bool @@ -38,225 +36,183 @@ options: - Type of virtual machine. The V(bhyve) option was added in community.general 0.2.0. type: str boot: - required: false description: - Set the boot order for KVM VMs. type: str cpu_cap: - required: false description: - Sets a limit on the amount of CPU time that can be used by a VM. Use V(0) for no cap. type: int cpu_shares: - required: false description: - Sets a limit on the number of fair share scheduler (FSS) CPU shares for a VM. This limit is relative to all other VMs on the system. type: int cpu_type: - required: false choices: [qemu64, host] default: qemu64 description: - Control the type of virtual CPU exposed to KVM VMs. type: str customer_metadata: - required: false description: - Metadata to be set and associated with this VM, this contain customer modifiable keys. type: dict delegate_dataset: - required: false description: - Whether to delegate a ZFS dataset to an OS VM. type: bool disk_driver: - required: false description: - Default value for a virtual disk model for KVM guests. type: str disks: - required: false description: - A list of disks to add, valid properties are documented in vmadm(1M). type: list elements: dict dns_domain: - required: false description: - Domain value for C(/etc/hosts). type: str docker: - required: false description: - Docker images need this flag enabled along with the O(brand) set to C(lx). type: bool filesystems: - required: false description: - Mount additional filesystems into an OS VM. type: list elements: dict firewall_enabled: - required: false description: - Enables the firewall, allowing fwadm(1M) rules to be applied. type: bool flexible_disk_size: - required: false description: - This sets an upper bound for the amount of space that a bhyve instance may use for its disks and snapshots of those disks (in MiBs). type: int version_added: 10.5.0 force: - required: false description: - Force a particular action (in other words, stop or delete a VM). type: bool fs_allowed: - required: false description: - Comma separated list of filesystem types this zone is allowed to mount. type: str hostname: - required: false description: - Zone/VM hostname. type: str image_uuid: - required: false description: - Image UUID. type: str indestructible_delegated: - required: false description: - Adds an C(@indestructible) snapshot to delegated datasets. type: bool indestructible_zoneroot: - required: false description: - Adds an C(@indestructible) snapshot to zoneroot. type: bool internal_metadata: - required: false description: - Metadata to be set and associated with this VM, this contains operator generated keys. type: dict internal_metadata_namespace: - required: false description: - List of namespaces to be set as C(internal_metadata-only); these namespaces come from O(internal_metadata) rather than O(customer_metadata). type: str kernel_version: - required: false description: - Kernel version to emulate for LX VMs. type: str limit_priv: - required: false description: - Set (comma separated) list of privileges the zone is allowed to use. type: str maintain_resolvers: - required: false description: - Resolvers in C(/etc/resolv.conf) are updated when updating the O(resolvers) property. type: bool max_locked_memory: - required: false description: - Total amount of memory (in MiBs) on the host that can be locked by this VM. type: int max_lwps: - required: false description: - Maximum number of lightweight processes this VM is allowed to have running. type: int max_physical_memory: - required: false description: - Maximum amount of memory (in MiBs) on the host that the VM is allowed to use. type: int max_swap: - required: false description: - Maximum amount of virtual memory (in MiBs) the VM is allowed to use. type: int mdata_exec_timeout: - required: false description: - Timeout in seconds (or 0 to disable) for the C(svc:/smartdc/mdata:execute) service that runs user-scripts in the zone. type: int name: - required: false aliases: [alias] description: - Name of the VM. vmadm(1M) uses this as an optional name. type: str nic_driver: - required: false description: - Default value for a virtual NIC model for KVM guests. type: str nics: - required: false description: - A list of nics to add, valid properties are documented in vmadm(1M). type: list elements: dict nowait: - required: false description: - Consider the provisioning complete when the VM first starts, rather than when the VM has rebooted. type: bool owner_uuid: - required: false description: - Define the UUID of the owner of the VM. type: str version_added: 10.5.0 qemu_opts: - required: false description: - Additional qemu arguments for KVM guests. This overwrites the default arguments provided by vmadm(1M) and should only be used for debugging. type: str qemu_extra_opts: - required: false description: - Additional qemu cmdline arguments for KVM guests. type: str quota: - required: false description: - Quota on zone filesystems (in MiBs). type: int ram: - required: false description: - Amount of virtual RAM for a KVM guest (in MiBs). type: int resolvers: - required: false description: - List of resolvers to be put into C(/etc/resolv.conf). type: list elements: str routes: - required: false description: - Dictionary that maps destinations to gateways, these are set as static routes in the VM. type: dict spice_opts: - required: false description: - Addition options for SPICE-enabled KVM VMs. type: str spice_password: - required: false description: - Password required to connect to SPICE. By default no password is set. Please note this can be read from the Global Zone. @@ -271,82 +227,66 @@ options: it down. type: str tmpfs: - required: false description: - Amount of memory (in MiBs) that is available in the VM for the C(/tmp) filesystem. type: int uuid: - required: false description: - UUID of the VM. Can either be a full UUID or V(*) for all VMs. type: str vcpus: - required: false description: - Number of virtual CPUs for a KVM guest. type: int vga: - required: false description: - Specify VGA emulation used by KVM VMs. type: str virtio_txburst: - required: false description: - Number of packets that can be sent in a single flush of the tx queue of virtio NICs. type: int virtio_txtimer: - required: false description: - Timeout (in nanoseconds) for the TX timer of virtio NICs. type: int vnc_password: - required: false description: - Password required to connect to VNC. By default no password is set. Please note this can be read from the Global Zone. type: str vnc_port: - required: false description: - TCP port to listen of the VNC server. Or set V(0) for random, or V(-1) to disable. type: int zfs_data_compression: - required: false description: - Specifies compression algorithm used for this VMs data dataset. This option only has effect on delegated datasets. type: str zfs_data_recsize: - required: false description: - Suggested block size (power of 2) for files in the delegated dataset's filesystem. type: int zfs_filesystem_limit: - required: false description: - Maximum number of filesystems the VM can have. type: int zfs_io_priority: - required: false description: - IO throttle priority value relative to other VMs. type: int zfs_root_compression: - required: false description: - Specifies compression algorithm used for this VMs root dataset. This option only has effect on the zoneroot dataset. type: str zfs_root_recsize: - required: false description: - Suggested block size (power of 2) for files in the zoneroot dataset's filesystem. type: int zfs_snapshot_limit: - required: false description: - Number of snapshots the VM can have. type: int zpool: - required: false description: - ZFS pool the VM's zone dataset is created in. type: str diff --git a/plugins/modules/wdc_redfish_command.py b/plugins/modules/wdc_redfish_command.py index 43d4e490f1..8ce1d66c25 100644 --- a/plugins/modules/wdc_redfish_command.py +++ b/plugins/modules/wdc_redfish_command.py @@ -60,29 +60,24 @@ options: default: 10 type: int resource_id: - required: false description: - ID of the component to modify, such as V(Enclosure), V(IOModuleAFRU), V(PowerSupplyBFRU), V(FanExternalFRU3), or V(FanInternalFRU). type: str version_added: 5.4.0 update_image_uri: - required: false description: - The URI of the image for the update. type: str update_creds: - required: false description: - The credentials for retrieving the update image. type: dict suboptions: username: - required: false description: - The username for retrieving the update image. type: str password: - required: false description: - The password for retrieving the update image. type: str diff --git a/plugins/modules/xcc_redfish_command.py b/plugins/modules/xcc_redfish_command.py index ee09b4f3eb..8f25919f02 100644 --- a/plugins/modules/xcc_redfish_command.py +++ b/plugins/modules/xcc_redfish_command.py @@ -60,12 +60,10 @@ options: default: 10 type: int resource_id: - required: false description: - The ID of the System, Manager or Chassis to modify. type: str virtual_media: - required: false description: - The options for VirtualMedia commands. type: dict @@ -107,12 +105,10 @@ options: - The transfer method to use with the image. type: str resource_uri: - required: false description: - The resource URI to get or patch or post. type: str request_body: - required: false description: - The request body to patch or post. type: dict diff --git a/plugins/modules/yarn.py b/plugins/modules/yarn.py index 04703fa192..7e9e358c3e 100644 --- a/plugins/modules/yarn.py +++ b/plugins/modules/yarn.py @@ -32,54 +32,45 @@ options: - The name of a Node.js library to install. - If omitted all packages in package.json are installed. - To globally install from local Node.js library. Prepend C(file:) to the path of the Node.js library. - required: false path: type: path description: - The base path where Node.js installs libraries. - This is where the C(node_modules) folder lives. - required: false version: type: str description: - The version of the library to be installed. - Must be in semver format. If "latest" is desired, use O(state) arg instead. - required: false global: description: - Install the Node.js library globally. - required: false default: false type: bool executable: type: path description: - The executable location for yarn. - required: false ignore_scripts: description: - Use the C(--ignore-scripts) flag when installing. - required: false type: bool default: false production: description: - Install dependencies in production mode. - C(yarn) ignores any dependencies under devDependencies in C(package.json). - required: false type: bool default: false registry: type: str description: - The registry to install modules from. - required: false state: type: str description: - Installation state of the named Node.js library. - If V(absent) is selected, a O(name) option must be provided. - required: false default: present choices: ["present", "absent", "latest"] requirements: diff --git a/plugins/modules/znode.py b/plugins/modules/znode.py index c0cef494ee..36d692fd34 100644 --- a/plugins/modules/znode.py +++ b/plugins/modules/znode.py @@ -59,21 +59,18 @@ options: choices: [digest, sasl] type: str default: "digest" - required: false version_added: 5.8.0 auth_credential: description: - The authentication credential value. Depends on O(auth_scheme). - The format for O(auth_scheme=digest) is C(user:password), and the format for O(auth_scheme=sasl) is C(user:password). type: str - required: false version_added: 5.8.0 use_tls: description: - Using TLS/SSL or not. type: bool default: false - required: false version_added: '6.5.0' requirements: - kazoo >= 2.1 diff --git a/plugins/modules/zpool_facts.py b/plugins/modules/zpool_facts.py index 3722941919..39125cd97d 100644 --- a/plugins/modules/zpool_facts.py +++ b/plugins/modules/zpool_facts.py @@ -23,20 +23,17 @@ options: - ZFS pool name. type: str aliases: ["pool", "zpool"] - required: false parsable: description: - Specifies if property values should be displayed in machine friendly format. type: bool default: false - required: false properties: description: - Specifies which dataset properties should be queried in comma-separated format. For more information about dataset properties, check zpool(1M) man page. type: str default: all - required: false """ EXAMPLES = r""" diff --git a/plugins/modules/zypper.py b/plugins/modules/zypper.py index b24b150732..530ac8fa39 100644 --- a/plugins/modules/zypper.py +++ b/plugins/modules/zypper.py @@ -56,19 +56,16 @@ options: - V(absent) makes sure the specified package is not installed. - V(dist-upgrade) makes sure the latest version of all installed packages from all enabled repositories is installed. - When using V(dist-upgrade), O(name) should be V(*). - required: false choices: [present, latest, absent, dist-upgrade, installed, removed] default: "present" type: str type: description: - The type of package to be operated on. - required: false choices: [package, patch, pattern, product, srcpackage, application] default: "package" type: str extra_args_precommand: - required: false description: - Add additional global target options to C(zypper). - Options should be supplied in a single line as if given in the command line. @@ -77,14 +74,12 @@ options: description: - Whether to disable to GPG signature checking of the package signature being installed. Has an effect only if O(state) is V(present) or V(latest). - required: false default: false type: bool auto_import_keys: description: - Whether to automatically import new repository signing keys. Adds C(--gpg-auto-import-keys) option to I(zypper). - Is only used when installing. - required: false default: false type: bool version_added: 11.3.0 @@ -92,27 +87,23 @@ options: description: - Corresponds to the C(--no-recommends) option for I(zypper). Default behavior (V(true)) modifies zypper's default behavior; V(false) does install recommended packages. - required: false default: true type: bool force: description: - Adds C(--force) option to I(zypper). Allows to downgrade packages and change vendor or architecture. - required: false default: false type: bool force_resolution: description: - Adds C(--force-resolution) option to I(zypper). Allows to (un)install packages with conflicting requirements (resolver chooses a solution). - required: false default: false type: bool version_added: '0.2.0' update_cache: description: - Run the equivalent of C(zypper refresh) before the operation. Disabled in check mode. - required: false default: false type: bool aliases: ["refresh"] @@ -120,53 +111,45 @@ options: description: - Adds C(--oldpackage) option to I(zypper). Allows to downgrade packages with less side-effects than force. This is implied as soon as a version is specified as part of the package name. - required: false default: false type: bool extra_args: - required: false description: - Add additional options to C(zypper) command. - Options should be supplied in a single line as if given in the command line. type: str allow_vendor_change: type: bool - required: false 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' clean_deps: type: bool - required: false default: false description: - Adds C(--clean-deps) option to I(zypper) remove command. version_added: '4.6.0' simple_errors: type: bool - required: false default: false description: - When set to V(true), provide a simplified error output (parses only the C() tag text in the XML output). version_added: '10.2.0' quiet: type: bool - required: false default: true description: - Adds C(--quiet) option to I(zypper) install/update command. version_added: '10.2.0' skip_post_errors: type: bool - required: false default: false description: - When set to V(true), ignore I(zypper) return code 107 (post install script errors).