Skip to content

Latest commit

 

History

History
330 lines (289 loc) · 14 KB

fortios_system_lte_modem.rst

File metadata and controls

330 lines (289 loc) · 14 KB
Raw
source:fortios_system_lte_modem.py
orphan:

fortios_system_lte_modem -- Configure USB LTE/WIMAX devices in Fortinet's FortiOS and FortiGate.

.. versionadded:: 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

Requirements

The below requirements are needed on the host that executes this module.

  • ansible>=2.15

Tips

Using member operation to add an element to an existing object.

FortiOS Version Compatibility

Supported Version Ranges: v6.0.0 -> 7.4.3

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...
    Supported Version Ranges
    system_lte_modem v6.0.0 -> 7.4.3
    • apn - Login APN string for PDP-IP packet data calls. type: str more...
      Supported Version Ranges
      apn v6.0.0 -> 7.4.3
    • authtype - Authentication type for PDP-IP packet data calls. type: str choices: none, pap, chap more...
      Supported Version Ranges
      authtype v6.0.0 -> 7.4.3
      [none] v6.0.0 -> 7.4.3
      [pap] v6.0.0 -> 7.4.3
      [chap] v6.0.0 -> 7.4.3
    • extra_init - Extra initialization string for USB LTE/WIMAX devices. type: str more...
      Supported Version Ranges
      extra_init v6.0.0 -> 7.4.3
    • holddown_timer - Hold down timer (10 - 60 sec). type: int more...
      Supported Version Ranges
      holddown_timer v6.0.0 -> 7.4.3
    • interface - The interface that the modem is acting as a redundant interface for. Source system.interface.name. type: str more...
      Supported Version Ranges
      interface v6.0.0 -> 7.4.3
    • mode - Modem operation mode. type: str choices: standalone, redundant more...
      Supported Version Ranges
      mode v6.0.0 -> 7.4.3
      [standalone] v6.0.0 -> 7.4.3
      [redundant] v6.0.0 -> 7.4.3
    • modem_port - Modem port index (0 - 20). type: int more...
      Supported Version Ranges
      modem_port v6.0.0 -> 7.4.3
    • passwd - Authentication password for PDP-IP packet data calls. type: str more...
      Supported Version Ranges
      passwd v6.0.0 -> 7.4.3
    • pdptype - Packet Data Protocol (PDP) context type. type: str choices: IPv4 more...
      Supported Version Ranges
      pdptype v7.4.1 -> 7.4.3
      [IPv4] v7.4.1 -> 7.4.3
    • status - Enable/disable USB LTE/WIMAX device. type: str choices: enable, disable more...
      Supported Version Ranges
      status v6.0.0 -> 7.4.3
      [enable] v6.0.0 -> 7.4.3
      [disable] v6.0.0 -> 7.4.3
    • username - Authentication username for PDP-IP packet data calls. type: str more...
      Supported Version Ranges
      username v6.0.0 -> 7.4.3

Notes

Note

  • Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks

Examples

- name: Configure USB LTE/WIMAX devices.
  fortinet.fortios.fortios_system_lte_modem:
      vdom: "{{ vdom }}"
      system_lte_modem:
          apn: "<your_own_value>"
          authtype: "none"
          extra_init: "<your_own_value>"
          holddown_timer: "30"
          interface: "<your_own_value> (source system.interface.name)"
          mode: "standalone"
          modem_port: "255"
          passwd: "<your_own_value>"
          pdptype: "IPv4"
          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

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.