fortinet.fortios.fortios_system_modem module – Configure MODEM in Fortinet’s FortiOS and FortiGate.
Note
This module is part of the fortinet.fortios collection (version 2.3.8).
You might already have this collection installed if you are using the ansible
package.
It is not included in ansible-core
.
To check whether it is installed, run ansible-galaxy collection list
.
To install it, use: ansible-galaxy collection install fortinet.fortios
.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: fortinet.fortios.fortios_system_modem
.
New in fortinet.fortios 2.0.0
Synopsis
This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify system feature and modem 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.15
Parameters
Parameter |
Comments |
---|---|
Token-based authentication. Generated from GUI of Fortigate. |
|
Enable/Disable logging for task. Choices:
|
|
Member attribute path to operate on. Delimited by a slash character if there are more than one attribute. Parameter marked with member_path is legitimate for doing member operation. |
|
Add or delete a member under specified attribute path. When member_state is specified, the state option is ignored. Choices:
|
|
Configure MODEM. |
|
Dial up/stop MODEM. Choices:
|
|
Enable/disable altmode for installations using PPP in China. Choices:
|
|
Allowed authentication types for ISP 1. Choices:
|
|
Allowed authentication types for ISP 2. Choices:
|
|
Allowed authentication types for ISP 3. Choices:
|
|
Enable/disable auto-dial after a reboot or disconnection. Choices:
|
|
Connection completion timeout (30 - 255 sec). |
|
Dial command (this is often an ATD or ATDT command). |
|
Dial command (this is often an ATD or ATDT command). |
|
Dial command (this is often an ATD or ATDT command). |
|
Enable/disable to dial the modem when packets are routed to the modem interface. Choices:
|
|
Distance of learned routes (1 - 255). |
|
Do not send CR when connected (ISP1). Choices:
|
|
Do not send CR when connected (ISP2). Choices:
|
|
Do not send CR when connected (ISP3). Choices:
|
|
Extra initialization string to ISP 1. |
|
Extra initialization string to ISP 2. |
|
Extra initialization string to ISP 3. |
|
Hold down timer in seconds (1 - 60 sec). |
|
MODEM connection idle time (1 - 9999 min). |
|
Name of redundant interface. Source system.interface.name. |
|
Allow connection only to the specified Location Area Code (LAC). |
|
Set MODEM operation mode to redundant or standalone. Choices:
|
|
AT command to set the Network name/type (AT+COPS=<mode>,[<format>,<oper>[,<AcT>]]). |
|
Password to access the specified dialup account. |
|
Password to access the specified dialup account. |
|
Password to access the specified dialup account. |
|
Specify peer MODEM type for phone1. Choices:
|
|
Specify peer MODEM type for phone2. Choices:
|
|
Specify peer MODEM type for phone3. Choices:
|
|
Phone number to connect to the dialup account (must not contain spaces, and should include standard special characters). |
|
Phone number to connect to the dialup account (must not contain spaces, and should include standard special characters). |
|
Phone number to connect to the dialup account (must not contain spaces, and should include standard special characters). |
|
AT command to set the PIN (AT+PIN=<pin>). |
|
Enable/disable PPP echo-request to ISP 1. Choices:
|
|
Enable/disable PPP echo-request to ISP 2. Choices:
|
|
Enable/disable PPP echo-request to ISP 3. Choices:
|
|
Priority of learned routes (1 - 65535). |
|
Redial limit (1 - 10 attempts, none = redial forever). Choices:
|
|
Number of dial attempts before resetting modem (0 = never reset). |
|
Enable/disable Modem support (equivalent to bringing an interface up or down). Choices:
|
|
Enable/disable traffic-check. Choices:
|
|
User name to access the specified dialup account. |
|
User name to access the specified dialup account. |
|
User name to access the specified dialup account. |
|
Enter wireless port number: 0 for default, 1 for first port, and so on (0 - 4294967295). |
|
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. Default: |
Notes
Note
Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
- name: Configure MODEM.
fortinet.fortios.fortios_system_modem:
vdom: "{{ vdom }}"
system_modem:
action: "dial"
altmode: "enable"
authtype1: "pap"
authtype2: "pap"
authtype3: "pap"
auto_dial: "enable"
connect_timeout: "90"
dial_cmd1: "<your_own_value>"
dial_cmd2: "<your_own_value>"
dial_cmd3: "<your_own_value>"
dial_on_demand: "enable"
distance: "1"
dont_send_CR1: "enable"
dont_send_CR2: "enable"
dont_send_CR3: "enable"
extra_init1: "<your_own_value>"
extra_init2: "<your_own_value>"
extra_init3: "<your_own_value>"
holddown_timer: "60"
idle_timer: "5"
interface: "<your_own_value> (source system.interface.name)"
lockdown_lac: "<your_own_value>"
mode: "standalone"
network_init: "<your_own_value>"
passwd1: "<your_own_value>"
passwd2: "<your_own_value>"
passwd3: "<your_own_value>"
peer_modem1: "generic"
peer_modem2: "generic"
peer_modem3: "generic"
phone1: "<your_own_value>"
phone2: "<your_own_value>"
phone3: "<your_own_value>"
pin_init: "<your_own_value>"
ppp_echo_request1: "enable"
ppp_echo_request2: "enable"
ppp_echo_request3: "enable"
priority: "1"
redial: "none"
reset: "0"
status: "enable"
traffic_check: "enable"
username1: "<your_own_value>"
username2: "<your_own_value>"
username3: "<your_own_value>"
wireless_port: "0"
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
Build number of the fortigate image Returned: always Sample: |
|
Last method used to provision the content into FortiGate Returned: always Sample: |
|
Last result given by FortiGate on last operation applied Returned: always Sample: |
|
Master key (id) used in the last call to FortiGate Returned: success Sample: |
|
Name of the table used to fulfill the request Returned: always Sample: |
|
Path of the table used to fulfill the request Returned: always Sample: |
|
Internal revision number Returned: always Sample: |
|
Serial number of the unit Returned: always Sample: |
|
Indication of the operation’s result Returned: always Sample: |
|
Virtual domain used Returned: always Sample: |
|
Version of the FortiGate Returned: always Sample: |