fortinet.fortimanager.fmgr_user_exchange – Configure MS Exchange server entries.

Note

This plugin is part of the fortinet.fortimanager collection (version 2.1.4).

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

To use it in a playbook, specify: fortinet.fortimanager.fmgr_user_exchange.

New in version 2.10: of fortinet.fortimanager

Synopsis

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

Parameters

Parameter

Comments

adom

string / required

the parameter (adom) in requested url

bypass_validation

boolean

only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters

Choices:

  • no ← (default)

  • yes

enable_log

boolean

Enable/Disable logging for task

Choices:

  • no ← (default)

  • yes

proposed_method

string

The overridden method for the underlying Json RPC request

Choices:

  • update

  • set

  • add

rc_failed

list / elements=string

the rc codes list with which the conditions to fail will be overriden

rc_succeeded

list / elements=string

the rc codes list with which the conditions to succeed will be overriden

state

string / required

the directive to create, update or delete an object

Choices:

  • present

  • absent

user_exchange

dictionary

the top level parameters set

addr-type

string

Indicate whether the server IP-address is IPv4 or IPv6.

Choices:

  • ipv4

  • ipv6

auth-level

string

Authentication security level used for the RPC protocol layer.

Choices:

  • low

  • medium

  • normal

  • high

  • connect

  • call

  • packet

  • integrity

  • privacy

auth-type

string

Authentication security type used for the RPC protocol layer.

Choices:

  • spnego

  • ntlm

  • kerberos

auto-discover-kdc

string

Enable/disable automatic discovery of KDC IP addresses.

Choices:

  • disable

  • enable

connect-protocol

string

Connection protocol used to connect to MS Exchange service.

Choices:

  • rpc-over-tcp

  • rpc-over-http

  • rpc-over-https

domain-name

string

MS Exchange server fully qualified domain name.

http-auth-type

string

Authentication security type used for the HTTP transport.

Choices:

  • ntlm

  • basic

ip

string

Server IPv4 address.

ip6

string

Server IPv6 address.

kdc-ip

string

KDC IPv4 addresses for Kerberos authentication.

name

string

MS Exchange server entry name.

password

string

Password for the specified username.

server-name

string

MS Exchange server hostname.

ssl-min-proto-version

string

Minimum SSL/TLS protocol version for HTTPS transport (default is to follow system global setting).

Choices:

  • default

  • TLSv1-1

  • TLSv1-2

  • SSLv3

  • TLSv1

username

string

User name used to sign in to the server. Must have proper permissions for service.

workspace_locking_adom

string

the adom to lock for FortiManager running in workspace mode, the value can be global and others including root

workspace_locking_timeout

integer

the maximum time in seconds to wait for other user to release the workspace lock

Default: 300

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: Configure MS Exchange server entries.
     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 here, the following are the fields unique to this module:

Key

Description

request_url

string

The full url requested

Returned: always

Sample: “/sys/login/user”

response_code

integer

The status of api request

Returned: always

Sample: 0

response_message

string

The descriptive message of the api response

Returned: always

Sample: “OK.”

Authors

  • Link Zheng (@chillancezen)

  • Jie Xue (@JieX19)

  • Frank Shen (@fshen01)

  • Hongbin Lu (@fgtdev-hblu)