fmgr_user_exchange – Configure MS Exchange server entries.¶
New in version 2.10.
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.
Requirements¶
The below requirements are needed on the host that executes this module.
- ansible>=2.9.0
FortiManager Version Compatibility¶
6.2.1 |
6.2.3 |
6.2.5 |
6.4.0 |
6.4.2 |
6.4.5 |
7.0.0 |
7.2.0 |
|
| user_exchange | yes | yes | yes | yes | yes | yes | yes | yes |
Parameters¶
- enable_log - Enable/Disable logging for task type: bool required: false default: False
- forticloud_access_token - Access token of forticloud managed API users, this option is available with FortiManager later than 6.4.0 type: str required: false
- proposed_method - The overridden method for the underlying Json RPC request type: str required: false choices: set, update, add
- bypass_validation - Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters 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 adom including root
- workspace_locking_timeout - The maximum time in seconds to wait for other users to release workspace lock type: integer required: false default: 300
- rc_succeeded - The rc codes list with which the conditions to succeed will be overriden type: list required: false
- rc_failed - The rc codes list with which the conditions to fail will be overriden type: list required: false
- state - The directive to create, update or delete an object type: str required: true choices: present, absent
- adom - The parameter in requested url type: str required: true
- user_exchange - no description type: dict
- addr-type - Indicate whether the server IP-address is IPv4 or IPv6. type: str choices: [ipv4, ipv6] more...
- auth-level - Authentication security level used for the RPC protocol layer. type: str choices: [low, medium, normal, high, connect, call, packet, integrity, privacy] more...
- auth-type - Authentication security type used for the RPC protocol layer. type: str choices: [spnego, ntlm, kerberos] more...
- connect-protocol - Connection protocol used to connect to MS Exchange service. type: str choices: [rpc-over-tcp, rpc-over-http, rpc-over-https] more...
- domain-name - MS Exchange server fully qualified domain name. type: str more...
- http-auth-type - Authentication security type used for the HTTP transport. type: str choices: [ntlm, basic] more...
- ip - Server IPv4 address. type: str more...
- ip6 - Server IPv6 address. type: str more...
- kdc-ip - KDC IPv4 addresses for Kerberos authentication. type: str more...
- name - MS Exchange server entry name. type: str more...
- password - Password for the specified username. type: str more...
- server-name - MS Exchange server hostname. type: str more...
- ssl-min-proto-version - Minimum SSL/TLS protocol version for HTTPS transport (default is to follow system global setting). type: str choices: [default, TLSv1-1, TLSv1-2, SSLv3, TLSv1] more...
- username - User name used to sign in to the server. type: str more...
- auto-discover-kdc - Enable/disable automatic discovery of KDC IP addresses. type: str choices: [disable, enable] more...
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¶
- 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: no description
fmgr_user_exchange:
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>
state: <value in [present, absent]>
user_exchange:
addr-type: <value in [ipv4, ipv6]>
auth-level: <value in [low, medium, normal, ...]>
auth-type: <value in [spnego, ntlm, kerberos]>
connect-protocol: <value in [rpc-over-tcp, rpc-over-http, rpc-over-https]>
domain-name: <value of string>
http-auth-type: <value in [ntlm, basic]>
ip: <value of string>
ip6: <value of string>
kdc-ip: <value of string>
name: <value of string>
password: <value of string>
server-name: <value of string>
ssl-min-proto-version: <value in [default, TLSv1-1, TLSv1-2, ...]>
username: <value of string>
auto-discover-kdc: <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:
- 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_message - The descriptive message of the api response returned: always type: str sample: OK
- response_data - The data body of the api response returned: optional type: list or dict