opentelekomcloud.cloud.anti_ddos_optional_policies_info (0.14.2) — module

Get Anti-DDoS optional defense policies info

| "added in version" 0.4.0 of opentelekomcloud.cloud"

Authors: Irina Pereiaslavskaia (@irina-pereiaslavskaia)

Install collection

Install with ansible-galaxy collection install opentelekomcloud.cloud:==0.14.2


Add to requirements.yml

  collections:
    - name: opentelekomcloud.cloud
      version: 0.14.2

Description

Get optional Anti-DDoS defense policies from the OTC.


Requirements

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
# Querying Optional Anti-DDoS Defense Policies
- opentelekomcloud.cloud.anti_ddos_optional_policies_info:
  register: anti_ddos_optional_policies_info

Inputs

    
auth:
    description:
    - Dictionary containing auth information as needed by the cloud's auth plugin strategy.
      For the default I(password) plugin, this would contain I(auth_url), I(username),
      I(password), I(project_name) and any information about domains (for example, I(os_user_domain_name)
      or I(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.
    type: dict

wait:
    default: true
    description:
    - Should ansible wait until the requested resource is complete.
    type: bool

cloud:
    description:
    - Named cloud or cloud config to operate against. If I(cloud) is a string, it references
      a named cloud config as defined in an OpenStack clouds.yaml file. Provides default
      values for I(auth) and I(auth_type). This parameter is not needed if I(auth) is
      provided or if OpenStack OS_* environment variables are present. If I(cloud) is
      a dict, it contains a complete cloud configuration like would be in a section of
      clouds.yaml.
    type: raw

ca_cert:
    aliases:
    - cacert
    description:
    - A path to a CA Cert bundle that can be used as part of verifying SSL API requests.
    type: str

timeout:
    default: 180
    description:
    - How long should ansible wait for the requested resource.
    type: int

auth_type:
    description:
    - 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 I(auth) parameter should be updated accordingly.
    type: str

interface:
    aliases:
    - endpoint_type
    choices:
    - admin
    - internal
    - public
    default: public
    description:
    - Endpoint URL type to fetch from the service catalog.
    type: str

client_key:
    aliases:
    - key
    description:
    - A path to a client key to use as part of the SSL transaction.
    type: str

api_timeout:
    description:
    - 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.
    type: int

client_cert:
    aliases:
    - cert
    description:
    - A path to a client certificate to use as part of the SSL transaction.
    type: str

region_name:
    description:
    - Name of the region.
    type: str

sdk_log_path:
    description:
    - Path to the logfile of the OpenStackSDK. If empty no log is written
    type: str

sdk_log_level:
    choices:
    - ERROR
    - WARN
    - INFO
    - DEBUG
    default: WARN
    description: Log level of the OpenStackSDK
    type: str

validate_certs:
    aliases:
    - verify
    description:
    - Whether or not SSL API requests should be verified.
    - Before Ansible 2.3 this defaulted to C(yes).
    type: bool

Outputs

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