damex.cloudflare.cloudflare_pages_project_info module – Ensure Cloudflare Pages project information is gathered

Note

This module is part of the damex.cloudflare collection (version 1.2.3).

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

Synopsis

  • Gathers information about Cloudflare Pages projects.

  • Returns information about all projects or a specific project.

Parameters

Parameter

Comments

account_api_key

string

Cloudflare account API key.

Required together with account_email if api_token is not provided.

account_email

string

Cloudflare account email.

Required together with account_api_key if api_token is not provided.

account_id

string

Cloudflare account identifier.

Required if account_name is not provided.

account_name

string

Cloudflare account name.

Required if account_id is not provided.

Resolved to account identifier via the Cloudflare API.

api_token

string

Cloudflare API token.

Required if account_email and account_api_key are not provided.

Can be specified in CLOUDFLARE_TOKEN environment variable.

name

string

Project name to query.

If not specified, all projects are returned.

Attributes

Attribute

Support

Description

check_mode

Support: full

Supports check mode.

diff_mode

Support: none

Does not support diff mode.

Examples

- name: Ensure Pages project information is gathered
  damex.cloudflare.cloudflare_pages_project_info:
    account_name: damex
    api_token: "{{ cloudflare_api_token }}"
  register: cloudflare_pages_project_information

- name: Ensure specific Pages project information is gathered
  damex.cloudflare.cloudflare_pages_project_info:
    name: my-docs
    account_name: damex
    api_token: "{{ cloudflare_api_token }}"
  register: cloudflare_pages_project_information

Return Values

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

Key

Description

projects

list / elements=dictionary

Pages project information.

Returned: always

domains

list / elements=string

Custom domains.

Returned: always

name

string

Project name.

Returned: always

production_branch

string

Production branch.

Returned: always

subdomain

string

Pages subdomain.

Returned: always

Authors

  • Roman Kuzmitskii (@damex)