fortios_system_lte_modem – Configure USB LTE/WIMAX devices 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 system feature and lte_modem 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.2.0 |
|
fortios_system_lte_modem | 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
- system_lte_modem - Configure USB LTE/WIMAX devices. type: dict more...
- apn - Login APN string for PDP-IP packet data calls. type: str more...
- authtype - Authentication type for PDP-IP packet data calls. type: str choices: none, pap, chap more...
- extra_init - Extra initialization string for USB LTE/WIMAX devices. type: str more...
- holddown_timer - Hold down timer (10 - 60 sec). type: int more...
- interface - The interface that the modem is acting as a redundant interface for. Source system.interface.name. type: str more...
- mode - Modem operation mode. type: str choices: standalone, redundant more...
- modem_port - Modem port index (0 - 20). type: int more...
- passwd - Authentication password for PDP-IP packet data calls. type: str more...
- status - Enable/disable USB LTE/WIMAX device. type: str choices: enable, disable more...
- username - Authentication username for PDP-IP packet data calls. type: str 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 USB LTE/WIMAX devices.
fortios_system_lte_modem:
vdom: "{{ vdom }}"
system_lte_modem:
apn: "<your_own_value>"
authtype: "none"
extra_init: "<your_own_value>"
holddown_timer: "6"
interface: "<your_own_value> (source system.interface.name)"
mode: "standalone"
modem_port: "9"
passwd: "<your_own_value>"
status: "enable"
username: "<your_own_value>"
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