damex.cloudflare.cloudflare_zones role – Ensure Cloudflare zones.

Note

This role is part of the damex.cloudflare collection (version 1.0.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 damex.cloudflare.

To use it in a playbook, specify: damex.cloudflare.cloudflare_zones.

Entry point main – Ensure Cloudflare zones.

Synopsis

  • Ensure Cloudflare zones.

Parameters

Parameter

Comments

cloudflare_zones

list / elements=dictionary / required

Zones to ensure.

account_api_key

string

Cloudflare account API key.

account_email

string

Cloudflare account email.

account_name

string

Cloudflare account name.

always_https

boolean

Always HTTPS redirect.

Choices:

  • false

  • true

api_token

string

Cloudflare API token.

jump_start

boolean

Zone jump start.

Choices:

  • false

  • true

min_tls_version

string

Minimum TLS version.

Choices:

  • "1.0"

  • "1.1"

  • "1.2"

  • "1.3"

name

string / required

Zone domain name.

ssl_mode

string

SSL mode.

Choices:

  • "off"

  • "flexible"

  • "full"

  • "strict"

  • "origin_pull"

state

string

Zone state.

Choices:

  • "absent"

  • "present"

type

string

Zone type.

universal_ssl

boolean

Universal SSL.

Choices:

  • false

  • true

cloudflare_zones_account_api_key

string

Cloudflare account API key.

cloudflare_zones_account_email

string

Cloudflare account email.

cloudflare_zones_account_name

string / required

Cloudflare account name.

cloudflare_zones_always_https

boolean

Always HTTPS redirect.

Choices:

  • false

  • true

cloudflare_zones_api_token

string

Cloudflare API token.

cloudflare_zones_default_jump_start

boolean

Default zone jump start.

Choices:

  • false

  • true

cloudflare_zones_default_state

string

Default zone state.

Choices:

  • "absent"

  • "present"

cloudflare_zones_default_type

string

Default zone type.

cloudflare_zones_min_tls_version

string

Minimum TLS version.

Choices:

  • "1.0"

  • "1.1"

  • "1.2"

  • "1.3"

cloudflare_zones_ssl_mode

string

SSL mode.

Choices:

  • "off"

  • "flexible"

  • "full"

  • "strict"

  • "origin_pull"

cloudflare_zones_universal_ssl

boolean

Universal SSL.

Choices:

  • false

  • true

Examples

- name: Ensure cloudflare zones
  hosts: all
  tasks:
    - name: Ensure cloudflare zones
      ansible.builtin.import_role:
        name: damex.cloudflare.cloudflare_zones
      vars:
        cloudflare_zones_account_name: my-account
        cloudflare_zones_api_token: "{{ cloudflare_api_token }}"
        cloudflare_zones:
          - name: example.com
          - name: example.org
            state: absent