fmgr_devprof_system_emailserver – Configure the email server used by the FortiGate various things.¶
New in version 2.10.
Synopsis¶
- This module is able to configure a FortiManager device by allowing the user to [get, set, update] the following FortiManager json-rpc urls.
- /pm/config/adom/{adom}/devprof/{devprof}/system/email-server
- Examples include all parameters and values need to be adjusted to data sources before usage.
- Tested with FortiManager v6.0.0
Requirements¶
The below requirements are needed on the host that executes this module.
- ansible>=2.10.0
Parameters¶
- loose_validation - Do parameter validation in a loose way type: bool required: false default: false
- workspace_locking_adom - Acquire the workspace lock if FortiManager is running in workspace mode type: str required: false choices: global, custom dom
- workspace_locking_timeout - The maximum time in seconds to wait for other users to release workspace lock type: integer required: false default: 300
- url_params - parameters in url path type: dict required: true
- adom - the domain prefix type: str choices: none, global, custom dom
- devprof - the object name type: str
- parameters for method: [get] - Configure the email server used by the FortiGate various things. For example, for sending email messages to users to support user authentication features.
- option - Set fetch option for the request. type: str choices: [object member, chksum, datasrc]
- parameters for method: [set, update] - Configure the email server used by the FortiGate various things. For example, for sending email messages to users to support user authentication features.
- data - No description for the parameter type: dict
- authenticate - Enable/disable authentication. type: str choices: [disable, enable]
- password - No description for the parameter type: array
- {no-name} - No description for the parameter type: str
- port - SMTP server port. type: int
- reply-to - Reply-To email address. type: str
- security - Connection security used by the email server. type: str choices: [none, starttls, smtps]
- server - SMTP server IP address or hostname. type: str
- source-ip - SMTP server IPv4 source IP. type: str
- source-ip6 - SMTP server IPv6 source IP. type: str
- ssl-min-proto-version - Minimum supported protocol version for SSL/TLS connections (default is to follow system global setting). type: str choices: [default, TLSv1, TLSv1-1, TLSv1-2, SSLv3]
- type - Use FortiGuard Message service or custom email server. type: str choices: [custom]
- username - SMTP server user name for authentication. type: str
- validate-server - Enable/disable validation of server certificate. type: str choices: [disable, enable]
Notes¶
Note
- The module may supports multiple method, every method has different parameters definition
- One method may also have more than one parameter definition collection, each collection is dedicated to one API endpoint
- The module may include domain dependent urls, the domain can be specified in url_params as adom
- To run in workspace mode, the paremeter workspace_locking_adom must be included in the task
Examples¶
- hosts: fortimanager-inventory
collections:
- fortinet.fortimanager
connection: httpapi
vars:
ansible_httpapi_use_ssl: True
ansible_httpapi_validate_certs: False
ansible_httpapi_port: 443
tasks:
- name: REQUESTING /PM/CONFIG/DEVPROF/{DEVPROF}/SYSTEM/EMAIL-SERVER
fmgr_devprof_system_emailserver:
loose_validation: False
workspace_locking_adom: <value in [global, custom adom]>
workspace_locking_timeout: 300
method: <value in [get]>
url_params:
adom: <value in [none, global, custom dom]>
devprof: <value of string>
params:
-
option: <value in [object member, chksum, datasrc]>
- name: REQUESTING /PM/CONFIG/DEVPROF/{DEVPROF}/SYSTEM/EMAIL-SERVER
fmgr_devprof_system_emailserver:
loose_validation: False
workspace_locking_adom: <value in [global, custom adom]>
workspace_locking_timeout: 300
method: <value in [set, update]>
url_params:
adom: <value in [none, global, custom dom]>
devprof: <value of string>
params:
-
data:
authenticate: <value in [disable, enable]>
password:
- <value of string>
port: <value of integer>
reply-to: <value of string>
security: <value in [none, starttls, smtps]>
server: <value of string>
source-ip: <value of string>
source-ip6: <value of string>
ssl-min-proto-version: <value in [default, TLSv1, TLSv1-1, ...]>
type: <value in [custom]>
username: <value of string>
validate-server: <value in [disable, enable]>
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:
- return values for method: [get]
- data
- No description for the parameter type: dict
- authenticate - Enable/disable authentication. type: str
- password - No description for the parameter type: array
- {no-name} - No description for the parameter type: str
- port - SMTP server port. type: int
- reply-to - Reply-To email address. type: str
- security - Connection security used by the email server. type: str
- server - SMTP server IP address or hostname. type: str
- source-ip - SMTP server IPv4 source IP. type: str
- source-ip6 - SMTP server IPv6 source IP. type: str
- ssl-min-proto-version - Minimum supported protocol version for SSL/TLS connections (default is to follow system global setting). type: str
- type - Use FortiGuard Message service or custom email server. type: str
- username - SMTP server user name for authentication. type: str
- validate-server - Enable/disable validation of server certificate. type: str
- status
- No description for the parameter type: dict
- code - No description for the parameter type: int
- message - No description for the parameter type: str
- url - No description for the parameter type: str example: /pm/config/adom/{adom}/devprof/{devprof}/system/email-server
- return values for method: [set, update]
- status
- No description for the parameter type: dict
- code - No description for the parameter type: int
- message - No description for the parameter type: str
- url - No description for the parameter type: str example: /pm/config/adom/{adom}/devprof/{devprof}/system/email-server