pfsense_dhcp_static

pfsensible.core.pfsense_dhcp_static

        Manage pfSense DHCP static mapping

ADDED IN: version 0.5.0 of pfsensible.core

OPTIONS (= is mandatory):

- ddnsdomain
        The ddns domain
        default: null
        type: str

- ddnsdomainkey
        The ddns domain key
        default: null
        type: str

- ddnsdomainkeyalgorithm
        The ddns key algorithm
        choices: [hmac-md5, hmac-sha1, hmac-sha224, hmac-sha256, hmac-sha384, hmac-sha512]
        default: null
        type: str

- ddnsdomainkeyname
        The ddns domain key name
        default: null
        type: str

- ddnsdomainprimary
        The ddns primary domain
        default: null
        type: str

- ddnsdomainsecondary
        The ddns secondary domain
        default: null
        type: str

- defaultleasetime
        the default lease time
        default: null
        type: str

- descr
        The description
        default: null
        type: str

- dnsserver
        The dns server
        default: null
        elements: str
        type: list

- domain
        The domain
        default: null
        type: str

- domainsearchlist
        The domain search list servers
        default: null
        type: str

- filename
        The filename
        default: null
        type: str

- filename32
        The filename for 32bits
        default: null
        type: str

- filename32arm
        The filename for 32arm
        default: null
        type: str

- filename64
        The filename for 64bits
        default: null
        type: str

- filename64arm
        The filename for 64arm
        default: null
        type: str

- gateway
        The gateway
        default: null
        type: str

- hostname
        The hostname
        default: null
        type: str

- ipaddr
        The IP address
        default: null
        type: str

- ldap
        The ldap server
        default: null
        type: str

- macaddr
        The mac address.  At least one of `name' or `macaddr' is
        required.
        default: null
        type: str

- maxleasetime
        The max lease time
        default: null
        type: str

- name
        The client name identifier.  At least one of `name' or
        `macaddr' is required.
        aliases: [cid]
        default: null
        type: str

- netif
        The network interface.  This defaults to the only enabled DHCP
        interface if there is only one.
        default: null
        type: str

- nextserver
        The next server
        default: null
        type: str

- ntpserver
        The ntpserver
        default: null
        elements: str
        type: list

- numberoptions
        The number options
        default: null
        type: str

- rootpath
        The roothpath
        default: null
        type: str

- state
        State in which to leave the configuration
        choices: [present, absent]
        default: present
        type: str

- tftp
        The TFTP server
        default: null
        type: str

- uefihttpboot
        UEFI HTTPBoot URL
        default: null
        type: str
        added in: version 0.5.2 of pfsensible.core


- winsserver
        The WINS server
        default: null
        elements: str
        type: list


AUTHOR: Carlos Rodrigues (@cmarodrigues)

METADATA:
  metadata_version: '1.1'
  status:
  - preview
  supported_by: community

EXAMPLES:

- name: Create DHCP static mapping
  pfsense_dhcp_static:
    name: "test"
    macaddr: "aa:aa:aa:aa:aa:aa"
    ipaddr: "192.168.1.10"
    state: present

- name: Remove DHCP static mapping
  pfsense_dhcp_static:
    name: "test"
    state: absent


RETURN VALUES:
- netif
        The selected interface
        returned: success
        sample: lan
        type: str