opentelekomcloud.cloud.anti_ddos_optional_policies_info module -- Get Anti-DDoS optional defense policies info

Note

This module is part of the opentelekomcloud.cloud collection (version 0.14.6).

It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install opentelekomcloud.cloud. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: opentelekomcloud.cloud.anti_ddos_optional_policies_info.

New in opentelekomcloud.cloud 0.4.0

Synopsis

• Get optional Anti-DDoS defense policies from the OTC.

Requirements

The below requirements are needed on the host that executes this module.

• openstacksdk

• openstacksdk >= 0.36.0

• otcextensions

• python >= 3.6

Parameters

Parameter	Comments
api_timeout integer	How long should the socket layer wait before timing out for API calls. If this is omitted, nothing will be passed to the requests library.
auth dictionary	Dictionary containing auth information as needed by the cloud's auth plugin strategy. For the default password plugin, this would contain auth_url, username, password, project_name and any information about domains (for example, os_user_domain_name or os_project_domain_name) if the cloud supports them. For other plugins, this param will need to contain whatever parameters that auth plugin requires. This parameter is not needed if a named cloud is provided or OpenStack OS_* environment variables are present.
auth_type string	Name of the auth plugin to use. If the cloud uses something other than password authentication, the name of the plugin should be indicated here and the contents of the auth parameter should be updated accordingly.
ca_cert aliases: cacert string	A path to a CA Cert bundle that can be used as part of verifying SSL API requests.
client_cert aliases: cert string	A path to a client certificate to use as part of the SSL transaction.
client_key aliases: key string	A path to a client key to use as part of the SSL transaction.
cloud any	Named cloud or cloud config to operate against. If cloud is a string, it references a named cloud config as defined in an OpenStack clouds.yaml file. Provides default values for auth and auth_type. This parameter is not needed if auth is provided or if OpenStack OS_* environment variables are present. If cloud is a dict, it contains a complete cloud configuration like would be in a section of clouds.yaml.
interface aliases: endpoint_type string	Endpoint URL type to fetch from the service catalog. Choices: "admin" "internal" "public" ← (default)
region_name string	Name of the region.
sdk_log_level string	Log level of the OpenStackSDK Choices: "ERROR" "WARN" ← (default) "INFO" "DEBUG"
sdk_log_path string	Path to the logfile of the OpenStackSDK. If empty no log is written
timeout integer	How long should ansible wait for the requested resource. Default: 180
validate_certs aliases: verify boolean	Whether or not SSL API requests should be verified. Before Ansible 2.3 this defaulted to yes. Choices: false true
wait boolean	Should ansible wait until the requested resource is complete. Choices: false true ← (default)

Notes

Note

• The standard OpenStack environment variables, such as OS_USERNAME may be used instead of providing explicit values.

• Auth information is driven by openstacksdk, which means that values can come from a yaml config file in /etc/ansible/openstack.yaml, /etc/openstack/clouds.yaml or ~/.config/openstack/clouds.yaml, then from standard environment variables, then finally by explicit parameters in plays. More information can be found at https://docs.openstack.org/openstacksdk/

Examples

# Querying Optional Anti-DDoS Defense Policies
- opentelekomcloud.cloud.anti_ddos_optional_policies_info:
  register: anti_ddos_optional_policies_info

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key	Description
anti_ddos_optional_policies_info complex	Lists of defense policies info. Returned: On Success
connection_limited_list complex	List of limits of numbers of connections Returned: On Success
cleaning_access_pos_id integer	Position ID of access limit during cleaning Returned: success Sample: 1
new_connection_limited integer	Number of new connections of a source IP address Returned: success Sample: 80
total_connection_limited integer	Total number of connections of a source IP address Returned: success Sample: 700
extend_ddos_config complex	Information about Anti-DDoS defense policies set by users. Returned: On Success
http_packet_per_second integer	Threshold of number of HTTP requests per second Returned: success Sample: 10000
new_connection_limited integer	Number of new connections of a source IP address Returned: success Sample: 80
packet_per_second integer	Threshold of number of packets per second. Returned: success Sample: 2000
setID integer	Position ID Returned: success Sample: 33
total_connection_limited integer	Total number of connections of a source IP address Returned: success Sample: 700
traffic_per_second integer	Threshold of traffic per second (Mbit/s). Returned: success Sample: 10
http_limited_list complex	List of HTTP limits Returned: On Success
http_packet_per_second integer	Threshold of number of HTTP requests per second Returned: success Sample: 10000
http_request_pos_id integer	Position ID of number of HTTP requests Returned: success Sample: 1
traffic_limited_list complex	List of traffic limits. Returned: On Success
packet_per_second integer	Threshold of number of packets per second. Returned: success Sample: 2000
traffic_per_second integer	Threshold of traffic per second (Mbit/s). Returned: success Sample: 10
traffic_pos_id integer	Position ID of traffic. Returned: success Sample: 1

Authors

• Irina Pereiaslavskaia (@irina-pereiaslavskaia)

Collection links

• Issue Tracker
• Homepage
• Repository (Sources)

last updated: 2024-11-15 11:10 UTC - commit: 50bda984453bb05944b37f6d85b6380fcf26d10b