fortinet / fortinet.fortimanager / 2.4.0 / module / fmgr_devprof_system_emailserver Configure the email server used by the FortiGate various things. | "added in version" 1.0.0 of fortinet.fortimanager" Authors: Xinwei Du (@dux-fortinet), Xing Li (@lix-fortinet), Jie Xue (@JieX19), Link Zheng (@chillancezen), Frank Shen (@fshen01), Hongbin Lu (@fgtdev-hblu) preview | supported by communityfortinet.fortimanager.fmgr_devprof_system_emailserver (2.4.0) — module
Install with ansible-galaxy collection install fortinet.fortimanager:==2.4.0
collections: - name: fortinet.fortimanager version: 2.4.0
This module is able to configure a FortiManager device.
Examples include all parameters and values which need to be adjusted to data sources before usage.
- name: Example playbook (generated based on argument schema) hosts: fortimanagers connection: httpapi vars: ansible_httpapi_use_ssl: true ansible_httpapi_validate_certs: false ansible_httpapi_port: 443 tasks: - name: Configure the email server used by the FortiGate various things. fortinet.fortimanager.fmgr_devprof_system_emailserver: # bypass_validation: false workspace_locking_adom: <value in [global, custom adom including root]> workspace_locking_timeout: 300 # rc_succeeded: [0, -2, -3, ...] # rc_failed: [-2, -3, ...] adom: <your own value> devprof: <your own value> devprof_system_emailserver: authenticate: <value in [disable, enable]> password: <list or string> port: <integer> reply_to: <string> security: <value in [none, starttls, smtps]> server: <string> source_ip: <string> source_ip6: <string> ssl_min_proto_version: <value in [default, TLSv1, TLSv1-1, ...]> type: <value in [custom]> username: <string> validate_server: <value in [disable, enable]> interface: <string> interface_select_method: <value in [auto, sdwan, specify]>
adom: description: The parameter (adom) in requested url. required: true type: str devprof: description: The parameter (devprof) in requested url. required: true type: str rc_failed: description: The rc codes list with which the conditions to fail will be overriden. elements: int type: list enable_log: default: false description: Enable/Disable logging for task. type: bool access_token: description: The token to access FortiManager without using username and password. type: str rc_succeeded: description: The rc codes list with which the conditions to succeed will be overriden. elements: int type: list proposed_method: choices: - update - set - add description: The overridden method for the underlying Json RPC request. type: str bypass_validation: default: false description: Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters. type: bool workspace_locking_adom: description: The adom to lock for FortiManager running in workspace mode, the value can be global and others including root. type: str forticloud_access_token: description: Authenticate Ansible client with forticloud API access token. type: str workspace_locking_timeout: default: 300 description: The maximum time in seconds to wait for other user to release the workspace lock. type: int devprof_system_emailserver: description: The top level parameters set. required: false suboptions: authenticate: choices: - disable - enable description: Enable/disable authentication. type: str interface: description: Specify outgoing interface to reach server. type: str interface-select-method: choices: - auto - sdwan - specify description: Deprecated, please rename it to interface_select_method. Specify how to select outgoing interface to reach server. type: str password: description: (list) No description. type: raw port: description: SMTP server port. type: int reply-to: description: Deprecated, please rename it to reply_to. Reply-To email address. type: str security: choices: - none - starttls - smtps description: Connection security used by the email server. type: str server: description: SMTP server IP address or hostname. type: str source-ip: description: Deprecated, please rename it to source_ip. SMTP server IPv4 source IP. type: str source-ip6: description: Deprecated, please rename it to source_ip6. SMTP server IPv6 source IP. type: str ssl-min-proto-version: choices: - default - TLSv1 - TLSv1-1 - TLSv1-2 - SSLv3 - TLSv1-3 description: Deprecated, please rename it to ssl_min_proto_version. Minimum supported protocol version for SSL/TLS connections type: str type: choices: - custom description: Use FortiGuard Message service or custom email server. type: str username: description: SMTP server user name for authentication. type: str validate-server: choices: - disable - enable description: Deprecated, please rename it to validate_server. Enable/disable validation of server certificate. type: str type: dict
meta: contains: request_url: description: The full url requested. returned: always sample: /sys/login/user type: str response_code: description: The status of api request. returned: always sample: 0 type: int response_data: description: The api response. returned: always type: list response_message: description: The descriptive message of the api response. returned: always sample: OK. type: str system_information: description: The information of the target system. returned: always type: dict description: The result of the request. returned: always type: dict rc: description: The status the request. returned: always sample: 0 type: int version_check_warning: description: Warning if the parameters used in the playbook are not supported by the current FortiManager version. returned: complex type: list