check_point.gaia.cp_gaia_dhcp_server (5.0.1) — module

Install collection

Install with ansible-galaxy collection install check_point.gaia:==5.0.1

Add to requirements.yml

  collections:
    - name: check_point.gaia
      version: 5.0.1

Description

Change DHCP server settings.

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Change DHCP server settings
  check_point.gaia.cp_gaia_dhcp_server:
    enabled: False
    subnets: [
        {"subnet": "4.5.6.0",
        "netmask": 24,
        "max_lease": 86400,
        "default_lease": 43200,
        "default_gateway": "4.5.6.1",
        "ip_pools": [{"start": "4.5.6.5", "end": "4.5.6.7", "enabled": True, "include": "include"}],
        "dns": {"domain_name": "my_domain_name", "primary": "8.8.8.8", "secondary": "8.8.8.8", "tertiary": "8.8.4.4"},
        "enabled": True}
    ]

Inputs

    
enabled:
    description: DHCP server status.
    required: false
    type: bool

subnets:
    description: Subnets.
    elements: dict
    required: false
    suboptions:
      default_gateway:
        description: The IPv4 address of the default gateway for the DHCP clients.
        required: false
        type: str
      default_lease:
        default: 43200
        description: The default lease that the server allocates, in seconds.
        required: false
        type: int
      dns:
        description: DNS configuration.
        required: false
        suboptions:
          domain_name:
            description: Domain name.
            required: false
            type: str
          primary:
            description: The IPv4 address of the Primary DNS server for the DHCP clients.
            required: false
            type: str
          secondary:
            description: The IPv4 address of the Secondary DNS server for the DHCP clients
              (to use if the primary DNS server does not respond).
            required: false
            type: str
          tertiary:
            description: The IPv4 address of the Tertiary DNS server for the DHCP clients
              (to use if the primary and secondary DNS servers do not respond).
            required: false
            type: str
        type: dict
      enabled:
        description: Enable DHCP on this subnet.
        required: false
        type: bool
      ip_pools:
        description: Range of IPv4 addresses that the server assigns to hosts.
        elements: dict
        required: false
        suboptions:
          enabled:
            description: Enables or disables the DHCP Server for this subnet IP pool.
            required: false
            type: bool
          end:
            description: The last IPv4 address of the range.
            required: false
            type: str
          include:
            choices:
            - include
            - exclude
            description: Specifies whether to include or exclude this range of IPv4 addresses
              in the IP pool.
            required: false
            type: str
          start:
            description: The first IPv4 address of the range.
            required: false
            type: str
        type: list
      max_lease:
        default: 86400
        description: The longest lease that the server can allocate, in seconds.
        required: false
        type: int
      netmask:
        description: Subnet mask.
        required: false
        type: int
      subnet:
        description: IPv4 address for the subnet.
        required: false
        type: str
    type: list

version:
    description: Gaia API version for example 1.6.
    required: false
    type: str

Outputs

dhcp_server:
  description: The checkpoint object updated.
  returned: always.
  type: dict