fortinet.fortimanager.fmgr_user_domaincontroller – Configure domain controller entries.

Note

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

To install it use: ansible-galaxy collection install fortinet.fortimanager.

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

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 Choices/Defaults Comments
adom
string / required
the parameter (adom) in requested url
bypass_validation
boolean
    Choices:
  • no ←
  • yes
only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters
enable_log
boolean
    Choices:
  • no ←
  • yes
Enable/Disable logging for task
proposed_method
string
    Choices:
  • update
  • set
  • add
The overridden method for the underlying Json RPC request
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
    Choices:
  • present
  • absent
the directive to create, update or delete an object
user_domaincontroller
dictionary
the top level parameters set
ad-mode
string
    Choices:
  • none
  • ds
  • lds
Set Active Directory mode.
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 (default = 389).
dns-srv-lookup
string
    Choices:
  • disable
  • enable
Enable/disable DNS service lookup.
domain-name
string
Domain DNS name.
extra-server
list / elements=string
no description
id
integer
Server ID.
ip-address
string
Domain controller IP address.
port
integer
Port to be used for communication with the domain controller (default = 445).
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
    Choices:
  • auto
  • sdwan
  • specify
Specify how to select outgoing interface to reach server.
ip-address
string
Domain controller IP address.
ip6
string
Domain controller IPv6 address.
ldap-server
string
LDAP server name.
name
string
Domain controller entry name.
password
string
no description
port
integer
Port to be used for communication with the domain controller (default = 445).
replication-port
integer
Port to be used for communication with the domain controller for replication service. Port number 0 indicates automatic discov...
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. 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
Default:
300
the maximum time in seconds to wait for other user to release the workspace lock

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

Return Values

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

Key Returned Description
request_url
string
always
The full url requested

Sample:
/sys/login/user
response_code
integer
always
The status of api request

response_message
string
always
The descriptive message of the api response

Sample:
OK.


Authors

  • Link Zheng (@chillancezen)

  • Jie Xue (@JieX19)

  • Frank Shen (@fshen01)

  • Hongbin Lu (@fgtdev-hblu)