ansible.builtin.cp_mgmt_dns_domain_facts (v2.9.17) — module

Get dns-domain objects facts on Check Point over Web Services API

| "added in version" 2.9 of ansible.builtin"

Authors: Or Soffer (@chkp-orso)

preview | supported by community

Install Ansible via pip

Install with pip install ansible==2.9.17

Description

Get dns-domain objects facts on Check Point devices.

All operations are performed over Web Services API.

This module handles both operations, get a specific object and get several objects, For getting a specific object use the parameter 'name'.

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: show-dns-domain
  cp_mgmt_dns_domain_facts:
    name: .www.example.com
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: show-dns-domains
  cp_mgmt_dns_domain_facts:
    details_level: standard
    limit: 50
    offset: 0

Inputs

    
name:
    description:
    - Object name. This parameter is relevant only for getting a specific object.
    type: str

limit:
    description:
    - No more than that many results will be returned. This parameter is relevant only
      for getting few objects.
    type: int

order:
    description:
    - Sorts results by the given field. By default the results are sorted in the ascending
      order by name. This parameter is relevant only for getting few objects.
    suboptions:
      ASC:
        choices:
        - name
        description:
        - Sorts results by the given field in ascending order.
        type: str
      DESC:
        choices:
        - name
        description:
        - Sorts results by the given field in descending order.
        type: str
    type: list

offset:
    description:
    - Skip that many results before beginning to return them. This parameter is relevant
      only for getting few objects.
    type: int

version:
    description:
    - Version of checkpoint. If not given one, the latest version taken.
    type: str

details_level:
    choices:
    - uid
    - standard
    - full
    description:
    - The level of detail for some of the fields in the response can vary from showing
      only the UID value of the object to a fully detailed representation of the object.
    type: str

show_membership:
    description:
    - Indicates whether to calculate and show "groups" field for every object in reply.
    type: bool

Outputs

ansible_facts:
  description: The checkpoint object facts.
  returned: always.
  type: dict