fortios_system_replacemsg_mm1.rst

source:	fortios_system_replacemsg_mm1.py
orphan:

fortios_system_replacemsg_mm1 -- Replacement messages in Fortinet's FortiOS and FortiGate.

.. versionadded:: 2.0.0

• Synopsis
• Requirements
• FortiOS Version Compatibility
• Parameters
• Notes
• Examples
• Return Values
• Status
• Authors

Synopsis

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

Requirements

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

• ansible>=2.9

FortiOS Version Compatibility

	v6.0.0	v6.0.5	v6.0.11	v6.2.0	v6.2.3	v6.2.5	v6.2.7
fortios_system_replacemsg_mm1	yes	yes	yes	yes	yes	yes	yes

Parameters

• access_token - Token-based authentication. Generated from GUI of Fortigate. type: str required: false
• enable_log - Enable/Disable logging for task. type: bool required: false default: False
• vdom - 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 default: root
• member_path - Member attribute path to operate on. type: str
• member_state - Add or delete a member under specified attribute path. type: str choices: present, absent
• state - Indicates whether to create or remove the object. type: str required: true choices: present, absent
• system_replacemsg_mm1 - Replacement messages. type: dict more...

  	v6.0.0	v6.0.5	v6.0.11	v6.2.0	v6.2.3	v6.2.5	v6.2.7
  system_replacemsg_mm1	yes	yes	yes	yes	yes	yes	yes

• add_smil - add message encapsulation type: str choices: enable, disable more...

  	v6.0.0	v6.0.5	v6.0.11	v6.2.0	v6.2.3	v6.2.5	v6.2.7
  add_smil	yes	yes	yes	yes	yes	yes	yes
  [enable]	yes	yes	yes	yes	yes	yes	yes
  [disable]	yes	yes	yes	yes	yes	yes	yes

• charset - character encoding used for replacement message type: str choices: utf-8, us-ascii more...

  	v6.0.0	v6.0.5	v6.0.11	v6.2.0	v6.2.3	v6.2.5	v6.2.7
  charset	yes	yes	yes	yes	yes	yes	yes
  [utf-8]	yes	yes	yes	yes	yes	yes	yes
  [us-ascii]	yes	yes	yes	yes	yes	yes	yes

• class - message class type: str choices: not-included, personal, advertisement, information, automatic more...

  	v6.0.0	v6.0.5	v6.0.11	v6.2.0	v6.2.3	v6.2.5	v6.2.7
  class	yes	yes	yes	yes	yes	yes	yes
  [not-included]	yes	yes	yes	yes	yes	yes	yes
  [personal]	yes	yes	yes	yes	yes	yes	yes
  [advertisement]	yes	yes	yes	yes	yes	yes	yes
  [information]	yes	yes	yes	yes	yes	yes	yes
  [automatic]	yes	yes	yes	yes	yes	yes	yes

• format - Format flag. type: str choices: none, text, html, wml more...

  	v6.0.0	v6.0.5	v6.0.11	v6.2.0	v6.2.3	v6.2.5	v6.2.7
  format	yes	yes	yes	yes	yes	yes	yes
  [none]	yes	yes	yes	yes	yes	yes	yes
  [text]	yes	yes	yes	yes	yes	yes	yes
  [html]	yes	yes	yes	yes	yes	yes	yes
  [wml]	yes	yes	yes	yes	yes	yes	yes

• from - from address type: str more...

  	v6.0.0	v6.0.5	v6.0.11	v6.2.0	v6.2.3	v6.2.5	v6.2.7
  from	yes	yes	yes	yes	yes	yes	yes

• from_sender - notification message sent from recipient type: str choices: enable, disable more...

  	v6.0.0	v6.0.5	v6.0.11	v6.2.0	v6.2.3	v6.2.5	v6.2.7
  from_sender	yes	yes	yes	yes	yes	yes	yes
  [enable]	yes	yes	yes	yes	yes	yes	yes
  [disable]	yes	yes	yes	yes	yes	yes	yes

• header - Header flag. type: str choices: none, http, 8bit more...

  	v6.0.0	v6.0.5	v6.0.11	v6.2.0	v6.2.3	v6.2.5	v6.2.7
  header	yes	yes	yes	yes	yes	yes	yes
  [none]	yes	yes	yes	yes	yes	yes	yes
  [http]	yes	yes	yes	yes	yes	yes	yes
  [8bit]	yes	yes	yes	yes	yes	yes	yes

• image - Message string. Source system.replacemsg-image.name. type: str more...

  	v6.0.0	v6.0.5	v6.0.11	v6.2.0	v6.2.3	v6.2.5	v6.2.7
  image	yes	yes	yes	yes	yes	yes	yes

• message - message text type: str more...

  	v6.0.0	v6.0.5	v6.0.11	v6.2.0	v6.2.3	v6.2.5	v6.2.7
  message	yes	yes	yes	yes	yes	yes	yes

• msg_type - Message type. type: str more...

  	v6.0.0	v6.0.5	v6.0.11	v6.2.0	v6.2.3	v6.2.5	v6.2.7
  msg_type	yes	yes	yes	yes	yes	yes	yes

• priority - message priority type: str choices: not-included, low, normal, high more...

  	v6.0.0	v6.0.5	v6.0.11	v6.2.0	v6.2.3	v6.2.5	v6.2.7
  priority	yes	yes	yes	yes	yes	yes	yes
  [not-included]	yes	yes	yes	yes	yes	yes	yes
  [low]	yes	yes	yes	yes	yes	yes	yes
  [normal]	yes	yes	yes	yes	yes	yes	yes
  [high]	yes	yes	yes	yes	yes	yes	yes

• rsp_status - response status code type: str choices: ok, err-unspecified, err-srv-denied, err-msg-fmt-corrupt, err-snd-addr-unresolv, err-msg-not-found, err-net-prob, err-content-not-accept, err-unsupp-msg more...

  	v6.0.0	v6.0.5	v6.0.11	v6.2.0	v6.2.3	v6.2.5	v6.2.7
  rsp_status	yes	yes	yes	yes	yes	yes	yes
  [ok]	yes	yes	yes	yes	yes	yes	yes
  [err-unspecified]	yes	yes	yes	yes	yes	yes	yes
  [err-srv-denied]	yes	yes	yes	yes	yes	yes	yes
  [err-msg-fmt-corrupt]	yes	yes	yes	yes	yes	yes	yes
  [err-snd-addr-unresolv]	yes	yes	yes	yes	yes	yes	yes
  [err-msg-not-found]	yes	yes	yes	yes	yes	yes	yes
  [err-net-prob]	yes	yes	yes	yes	yes	yes	yes
  [err-content-not-accept]	yes	yes	yes	yes	yes	yes	yes
  [err-unsupp-msg]	yes	yes	yes	yes	yes	yes	yes

• rsp_text - response text type: str more...

  	v6.0.0	v6.0.5	v6.0.11	v6.2.0	v6.2.3	v6.2.5	v6.2.7
  rsp_text	yes	yes	yes	yes	yes	yes	yes

• sender_visibility - sender visibility type: str choices: not-specified, show, hide more...

  	v6.0.0	v6.0.5	v6.0.11	v6.2.0	v6.2.3	v6.2.5	v6.2.7
  sender_visibility	yes	yes	yes	yes	yes	yes	yes
  [not-specified]	yes	yes	yes	yes	yes	yes	yes
  [show]	yes	yes	yes	yes	yes	yes	yes
  [hide]	yes	yes	yes	yes	yes	yes	yes

• smil_part - message encapsulation text type: str more...

  	v6.0.0	v6.0.5	v6.0.11	v6.2.0	v6.2.3	v6.2.5	v6.2.7
  smil_part	yes	yes	yes	yes	yes	yes	yes

• subject - subject text string type: str more...

  	v6.0.0	v6.0.5	v6.0.11	v6.2.0	v6.2.3	v6.2.5	v6.2.7
  subject	yes	yes	yes	yes	yes	yes	yes

Notes

Note

• Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks

Examples

- 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_mm1:
      vdom:  "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      system_replacemsg_mm1:
        add_smil: "enable"
        charset: "utf-8"
        class: "not-included"
        format: "none"
        from: "<your_own_value>"
        from_sender: "enable"
        header: "none"
        image: "<your_own_value> (source system.replacemsg-image.name)"
        message: "<your_own_value>"
        msg_type: "<your_own_value>"
        priority: "not-included"
        rsp_status: "ok"
        rsp_text: "<your_own_value>"
        sender_visibility: "not-specified"
        smil_part: "<your_own_value>"
        subject: "<your_own_value>"

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:

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

Status

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

Authors

• Link Zheng (@chillancezen)
• Jie Xue (@JieX19)
• Hongbin Lu (@fgtdev-hblu)
• Frank Shen (@frankshen01)
• Miguel Angel Munoz (@mamunozgonzalez)
• Nicolas Thomas (@thomnico)

Hint

If you notice any issues in this documentation, you can create a pull request to improve it.