drmofu.fortimanager.fmgr_firewall_mmsprofile_notification (2.2.2) — module

Install collection

Install with ansible-galaxy collection install drmofu.fortimanager:==2.2.2

Add to requirements.yml

  collections:
    - name: drmofu.fortimanager
      version: 2.2.2

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.

 - hosts: fortimanager-inventory
   collections:
     - fortinet.fortimanager
   connection: httpapi
   vars:
      ansible_httpapi_use_ssl: True
      ansible_httpapi_validate_certs: False
      ansible_httpapi_port: 443
   tasks:
    - name: Notification configuration.
      fmgr_firewall_mmsprofile_notification:
         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>
         mms-profile: <your own value>
         firewall_mmsprofile_notification:
            alert-int: <value of integer>
            alert-int-mode: <value in [hours, minutes]>
            alert-src-msisdn: <value of string>
            alert-status: <value in [disable, enable]>
            bword-int: <value of integer>
            bword-int-mode: <value in [hours, minutes]>
            bword-status: <value in [disable, enable]>
            carrier-endpoint-bwl-int: <value of integer>
            carrier-endpoint-bwl-int-mode: <value in [hours, minutes]>
            carrier-endpoint-bwl-status: <value in [disable, enable]>
            days-allowed:
              - sunday
              - monday
              - tuesday
              - wednesday
              - thursday
              - friday
              - saturday
            detect-server: <value in [disable, enable]>
            dupe-int: <value of integer>
            dupe-int-mode: <value in [hours, minutes]>
            dupe-status: <value in [disable, enable]>
            file-block-int: <value of integer>
            file-block-int-mode: <value in [hours, minutes]>
            file-block-status: <value in [disable, enable]>
            flood-int: <value of integer>
            flood-int-mode: <value in [hours, minutes]>
            flood-status: <value in [disable, enable]>
            from-in-header: <value in [disable, enable]>
            mms-checksum-int: <value of integer>
            mms-checksum-int-mode: <value in [hours, minutes]>
            mms-checksum-status: <value in [disable, enable]>
            mmsc-hostname: <value of string>
            mmsc-password: <value of string>
            mmsc-port: <value of integer>
            mmsc-url: <value of string>
            mmsc-username: <value of string>
            msg-protocol: <value in [mm1, mm3, mm4, ...]>
            msg-type: <value in [submit-req, deliver-req]>
            protocol: <value of string>
            rate-limit: <value of integer>
            tod-window-duration: <value of string>
            tod-window-end: <value of string>
            tod-window-start: <value of string>
            user-domain: <value of string>
            vas-id: <value of string>
            vasp-id: <value of string>
            virus-int: <value of integer>
            virus-int-mode: <value in [hours, minutes]>
            virus-status: <value in [disable, enable]>

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
    required: false
    type: list

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

mms-profile:
    description: the parameter (mms-profile) in requested url
    required: true
    type: str

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

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

proposed_method:
    choices:
    - update
    - set
    - add
    description: The overridden method for the underlying Json RPC request.
    required: false
    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.
    required: false
    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.
    required: false
    type: str

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

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

firewall_mmsprofile_notification:
    description: the top level parameters set
    required: false
    suboptions:
      alert-int:
        description: Alert notification send interval.
        type: int
      alert-int-mode:
        choices:
        - hours
        - minutes
        description: Alert notification interval mode.
        type: str
      alert-src-msisdn:
        description: Specify from address for alert messages.
        type: str
      alert-status:
        choices:
        - disable
        - enable
        description: Alert notification status.
        type: str
      bword-int:
        description: Banned word notification send interval.
        type: int
      bword-int-mode:
        choices:
        - hours
        - minutes
        description: Banned word notification interval mode.
        type: str
      bword-status:
        choices:
        - disable
        - enable
        description: Banned word notification status.
        type: str
      carrier-endpoint-bwl-int:
        description: Carrier end point black/white list notification send interval.
        type: int
      carrier-endpoint-bwl-int-mode:
        choices:
        - hours
        - minutes
        description: Carrier end point black/white list notification interval mode.
        type: str
      carrier-endpoint-bwl-status:
        choices:
        - disable
        - enable
        description: Carrier end point black/white list notification status.
        type: str
      days-allowed:
        choices:
        - sunday
        - monday
        - tuesday
        - wednesday
        - thursday
        - friday
        - saturday
        description: description
        elements: str
        type: list
      detect-server:
        choices:
        - disable
        - enable
        description: Enable/disable automatic server address determination.
        type: str
      dupe-int:
        description: Duplicate notification send interval.
        type: int
      dupe-int-mode:
        choices:
        - hours
        - minutes
        description: Duplicate notification interval mode.
        type: str
      dupe-status:
        choices:
        - disable
        - enable
        description: Duplicate notification status.
        type: str
      file-block-int:
        description: File block notification send interval.
        type: int
      file-block-int-mode:
        choices:
        - hours
        - minutes
        description: File block notification interval mode.
        type: str
      file-block-status:
        choices:
        - disable
        - enable
        description: File block notification status.
        type: str
      flood-int:
        description: Flood notification send interval.
        type: int
      flood-int-mode:
        choices:
        - hours
        - minutes
        description: Flood notification interval mode.
        type: str
      flood-status:
        choices:
        - disable
        - enable
        description: Flood notification status.
        type: str
      from-in-header:
        choices:
        - disable
        - enable
        description: Enable/disable insertion of from address in HTTP header.
        type: str
      mms-checksum-int:
        description: MMS checksum notification send interval.
        type: int
      mms-checksum-int-mode:
        choices:
        - hours
        - minutes
        description: MMS checksum notification interval mode.
        type: str
      mms-checksum-status:
        choices:
        - disable
        - enable
        description: MMS checksum notification status.
        type: str
      mmsc-hostname:
        description: Host name or IP address of the MMSC.
        type: str
      mmsc-password:
        description: description
        type: str
      mmsc-port:
        description: Port used on the MMSC for sending MMS messages
        type: int
      mmsc-url:
        description: URL used on the MMSC for sending MMS messages.
        type: str
      mmsc-username:
        description: User name required for authentication with the MMSC.
        type: str
      msg-protocol:
        choices:
        - mm1
        - mm3
        - mm4
        - mm7
        description: Protocol to use for sending notification messages.
        type: str
      msg-type:
        choices:
        - submit-req
        - deliver-req
        description: MM7 message type.
        type: str
      protocol:
        description: Protocol.
        type: str
      rate-limit:
        description: Rate limit for sending notification messages
        type: int
      tod-window-duration:
        description: Time of day window duration.
        type: str
      tod-window-end:
        description: Obsolete.
        type: str
      tod-window-start:
        description: Time of day window start.
        type: str
      user-domain:
        description: Domain name to which the user addresses belong.
        type: str
      vas-id:
        description: VAS identifier.
        type: str
      vasp-id:
        description: VASP identifier.
        type: str
      virus-int:
        description: Virus notification send interval.
        type: int
      virus-int-mode:
        choices:
        - hours
        - minutes
        description: Virus notification interval mode.
        type: str
      virus-status:
        choices:
        - disable
        - enable
        description: Virus notification status.
        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