fortinet.fortios.fortios_system_pcp_server (2.3.6) — module

Configure PCP server information in Fortinet's FortiOS and FortiGate.

| "added in version" 2.0.0 of fortinet.fortios"

Authors: Link Zheng (@chillancezen), Jie Xue (@JieX19), Hongbin Lu (@fgtdev-hblu), Frank Shen (@frankshen01), Miguel Angel Munoz (@mamunozgonzalez), Nicolas Thomas (@thomnico)

preview | supported by community

Install collection

Install with ansible-galaxy collection install fortinet.fortios:==2.3.6


Add to requirements.yml

  collections:
    - name: fortinet.fortios
      version: 2.3.6

Description

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify system feature and pcp_server category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0


Requirements

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Configure PCP server information.
  fortinet.fortios.fortios_system_pcp_server:
      vdom: "{{ vdom }}"
      system_pcp_server:
          pools:
              -
                  allow_opcode: "map"
                  announcement_count: "3"
                  arp_reply: "disable"
                  client_mapping_limit: "0"
                  client_subnet:
                      -
                          subnet: "<your_own_value>"
                  description: "<your_own_value>"
                  ext_intf: "<your_own_value> (source system.interface.name)"
                  extip: "<your_own_value>"
                  extport: "<your_own_value>"
                  id: "14"
                  intl_intf:
                      -
                          interface_name: "<your_own_value> (source system.interface.name)"
                  mapping_filter_limit: "1"
                  maximal_lifetime: "86400"
                  minimal_lifetime: "120"
                  multicast_announcement: "enable"
                  name: "default_name_21"
                  recycle_delay: "0"
                  third_party: "allow"
                  third_party_subnet:
                      -
                          subnet: "<your_own_value>"
          status: "enable"

Inputs

    
vdom:
    default: root
    description:
    - Virtual domain, among those defined previously. A vdom is a virtual instance of
      the FortiGate that can be configured and used as a different unit.
    type: str

enable_log:
    default: false
    description:
    - Enable/Disable logging for task.
    required: false
    type: bool

member_path:
    description:
    - Member attribute path to operate on.
    - Delimited by a slash character if there are more than one attribute.
    - Parameter marked with member_path is legitimate for doing member operation.
    type: str

access_token:
    description:
    - Token-based authentication. Generated from GUI of Fortigate.
    required: false
    type: str

member_state:
    choices:
    - present
    - absent
    description:
    - Add or delete a member under specified attribute path.
    - When member_state is specified, the state option is ignored.
    type: str

system_pcp_server:
    default: null
    description:
    - Configure PCP server information.
    suboptions:
      pools:
        description:
        - Configure PCP pools.
        elements: dict
        suboptions:
          allow_opcode:
            choices:
            - map
            - peer
            - announce
            description:
            - Allowed PCP opcode.
            elements: str
            type: list
          announcement_count:
            description:
            - Number of multicast announcements.
            type: int
          arp_reply:
            choices:
            - disable
            - enable
            description:
            - Enable to respond to ARP requests for external IP .
            type: str
          client_mapping_limit:
            description:
            - Mapping limit per client (0 - 65535).
            type: int
          client_subnet:
            description:
            - Subnets from which PCP requests are accepted.
            elements: dict
            suboptions:
              subnet:
                description:
                - Client subnets.
                required: true
                type: str
            type: list
          description:
            description:
            - Description.
            type: str
          ext_intf:
            description:
            - External interface name. Source system.interface.name.
            type: str
          extip:
            description:
            - IP address or address range on the external interface that you want to map
              to an address on the internal network.
            type: str
          extport:
            description:
            - Incoming port number range that you want to map to a port number on the
              internal network.
            type: str
          id:
            description:
            - ID.
            type: int
          intl_intf:
            description:
            - Internal interface name.
            elements: dict
            suboptions:
              interface_name:
                description:
                - Interface name. Source system.interface.name.
                required: true
                type: str
            type: list
          mapping_filter_limit:
            description:
            - Filter limit per mapping (0 - 5).
            type: int
          maximal_lifetime:
            description:
            - Maximal lifetime of a PCP mapping in seconds (3600 - 604800).
            type: int
          minimal_lifetime:
            description:
            - Minimal lifetime of a PCP mapping in seconds (60 - 300).
            type: int
          multicast_announcement:
            choices:
            - enable
            - disable
            description:
            - Enable/disable multicast announcements.
            type: str
          name:
            description:
            - PCP pool name.
            required: true
            type: str
          recycle_delay:
            description:
            - Minimum delay (in seconds) the PCP Server will wait before recycling mappings
              that have expired (0 - 3600).
            type: int
          third_party:
            choices:
            - allow
            - disallow
            description:
            - Allow/disallow third party option.
            type: str
          third_party_subnet:
            description:
            - Subnets from which third party requests are accepted.
            elements: dict
            suboptions:
              subnet:
                description:
                - Third party subnets.
                required: true
                type: str
            type: list
        type: list
      status:
        choices:
        - enable
        - disable
        description:
        - Enable/disable PCP server.
        type: str
    type: dict

Outputs

build:
  description: Build number of the fortigate image
  returned: always
  sample: '1547'
  type: str
http_method:
  description: Last method used to provision the content into FortiGate
  returned: always
  sample: PUT
  type: str
http_status:
  description: Last result given by FortiGate on last operation applied
  returned: always
  sample: '200'
  type: str
mkey:
  description: Master key (id) used in the last call to FortiGate
  returned: success
  sample: id
  type: str
name:
  description: Name of the table used to fulfill the request
  returned: always
  sample: urlfilter
  type: str
path:
  description: Path of the table used to fulfill the request
  returned: always
  sample: webfilter
  type: str
revision:
  description: Internal revision number
  returned: always
  sample: 17.0.2.10658
  type: str
serial:
  description: Serial number of the unit
  returned: always
  sample: FGVMEVYYQT3AB5352
  type: str
status:
  description: Indication of the operation's result
  returned: always
  sample: success
  type: str
vdom:
  description: Virtual domain used
  returned: always
  sample: root
  type: str
version:
  description: Version of the FortiGate
  returned: always
  sample: v5.6.3
  type: str