diff --git a/plugins/modules/cloud/oneandone/oneandone_firewall_policy.py b/plugins/modules/cloud/oneandone/oneandone_firewall_policy.py index b37c2c7c5b..3f545e6eb7 100644 --- a/plugins/modules/cloud/oneandone/oneandone_firewall_policy.py +++ b/plugins/modules/cloud/oneandone/oneandone_firewall_policy.py @@ -29,52 +29,60 @@ options: description: - Define a firewall policy state to create, remove, or update. required: false + type: str default: 'present' choices: [ "present", "absent", "update" ] auth_token: description: - Authenticating API token provided by 1&1. - required: true + type: str api_url: description: - Custom API URL. Overrides the 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 - required: true + type: str firewall_policy: description: - The identifier (id or name) of the firewall policy used with update state. - required: true + type: str rules: description: - A list of rules that will be set for the firewall policy. Each rule must contain protocol parameter, in addition to three optional parameters (port_from, port_to, and source) + type: list add_server_ips: description: - A list of server identifiers (id or name) to be assigned to a firewall policy. Used in combination with update state. + type: list required: false 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 required: false add_rules: description: - A list of rules that will be added to an existing firewall policy. It is syntax is the same as the one used for rules parameter. Used in combination with update state. + type: list required: false remove_rules: description: - A list of rule ids that will be removed from an existing firewall policy. Used in combination with update state. + type: list required: false description: description: - Firewall policy description. maxLength=256 + type: str required: false wait: description: @@ -85,10 +93,12 @@ options: wait_timeout: description: - how long before wait gives up, in seconds + type: int default: 600 wait_interval: description: - Defines the number of seconds to wait when using the _wait_for methods + type: int default: 5 requirements: diff --git a/plugins/modules/cloud/oneandone/oneandone_load_balancer.py b/plugins/modules/cloud/oneandone/oneandone_load_balancer.py index c345c16dc2..104302b9fa 100644 --- a/plugins/modules/cloud/oneandone/oneandone_load_balancer.py +++ b/plugins/modules/cloud/oneandone/oneandone_load_balancer.py @@ -28,90 +28,99 @@ options: state: description: - Define a load balancer state to create, remove, or update. + type: str required: false default: 'present' choices: [ "present", "absent", "update" ] auth_token: description: - Authenticating API token provided by 1&1. - required: true + type: str load_balancer: description: - The identifier (id or name) of the load balancer used with update state. - required: true + type: str api_url: description: - Custom API URL. Overrides the 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 - required: true + type: str health_check_test: description: - Type of the health check. At the moment, HTTP is not allowed. + type: str choices: [ "NONE", "TCP", "HTTP", "ICMP" ] - required: true health_check_interval: description: - Health check period in seconds. minimum=5, maximum=300, multipleOf=1 - required: true + type: str health_check_path: 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. - required: true type: bool persistence_time: description: - Persistence time in seconds. Required if persistence is enabled. minimum=30, maximum=1200, multipleOf=1 - required: true + type: str method: description: - Balancing procedure. + type: str choices: [ "ROUND_ROBIN", "LEAST_CONNECTIONS" ] - required: true datacenter: description: - ID or country code of the datacenter where the load balancer will be created. - default: US + - If not specified, it defaults to I(US). + type: str choices: [ "US", "ES", "DE", "GB" ] required: false rules: description: - A list of rule objects that will be set for the load balancer. Each rule must contain protocol, port_balancer, and port_server parameters, in addition to source parameter, which is optional. - required: true + type: list description: 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 update state. + type: list required: false remove_server_ips: description: - A list of server IP ids to be unassigned from a load balancer. Used in combination with update state. + type: list required: false add_rules: description: - A list of rules that will be added to an existing load balancer. It is syntax is the same as the one used for rules parameter. Used in combination with update state. + type: list required: false remove_rules: description: - A list of rule ids that will be removed from an existing load balancer. Used in combination with update state. + type: list required: false wait: description: @@ -122,10 +131,12 @@ options: wait_timeout: description: - how long before wait gives up, in seconds + type: int default: 600 wait_interval: description: - Defines the number of seconds to wait when using the _wait_for methods + type: int default: 5 requirements: diff --git a/plugins/modules/cloud/oneandone/oneandone_monitoring_policy.py b/plugins/modules/cloud/oneandone/oneandone_monitoring_policy.py index 648ac32345..7488b7aeab 100644 --- a/plugins/modules/cloud/oneandone/oneandone_monitoring_policy.py +++ b/plugins/modules/cloud/oneandone/oneandone_monitoring_policy.py @@ -29,37 +29,40 @@ options: state: description: - Define a monitoring policy's state to create, remove, update. + type: str required: false default: present choices: [ "present", "absent", "update" ] auth_token: description: - Authenticating API token provided by 1&1. - required: true + type: str api_url: description: - Custom API URL. Overrides the 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 - required: true + type: str monitoring_policy: description: - The identifier (id or name) of the monitoring policy used with update state. - required: true + type: str agent: description: - Set true for using agent. - required: true + type: str email: description: - User's email. maxLength=128 - required: true + type: str description: description: - Monitoring policy description. maxLength=256 + type: str required: false thresholds: description: @@ -67,7 +70,7 @@ options: which both have alert and value suboptions. Warning is used to set limits for warning alerts, critical is used to set critical alerts. alert enables alert, and value is used to advise when the value is exceeded. - required: true + type: list suboptions: cpu: description: @@ -92,7 +95,7 @@ options: ports: description: - Array of ports that will be monitoring. - required: true + type: list suboptions: protocol: description: @@ -115,7 +118,7 @@ options: processes: description: - Array of processes that will be monitoring. - required: true + type: list suboptions: process: description: @@ -129,34 +132,42 @@ options: add_ports: description: - Ports to add to the monitoring policy. + type: list required: false add_processes: description: - Processes to add to the monitoring policy. + type: list required: false add_servers: description: - Servers to add to the monitoring policy. + type: list required: false remove_ports: description: - Ports to remove from the monitoring policy. + type: list required: false remove_processes: description: - Processes to remove from the monitoring policy. + type: list required: false remove_servers: description: - Servers to remove from the monitoring policy. + type: list required: false update_ports: description: - Ports to be updated on the monitoring policy. + type: list required: false update_processes: description: - Processes to be updated on the monitoring policy. + type: list required: false wait: description: @@ -167,10 +178,12 @@ options: wait_timeout: description: - how long before wait gives up, in seconds + type: int default: 600 wait_interval: description: - Defines the number of seconds to wait when using the _wait_for methods + type: int default: 5 requirements: diff --git a/plugins/modules/cloud/oneandone/oneandone_private_network.py b/plugins/modules/cloud/oneandone/oneandone_private_network.py index d8a989e4cc..ebd44130d5 100644 --- a/plugins/modules/cloud/oneandone/oneandone_private_network.py +++ b/plugins/modules/cloud/oneandone/oneandone_private_network.py @@ -28,44 +28,53 @@ options: state: description: - Define a network's state to create, remove, or update. + type: str required: false default: 'present' choices: [ "present", "absent", "update" ] auth_token: description: - Authenticating API token provided by 1&1. - required: true + type: str private_network: description: - The identifier (id or name) of the network used with update state. - required: true + type: str api_url: description: - Custom API URL. Overrides the 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. - required: true + type: str description: description: - Set a description for the network. + type: str datacenter: description: - The identifier of the datacenter where the private network will be created + type: str + choices: [US, ES, DE, GB] network_address: description: - Set a private network space, i.e. 192.168.1.0 + type: str subnet_mask: description: - Set the netmask for the private network, i.e. 255.255.255.0 + type: str add_members: description: - List of server identifiers (name or id) to be added to the private network. + type: list remove_members: description: - List of server identifiers (name or id) to be removed from the private network. + type: list wait: description: - wait for the instance to be in state 'running' before returning @@ -75,10 +84,12 @@ options: wait_timeout: description: - how long before wait gives up, in seconds + type: int default: 600 wait_interval: description: - Defines the number of seconds to wait when using the _wait_for methods + type: int default: 5 requirements: diff --git a/plugins/modules/cloud/oneandone/oneandone_public_ip.py b/plugins/modules/cloud/oneandone/oneandone_public_ip.py index 45bd3fae5f..62cb62da63 100644 --- a/plugins/modules/cloud/oneandone/oneandone_public_ip.py +++ b/plugins/modules/cloud/oneandone/oneandone_public_ip.py @@ -28,36 +28,43 @@ options: state: description: - Define a public ip state to create, remove, or update. + type: str required: false default: 'present' choices: [ "present", "absent", "update" ] auth_token: description: - Authenticating API token provided by 1&1. - required: true + type: str api_url: description: - Custom API URL. Overrides the 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 will be 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. - required: true + type: str wait: description: - wait for the instance to be in state 'running' before returning @@ -67,10 +74,12 @@ options: wait_timeout: description: - how long before wait gives up, in seconds + type: int default: 600 wait_interval: description: - Defines the number of seconds to wait when using the _wait_for methods + type: int default: 5 requirements: diff --git a/plugins/modules/cloud/oneandone/oneandone_server.py b/plugins/modules/cloud/oneandone/oneandone_server.py index 58b7e7ce3a..1e6caab5eb 100644 --- a/plugins/modules/cloud/oneandone/oneandone_server.py +++ b/plugins/modules/cloud/oneandone/oneandone_server.py @@ -28,80 +28,98 @@ options: state: description: - Define a server's state to create, remove, start or stop it. + type: str default: present choices: [ "present", "absent", "running", "stopped" ] auth_token: description: - Authenticating API token provided by 1&1. Overrides the ONEANDONE_AUTH_TOKEN environment variable. - required: true + type: str api_url: description: - Custom API URL. Overrides the ONEANDONE_API_URL environment variable. + type: str datacenter: description: - The datacenter location. + type: str default: US choices: [ "US", "ES", "DE", "GB" ] hostname: description: - The hostname or ID of the server. Only used when state is 'present'. + type: str description: description: - The description of the server. + type: str appliance: description: - The operating system name or ID for the server. It is required only for 'present' state. + type: str fixed_instance_size: description: - The instance size name or ID of the server. It is required only for 'present' state, and it is mutually exclusive with vcore, cores_per_processor, ram, and hdds parameters. - required: true - choices: [ "S", "M", "L", "XL", "XXL", "3XL", "4XL", "5XL" ] + - 'The available choices are: C(S), C(M), C(L), C(XL), C(XXL), C(3XL), C(4XL), C(5XL)' + type: str vcore: description: - The total number of processors. It must be provided with cores_per_processor, ram, and hdds parameters. + type: int cores_per_processor: description: - The number of cores per processor. It must be provided with vcore, ram, and hdds parameters. + type: int ram: description: - The amount of RAM memory. It must be provided with with vcore, cores_per_processor, and hdds parameters. + type: float hdds: description: - A list of hard disks with nested "size" and "is_main" properties. It must be provided with vcore, cores_per_processor, and ram parameters. + type: list private_network: description: - The private network name or ID. + type: str firewall_policy: description: - The firewall policy name or ID. + type: str load_balancer: description: - The load balancer name or ID. + type: str monitoring_policy: description: - The monitoring policy name or ID. + type: str server: description: - Server identifier (ID or hostname). It is required for all states except 'running' and 'present'. + type: str count: description: - The number of servers to create. + type: int default: 1 ssh_key: description: - User's public SSH key (contents, not path). + type: raw server_type: description: - The type of server to be built. + type: str default: "cloud" choices: [ "cloud", "baremetal", "k8s_node" ] wait: @@ -115,10 +133,12 @@ options: wait_timeout: description: - how long before wait gives up, in seconds + type: int default: 600 wait_interval: description: - Defines the number of seconds to wait when using the wait_for methods + type: int default: 5 auto_increment: description: diff --git a/tests/sanity/ignore-2.10.txt b/tests/sanity/ignore-2.10.txt index c38b1109ce..97d36f0ad5 100644 --- a/tests/sanity/ignore-2.10.txt +++ b/tests/sanity/ignore-2.10.txt @@ -116,32 +116,11 @@ plugins/modules/cloud/lxd/lxd_profile.py validate-modules:doc-default-does-not-m plugins/modules/cloud/lxd/lxd_profile.py validate-modules:doc-missing-type plugins/modules/cloud/lxd/lxd_profile.py validate-modules:parameter-type-not-in-doc plugins/modules/cloud/misc/rhevm.py validate-modules:parameter-state-invalid-choice -plugins/modules/cloud/oneandone/oneandone_firewall_policy.py validate-modules:doc-required-mismatch plugins/modules/cloud/oneandone/oneandone_firewall_policy.py validate-modules:parameter-list-no-elements -plugins/modules/cloud/oneandone/oneandone_firewall_policy.py validate-modules:parameter-type-not-in-doc -plugins/modules/cloud/oneandone/oneandone_load_balancer.py validate-modules:doc-default-does-not-match-spec -plugins/modules/cloud/oneandone/oneandone_load_balancer.py validate-modules:doc-missing-type -plugins/modules/cloud/oneandone/oneandone_load_balancer.py validate-modules:doc-required-mismatch plugins/modules/cloud/oneandone/oneandone_load_balancer.py validate-modules:parameter-list-no-elements -plugins/modules/cloud/oneandone/oneandone_load_balancer.py validate-modules:parameter-type-not-in-doc -plugins/modules/cloud/oneandone/oneandone_monitoring_policy.py validate-modules:doc-required-mismatch plugins/modules/cloud/oneandone/oneandone_monitoring_policy.py validate-modules:parameter-list-no-elements -plugins/modules/cloud/oneandone/oneandone_monitoring_policy.py validate-modules:parameter-type-not-in-doc -plugins/modules/cloud/oneandone/oneandone_private_network.py validate-modules:doc-choices-do-not-match-spec -plugins/modules/cloud/oneandone/oneandone_private_network.py validate-modules:doc-missing-type -plugins/modules/cloud/oneandone/oneandone_private_network.py validate-modules:doc-required-mismatch plugins/modules/cloud/oneandone/oneandone_private_network.py validate-modules:parameter-list-no-elements -plugins/modules/cloud/oneandone/oneandone_private_network.py validate-modules:parameter-type-not-in-doc -plugins/modules/cloud/oneandone/oneandone_public_ip.py validate-modules:doc-choices-do-not-match-spec -plugins/modules/cloud/oneandone/oneandone_public_ip.py validate-modules:doc-default-does-not-match-spec -plugins/modules/cloud/oneandone/oneandone_public_ip.py validate-modules:doc-missing-type -plugins/modules/cloud/oneandone/oneandone_public_ip.py validate-modules:doc-required-mismatch -plugins/modules/cloud/oneandone/oneandone_public_ip.py validate-modules:parameter-type-not-in-doc -plugins/modules/cloud/oneandone/oneandone_server.py validate-modules:doc-choices-do-not-match-spec -plugins/modules/cloud/oneandone/oneandone_server.py validate-modules:doc-missing-type -plugins/modules/cloud/oneandone/oneandone_server.py validate-modules:doc-required-mismatch plugins/modules/cloud/oneandone/oneandone_server.py validate-modules:parameter-list-no-elements -plugins/modules/cloud/oneandone/oneandone_server.py validate-modules:parameter-type-not-in-doc plugins/modules/cloud/online/online_server_facts.py validate-modules:doc-required-mismatch plugins/modules/cloud/online/online_server_facts.py validate-modules:return-syntax-error plugins/modules/cloud/online/online_server_info.py validate-modules:doc-required-mismatch diff --git a/tests/sanity/ignore-2.11.txt b/tests/sanity/ignore-2.11.txt index c38b1109ce..97d36f0ad5 100644 --- a/tests/sanity/ignore-2.11.txt +++ b/tests/sanity/ignore-2.11.txt @@ -116,32 +116,11 @@ plugins/modules/cloud/lxd/lxd_profile.py validate-modules:doc-default-does-not-m plugins/modules/cloud/lxd/lxd_profile.py validate-modules:doc-missing-type plugins/modules/cloud/lxd/lxd_profile.py validate-modules:parameter-type-not-in-doc plugins/modules/cloud/misc/rhevm.py validate-modules:parameter-state-invalid-choice -plugins/modules/cloud/oneandone/oneandone_firewall_policy.py validate-modules:doc-required-mismatch plugins/modules/cloud/oneandone/oneandone_firewall_policy.py validate-modules:parameter-list-no-elements -plugins/modules/cloud/oneandone/oneandone_firewall_policy.py validate-modules:parameter-type-not-in-doc -plugins/modules/cloud/oneandone/oneandone_load_balancer.py validate-modules:doc-default-does-not-match-spec -plugins/modules/cloud/oneandone/oneandone_load_balancer.py validate-modules:doc-missing-type -plugins/modules/cloud/oneandone/oneandone_load_balancer.py validate-modules:doc-required-mismatch plugins/modules/cloud/oneandone/oneandone_load_balancer.py validate-modules:parameter-list-no-elements -plugins/modules/cloud/oneandone/oneandone_load_balancer.py validate-modules:parameter-type-not-in-doc -plugins/modules/cloud/oneandone/oneandone_monitoring_policy.py validate-modules:doc-required-mismatch plugins/modules/cloud/oneandone/oneandone_monitoring_policy.py validate-modules:parameter-list-no-elements -plugins/modules/cloud/oneandone/oneandone_monitoring_policy.py validate-modules:parameter-type-not-in-doc -plugins/modules/cloud/oneandone/oneandone_private_network.py validate-modules:doc-choices-do-not-match-spec -plugins/modules/cloud/oneandone/oneandone_private_network.py validate-modules:doc-missing-type -plugins/modules/cloud/oneandone/oneandone_private_network.py validate-modules:doc-required-mismatch plugins/modules/cloud/oneandone/oneandone_private_network.py validate-modules:parameter-list-no-elements -plugins/modules/cloud/oneandone/oneandone_private_network.py validate-modules:parameter-type-not-in-doc -plugins/modules/cloud/oneandone/oneandone_public_ip.py validate-modules:doc-choices-do-not-match-spec -plugins/modules/cloud/oneandone/oneandone_public_ip.py validate-modules:doc-default-does-not-match-spec -plugins/modules/cloud/oneandone/oneandone_public_ip.py validate-modules:doc-missing-type -plugins/modules/cloud/oneandone/oneandone_public_ip.py validate-modules:doc-required-mismatch -plugins/modules/cloud/oneandone/oneandone_public_ip.py validate-modules:parameter-type-not-in-doc -plugins/modules/cloud/oneandone/oneandone_server.py validate-modules:doc-choices-do-not-match-spec -plugins/modules/cloud/oneandone/oneandone_server.py validate-modules:doc-missing-type -plugins/modules/cloud/oneandone/oneandone_server.py validate-modules:doc-required-mismatch plugins/modules/cloud/oneandone/oneandone_server.py validate-modules:parameter-list-no-elements -plugins/modules/cloud/oneandone/oneandone_server.py validate-modules:parameter-type-not-in-doc plugins/modules/cloud/online/online_server_facts.py validate-modules:doc-required-mismatch plugins/modules/cloud/online/online_server_facts.py validate-modules:return-syntax-error plugins/modules/cloud/online/online_server_info.py validate-modules:doc-required-mismatch diff --git a/tests/sanity/ignore-2.9.txt b/tests/sanity/ignore-2.9.txt index 7e51df747e..1b920062fc 100644 --- a/tests/sanity/ignore-2.9.txt +++ b/tests/sanity/ignore-2.9.txt @@ -94,21 +94,6 @@ plugins/modules/cloud/misc/helm.py validate-modules:deprecation-mismatch plugins/modules/cloud/misc/helm.py validate-modules:invalid-documentation plugins/modules/cloud/misc/ovirt.py validate-modules:deprecation-mismatch plugins/modules/cloud/misc/ovirt.py validate-modules:invalid-documentation -plugins/modules/cloud/oneandone/oneandone_firewall_policy.py validate-modules:parameter-type-not-in-doc -plugins/modules/cloud/oneandone/oneandone_load_balancer.py validate-modules:doc-default-does-not-match-spec -plugins/modules/cloud/oneandone/oneandone_load_balancer.py validate-modules:doc-missing-type -plugins/modules/cloud/oneandone/oneandone_load_balancer.py validate-modules:parameter-type-not-in-doc -plugins/modules/cloud/oneandone/oneandone_monitoring_policy.py validate-modules:parameter-type-not-in-doc -plugins/modules/cloud/oneandone/oneandone_private_network.py validate-modules:doc-choices-do-not-match-spec -plugins/modules/cloud/oneandone/oneandone_private_network.py validate-modules:doc-missing-type -plugins/modules/cloud/oneandone/oneandone_private_network.py validate-modules:parameter-type-not-in-doc -plugins/modules/cloud/oneandone/oneandone_public_ip.py validate-modules:doc-choices-do-not-match-spec -plugins/modules/cloud/oneandone/oneandone_public_ip.py validate-modules:doc-default-does-not-match-spec -plugins/modules/cloud/oneandone/oneandone_public_ip.py validate-modules:doc-missing-type -plugins/modules/cloud/oneandone/oneandone_public_ip.py validate-modules:parameter-type-not-in-doc -plugins/modules/cloud/oneandone/oneandone_server.py validate-modules:doc-choices-do-not-match-spec -plugins/modules/cloud/oneandone/oneandone_server.py validate-modules:doc-missing-type -plugins/modules/cloud/oneandone/oneandone_server.py validate-modules:parameter-type-not-in-doc plugins/modules/cloud/online/online_server_facts.py validate-modules:deprecation-mismatch plugins/modules/cloud/online/online_server_facts.py validate-modules:invalid-documentation plugins/modules/cloud/online/online_server_facts.py validate-modules:return-syntax-error