opentelekomcloud.cloud.waf_domain module -- Add/Modify/Delete WAF domain

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.waf_domain.

New in opentelekomcloud.cloud 0.0.3

Synopsis

• Add/Modify/Delete WAF domain 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.
certificate string	Specifies the certificate.
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)
name string / required	Specifies the domain name.
proxy boolean	Specifies whether a proxy is configured. Choices: false true
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
server list / elements=dictionary	Specifies the origin server information. Each element contains client_protocol (HTTP or HTTPS), server_protocol (HTTP or HTTPS), address (IP address or domain name), port (from 0 to 65535)
sip_header_list list / elements=string	Specifies the HTTP request header for identifying the real source IP address.
sip_header_name string	Specifies the type of the source IP header. Choices: "default" "cloudflare" "akamai" "custom"
state string	Should the resource be present or absent. Choices: "present" ← (default) "absent"
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

# Create Domain.
- waf_domain:
    name: test.domain.name
    server:
      - client_protocol: https
        server_protocol: https
        address: 4.3.2.1
        port: 8080
    proxy: False
  state: present

# Modify Domain.
- waf_domain:
    name: "{{ domain_name }}"
    certificate: "{{ cert_name }}"

# Delete Domain.
- waf_domain:
    name: "{{ domain_id }}"
  state: absent

Return Values

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

Key	Description
waf_domain complex	List of dictionaries describing domains matching query. Returned: On Success.
access_status integer	Specifies whether a domain name is connected to WAF. Returned: success
certificate_id string	Specifies the certificate ID. Returned: success
cname string	Specifies the CNAME value. Returned: success Sample: "efec1196267b41c399f2980ea4048517.waf.cloud.com."
hostname string	Specifies the domain name. Returned: success
id string	Specifies the instance ID. Returned: success
policy_id string	Specifies the policy ID. Returned: success
protect_status integer	Specifies the WAF mode. Returned: success
protocol string	Specifies the protocol type. Returned: success
proxy boolean	Specifies whether a proxy is configured. Returned: success
server dictionary	Specifies the origin server information. Returned: success
timestamp string	Specifies the time when a domain name is created. Returned: success

Authors

• Anton Sidelnikov (@anton-sidelnikov)

Collection links

• Issue Tracker
• Homepage
• Repository (Sources)

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