:source: fortios_system_pcp_server.py
:orphan:
.. fortios_system_pcp_server:
fortios_system_pcp_server -- Configure PCP server information in Fortinet's FortiOS and FortiGate.
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
.. versionadded:: 2.0.0
.. contents::
:local:
:depth: 1
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.16
Tips
----
Using member operation to add an element to an existing object.
FortiOS Version Compatibility
-----------------------------
Supported Version Ranges: v7.4.0 -> v7.6.6
Parameters
----------
.. raw:: html
- 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...
| Supported Version Ranges |
| system_pcp_server |
v7.4.0 -> 7.6.6 |
- pools - Configure PCP pools. type: list member_path: pools:name
more...
| Supported Version Ranges |
| pools |
v7.4.0 -> 7.6.6 |
- allow_opcode - Allowed PCP opcode. type: list choices: map, peer, announce
more...
|
Supported Version Ranges |
| allow_opcode |
v7.4.0 -> 7.6.6 |
| [map] |
v7.4.0 -> 7.6.6 |
| [peer] |
v7.4.0 -> 7.6.6 |
| [announce] |
v7.4.0 -> 7.6.6 |
- announcement_count - Number of multicast announcements. type: int
more...
|
Supported Version Ranges |
| announcement_count |
v7.4.0 -> 7.6.6 |
- arp_reply - Enable to respond to ARP requests for external IP . type: str choices: disable, enable
more...
|
Supported Version Ranges |
| arp_reply |
v7.4.0 -> 7.6.6 |
| [disable] |
v7.4.0 -> 7.6.6 |
| [enable] |
v7.4.0 -> 7.6.6 |
- client_mapping_limit - Mapping limit per client (0 - 65535). type: int
more...
|
Supported Version Ranges |
| client_mapping_limit |
v7.4.0 -> 7.6.6 |
- client_subnet - Subnets from which PCP requests are accepted. type: list member_path: pools:name/client_subnet:subnet
more...
| Supported Version Ranges |
| client_subnet |
v7.4.0 -> 7.6.6 |
- subnet - Client subnets. type: str required: true
more...
|
Supported Version Ranges |
| subnet |
v7.4.0 -> 7.6.6 |
- description - Description. type: str
more...
|
Supported Version Ranges |
| description |
v7.4.0 -> 7.6.6 |
- ext_intf - External interface name. Source system.interface.name. type: str
more...
|
Supported Version Ranges |
| ext_intf |
v7.4.0 -> 7.6.6 |
- 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...
|
Supported Version Ranges |
| extip |
v7.4.0 -> 7.6.6 |
- extport - Incoming port number range that you want to map to a port number on the internal network. type: str
more...
|
Supported Version Ranges |
| extport |
v7.4.0 -> 7.6.6 |
- id - ID. type: int
more...
|
Supported Version Ranges |
| id |
v7.4.0 -> 7.6.6 |
- intl_intf - Internal interface name. type: list member_path: pools:name/intl_intf:interface_name
more...
| Supported Version Ranges |
| intl_intf |
v7.4.0 -> 7.6.6 |
- interface_name - Interface name. Source system.interface.name. type: str required: true
more...
|
Supported Version Ranges |
| interface_name |
v7.4.0 -> 7.6.6 |
- mapping_filter_limit - Filter limit per mapping (0 - 5). type: int
more...
|
Supported Version Ranges |
| mapping_filter_limit |
v7.4.0 -> 7.6.6 |
- maximal_lifetime - Maximal lifetime of a PCP mapping in seconds (3600 - 604800). type: int
more...
|
Supported Version Ranges |
| maximal_lifetime |
v7.4.0 -> 7.6.6 |
- minimal_lifetime - Minimal lifetime of a PCP mapping in seconds (60 - 300). type: int
more...
|
Supported Version Ranges |
| minimal_lifetime |
v7.4.0 -> 7.6.6 |
- multicast_announcement - Enable/disable multicast announcements. type: str choices: enable, disable
more...
|
Supported Version Ranges |
| multicast_announcement |
v7.4.0 -> 7.6.6 |
| [enable] |
v7.4.0 -> 7.6.6 |
| [disable] |
v7.4.0 -> 7.6.6 |
- name - PCP pool name. type: str required: true
more...
|
Supported Version Ranges |
| name |
v7.4.0 -> 7.6.6 |
- recycle_delay - Minimum delay (in seconds) the PCP Server will wait before recycling mappings that have expired (0 - 3600). type: int
more...
|
Supported Version Ranges |
| recycle_delay |
v7.4.0 -> 7.6.6 |
- third_party - Allow/disallow third party option. type: str choices: allow, disallow
more...
|
Supported Version Ranges |
| third_party |
v7.4.0 -> 7.6.6 |
| [allow] |
v7.4.0 -> 7.6.6 |
| [disallow] |
v7.4.0 -> 7.6.6 |
- third_party_subnet - Subnets from which third party requests are accepted. type: list member_path: pools:name/third_party_subnet:subnet
more...
| Supported Version Ranges |
| third_party_subnet |
v7.4.0 -> 7.6.6 |
- subnet - Third party subnets. type: str required: true
more...
|
Supported Version Ranges |
| subnet |
v7.4.0 -> 7.6.6 |
- status - Enable/disable PCP server. type: str choices: enable, disable
more...
|
Supported Version Ranges |
| status |
v7.4.0 -> 7.6.6 |
| [enable] |
v7.4.0 -> 7.6.6 |
| [disable] |
v7.4.0 -> 7.6.6 |
Notes
-----
.. note::
- Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
- The module supports check_mode.
Examples
--------
.. code-block:: yaml+jinja
- 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: ""
description: ""
ext_intf: " (source system.interface.name)"
extip: ""
extport: ""
id: "14"
intl_intf:
-
interface_name: " (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: ""
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:
.. raw:: html
- 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.