pfsense_interface

pfsensible.core.pfsense_interface

        Manage pfSense interfaces.

ADDED IN: version 0.1.0 of pfsensible.core

OPTIONS (= is mandatory):

- blockbogons
        Blocks traffic from reserved IP addresses (but not RFC 1918)
        or not yet assigned by IANA.
        default: null
        type: bool

- blockpriv
        Blocks traffic from IP addresses that are reserved for private
        networks.
        default: null
        type: bool

= descr
        Description (name) for the interface.
        type: str

- enable
        Enable interface.
        default: false
        type: bool

- interface
        Network port to which assign the interface.
        default: null
        type: str

- interface_descr
        Network port descr to which assign the interface.
        default: null
        type: str

- ipv4_address
        IPv4 Address.
        default: null
        type: str

- ipv4_gateway
        IPv4 gateway for this interface.
        default: null
        type: str

- ipv4_prefixlen
        IPv4 subnet prefix length.
        default: 24
        type: int

- ipv4_type
        IPv4 Configuration Type.
        choices: [none, static, dhcp]
        default: none
        type: str

- ipv6_address
        IPv6 Address.
        default: null
        type: str

- ipv6_gateway
        IPv6 gateway for this interface.
        default: null
        type: str

- ipv6_prefixlen
        IPv6 subnet prefix length.
        default: 128
        type: int

- ipv6_type
        IPv4 Configuration Type.
        choices: [none, static, slaac]
        default: none
        type: str

- mac
        Used to modify ("spoof") the MAC address of this interface.
        default: null
        type: str

- mss
        MSS clamping for TCP connections.
        default: null
        type: int

- mtu
        Maximum transmission unit
        default: null
        type: int

- speed_duplex
        Set speed and duplex mode for this interface.
        default: autoselect
        type: str

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


AUTHOR: Frederic Bor (@f-bor)

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

EXAMPLES:

- name: Add interface
  pfsense_interface:
    descr: voice
    interface: mvneta0.100
    enable: True

- name: Remove interface
  pfsense_interface:
    state: absent
    descr: voice
    interface: mvneta0.100


RETURN VALUES:
- commands
        The set of commands that would be pushed to the remote device
        (if pfSense had a CLI).
        returned: always
        sample: ['create interface ''voice'', port=''mvneta0.100'', speed_duplex=''autoselect'', enable=''True''',
          delete interface 'voice']
        type: list

- ifname
        The pseudo-device name of the interface.
        returned: always
        sample: opt1
        type: str