fmgr_user_domaincontroller – Configure domain controller entries.¶
New in version 2.10.
Synopsis¶
- This module is able to configure a FortiManager device.
- Examples include all parameters and values need to be adjusted to data sources before usage.
- Tested with FortiManager v6.0.0.
Requirements¶
The below requirements are needed on the host that executes this module.
- ansible>=2.9.0
FortiManager Version Compatibility¶
6.2.1 |
6.2.3 |
6.2.5 |
6.4.0 |
6.4.2 |
6.4.5 |
7.0.0 |
|
user_domaincontroller | yes | yes | yes | yes | yes | yes | yes |
Parameters¶
- enable_log - Enable/Disable logging for task type: bool required: false default: False
- proposed_method - The overridden method for the underlying Json RPC request type: str required: false choices: set, update, add
- bypass_validation - Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters type: bool required: false default: False
- workspace_locking_adom - Acquire the workspace lock if FortiManager is running in workspace mode type: str required: false choices: global, custom adom including root
- workspace_locking_timeout - The maximum time in seconds to wait for other users to release workspace lock type: integer required: false default: 300
- rc_succeeded - The rc codes list with which the conditions to succeed will be overriden type: list required: false
- rc_failed - The rc codes list with which the conditions to fail will be overriden type: list required: false
- state - The directive to create, update or delete an object type: str required: true choices: present, absent
- adom - The parameter in requested url type: str required: true
- user_domaincontroller - Configure domain controller entries. type: dict
- domain-name - Domain DNS name. type: str more...
- extra-server - No description for the parameter type: array
more...
- id - Server ID. type: int more...
- ip-address - Domain controller IP address. type: str more...
- port - Port to be used for communication with the domain controller (default = 445). type: int more...
- source-ip-address - FortiGate IPv4 address to be used for communication with the domain controller. type: str more...
- source-port - Source port to be used for communication with the domain controller. type: int more...
- ip-address - Domain controller IP address. type: str more...
- ldap-server - LDAP server name. type: str more...
- name - Domain controller entry name. type: str more...
- port - Port to be used for communication with the domain controller (default = 445). type: int more...
- ad-mode - Set Active Directory mode. type: str choices: [none, ds, lds] more...
- adlds-dn - AD LDS distinguished name. type: str more...
- adlds-ip-address - AD LDS IPv4 address. type: str more...
- adlds-ip6 - AD LDS IPv6 address. type: str more...
- adlds-port - Port number of AD LDS service (default = 389). type: int more...
- dns-srv-lookup - Enable/disable DNS service lookup. type: str choices: [disable, enable] more...
- hostname - Hostname of the server to connect to. type: str more...
- interface - Specify outgoing interface to reach server. type: str more...
- interface-select-method - Specify how to select outgoing interface to reach server. type: str choices: [auto, sdwan, specify] more...
- ip6 - Domain controller IPv6 address. type: str more...
- password - No description for the parameter type: str more...
- replication-port - Port to be used for communication with the domain controller for replication service. type: int more...
- source-ip-address - FortiGate IPv4 address to be used for communication with the domain controller. type: str more...
- source-ip6 - FortiGate IPv6 address to be used for communication with the domain controller. type: str more...
- source-port - Source port to be used for communication with the domain controller. type: int more...
- username - User name to sign in with. type: str more...
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: https://docs.ansible.com/ansible/latest/reference_appendices/common_return_values.html#common-return-values, the following are the fields unique to this module:
- request_url - The full url requested returned: always type: str sample: /sys/login/user
- response_code - The status of api request returned: always type: int sample: 0
- response_message - The descriptive message of the api response returned: always type: str sample: OK
- response_data - The data body of the api response returned: optional type: list or dict