Skip to content

Latest commit

 

History

History
471 lines (427 loc) · 20.6 KB

fortios_system_replacemsg_mm1.rst

File metadata and controls

471 lines (427 loc) · 20.6 KB
Raw
source:fortios_system_replacemsg_mm1.py
orphan:

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

.. versionadded:: 2.0.0

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.14

Tips

Using member operation to add an element to an existing object.

FortiOS Version Compatibility


Supported Version Ranges
fortios_system_replacemsg_mm1 v6.0.0 -> v6.2.7

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...
    Supported Version Ranges
    system_replacemsg_mm1 v6.0.0 -> v6.2.7
    • add_smil - add message encapsulation type: str choices: enable, disable more...
      Supported Version Ranges
      add_smil v6.0.0 -> v6.2.7
      [enable] v6.0.0 -> latest
      [disable] v6.0.0 -> latest
    • charset - character encoding used for replacement message type: str choices: utf-8, us-ascii more...
      Supported Version Ranges
      charset v6.0.0 -> v6.2.7
      [utf-8] v6.0.0 -> latest
      [us-ascii] v6.0.0 -> latest
    • class - message class type: str choices: not-included, personal, advertisement, information, automatic more...
      Supported Version Ranges
      class v6.0.0 -> v6.2.7
      [not-included] v6.0.0 -> latest
      [personal] v6.0.0 -> latest
      [advertisement] v6.0.0 -> latest
      [information] v6.0.0 -> latest
      [automatic] v6.0.0 -> latest
    • format - Format flag. type: str choices: none, text, html, wml more...
      Supported Version Ranges
      format v6.0.0 -> v6.2.7
      [none] v6.0.0 -> latest
      [text] v6.0.0 -> latest
      [html] v6.0.0 -> latest
      [wml] v6.0.0 -> latest
    • fos_message - message text type: str more...
      Supported Version Ranges
      fos_message v6.0.0 -> v6.2.7
    • from - from address type: str more...
      Supported Version Ranges
      from v6.0.0 -> v6.2.7
    • from_sender - notification message sent from recipient type: str choices: enable, disable more...
      Supported Version Ranges
      from_sender v6.0.0 -> v6.2.7
      [enable] v6.0.0 -> latest
      [disable] v6.0.0 -> latest
    • header - Header flag. type: str choices: none, http, 8bit more...
      Supported Version Ranges
      header v6.0.0 -> v6.2.7
      [none] v6.0.0 -> latest
      [http] v6.0.0 -> latest
      [8bit] v6.0.0 -> latest
    • image - Message string. Source system.replacemsg-image.name. type: str more...
      Supported Version Ranges
      image v6.0.0 -> v6.2.7
    • msg_type - Message type. type: str required: true more...
      Supported Version Ranges
      msg_type v6.0.0 -> v6.2.7
    • priority - message priority type: str choices: not-included, low, normal, high more...
      Supported Version Ranges
      priority v6.0.0 -> v6.2.7
      [not-included] v6.0.0 -> latest
      [low] v6.0.0 -> latest
      [normal] v6.0.0 -> latest
      [high] v6.0.0 -> latest
    • 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...
      Supported Version Ranges
      rsp_status v6.0.0 -> v6.2.7
      [ok] v6.0.0 -> latest
      [err-unspecified] v6.0.0 -> latest
      [err-srv-denied] v6.0.0 -> latest
      [err-msg-fmt-corrupt] v6.0.0 -> latest
      [err-snd-addr-unresolv] v6.0.0 -> latest
      [err-msg-not-found] v6.0.0 -> latest
      [err-net-prob] v6.0.0 -> latest
      [err-content-not-accept] v6.0.0 -> latest
      [err-unsupp-msg] v6.0.0 -> latest
    • rsp_text - response text type: str more...
      Supported Version Ranges
      rsp_text v6.0.0 -> v6.2.7
    • sender_visibility - sender visibility type: str choices: not-specified, show, hide more...
      Supported Version Ranges
      sender_visibility v6.0.0 -> v6.2.7
      [not-specified] v6.0.0 -> latest
      [show] v6.0.0 -> latest
      [hide] v6.0.0 -> latest
    • smil_part - message encapsulation text type: str more...
      Supported Version Ranges
      smil_part v6.0.0 -> v6.2.7
    • subject - subject text string type: str more...
      Supported Version Ranges
      subject v6.0.0 -> v6.2.7

Notes

Note

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

Examples

- name: Replacement messages.
  fortinet.fortios.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"
          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"
          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.