fortinet.fortimanager.fmgr_user_domaincontroller module – Configure domain controller entries.

Note

This module is part of the fortinet.fortimanager collection (version 2.3.1).

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

New in fortinet.fortimanager 2.1.0

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

access_token

string

The token to access FortiManager without using username and password.

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:

  • false ← (default)

  • true

enable_log

boolean

Enable/Disable logging for task.

Choices:

  • false ← (default)

  • true

forticloud_access_token

string

Authenticate Ansible client with forticloud API access token.

proposed_method

string

The overridden method for the underlying Json RPC request.

Choices:

  • "update"

  • "set"

  • "add"

rc_failed

list / elements=integer

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

rc_succeeded

list / elements=integer

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_domaincontroller

dictionary

the top level parameters set

ad-mode

string

Set Active Directory mode.

Choices:

  • "none"

  • "ds"

  • "lds"

adlds-dn

string

AD LDS distinguished name.

adlds-ip-address

string

AD LDS IPv4 address.

adlds-ip6

string

AD LDS IPv6 address.

adlds-port

integer

Port number of AD LDS service

change-detection

string

Enable/disable detection of a configuration change in the Active Directory server.

Choices:

  • "disable"

  • "enable"

change-detection-period

integer

Minutes to detect a configuration change in the Active Directory server

dns-srv-lookup

string

Enable/disable DNS service lookup.

Choices:

  • "disable"

  • "enable"

domain-name

string

Domain DNS name.

extra-server

list / elements=dictionary

Extra-Server.

id

integer

Server ID.

ip-address

string

Domain controller IP address.

port

integer

Port to be used for communication with the domain controller

source-ip-address

string

FortiGate IPv4 address to be used for communication with the domain controller.

source-port

integer

Source port to be used for communication with the domain controller.

hostname

string

Hostname of the server to connect to.

interface

string

Specify outgoing interface to reach server.

interface-select-method

string

Specify how to select outgoing interface to reach server.

Choices:

  • "auto"

  • "sdwan"

  • "specify"

ip-address

string

Domain controller IP address.

ip6

string

Domain controller IPv6 address.

ldap-server

any

(list or str) LDAP server name.

name

string / required

Domain controller entry name.

password

any

(list) Password for specified username.

port

integer

Port to be used for communication with the domain controller

replication-port

integer

Port to be used for communication with the domain controller for replication service.

source-ip-address

string

FortiGate IPv4 address to be used for communication with the domain controller.

source-ip6

string

FortiGate IPv6 address to be used for communication with the domain controller.

source-port

integer

Source port to be used for communication with the domain controller.

username

string

User name to sign in with.

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 domain controller entries.
      fmgr_user_domaincontroller:
        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_domaincontroller:
          domain-name: <string>
          extra-server:
            -
              id: <integer>
              ip-address: <string>
              port: <integer>
              source-ip-address: <string>
              source-port: <integer>
          ip-address: <string>
          ldap-server: <list or string>
          name: <string>
          port: <integer>
          ad-mode: <value in [none, ds, lds]>
          adlds-dn: <string>
          adlds-ip-address: <string>
          adlds-ip6: <string>
          adlds-port: <integer>
          dns-srv-lookup: <value in [disable, enable]>
          hostname: <string>
          interface: <string>
          interface-select-method: <value in [auto, sdwan, specify]>
          ip6: <string>
          password: <list or string>
          replication-port: <integer>
          source-ip-address: <string>
          source-ip6: <string>
          source-port: <integer>
          username: <string>
          change-detection: <value in [disable, enable]>
          change-detection-period: <integer>

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key

Description

meta

dictionary

The result of the request.

Returned: always

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_data

list / elements=string

The api response.

Returned: always

response_message

string

The descriptive message of the api response.

Returned: always

Sample: "OK."

system_information

dictionary

The information of the target system.

Returned: always

rc

integer

The status the request.

Returned: always

Sample: 0

version_check_warning

list / elements=string

Warning if the parameters used in the playbook are not supported by the current FortiManager version.

Returned: complex

Authors

  • Xinwei Du (@dux-fortinet)

  • Xing Li (@lix-fortinet)

  • Jie Xue (@JieX19)

  • Link Zheng (@chillancezen)

  • Frank Shen (@fshen01)

  • Hongbin Lu (@fgtdev-hblu)