fortios_user_exchange – Configure MS Exchange server entries in Fortinet’s FortiOS and FortiGate.
New in version 2.0.0.
Synopsis
This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify user feature and exchange category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0
Requirements
The below requirements are needed on the host that executes this module.
ansible>=2.15
Tips
Using member operation to add an element to an existing object.
FortiOS Version Compatibility
Supported Version Ranges: v6.2.0 -> 7.4.3
Parameters
- access_token - Token-based authentication. Generated from GUI of Fortigate. type: str required: false
- enable_log - Enable/Disable logging for task. type: bool required: false default: False
- vdom - Virtual domain, among those defined previously. A vdom is a virtual instance of the FortiGate that can be configured and used as a different unit. type: str default: root
- member_path - Member attribute path to operate on. type: str
- member_state - Add or delete a member under specified attribute path. type: str choices: present, absent
- state - Indicates whether to create or remove the object. type: str required: true choices: present, absent
- user_exchange - Configure MS Exchange server entries. type: dict more...
- auth_level - Authentication security level used for the RPC protocol layer. type: str choices: connect, call, packet, integrity, privacy more...
- auth_type - Authentication security type used for the RPC protocol layer. type: str choices: spnego, ntlm, kerberos more...
- auto_discover_kdc - Enable/disable automatic discovery of KDC IP addresses. type: str choices: enable, disable 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: basic, ntlm more...
- ip - Server IPv4 address. type: str more...
- kdc_ip - KDC IPv4 addresses for Kerberos authentication. type: list member_path: kdc_ip:ipv4 more...
- ipv4 - KDC IPv4 addresses for Kerberos authentication. type: str required: true more...
- name - MS Exchange server entry name. type: str required: true 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 . type: str choices: default, SSLv3, TLSv1, TLSv1-1, TLSv1-2, TLSv1-3 more...
- username - User name used to sign in to the server. Must have proper permissions for service. type: str more...
Notes
Note
Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
- name: Configure MS Exchange server entries.
fortinet.fortios.fortios_user_exchange:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
user_exchange:
auth_level: "connect"
auth_type: "spnego"
auto_discover_kdc: "enable"
connect_protocol: "rpc-over-tcp"
domain_name: "<your_own_value>"
http_auth_type: "basic"
ip: "<your_own_value>"
kdc_ip:
-
ipv4: "<your_own_value>"
name: "default_name_12"
password: "<your_own_value>"
server_name: "<your_own_value>"
ssl_min_proto_version: "default"
username: "<your_own_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:
- build - Build number of the fortigate image returned: always type: str sample: 1547
- http_method - Last method used to provision the content into FortiGate returned: always type: str sample: PUT
- http_status - Last result given by FortiGate on last operation applied returned: always type: str sample: 200
- mkey - Master key (id) used in the last call to FortiGate returned: success type: str sample: id
- name - Name of the table used to fulfill the request returned: always type: str sample: urlfilter
- path - Path of the table used to fulfill the request returned: always type: str sample: webfilter
- revision - Internal revision number returned: always type: str sample: 17.0.2.10658
- serial - Serial number of the unit returned: always type: str sample: FGVMEVYYQT3AB5352
- status - Indication of the operation's result returned: always type: str sample: success
- vdom - Virtual domain used returned: always type: str sample: root
- version - Version of the FortiGate returned: always type: str sample: v5.6.3
Status
This module is not guaranteed to have a backwards compatible interface.