paloaltonetworks.panos.panos_dhcp_relay module – Manage dhcp relay.

Note

This module is part of the paloaltonetworks.panos collection (version 2.13.2).

To install it, use: ansible-galaxy collection install paloaltonetworks.panos. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: paloaltonetworks.panos.panos_dhcp_relay.

New in paloaltonetworks.panos 2.10.0

Synopsis

    • Manage dhcp relay on PAN-OS firewall. - Due to the implementation details of PAN-OS itself, you can use this module to create a DHCP config without ever having to use paloaltonetworks.panos.panos_dhcpfirst.

    • However, if you intend to delete an interface that was ever reference by this module, you will need to use paloaltonetworks.panos.panos_dhcp to delete the parent reference or PAN-OS’s internal validation checks will prevent the deletion, seeing that a DHCP config is referring to the interface.

Requirements

The below requirements are needed on the host that executes this module.

  • pan-python >= 0.17

  • pan-os-python >= 1.7.3

Parameters

Parameter

Comments

api_key

string

Deprecated

Use provider to specify PAN-OS connectivity instead.


The API key to use instead of generating it using username / password.

dhcp_interface

string / required

The interface name.

This is probably the same as interface.

gathered_filter

string

When state=gathered.

An advanced filtering option to filter results returned from PAN-OS.

Refer to the guide discussing gathered_filter for more information.

interface

string

The interface name for the DHCP relay.

This is probably the same as the dhcp_interface.

ip_address

string

Deprecated

Use provider to specify PAN-OS connectivity instead.


The IP address or hostname of the PAN-OS device being configured.

ipv4_enabled

boolean

ipv4_servers

list / elements=string

Relay server IP addresses.

ipv6_enabled

boolean

password

string

Deprecated

Use provider to specify PAN-OS connectivity instead.


The password to use for authentication. This is ignored if api_key is specified.

port

integer

Deprecated

Use provider to specify PAN-OS connectivity instead.


The port number to connect to the PAN-OS device on.

Default: :ansible-option-default:`443`

provider

dictionary

added in paloaltonetworks.panos 1.0.0

A dict object containing connection details.

api_key

string

The API key to use instead of generating it using username / password.

ip_address

string

The IP address or hostname of the PAN-OS device being configured.

password

string

The password to use for authentication. This is ignored if api_key is specified.

port

integer

The port number to connect to the PAN-OS device on.

Default: :ansible-option-default:`443`

serial_number

string

The serial number of a firewall to use for targeted commands. If ip_address is not a Panorama PAN-OS device, then this param is ignored.

username

string

The username to use for authentication. This is ignored if api_key is specified.

Default: :ansible-option-default:`"admin"`

state

string

username

string

Deprecated

Use provider to specify PAN-OS connectivity instead.


The username to use for authentication. This is ignored if api_key is specified.

Default: :ansible-option-default:`"admin"`

Notes

Note

  • Check mode is supported.

  • Panorama is not supported.

  • PAN-OS connectivity should be specified using provider or the classic PAN-OS connectivity params (ip_address, username, password, api_key, and port). If both are present, then the classic params are ignored.

Examples

# Create IPv4 DHCP Relay
- panos_dhcp_relay:
    provider: '{{ provider }}'
    dhcp_interface: 'ethernet1/1'
    interface: 'ethernet1/1'
    ipv4_enabled: True
    ipv4_servers:
      - '1.1.1.1'
      - '2.2.2.2'

# Delete DHCP Relay
- panos_dhcp_relay:
    provider: '{{ provider }}'
    dhcp_interface: 'ethernet1/1'
    interface: 'ethernet1/1'
    state: absent

Authors

  • Sean O’Brien (@undodelete)