:source: fortios_firewall_internet_service_extension.py
:orphan:
.. fortios_firewall_internet_service_extension:
fortios_firewall_internet_service_extension -- Configure Internet Services Extension 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 firewall feature and internet_service_extension 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: v6.2.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
- state - Indicates whether to create or remove the object. type: str required: true choices: present, absent
- firewall_internet_service_extension - Configure Internet Services Extension. type: dict
more...
| Supported Version Ranges |
| firewall_internet_service_extension |
v6.2.0 -> 7.6.6 |
- comment - Comment. type: str
more...
|
Supported Version Ranges |
| comment |
v6.2.0 -> 7.6.6 |
- disable_entry - Disable entries in the Internet Service database. type: list member_path: disable_entry:id
more...
| Supported Version Ranges |
| disable_entry |
v6.2.0 -> 7.6.6 |
- addr_mode - Address mode (IPv4 or IPv6). type: str choices: ipv4, ipv6
more...
|
Supported Version Ranges |
| addr_mode |
v7.2.1 -> 7.6.6 |
| [ipv4] |
v7.2.1 -> 7.6.6 |
| [ipv6] |
v7.2.1 -> 7.6.6 |
- id - Disable entry ID. see Notes. type: int required: true
more...
|
Supported Version Ranges |
| id |
v6.2.0 -> 7.6.6 |
- ip_range - IPv4 ranges in the disable entry. type: list member_path: disable_entry:id/ip_range:id
more...
| Supported Version Ranges |
| ip_range |
v6.2.0 -> 7.6.6 |
- end_ip - End IPv4 address. type: str
more...
|
Supported Version Ranges |
| end_ip |
v6.2.0 -> 7.6.6 |
- id - Disable entry range ID. see Notes. type: int required: true
more...
|
Supported Version Ranges |
| id |
v6.2.0 -> 7.6.6 |
- start_ip - Start IPv4 address. type: str
more...
|
Supported Version Ranges |
| start_ip |
v6.2.0 -> 7.6.6 |
- ip6_range - IPv6 ranges in the disable entry. type: list member_path: disable_entry:id/ip6_range:id
more...
| Supported Version Ranges |
| ip6_range |
v7.2.1 -> 7.6.6 |
- end_ip6 - End IPv6 address. type: str
more...
|
Supported Version Ranges |
| end_ip6 |
v7.2.1 -> 7.6.6 |
- id - Disable entry range ID. see Notes. type: int required: true
more...
|
Supported Version Ranges |
| id |
v7.2.1 -> 7.6.6 |
- start_ip6 - Start IPv6 address. type: str
more...
|
Supported Version Ranges |
| start_ip6 |
v7.2.1 -> 7.6.6 |
- port_range - Port ranges in the disable entry. type: list member_path: disable_entry:id/port_range:id
more...
| Supported Version Ranges |
| port_range |
v6.2.0 -> 7.6.6 |
- end_port - Ending TCP/UDP/SCTP destination port (0 to 65535). type: int
more...
|
Supported Version Ranges |
| end_port |
v6.2.0 -> 7.6.6 |
- id - Custom entry port range ID. see Notes. type: int required: true
more...
|
Supported Version Ranges |
| id |
v6.2.0 -> 7.6.6 |
- start_port - Starting TCP/UDP/SCTP destination port (0 to 65535). type: int
more...
|
Supported Version Ranges |
| start_port |
v6.2.0 -> 7.6.6 |
- protocol - Integer value for the protocol type as defined by IANA (0 - 255). type: int
more...
|
Supported Version Ranges |
| protocol |
v6.2.0 -> 7.6.6 |
- entry - Entries added to the Internet Service extension database. type: list member_path: entry:id
more...
| Supported Version Ranges |
| entry |
v6.2.0 -> 7.6.6 |
- addr_mode - Address mode (IPv4 or IPv6). type: str choices: ipv4, ipv6
more...
|
Supported Version Ranges |
| addr_mode |
v7.2.1 -> 7.6.6 |
| [ipv4] |
v7.2.1 -> 7.6.6 |
| [ipv6] |
v7.2.1 -> 7.6.6 |
- dst - Destination address or address group name. type: list member_path: entry:id/dst:name
more...
| Supported Version Ranges |
| dst |
v6.2.0 -> 7.6.6 |
- name - Select the destination address or address group object from available options. Source firewall.address.name firewall .addrgrp.name. type: str required: true
more...
|
Supported Version Ranges |
| name |
v6.2.0 -> 7.6.6 |
- dst6 - Destination address6 or address6 group name. type: list member_path: entry:id/dst6:name
more...
| Supported Version Ranges |
| dst6 |
v7.2.1 -> 7.6.6 |
- name - Select the destination address6 or address group object from available options. Source firewall.address6.name firewall .addrgrp6.name. type: str required: true
more...
|
Supported Version Ranges |
| name |
v7.2.1 -> 7.6.6 |
- id - Entry ID(1-255). see Notes. type: int required: true
more...
|
Supported Version Ranges |
| id |
v6.2.0 -> 7.6.6 |
- port_range - Port ranges in the custom entry. type: list member_path: entry:id/port_range:id
more...
| Supported Version Ranges |
| port_range |
v6.2.0 -> 7.6.6 |
- end_port - Integer value for ending TCP/UDP/SCTP destination port in range (0 to 65535). type: int
more...
|
Supported Version Ranges |
| end_port |
v6.2.0 -> 7.6.6 |
- id - Custom entry port range ID. see Notes. type: int required: true
more...
|
Supported Version Ranges |
| id |
v6.2.0 -> 7.6.6 |
- start_port - Integer value for starting TCP/UDP/SCTP destination port in range (0 to 65535). type: int
more...
|
Supported Version Ranges |
| start_port |
v6.2.0 -> 7.6.6 |
- protocol - Integer value for the protocol type as defined by IANA (0 - 255). type: int
more...
|
Supported Version Ranges |
| protocol |
v6.2.0 -> 7.6.6 |
- id - Internet Service ID in the Internet Service database. see Notes. Source firewall.internet-service.id. type: int required: true
more...
|
Supported Version Ranges |
| id |
v6.2.0 -> 7.6.6 |
Notes
-----
.. note::
- We highly recommend using your own value as the id instead of 0, while '0' is a special placeholder that allows the backend to assign the latest available number for the object, it does have limitations. Please find more details in Q&A.
- 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 Internet Services Extension.
fortinet.fortios.fortios_firewall_internet_service_extension:
vdom: "{{ vdom }}"
state: "present"
access_token: ""
firewall_internet_service_extension:
comment: "Comment."
disable_entry:
-
addr_mode: "ipv4"
id: "6"
ip_range:
-
end_ip: ""
id: "9"
start_ip: ""
ip6_range:
-
end_ip6: ""
id: "13"
start_ip6: ""
port_range:
-
end_port: "65535"
id: "17"
start_port: "1"
protocol: "0"
entry:
-
addr_mode: "ipv4"
dst:
-
name: "default_name_23 (source firewall.address.name firewall.addrgrp.name)"
dst6:
-
name: "default_name_25 (source firewall.address6.name firewall.addrgrp6.name)"
id: "26"
port_range:
-
end_port: "65535"
id: "29"
start_port: "1"
protocol: "0"
id: "32 (source firewall.internet-service.id)"
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.