New in version 2.8.
The below requirements are needed on the host that executes this module.
Parameter | Choices/Defaults | Comments | |||
---|---|---|---|---|---|
firewall_internet_service_custom
-
|
Default: null
|
Configure custom Internet Services.
|
|||
comment
-
|
Comment.
|
||||
disable-entry
-
|
Disable entries in the Internet Service database.
|
||||
id
-
/ required
|
Disable entry ID.
|
||||
ip-range
-
|
IP ranges in the disable entry.
|
||||
end-ip
-
|
End IP address.
|
||||
id
-
/ required
|
Disable entry range ID.
|
||||
start-ip
-
|
Start IP address.
|
||||
port
-
|
Integer value for the TCP/IP port (0 - 65535).
|
||||
protocol
-
|
Integer value for the protocol type as defined by IANA (0 - 255).
|
||||
entry
-
|
Entries added to the Internet Service database and custom database.
|
||||
dst
-
|
Destination address or address group name.
|
||||
name
-
/ required
|
Select the destination address or address group object from available options. Source firewall.address.name firewall .addrgrp.name.
|
||||
id
-
/ required
|
Entry ID(1-255).
|
||||
port-range
-
|
Port ranges in the custom entry.
|
||||
end-port
-
|
Integer value for ending TCP/UDP/SCTP destination port in range (1 to 65535).
|
||||
id
-
/ required
|
Custom entry port range ID.
|
||||
start-port
-
|
Integer value for starting TCP/UDP/SCTP destination port in range (1 to 65535).
|
||||
protocol
-
|
Integer value for the protocol type as defined by IANA (0 - 255).
|
||||
master-service-id
-
|
Internet Service ID in the Internet Service database. Source firewall.internet-service.id.
|
||||
name
-
/ required
|
Internet Service name.
|
||||
state
-
|
|
Indicates whether to create or remove the object
|
|||
host
-
/ required
|
FortiOS or FortiGate ip address.
|
||||
https
boolean
|
|
Indicates if the requests towards FortiGate must use HTTPS protocol
|
|||
password
-
|
Default: ""
|
FortiOS or FortiGate password.
|
|||
username
-
/ required
|
FortiOS or FortiGate username.
|
||||
vdom
-
|
Default: "root"
|
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.
|
Note
- hosts: localhost
vars:
host: "192.168.122.40"
username: "admin"
password: ""
vdom: "root"
tasks:
- name: Configure custom Internet Services.
fortios_firewall_internet_service_custom:
host: "{{ host }}"
username: "{{ username }}"
password: "{{ password }}"
vdom: "{{ vdom }}"
firewall_internet_service_custom:
state: "present"
comment: "Comment."
disable-entry:
-
id: "5"
ip-range:
-
end-ip: "<your_own_value>"
id: "8"
start-ip: "<your_own_value>"
port: "10"
protocol: "11"
entry:
-
dst:
-
name: "default_name_14 (source firewall.address.name firewall.addrgrp.name)"
id: "15"
port-range:
-
end-port: "17"
id: "18"
start-port: "19"
protocol: "20"
master-service-id: "21 (source firewall.internet-service.id)"
name: "default_name_22"
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description |
---|---|---|
build
string
|
always |
Build number of the fortigate image
Sample:
1547
|
http_method
string
|
always |
Last method used to provision the content into FortiGate
Sample:
PUT
|
http_status
string
|
always |
Last result given by FortiGate on last operation applied
Sample:
200
|
mkey
string
|
success |
Master key (id) used in the last call to FortiGate
Sample:
id
|
name
string
|
always |
Name of the table used to fulfill the request
Sample:
urlfilter
|
path
string
|
always |
Path of the table used to fulfill the request
Sample:
webfilter
|
revision
string
|
always |
Internal revision number
Sample:
17.0.2.10658
|
serial
string
|
always |
Serial number of the unit
Sample:
FGVMEVYYQT3AB5352
|
status
string
|
always |
Indication of the operation's result
Sample:
success
|
vdom
string
|
always |
Virtual domain used
Sample:
root
|
version
string
|
always |
Version of the FortiGate
Sample:
v5.6.3
|
Hint
If you notice any issues in this documentation you can edit this document to improve it.