check_point.gaia.cp_gaia_physical_interfaces_facts (5.0.1) — module

Show Physical interface/s.

| "added in version" 1.0.0 of check_point.gaia"

Authors: Yuval Feiger (@chkp-yuvalfe)

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

Show Physical interfaces.

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Show physical interfaces
  check_point.gaia.cp_gaia_physical_interfaces_facts:
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Show physical interface by specifying it name
  check_point.gaia.cp_gaia_physical_interfaces_facts:
    name: eth0

Inputs

    
name:
    description: Interface name to show. If not specified, all physical interfaces information
      is returned.
    required: false
    type: str

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

Outputs

ansible_facts:
  contains:
    objects:
      contains:
        auto_negotiation:
          description: Interface auto negotiation.
          returned: always
          type: bool
        comments:
          description: Interface Comments.
          returned: always
          type: str
        dhcp:
          contains:
            enabled:
              description: Enable DHCP on this interface.
              returned: always
              type: bool
            leasetime:
              description:
              - Specifies the lease time, in seconds, when requesting for an IP address.
                Default value is "default" - according to the server.
              returned: always
              type: int
            reacquire_timeout:
              description:
              - When trying to reacquire the last ip address, The reacquire-timeout
                statement sets the time, in seconds, that must elapse after the first
                try to reacquire the old address before it gives up and tries to discover
                a new address.
              returned: always
              type: int
            retry:
              description: Specifies the time, in seconds, that must pass after the
                interface has determined that there is no DHCP server present before
                it tries again to contact a DHCP server.
              returned: always
              type: int
            server_timeout:
              description: Specifies the amount of time, in seconds, that must pass
                between the time that the interface begins to try to determine its
                address and the time that it decides that it's not going to be able
                to contact a server.
              returned: always
              type: int
          description: DHCP configuration.
          returned: always
          type: dict
        enabled:
          description: Interface State.
          returned: always
          type: bool
        ipv4_address:
          description: Interface IPv4 address.
          returned: always
          type: str
        ipv4_mask_length:
          description: Interface IPv4 address mask length.
          returned: always
          type: int
        ipv6_address:
          description: Interface IPv6 address.
          returned: always
          type: str
        ipv6_autoconfig:
          description: Configure IPv6 auto-configuration.
          returned: always
          type: bool
        ipv6_local_link_address:
          description: Interface ipv6 local link address.
          returned: always
          type: str
        ipv6_mask_length:
          description: Interface IPv6 address mask length.
          returned: always
          type: int
        mac_addr:
          description: Interface MAC address.
          returned: always
          type: str
        monitor_mode:
          description: Interface monitor mode.
          returned: always
          type: bool
        mtu:
          description: Interface mtu.
          returned: always
          type: int
        name:
          description:
          - Interface name.
          returned: always
          type: str
        rx_ringsize:
          description: Interface rx ringsize.
          returned: always
          type: int
        status:
          contains:
            duplex:
              description: Duplex.
              returned: always
              type: str
            link_state:
              description: Link status.
              returned: always
              type: bool
            rx_bytes:
              description: RX bytes.
              returned: always
              type: int
            rx_packets:
              description: RX packets.
              returned: always
              type: int
            speed:
              description: Speed.
              returned: always
              type: str
            tx_bytes:
              description: TX bytes.
              returned: always
              type: int
            tx_packets:
              description: TX packets.
              returned: always
              type: int
          description: Interface data.
          returned: always
          type: dict
        tx_ringsize:
          description: Interface tx ringsize.
          returned: always
          type: int
      description:
      - List of interfaces.
      elements: dict
      returned: always
      type: list
  description: The interface/s facts.
  returned: always.
  type: dict