:source: fmgd_system_automationaction.py :orphan: .. _fmgd_system_automationaction: fmgd_system_automationaction -- Action for automation stitches. +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. versionadded:: 1.0.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.2.6 -> v7.2.12, v7.4.3 -> 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: Action for automation stitches. fortinet.fmgdevice.fmgd_system_automationaction: # bypass_validation: false # workspace_locking_adom: # workspace_locking_timeout: 300 # rc_succeeded: [0, -2, -3, ...] # rc_failed: [-2, -3, ...] device: state: present # system_automationaction: name: "your value" # Required variable, string # accprofile: # action_type: # alicloud_access_key_id: # alicloud_access_key_secret: # alicloud_function_authorization: # aws_api_key: # azure_api_key: # azure_function_authorization: # description: # email_from: # email_subject: # email_to: # execute_security_fabric: # forticare_email: # http_body: # http_headers: # - id: # key: # value: # fmgr_message: # message_type: # method: # minimum_interval: # output_size: # port: # protocol: # replacement_message: # replacemsg_group: # script: # sdn_connector: # security_tag: # system_action: # timeout: # tls_certificate: # uri: # verify_host_cert: # headers: # required: # delay: # azure_app: # azure_function: # aws_api_path: # aws_region: # gcp_function_domain: # alicloud_account_id: # alicloud_version: # azure_domain: # aws_api_stage: # alicloud_region: # gcp_function_region: # aws_api_id: # alicloud_service: # alicloud_function: # aws_domain: # gcp_project: # gcp_function: # alicloud_function_domain: # email_body: # duration: # regular_expression: # log_debug_print: # password: # output_interval: # file_only: # form_data: # - id: # key: # 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: .. 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)