:source: fmgd_system_replacemsggroup.py :orphan: .. _fmgd_system_replacemsggroup: fmgd_system_replacemsggroup -- Configure replacement message groups. ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. versionadded:: 1.1.0 .. contents:: :local: :depth: 1 Synopsis -------- - This module is able to configure a FortiManager device. - Examples include all parameters and values need to be adjusted to data sources before usage. - Tested with FortiManager v7.x. Requirements ------------ The below requirements are needed on the host that executes this module. - ansible-core>=2.16.0 FortiManager Version Compatibility ---------------------------------- .. raw:: html

Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest

Parameters ---------- .. raw:: html Notes ----- .. note:: - Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace_locking_adom and workspace_locking_timeout help do the work. - To create or update an object, use state: present directive. - To delete an object, use state: absent directive - Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc_failed and rc_succeeded Examples -------- .. code-block:: yaml+jinja - name: Example playbook (generated based on argument schema) hosts: fortimanagers connection: httpapi gather_facts: false vars: ansible_httpapi_use_ssl: true ansible_httpapi_validate_certs: false ansible_httpapi_port: 443 tasks: - name: Configure replacement message groups. fortinet.fmgdevice.fmgd_system_replacemsggroup: # bypass_validation: false # workspace_locking_adom: # workspace_locking_timeout: 300 # rc_succeeded: [0, -2, -3, ...] # rc_failed: [-2, -3, ...] device: vdom: state: present # system_replacemsggroup: name: "your value" # Required variable, string # admin: # - buffer: # format: # header: # msg_type: # alertmail: # - buffer: # format: # header: # msg_type: # id: # auth: # - buffer: # format: # header: # msg_type: # automation: # - buffer: # format: # header: # msg_type: # comment: # custom_message: # - buffer: # format: # header: # msg_type: # fortiguard_wf: # - buffer: # format: # header: # msg_type: # ftp: # - buffer: # format: # header: # msg_type: # group_type: # http: # - buffer: # format: # header: # msg_type: # icap: # - buffer: # format: # header: # msg_type: # mail: # - buffer: # format: # header: # msg_type: # nac_quar: # - buffer: # format: # header: # msg_type: # id: # spam: # - buffer: # format: # header: # msg_type: # traffic_quota: # - buffer: # format: # header: # msg_type: # utm: # - buffer: # format: # header: # msg_type: # webproxy: # - buffer: # format: # header: # msg_type: # sslvpn: # - buffer: # format: # header: # msg_type: # device_detection_portal: # - buffer: # format: # header: # msg_type: # nntp: # - buffer: # format: # header: # msg_type: # mms: # - buffer: # charset: # format: # header: # image: # msg_type: # mm1: # - add_smil: # charset: # class: # format: # from: # from_sender: # header: # image: # fmgr_message: # msg_type: # priority: # rsp_status: # rsp_text: # sender_visibility: # smil_part: # subject: # mm7: # - add_smil: # addr_type: # allow_content_adaptation: # charset: # class: # format: # from: # from_sender: # header: # image: # fmgr_message: # msg_type: # priority: # rsp_status: # smil_part: # subject: # mm4: # - add_smil: # charset: # class: # domain: # format: # from: # from_sender: # header: # image: # fmgr_message: # msg_type: # priority: # rsp_status: # smil_part: # subject: # mm3: # - add_html: # charset: # format: # from: # from_sender: # header: # html_part: # image: # fmgr_message: # msg_type: # priority: # subject: # ec: # - buffer: # format: # header: # msg_type: 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: .. raw:: html
  • meta - The result of the request.returned: always type: dict
    • request_url - The full url requested. returned: always type: str sample: /sys/login/user
    • response_code - The status of api request. returned: always type: int sample: 0
    • response_data - The data body of the api response. returned: optional type: list or dict
    • response_message - The descriptive message of the api response. returned: always type: str sample: OK
    • system_information - The information of the target system. returned: always type: dict
  • rc - The status the request. returned: always type: int sample: 0
  • version_check_warning - Warning if the parameters used in the playbook are not supported by the current FortiManager version. returned: if at least one parameter not supported by the current FortiManager version type: list
Status ------ - This module is not guaranteed to have a backwards compatible interface. Authors ------- - Xinwei Du (@dux-fortinet) - Xing Li (@lix-fortinet) - Jie Xue (@JieX19) - Link Zheng (@chillancezen) - Frank Shen (@fshen01) - Hongbin Lu (@fgtdev-hblu)