lix_fortinet.fortios.fortios_system_replacemsg_mm4 (102.2.120) — module

Install collection

Install with ansible-galaxy collection install lix_fortinet.fortios:==102.2.120

Add to requirements.yml

  collections:
    - name: lix_fortinet.fortios
      version: 102.2.120

Description

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify system_replacemsg feature and mm4 category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0

Requirements

• ansible>=2.9

Usage examples

Scanned by Steampunk Spotter

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

- hosts: fortigates
  collections:
    - fortinet.fortios
  connection: httpapi
  vars:
   vdom: "root"
   ansible_httpapi_use_ssl: yes
   ansible_httpapi_validate_certs: no
   ansible_httpapi_port: 443
  tasks:
  - name: Replacement messages.
    fortios_system_replacemsg_mm4:
      vdom:  "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      system_replacemsg_mm4:
        add_smil: "enable"
        charset: "utf-8"
        class: "not-included"
        domain: "<your_own_value>"
        format: "none"
        fos_message: "<your_own_value>"
        from: "<your_own_value>"
        from_sender: "enable"
        header: "none"
        image: "<your_own_value> (source system.replacemsg-image.name)"
        msg_type: "<your_own_value>"
        priority: "not-included"
        rsp_status: "ok"
        smil_part: "<your_own_value>"
        subject: "<your_own_value>"

Inputs

    
vdom:
    default: root
    description:
    - 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

state:
    choices:
    - present
    - absent
    description:
    - Indicates whether to create or remove the object.
    required: true
    type: str

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

member_path:
    description:
    - Member attribute path to operate on.
    - Delimited by a slash character if there are more than one attribute.
    - Parameter marked with member_path is legitimate for doing member operation.
    type: str

access_token:
    description:
    - Token-based authentication. Generated from GUI of Fortigate.
    required: false
    type: str

member_state:
    choices:
    - present
    - absent
    description:
    - Add or delete a member under specified attribute path.
    - When member_state is specified, the state option is ignored.
    type: str

system_replacemsg_mm4:
    default: null
    description:
    - Replacement messages.
    suboptions:
      add_smil:
        choices:
        - enable
        - disable
        description:
        - add message encapsulation
        type: str
      charset:
        choices:
        - utf-8
        - us-ascii
        description:
        - character encoding used for replacement message
        type: str
      class:
        choices:
        - not-included
        - personal
        - informational
        - advertisement
        - auto
        description:
        - message class
        type: str
      domain:
        description:
        - from address domain
        type: str
      format:
        choices:
        - none
        - text
        - html
        - wml
        description:
        - Format flag.
        type: str
      fos_message:
        description:
        - message text
        type: str
      from:
        description:
        - from address
        type: str
      from_sender:
        choices:
        - enable
        - disable
        description:
        - notification message sent from recipient
        type: str
      header:
        choices:
        - none
        - http
        - 8bit
        description:
        - Header flag.
        type: str
      image:
        description:
        - Message string. Source system.replacemsg-image.name.
        type: str
      msg_type:
        description:
        - Message type.
        type: str
      priority:
        choices:
        - not-included
        - low
        - normal
        - high
        description:
        - message priority
        type: str
      rsp_status:
        choices:
        - ok
        - err-unspecified
        - err-srv-denied
        - err-msg-fmt-corrupt
        - err-snd-addr-unresolv
        - err-net-prob
        - err-content-not-accept
        - err-unsupp-msg
        description:
        - response status
        type: str
      smil_part:
        description:
        - message encapsulation text
        type: str
      subject:
        description:
        - subject text string
        type: str
    type: dict

Outputs

build:
  description: Build number of the fortigate image
  returned: always
  sample: '1547'
  type: str
http_method:
  description: Last method used to provision the content into FortiGate
  returned: always
  sample: PUT
  type: str
http_status:
  description: Last result given by FortiGate on last operation applied
  returned: always
  sample: '200'
  type: str
mkey:
  description: Master key (id) used in the last call to FortiGate
  returned: success
  sample: id
  type: str
name:
  description: Name of the table used to fulfill the request
  returned: always
  sample: urlfilter
  type: str
path:
  description: Path of the table used to fulfill the request
  returned: always
  sample: webfilter
  type: str
revision:
  description: Internal revision number
  returned: always
  sample: 17.0.2.10658
  type: str
serial:
  description: Serial number of the unit
  returned: always
  sample: FGVMEVYYQT3AB5352
  type: str
status:
  description: Indication of the operation's result
  returned: always
  sample: success
  type: str
vdom:
  description: Virtual domain used
  returned: always
  sample: root
  type: str
version:
  description: Version of the FortiGate
  returned: always
  sample: v5.6.3
  type: str