fmgd_system_5gmodem – Configure USB 5G modems.

Added in version 1.0.0.

Synopsis

  • This module is able to configure a FortiManager device.

  • Examples include all parameters and values need to be adjusted to data sources before usage.

  • Tested with FortiManager v7.x.

Requirements

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

  • ansible-core>=2.16.0

FortiManager Version Compatibility

Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest

Parameters

  • access_token -The token to access FortiManager without using username and password. type: str required: false
  • bypass_validation - Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters. type: bool required: false default: False
  • enable_log - Enable/Disable logging for task. type: bool required: false default: False
  • forticloud_access_token - Access token of forticloud managed API users, this option is available with FortiManager later than 6.4.0. type: str required: false
  • proposed_method - The overridden method for the underlying Json RPC request. type: str required: false choices: set, update, add
  • rc_succeeded - The rc codes list with which the conditions to succeed will be overriden. type: list required: false
  • rc_failed - The rc codes list with which the conditions to fail will be overriden. type: list required: false
  • workspace_locking_adom - Acquire the workspace lock if FortiManager is running in workspace mode. type: str required: false choices: global, custom adom including root
  • workspace_locking_timeout - The maximum time in seconds to wait for other users to release workspace lock. type: integer required: false default: 300
  • device - The parameter in requested url type: str required: true
  • system_5gmodem - Configure USB 5G modems. type: dict
    • data_plan (Alias name: data-plan) Data plan. type: list more...
      • apn Login apn string for pdp-ip packet data calls. type: str more...
      • auth_type (Alias name: auth-type) Authentication type for pdp-ip packet data calls. type: str choices: [none, pap, chap] more...
      • name Data plan name. type: str more...
      • password Authentication password for pdp-ip packet data calls. type: list more...
      • pdp_type (Alias name: pdp-type) Packet data protocol (pdp) context type. type: str choices: [ipv4, ipv6, ipv4v6] more...
      • username Authentication username for pdp-ip packet data calls. type: str more...
    • modem1 Modem1. type: dict more...
      • carrier_config (Alias name: carrier-config) Carrier-config selection mode. type: str choices: [manual, auto-gcf, auto-ptcrb] more...
      • custom_ipv4_netmask (Alias name: custom-ipv4-netmask) Netmask assigned by the dhcp server. type: str more...
      • default_gateway (Alias name: default-gateway) Modem interface default gateway. type: str choices: [auto, none] more...
      • default_netmask (Alias name: default-netmask) Modem interface default netmask. type: str choices: [auto, custom] more...
      • gps_service (Alias name: gps-service) Enable/disable modem online mode. type: str choices: [disable, enable] more...
      • intferface Modem interface. type: str more...
      • modem_id (Alias name: modem-id) Modem id. type: int more...
      • network_type (Alias name: network-type) Modem network type. type: str choices: [auto, 4g|5g, 3g|4g, 3g|5g, 5g, 4g, 3g] more...
      • sim_data_plan (Alias name: sim-data-plan) Data plan for sim. type: list more...
      • sim_pin (Alias name: sim-pin) Pin code for sim(if applicable). type: list more...
      • sim_switch (Alias name: sim-switch) Sim switch. type: dict more...
        • active_sim_slot (Alias name: active-sim-slot) Set active sim card slot to slot-1 or slot-2. type: str choices: [slot-1, slot-2] more...
        • by_connection_state (Alias name: by-connection-state) Enable/disable automatic switch of sim by modem connection state (mobile data usage charges not incurred). type: str choices: [disable, enable] more...
        • by_link_monitor (Alias name: by-link-monitor) Enable/disable automatic switch of sim by link monitor (mobile data usage charges incurred). type: str choices: [disable, enable] more...
        • by_sim_state (Alias name: by-sim-state) Enable/disable automatic switch of sim when modem sim state is empty or in error. type: str choices: [disable, enable] more...
        • link_monitor (Alias name: link-monitor) Set link monitor name. type: str more...
        • modem_disconnection_time (Alias name: modem-disconnection-time) Configure connection-based automatic switch of sim time interval in seconds (30 - 86400). type: int more...
        • sim_switch_log_alert_interval (Alias name: sim-switch-log-alert-interval) When sim-switch > x threshold within y interval, trigger log event (y:1 - 99999 min, default = 15). type: int more...
        • sim_switch_log_alert_threshold (Alias name: sim-switch-log-alert-threshold) When sim-switch > x threshold within y interval, trigger log event (x:1 - 1000 times, default = 5). type: int more...
      • sim1_data_plan (Alias name: sim1-data-plan) Data plan for sim #1. type: list more...
      • sim1_pin (Alias name: sim1-pin) Pin code for sim #1 (if applicable). type: list more...
      • sim2_data_plan (Alias name: sim2-data-plan) Data plan for sim #2. type: list more...
      • sim2_pin (Alias name: sim2-pin) Pin code for sim #2 (if applicable). type: list more...
      • status Enable/disable modem online mode. type: str choices: [online, low-power] more...
    • modem2 Modem2. type: dict more...
      • carrier_config (Alias name: carrier-config) Carrier-config selection mode. type: str choices: [manual, auto-gcf, auto-ptcrb] more...
      • custom_ipv4_netmask (Alias name: custom-ipv4-netmask) Netmask assigned by the dhcp server. type: str more...
      • default_gateway (Alias name: default-gateway) Modem interface default gateway. type: str choices: [auto, none] more...
      • default_netmask (Alias name: default-netmask) Modem interface default netmask. type: str choices: [auto, custom] more...
      • gps_service (Alias name: gps-service) Enable/disable modem online mode. type: str choices: [disable, enable] more...
      • intferface Modem interface. type: str more...
      • modem_id (Alias name: modem-id) Modem id. type: int more...
      • network_type (Alias name: network-type) Modem network type. type: str choices: [auto, 4g|5g, 3g|4g, 3g|5g, 5g, 4g, 3g] more...
      • sim_data_plan (Alias name: sim-data-plan) Data plan for sim. type: list more...
      • sim_pin (Alias name: sim-pin) Pin code for sim(if applicable). type: list more...
      • status Enable/disable modem online mode. type: str choices: [online, low-power] more...
    • status Enable/disable usb 5g modem daemon. type: str choices: [disable, enable] more...

Notes

Note

  • Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace_locking_adom and workspace_locking_timeout help do the work.

  • To create or update an object, use state: present directive.

  • To delete an object, use state: absent directive

  • Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc_failed and rc_succeeded

Examples

- name: Example playbook (generated based on argument schema)
  hosts: fortimanagers
  connection: httpapi
  gather_facts: false
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Configure USB 5G modems.
      fortinet.fmgdevice.fmgd_system_5gmodem:
        # bypass_validation: false
        # workspace_locking_adom: <global or your adom name>
        # workspace_locking_timeout: 300
        # rc_succeeded: [0, -2, -3, ...]
        # rc_failed: [-2, -3, ...]
        device: <your own value>
        system_5gmodem:
          # data_plan:
          #   - apn: <string>
          #     auth_type: <value in [none, pap, chap]>
          #     name: <string>
          #     password: <list or string>
          #     pdp_type: <value in [ipv4, ipv6, ipv4v6]>
          #     username: <string>
          # modem1:
          #   carrier_config: <value in [manual, auto-gcf, auto-ptcrb]>
          #   custom_ipv4_netmask: <string>
          #   default_gateway: <value in [auto, none]>
          #   default_netmask: <value in [auto, custom]>
          #   gps_service: <value in [disable, enable]>
          #   intferface: <string>
          #   modem_id: <integer>
          #   network_type: <value in [auto, 4g|5g, 3g|4g, ...]>
          #   sim_data_plan: <list or string>
          #   sim_pin: <list or string>
          #   sim_switch:
          #     active_sim_slot: <value in [slot-1, slot-2]>
          #     by_connection_state: <value in [disable, enable]>
          #     by_link_monitor: <value in [disable, enable]>
          #     by_sim_state: <value in [disable, enable]>
          #     link_monitor: <string>
          #     modem_disconnection_time: <integer>
          #     sim_switch_log_alert_interval: <integer>
          #     sim_switch_log_alert_threshold: <integer>
          #   sim1_data_plan: <list or string>
          #   sim1_pin: <list or string>
          #   sim2_data_plan: <list or string>
          #   sim2_pin: <list or string>
          #   status: <value in [online, low-power]>
          # modem2:
          #   carrier_config: <value in [manual, auto-gcf, auto-ptcrb]>
          #   custom_ipv4_netmask: <string>
          #   default_gateway: <value in [auto, none]>
          #   default_netmask: <value in [auto, custom]>
          #   gps_service: <value in [disable, enable]>
          #   intferface: <string>
          #   modem_id: <integer>
          #   network_type: <value in [auto, 4g|5g, 3g|4g, ...]>
          #   sim_data_plan: <list or string>
          #   sim_pin: <list or string>
          #   status: <value in [online, low-power]>
          # status: <value in [disable, enable]>

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:

  • meta - The result of the request.returned: always type: dict
    • request_url - The full url requested. returned: always type: str sample: /sys/login/user
    • response_code - The status of api request. returned: always type: int sample: 0
    • response_data - The data body of the api response. returned: optional type: list or dict
    • response_message - The descriptive message of the api response. returned: always type: str sample: OK
    • system_information - The information of the target system. returned: always type: dict
  • rc - The status the request. returned: always type: int sample: 0
  • version_check_warning - Warning if the parameters used in the playbook are not supported by the current FortiManager version. returned: if at least one parameter not supported by the current FortiManager version type: list

Status

  • This module is not guaranteed to have a backwards compatible interface.

Authors

  • Xinwei Du (@dux-fortinet)

  • Xing Li (@lix-fortinet)

  • Jie Xue (@JieX19)

  • Link Zheng (@chillancezen)

  • Frank Shen (@fshen01)

  • Hongbin Lu (@fgtdev-hblu)