anti_ddos_optional_policies_info

updated: None

anti_ddos_optional_policies_info

Note

This plugin is part of the opentelekomcloud.cloud collection (version 0.0.1).

To install it use: ansible-galaxy collection install opentelekomcloud.cloud.

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

New in version 0.4.0: of opentelekomcloud.cloud

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 Choices/Defaults 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
string
A path to a CA Cert bundle that can be used as part of verifying SSL API requests.

aliases: cacert
client_cert
string
A path to a client certificate to use as part of the SSL transaction.

aliases: cert
client_key
string
A path to a client key to use as part of the SSL transaction.

aliases: key
cloud
raw
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
string
    Choices:
  • admin
  • internal
  • public ←
Endpoint URL type to fetch from the service catalog.

aliases: endpoint_type
region_name
string
Name of the region.
timeout
integer
Default:
180
How long should ansible wait for the requested resource.
validate_certs
boolean
    Choices:
  • no ←
  • yes
Whether or not SSL API requests should be verified.
Before Ansible 2.3 this defaulted to yes.

aliases: verify
wait
boolean
    Choices:
  • no
  • yes ←
Should ansible wait until the requested resource is complete.

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 Returned Description
anti_ddos_optional_policies_info
complex
On Success
Lists of defense policies info.
 
connection_limited_list
complex
On Success
List of limits of numbers of connections
   
cleaning_access_pos_id
integer
success
Position ID of access limit during cleaning

Sample:
1
   
new_connection_limited
integer
success
Number of new connections of a source IP address

Sample:
80
   
total_connection_limited
integer
success
Total number of connections of a source IP address

Sample:
700
 
extend_ddos_config
complex
On Success
Information about Anti-DDoS defense policies set by users.
   
http_packet_per_second
integer
success
Threshold of number of HTTP requests per second

Sample:
10000
   
new_connection_limited
integer
success
Number of new connections of a source IP address

Sample:
80
   
packet_per_second
integer
success
Threshold of number of packets per second.

Sample:
2000
   
setID
integer
success
Position ID

Sample:
33
   
total_connection_limited
integer
success
Total number of connections of a source IP address

Sample:
700
   
traffic_per_second
integer
success
Threshold of traffic per second (Mbit/s).

Sample:
10
 
http_limited_list
complex
On Success
List of HTTP limits
   
http_packet_per_second
integer
success
Threshold of number of HTTP requests per second

Sample:
10000
   
http_request_pos_id
integer
success
Position ID of number of HTTP requests

Sample:
1
 
traffic_limited_list
complex
On Success
List of traffic limits.
   
packet_per_second
integer
success
Threshold of number of packets per second.

Sample:
2000
   
traffic_per_second
integer
success
Threshold of traffic per second (Mbit/s).

Sample:
10
   
traffic_pos_id
integer
success
Position ID of traffic.

Sample:
1


Authors

  • Irina Pereiaslavskaia (@irina-pereiaslavskaia)

updated: None