From ca2c64b5ca944f610209d8c44999060960f6f7d9 Mon Sep 17 00:00:00 2001 From: Felix Fontein Date: Mon, 14 Mar 2022 20:56:27 +0100 Subject: [PATCH] Fix sanity issues. (#4346) --- plugins/cache/memcached.py | 1 + plugins/inventory/cobbler.py | 1 + plugins/inventory/gitlab_runners.py | 1 - plugins/inventory/linode.py | 3 +++ plugins/inventory/nmap.py | 1 + plugins/inventory/online.py | 2 ++ plugins/inventory/scaleway.py | 3 +++ plugins/lookup/consul_kv.py | 1 + plugins/lookup/credstash.py | 4 ++-- plugins/lookup/dnstxt.py | 1 + plugins/modules/cloud/centurylink/clc_blueprint_package.py | 2 +- plugins/modules/cloud/centurylink/clc_firewall_policy.py | 4 ++-- plugins/modules/cloud/centurylink/clc_loadbalancer.py | 2 +- plugins/modules/cloud/centurylink/clc_server_snapshot.py | 2 +- plugins/modules/cloud/huawei/hwc_vpc_security_group.py | 1 - plugins/modules/cloud/rackspace/rax_cdb.py | 2 +- plugins/modules/database/vertica/vertica_info.py | 2 +- plugins/modules/database/vertica/vertica_role.py | 2 +- plugins/modules/database/vertica/vertica_schema.py | 2 +- plugins/modules/database/vertica/vertica_user.py | 2 +- plugins/modules/monitoring/datadog/datadog_monitor.py | 1 - plugins/modules/net_tools/infinity/infinity.py | 4 ++-- plugins/modules/system/open_iscsi.py | 2 +- plugins/modules/system/selinux_permissive.py | 1 - 24 files changed, 28 insertions(+), 19 deletions(-) diff --git a/plugins/cache/memcached.py b/plugins/cache/memcached.py index b7d14aa86d..dd6e0685c1 100644 --- a/plugins/cache/memcached.py +++ b/plugins/cache/memcached.py @@ -20,6 +20,7 @@ DOCUMENTATION = ''' - List of connection information for the memcached DBs default: ['127.0.0.1:11211'] type: list + elements: string env: - name: ANSIBLE_CACHE_PLUGIN_CONNECTION ini: diff --git a/plugins/inventory/cobbler.py b/plugins/inventory/cobbler.py index d5a3221bef..d50acd0c55 100644 --- a/plugins/inventory/cobbler.py +++ b/plugins/inventory/cobbler.py @@ -58,6 +58,7 @@ DOCUMENTATION = ''' group_by: description: Keys to group hosts by type: list + elements: string default: [ 'mgmt_classes', 'owners', 'status' ] group: description: Group to place all hosts into diff --git a/plugins/inventory/gitlab_runners.py b/plugins/inventory/gitlab_runners.py index ddf64cd626..ac0fa21ad9 100644 --- a/plugins/inventory/gitlab_runners.py +++ b/plugins/inventory/gitlab_runners.py @@ -35,7 +35,6 @@ DOCUMENTATION = ''' version_added: 1.0.0 type: str required: true - default: https://gitlab.com api_token: description: GitLab token for logging in. env: diff --git a/plugins/inventory/linode.py b/plugins/inventory/linode.py index 36ff2e692b..33ecc5135c 100644 --- a/plugins/inventory/linode.py +++ b/plugins/inventory/linode.py @@ -54,15 +54,18 @@ DOCUMENTATION = r''' description: Populate inventory with instances in this region. default: [] type: list + elements: string tags: description: Populate inventory only with instances which have at least one of the tags listed here. default: [] type: list + elements: string version_added: 2.0.0 types: description: Populate inventory with instances with this type. default: [] type: list + elements: string strict: version_added: 2.0.0 compose: diff --git a/plugins/inventory/nmap.py b/plugins/inventory/nmap.py index e411006ff0..44d687505a 100644 --- a/plugins/inventory/nmap.py +++ b/plugins/inventory/nmap.py @@ -27,6 +27,7 @@ DOCUMENTATION = ''' exclude: description: list of addresses to exclude type: list + elements: string ports: description: Enable/disable scanning for open ports type: boolean diff --git a/plugins/inventory/online.py b/plugins/inventory/online.py index 4b2587f33c..00454f558c 100644 --- a/plugins/inventory/online.py +++ b/plugins/inventory/online.py @@ -28,6 +28,7 @@ DOCUMENTATION = r''' hostnames: description: List of preference about what to use as an hostname. type: list + elements: string default: - public_ipv4 choices: @@ -37,6 +38,7 @@ DOCUMENTATION = r''' groups: description: List of groups. type: list + elements: string choices: - location - offer diff --git a/plugins/inventory/scaleway.py b/plugins/inventory/scaleway.py index 58b4d96fa5..d48cc97a1d 100644 --- a/plugins/inventory/scaleway.py +++ b/plugins/inventory/scaleway.py @@ -23,6 +23,7 @@ DOCUMENTATION = r''' regions: description: Filter results on a specific Scaleway region. type: list + elements: string default: - ams1 - par1 @@ -31,6 +32,7 @@ DOCUMENTATION = r''' tags: description: Filter results on a specific tag. type: list + elements: string scw_profile: description: - The config profile to use in config file. @@ -51,6 +53,7 @@ DOCUMENTATION = r''' hostnames: description: List of preference about what to use as an hostname. type: list + elements: string default: - public_ipv4 choices: diff --git a/plugins/lookup/consul_kv.py b/plugins/lookup/consul_kv.py index 8b779e6aca..3ad03bfe40 100644 --- a/plugins/lookup/consul_kv.py +++ b/plugins/lookup/consul_kv.py @@ -20,6 +20,7 @@ DOCUMENTATION = ''' _raw: description: List of key(s) to retrieve. type: list + elements: string recurse: type: boolean description: If true, will retrieve all the values that have the given key as prefix. diff --git a/plugins/lookup/credstash.py b/plugins/lookup/credstash.py index 9be3527b19..143c66c112 100644 --- a/plugins/lookup/credstash.py +++ b/plugins/lookup/credstash.py @@ -17,11 +17,11 @@ DOCUMENTATION = ''' _terms: description: term or list of terms to lookup in the credit store type: list - required: True + elements: string + required: true table: description: name of the credstash table to query default: 'credential-store' - required: True version: description: Credstash version region: diff --git a/plugins/lookup/dnstxt.py b/plugins/lookup/dnstxt.py index 868d3dd3a3..e724f8c8f7 100644 --- a/plugins/lookup/dnstxt.py +++ b/plugins/lookup/dnstxt.py @@ -18,6 +18,7 @@ DOCUMENTATION = ''' description: domain or list of domains to query TXT records from required: True type: list + elements: string ''' EXAMPLES = """ diff --git a/plugins/modules/cloud/centurylink/clc_blueprint_package.py b/plugins/modules/cloud/centurylink/clc_blueprint_package.py index 4e03062ba7..9e0bfa809c 100644 --- a/plugins/modules/cloud/centurylink/clc_blueprint_package.py +++ b/plugins/modules/cloud/centurylink/clc_blueprint_package.py @@ -42,7 +42,7 @@ options: description: - Whether to wait for the tasks to finish before returning. type: str - default: True + default: 'True' required: False requirements: - python = 2.7 diff --git a/plugins/modules/cloud/centurylink/clc_firewall_policy.py b/plugins/modules/cloud/centurylink/clc_firewall_policy.py index 3fc0427692..f1f4a2f22a 100644 --- a/plugins/modules/cloud/centurylink/clc_firewall_policy.py +++ b/plugins/modules/cloud/centurylink/clc_firewall_policy.py @@ -66,8 +66,8 @@ options: description: - Whether the firewall policy is enabled or disabled type: str - choices: [True, False] - default: True + choices: ['True', 'False'] + default: 'True' requirements: - python = 2.7 - requests >= 2.5.0 diff --git a/plugins/modules/cloud/centurylink/clc_loadbalancer.py b/plugins/modules/cloud/centurylink/clc_loadbalancer.py index bf09ce22be..656f4363a6 100644 --- a/plugins/modules/cloud/centurylink/clc_loadbalancer.py +++ b/plugins/modules/cloud/centurylink/clc_loadbalancer.py @@ -48,7 +48,7 @@ options: description: - Port to configure on the public-facing side of the load balancer pool type: str - choices: [80, 443] + choices: ['80', '443'] nodes: description: - A list of nodes that needs to be added to the load balancer pool diff --git a/plugins/modules/cloud/centurylink/clc_server_snapshot.py b/plugins/modules/cloud/centurylink/clc_server_snapshot.py index dbee34bbb2..4de4c9936e 100644 --- a/plugins/modules/cloud/centurylink/clc_server_snapshot.py +++ b/plugins/modules/cloud/centurylink/clc_server_snapshot.py @@ -36,7 +36,7 @@ options: wait: description: - Whether to wait for the provisioning tasks to finish before returning. - default: True + default: 'True' required: False type: str requirements: diff --git a/plugins/modules/cloud/huawei/hwc_vpc_security_group.py b/plugins/modules/cloud/huawei/hwc_vpc_security_group.py index 603518159b..5a1dfe706b 100644 --- a/plugins/modules/cloud/huawei/hwc_vpc_security_group.py +++ b/plugins/modules/cloud/huawei/hwc_vpc_security_group.py @@ -51,7 +51,6 @@ options: group.s type: str required: false - default: 0 vpc_id: description: - Specifies the resource ID of the VPC to which the security group diff --git a/plugins/modules/cloud/rackspace/rax_cdb.py b/plugins/modules/cloud/rackspace/rax_cdb.py index 04bbe71cda..a9c3243281 100644 --- a/plugins/modules/cloud/rackspace/rax_cdb.py +++ b/plugins/modules/cloud/rackspace/rax_cdb.py @@ -42,7 +42,7 @@ options: description: - version of database (MySQL supports 5.1 and 5.6, MariaDB supports 10, Percona supports 5.6) - "The available choices are: C(5.1), C(5.6) and C(10)." - default: 5.6 + default: '5.6' aliases: ['version'] state: type: str diff --git a/plugins/modules/database/vertica/vertica_info.py b/plugins/modules/database/vertica/vertica_info.py index feaebecbdc..3822a0717d 100644 --- a/plugins/modules/database/vertica/vertica_info.py +++ b/plugins/modules/database/vertica/vertica_info.py @@ -25,7 +25,7 @@ options: port: description: Database port to connect to. - default: 5433 + default: '5433' type: str db: description: diff --git a/plugins/modules/database/vertica/vertica_role.py b/plugins/modules/database/vertica/vertica_role.py index 06dd218ed0..4ec75d7dc6 100644 --- a/plugins/modules/database/vertica/vertica_role.py +++ b/plugins/modules/database/vertica/vertica_role.py @@ -44,7 +44,7 @@ options: port: description: - Vertica cluster port to connect to. - default: 5433 + default: '5433' type: str login_user: description: diff --git a/plugins/modules/database/vertica/vertica_schema.py b/plugins/modules/database/vertica/vertica_schema.py index 749234add0..12af3e64f7 100644 --- a/plugins/modules/database/vertica/vertica_schema.py +++ b/plugins/modules/database/vertica/vertica_schema.py @@ -58,7 +58,7 @@ options: port: description: - Vertica cluster port to connect to. - default: 5433 + default: '5433' type: str login_user: description: diff --git a/plugins/modules/database/vertica/vertica_user.py b/plugins/modules/database/vertica/vertica_user.py index fed3a2a56f..0616c302bd 100644 --- a/plugins/modules/database/vertica/vertica_user.py +++ b/plugins/modules/database/vertica/vertica_user.py @@ -70,7 +70,7 @@ options: port: description: - Vertica cluster port to connect to. - default: 5433 + default: '5433' type: str login_user: description: diff --git a/plugins/modules/monitoring/datadog/datadog_monitor.py b/plugins/modules/monitoring/datadog/datadog_monitor.py index b38779407e..e9b225dce9 100644 --- a/plugins/modules/monitoring/datadog/datadog_monitor.py +++ b/plugins/modules/monitoring/datadog/datadog_monitor.py @@ -84,7 +84,6 @@ options: description: - Dictionary of scopes to silence, with timestamps or None. - Each scope will be muted until the given POSIX timestamp or forever if the value is None. - default: "" notify_no_data: description: - Whether this monitor will notify when data stops reporting. diff --git a/plugins/modules/net_tools/infinity/infinity.py b/plugins/modules/net_tools/infinity/infinity.py index ab41f680c4..bd12f85af2 100644 --- a/plugins/modules/net_tools/infinity/infinity.py +++ b/plugins/modules/net_tools/infinity/infinity.py @@ -77,8 +77,8 @@ options: description: - Network family defined by Infinity, e.g. IPv4, IPv6 and Dual stack type: str - choices: [ 4, 6, dual ] - default: 4 + choices: [ '4', '6', dual ] + default: '4' ''' EXAMPLES = r''' diff --git a/plugins/modules/system/open_iscsi.py b/plugins/modules/system/open_iscsi.py index 1c9e954922..1768a8b6df 100644 --- a/plugins/modules/system/open_iscsi.py +++ b/plugins/modules/system/open_iscsi.py @@ -28,7 +28,7 @@ options: description: - The port on which the iSCSI target process listens. type: str - default: 3260 + default: '3260' target: description: - The iSCSI target name. diff --git a/plugins/modules/system/selinux_permissive.py b/plugins/modules/system/selinux_permissive.py index 7289705192..fd90475712 100644 --- a/plugins/modules/system/selinux_permissive.py +++ b/plugins/modules/system/selinux_permissive.py @@ -20,7 +20,6 @@ options: - The domain that will be added or removed from the list of permissive domains. type: str required: true - default: '' aliases: [ name ] permissive: description: