fortinet.fortimanager.fmgr_extendercontroller_extenderprofile_cellular_modem1 (2.4.0) — module

Install collection

Install with ansible-galaxy collection install fortinet.fortimanager:==2.4.0

Add to requirements.yml

  collections:
    - name: fortinet.fortimanager
      version: 2.4.0

Description

This module is able to configure a FortiManager device.

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

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Example playbook (generated based on argument schema)
  hosts: fortimanagers
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Configuration options for modem 1.
      fortinet.fortimanager.fmgr_extendercontroller_extenderprofile_cellular_modem1:
        # bypass_validation: false
        workspace_locking_adom: <value in [global, custom adom including root]>
        workspace_locking_timeout: 300
        # rc_succeeded: [0, -2, -3, ...]
        # rc_failed: [-2, -3, ...]
        adom: <your own value>
        extender_profile: <your own value>
        extendercontroller_extenderprofile_cellular_modem1:
          auto_switch:
            dataplan: <value in [disable, enable]>
            disconnect: <value in [disable, enable]>
            disconnect_period: <integer>
            disconnect_threshold: <integer>
            signal: <value in [disable, enable]>
            switch_back:
              - time
              - timer
            switch_back_time: <string>
            switch_back_timer: <integer>
          conn_status: <integer>
          default_sim: <value in [sim1, sim2, carrier, ...]>
          gps: <value in [disable, enable]>
          modem_id: <integer>
          preferred_carrier: <string>
          redundant_intf: <string>
          redundant_mode: <value in [disable, enable]>
          sim1_pin: <value in [disable, enable]>
          sim1_pin_code: <list or string>
          sim2_pin: <value in [disable, enable]>
          sim2_pin_code: <list or string>

Inputs

    
adom:
    description: The parameter (adom) in requested url.
    required: true
    type: str

rc_failed:
    description: The rc codes list with which the conditions to fail will be overriden.
    elements: int
    type: list

enable_log:
    default: false
    description: Enable/Disable logging for task.
    type: bool

access_token:
    description: The token to access FortiManager without using username and password.
    type: str

rc_succeeded:
    description: The rc codes list with which the conditions to succeed will be overriden.
    elements: int
    type: list

proposed_method:
    choices:
    - update
    - set
    - add
    description: The overridden method for the underlying Json RPC request.
    type: str

extender-profile:
    description: Deprecated, please use "extender_profile"
    type: str

extender_profile:
    description: The parameter (extender-profile) in requested url.
    type: str

bypass_validation:
    default: false
    description: Only set to True when module schema diffs with FortiManager API structure,
      module continues to execute without validating parameters.
    type: bool

workspace_locking_adom:
    description: The adom to lock for FortiManager running in workspace mode, the value
      can be global and others including root.
    type: str

forticloud_access_token:
    description: Authenticate Ansible client with forticloud API access token.
    type: str

workspace_locking_timeout:
    default: 300
    description: The maximum time in seconds to wait for other user to release the workspace
      lock.
    type: int

extendercontroller_extenderprofile_cellular_modem1:
    description: The top level parameters set.
    required: false
    suboptions:
      auto-switch:
        description: Deprecated, please rename it to auto_switch.
        suboptions:
          dataplan:
            choices:
            - disable
            - enable
            description: Automatically switch based on data usage.
            type: str
          disconnect:
            choices:
            - disable
            - enable
            description: Auto switch by disconnect.
            type: str
          disconnect-period:
            description: Deprecated, please rename it to disconnect_period. Automatically
              switch based on disconnect period.
            type: int
          disconnect-threshold:
            description: Deprecated, please rename it to disconnect_threshold. Automatically
              switch based on disconnect threshold.
            type: int
          signal:
            choices:
            - disable
            - enable
            description: Automatically switch based on signal strength.
            type: str
          switch-back:
            choices:
            - time
            - timer
            description: Deprecated, please rename it to switch_back.
            elements: str
            type: list
          switch-back-time:
            description: Deprecated, please rename it to switch_back_time. Automatically
              switch over to preferred SIM/carrier at a specifie...
            type: str
          switch-back-timer:
            description: Deprecated, please rename it to switch_back_timer. Automatically
              switch over to preferred SIM/carrier after the gi...
            type: int
        type: dict
      conn-status:
        description: Deprecated, please rename it to conn_status.
        type: int
      default-sim:
        choices:
        - sim1
        - sim2
        - carrier
        - cost
        description: Deprecated, please rename it to default_sim. Default SIM selection.
        type: str
      gps:
        choices:
        - disable
        - enable
        description: FortiExtender GPS enable/disable.
        type: str
      modem-id:
        description: Deprecated, please rename it to modem_id. Modem ID.
        type: int
      preferred-carrier:
        description: Deprecated, please rename it to preferred_carrier. Preferred carrier.
        type: str
      redundant-intf:
        description: Deprecated, please rename it to redundant_intf. Redundant interface.
        type: str
      redundant-mode:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to redundant_mode. FortiExtender mode.
        type: str
      sim1-pin:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to sim1_pin. SIM
        type: str
      sim1-pin-code:
        description: (list) Deprecated, please rename it to sim1_pin_code.
        type: raw
      sim2-pin:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to sim2_pin. SIM
        type: str
      sim2-pin-code:
        description: (list) Deprecated, please rename it to sim2_pin_code.
        type: raw
    type: dict

Outputs

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