drmofu / drmofu.fortimanager / 2.2.2 / module / fmgr_user_domaincontroller Configure domain controller entries. | "added in version" 2.1.0 of drmofu.fortimanager" Authors: Xinwei Du (@dux-fortinet), Xing Li (@lix-fortinet), Jie Xue (@JieX19), Link Zheng (@chillancezen), Frank Shen (@fshen01), Hongbin Lu (@fgtdev-hblu) preview | supported by communitydrmofu.fortimanager.fmgr_user_domaincontroller (2.2.2) — module
Install with ansible-galaxy collection install drmofu.fortimanager:==2.2.2
collections: - name: drmofu.fortimanager version: 2.2.2
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.
- 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> change-detection: <value in [disable, enable]> change-detection-period: <value of integer>
adom: description: the parameter (adom) in requested url required: true type: str state: choices: - present - absent description: The directive to create, update or delete an object. required: true type: str rc_failed: description: The rc codes list with which the conditions to fail will be overriden. elements: int required: false type: list enable_log: default: false description: Enable/Disable logging for task. required: false type: bool access_token: description: The token to access FortiManager without using username and password. required: false type: str rc_succeeded: description: The rc codes list with which the conditions to succeed will be overriden. elements: int required: false type: list proposed_method: choices: - update - set - add description: The overridden method for the underlying Json RPC request. required: false type: str bypass_validation: default: false description: Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters. required: false type: bool user_domaincontroller: description: the top level parameters set required: false suboptions: ad-mode: choices: - none - ds - lds description: Set Active Directory mode. type: str adlds-dn: description: AD LDS distinguished name. type: str adlds-ip-address: description: AD LDS IPv4 address. type: str adlds-ip6: description: AD LDS IPv6 address. type: str adlds-port: description: Port number of AD LDS service type: int change-detection: choices: - disable - enable description: Enable/disable detection of a configuration change in the Active Directory server. type: str change-detection-period: description: Minutes to detect a configuration change in the Active Directory server type: int dns-srv-lookup: choices: - disable - enable description: Enable/disable DNS service lookup. type: str domain-name: description: Domain DNS name. type: str extra-server: description: Extra-Server. elements: dict suboptions: id: description: Server ID. type: int ip-address: description: Domain controller IP address. type: str port: description: Port to be used for communication with the domain controller type: int source-ip-address: description: FortiGate IPv4 address to be used for communication with the domain controller. type: str source-port: description: Source port to be used for communication with the domain controller. type: int type: list hostname: description: Hostname of the server to connect to. type: str interface: description: Specify outgoing interface to reach server. type: str interface-select-method: choices: - auto - sdwan - specify description: Specify how to select outgoing interface to reach server. type: str ip-address: description: Domain controller IP address. type: str ip6: description: Domain controller IPv6 address. type: str ldap-server: description: LDAP server name. type: str name: description: Domain controller entry name. type: str password: description: Password for specified username. type: str port: description: Port to be used for communication with the domain controller type: int replication-port: description: Port to be used for communication with the domain controller for replication service. type: int source-ip-address: description: FortiGate IPv4 address to be used for communication with the domain controller. type: str source-ip6: description: FortiGate IPv6 address to be used for communication with the domain controller. type: str source-port: description: Source port to be used for communication with the domain controller. type: int username: description: User name to sign in with. type: str type: dict workspace_locking_adom: description: The adom to lock for FortiManager running in workspace mode, the value can be global and others including root. required: false type: str forticloud_access_token: description: Authenticate Ansible client with forticloud API access token. required: false type: str workspace_locking_timeout: default: 300 description: The maximum time in seconds to wait for other user to release the workspace lock. required: false type: int
meta: contains: request_url: description: The full url requested. returned: always sample: /sys/login/user type: str response_code: description: The status of api request. returned: always sample: 0 type: int response_data: description: The api response. returned: always type: list response_message: description: The descriptive message of the api response. returned: always sample: OK. type: str system_information: description: The information of the target system. returned: always type: dict description: The result of the request. returned: always type: dict rc: description: The status the request. returned: always sample: 0 type: int version_check_warning: description: Warning if the parameters used in the playbook are not supported by the current FortiManager version. returned: complex type: list