fortios_system_pcp_server.rst

source:	fortios_system_pcp_server.py
orphan:

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

.. versionadded:: 2.0.0

• Synopsis
• Requirements
• Tips
• FortiOS Version Compatibility
• Parameters
• Notes
• Examples
• Return Values
• Status
• Authors

Synopsis

• 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

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

• ansible>=2.9

Tips

Using member operation to add an element to an existing object.

FortiOS Version Compatibility

	v7.4.0
fortios_system_pcp_server	yes

Parameters

• access_token - Token-based authentication. Generated from GUI of Fortigate. type: str required: false
• enable_log - Enable/Disable logging for task. type: bool required: false default: False
• vdom - 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 default: root
• member_path - Member attribute path to operate on. type: str
• member_state - Add or delete a member under specified attribute path. type: str choices: present, absent
• system_pcp_server - Configure PCP server information. type: dict more...

  	v7.4.0
  system_pcp_server	yes

• pools - Configure PCP pools. type: list member_path: pools:name more...

  	v7.4.0
  pools	yes

• allow_opcode - Allowed PCP opcode. type: list choices: map, peer, announce more...

  	v7.4.0
  allow_opcode	yes
  [map]	yes
  [peer]	yes
  [announce]	yes

• announcement_count - Number of multicast announcements. type: int more...

  	v7.4.0
  announcement_count	yes

• arp_reply - Enable to respond to ARP requests for external IP . type: str choices: disable, enable more...

  	v7.4.0
  arp_reply	yes
  [disable]	yes
  [enable]	yes

• client_mapping_limit - Mapping limit per client (0 - 65535). type: int more...

  	v7.4.0
  client_mapping_limit	yes

• client_subnet - Subnets from which PCP requests are accepted. type: list member_path: pools:name/client_subnet:subnet more...

  	v7.4.0
  client_subnet	yes

• subnet - Client subnets. type: str required: true more...

  	v7.4.0
  subnet	yes

• description - Description. type: str more...

  	v7.4.0
  description	yes

• ext_intf - External interface name. Source system.interface.name. type: str more...

  	v7.4.0
  ext_intf	yes

• extip - IP address or address range on the external interface that you want to map to an address on the internal network. type: str more...

  	v7.4.0
  extip	yes

• extport - Incoming port number range that you want to map to a port number on the internal network. type: str more...

  	v7.4.0
  extport	yes

• id - ID. type: int more...

  	v7.4.0
  id	yes

• intl_intf - Internal interface name. type: list member_path: pools:name/intl_intf:interface_name more...

  	v7.4.0
  intl_intf	yes

• interface_name - Interface name. Source system.interface.name. type: str required: true more...

  	v7.4.0
  interface_name	yes

• mapping_filter_limit - Filter limit per mapping (0 - 5). type: int more...

  	v7.4.0
  mapping_filter_limit	yes

• maximal_lifetime - Maximal lifetime of a PCP mapping in seconds (3600 - 604800). type: int more...

  	v7.4.0
  maximal_lifetime	yes

• minimal_lifetime - Minimal lifetime of a PCP mapping in seconds (60 - 300). type: int more...

  	v7.4.0
  minimal_lifetime	yes

• multicast_announcement - Enable/disable multicast announcements. type: str choices: enable, disable more...

  	v7.4.0
  multicast_announcement	yes
  [enable]	yes
  [disable]	yes

• name - PCP pool name. type: str required: true more...

  	v7.4.0
  name	yes

• recycle_delay - Minimum delay (in seconds) the PCP Server will wait before recycling mappings that have expired (0 - 3600). type: int more...

  	v7.4.0
  recycle_delay	yes

• third_party - Allow/disallow third party option. type: str choices: allow, disallow more...

  	v7.4.0
  third_party	yes
  [allow]	yes
  [disallow]	yes

• third_party_subnet - Subnets from which third party requests are accepted. type: list member_path: pools:name/third_party_subnet:subnet more...

  	v7.4.0
  third_party_subnet	yes

• subnet - Third party subnets. type: str required: true more...

  	v7.4.0
  subnet	yes

• status - Enable/disable PCP server. type: str choices: enable, disable more...

  	v7.4.0
  status	yes
  [enable]	yes
  [disable]	yes

Notes

Note

• Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks

Examples

- hosts: fortigates
  collections:
    - fortinet.fortios
  connection: httpapi
  vars:
   vdom: "root"
   ansible_httpapi_use_ssl: yes
   ansible_httpapi_validate_certs: no
   ansible_httpapi_port: 443
  tasks:
  - name: Configure PCP server information.
    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"

Return Values

Common return values are documented: https://docs.ansible.com/ansible/latest/reference_appendices/common_return_values.html#common-return-values, the following are the fields unique to this module:

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

Status

• This module is not guaranteed to have a backwards compatible interface.

Authors

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

Hint

If you notice any issues in this documentation, you can create a pull request to improve it.