fortinet.fortios.fortios_user_exchange – Configure MS Exchange server entries in Fortinet’s FortiOS and FortiGate.

Note

This plugin is part of the fortinet.fortios collection (version 2.1.2).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install fortinet.fortios.

To use it in a playbook, specify: fortinet.fortios.fortios_user_exchange.

New in version 2.10: of fortinet.fortios

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.9.0

Parameters

Parameter			Choices/Defaults	Comments
access_token string				Token-based authentication. Generated from GUI of Fortigate.
enable_log boolean			Choices: no ← yes	Enable/Disable logging for task.
state string / required			Choices: present absent	Indicates whether to create or remove the object.
user_exchange dictionary				Configure MS Exchange server entries.
	auth_level string		Choices: connect call packet integrity privacy	Authentication security level used for the RPC protocol layer.
	auth_type string		Choices: spnego ntlm kerberos	Authentication security type used for the RPC protocol layer.
	auto_discover_kdc string		Choices: enable disable	Enable/disable automatic discovery of KDC IP addresses.
	connect_protocol string		Choices: rpc-over-tcp rpc-over-http rpc-over-https	Connection protocol used to connect to MS Exchange service.
	domain_name string			MS Exchange server fully qualified domain name.
	http_auth_type string		Choices: basic ntlm	Authentication security type used for the HTTP transport.
	ip string			Server IPv4 address.
	kdc_ip list / elements=string			KDC IPv4 addresses for Kerberos authentication.
		ipv4 string / required		KDC IPv4 addresses for Kerberos authentication.
	name string / required			MS Exchange server entry name.
	password string			Password for the specified username.
	server_name string			MS Exchange server hostname.
	ssl_min_proto_version string		Choices: default SSLv3 TLSv1 TLSv1-1 TLSv1-2	Minimum SSL/TLS protocol version for HTTPS transport .
	username string			User name used to sign in to the server. Must have proper permissions for service.
vdom string			Default: "root"	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.

Notes

Note

Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks

Examples

- hosts: fortigates
  collections:
    - fortinet.fortios
  connection: httpapi
  vars:
   vdom: "root"
   ansible_httpapi_use_ssl: yes
   ansible_httpapi_validate_certs: no
   ansible_httpapi_port: 443
  tasks:
  - name: Configure MS Exchange server entries.
    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 here, the following are the fields unique to this module:

Key	Returned	Description
build string	always	Build number of the fortigate image Sample: 1547
http_method string	always	Last method used to provision the content into FortiGate Sample: PUT
http_status string	always	Last result given by FortiGate on last operation applied Sample: 200
mkey string	success	Master key (id) used in the last call to FortiGate Sample: id
name string	always	Name of the table used to fulfill the request Sample: urlfilter
path string	always	Path of the table used to fulfill the request Sample: webfilter
revision string	always	Internal revision number Sample: 17.0.2.10658
serial string	always	Serial number of the unit Sample: FGVMEVYYQT3AB5352
status string	always	Indication of the operation's result Sample: success
vdom string	always	Virtual domain used Sample: root
version string	always	Version of the FortiGate Sample: v5.6.3

Authors

Link Zheng (@chillancezen)
Jie Xue (@JieX19)
Hongbin Lu (@fgtdev-hblu)
Frank Shen (@frankshen01)
Miguel Angel Munoz (@mamunozgonzalez)
Nicolas Thomas (@thomnico)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/fortinet/fortios/fortios_user_exchange_module.html

Docs

Docs4dev

Title here