fortios_firewall_internet_service_custom – Configure custom Internet Services in Fortinet’s FortiOS and FortiGate.¶
New in version 2.0.0.
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_custom category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0
FortiOS Version Compatibility¶
v6.0.0 |
v6.0.5 |
v6.0.11 |
v6.2.0 |
v6.2.3 |
v6.2.5 |
v6.2.7 |
v6.4.0 |
v6.4.1 |
v6.4.4 |
v7.0.0 |
v7.0.1 |
v7.0.2 |
v7.0.3 |
v7.0.4 |
v7.0.5 |
v7.0.6 |
v7.0.7 |
v7.0.8 |
v7.2.0 |
v7.2.1 |
v7.2.2 |
|
fortios_firewall_internet_service_custom | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | 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
- state - Indicates whether to create or remove the object. type: str required: true choices: present, absent
- firewall_internet_service_custom - Configure custom Internet Services. type: dict more...
- comment - Comment. type: str more...
- disable_entry - Disable entries in the Internet Service database. type: list more...
- id - Disable entry ID. type: int more...
- ip_range - IP ranges in the disable entry. type: list more...
- end_ip - End IP address. type: str more...
- id - Disable entry range ID. type: int more...
- start_ip - Start IP address. type: str more...
- port - Integer value for the TCP/IP port (0 - 65535). type: int more...
- protocol - Integer value for the protocol type as defined by IANA (0 - 255). type: int more...
- entry - Entries added to the Internet Service database and custom database. type: list more...
- addr_mode - Address mode (IPv4 or IPv6) type: str choices: ipv4, ipv6 more...
- dst - Destination address or address group name. type: list more...
- name - Select the destination address or address group object from available options. Source firewall.address.name firewall .addrgrp.name. type: str more...
- dst6 - Destination address6 or address6 group name. type: list more...
- name - Select the destination address6 or address group object from available options. Source . type: str more...
- id - Entry ID(1-255). type: int more...
- port_range - Port ranges in the custom entry. type: list more...
- end_port - Integer value for ending TCP/UDP/SCTP destination port in range (0 to 65535). type: int more...
- id - Custom entry port range ID. type: int more...
- start_port - Integer value for starting TCP/UDP/SCTP destination port in range (0 to 65535). type: int more...
- protocol - Integer value for the protocol type as defined by IANA (0 - 255). type: int more...
- master_service_id - Internet Service ID in the Internet Service database. Source firewall.internet-service.id. type: int more...
- name - Internet Service name. type: str required: true more...
- reputation - Reputation level of the custom Internet Service. Source firewall.internet-service-reputation.id. type: int more...
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 custom Internet Services.
fortios_firewall_internet_service_custom:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
firewall_internet_service_custom:
comment: "Comment."
disable_entry:
-
id: "5"
ip_range:
-
end_ip: "<your_own_value>"
id: "8"
start_ip: "<your_own_value>"
port: "32767"
protocol: "127"
entry:
-
addr_mode: "ipv4"
dst:
-
name: "default_name_15 (source firewall.address.name firewall.addrgrp.name)"
dst6:
-
name: "default_name_17 (source )"
id: "18"
port_range:
-
end_port: "65535"
id: "21"
start_port: "1"
protocol: "0"
master_service_id: "2147483647"
name: "default_name_25"
reputation: "3"
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