fortinet.fortimanager.fmgr_extendercontroller_extenderprofile_cellular_smsnotification_alert (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: SMS alert list.
      fortinet.fortimanager.fmgr_extendercontroller_extenderprofile_cellular_smsnotification_alert:
        # 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_smsnotification_alert:
          data_exhausted: <string>
          fgt_backup_mode_switch: <string>
          low_signal_strength: <string>
          mode_switch: <string>
          os_image_fallback: <string>
          session_disconnect: <string>
          system_reboot: <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_smsnotification_alert:
    description: The top level parameters set.
    required: false
    suboptions:
      data-exhausted:
        description: Deprecated, please rename it to data_exhausted. Display string when
          data exhausted.
        type: str
      fgt-backup-mode-switch:
        description: Deprecated, please rename it to fgt_backup_mode_switch. Display string
          when FortiGate backup mode switched.
        type: str
      low-signal-strength:
        description: Deprecated, please rename it to low_signal_strength. Display string
          when signal strength is low.
        type: str
      mode-switch:
        description: Deprecated, please rename it to mode_switch. Display string when
          mode is switched.
        type: str
      os-image-fallback:
        description: Deprecated, please rename it to os_image_fallback. Display string
          when falling back to a previous OS image.
        type: str
      session-disconnect:
        description: Deprecated, please rename it to session_disconnect. Display string
          when session disconnected.
        type: str
      system-reboot:
        description: Deprecated, please rename it to system_reboot. Display string when
          system rebooted.
        type: str
    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