Try SpotterConfigure domain controller entries.
| "added in version" 2.1.0 of fortinet.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 community
Install with ansible-galaxy collection install fortinet.fortimanager:==2.4.0
collections:
- name: fortinet.fortimanager
version: 2.4.0This module is able to configure a FortiManager device.
Examples include all parameters and values which need to be adjusted to data sources before usage.
- name: Example playbook (generated based on argument schema)
hosts: fortimanagers
connection: httpapi
vars:
ansible_httpapi_use_ssl: true
ansible_httpapi_validate_certs: false
ansible_httpapi_port: 443
tasks:
- name: Configure domain controller entries.
fortinet.fortimanager.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: present # <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>
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
type: list
enable_log:
default: false
description: Enable/Disable logging for task.
type: bool
access_token:
description: The token to access FortiManager without using username and password.
type: str
rc_succeeded:
description: The rc codes list with which the conditions to succeed will be overriden.
elements: int
type: list
proposed_method:
choices:
- update
- set
- add
description: The overridden method for the underlying Json RPC request.
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.
type: bool
user_domaincontroller:
description: The top level parameters set.
required: false
suboptions:
ad-mode:
choices:
- none
- ds
- lds
description: Deprecated, please rename it to ad_mode. Set Active Directory mode.
type: str
adlds-dn:
description: Deprecated, please rename it to adlds_dn. AD LDS distinguished name.
type: str
adlds-ip-address:
description: Deprecated, please rename it to adlds_ip_address. AD LDS IPv4 address.
type: str
adlds-ip6:
description: Deprecated, please rename it to adlds_ip6. AD LDS IPv6 address.
type: str
adlds-port:
description: Deprecated, please rename it to adlds_port. Port number of AD LDS
service
type: int
change-detection:
choices:
- disable
- enable
description: Deprecated, please rename it to change_detection. Enable/disable
detection of a configuration change in the Active Directo...
type: str
change-detection-period:
description: Deprecated, please rename it to change_detection_period. Minutes
to detect a configuration change in the Active Directory ...
type: int
dns-srv-lookup:
choices:
- disable
- enable
description: Deprecated, please rename it to dns_srv_lookup. Enable/disable DNS
service lookup.
type: str
domain-name:
description: Deprecated, please rename it to domain_name. Domain DNS name.
type: str
extra-server:
description: Deprecated, please rename it to extra_server. Extra-Server.
elements: dict
suboptions:
id:
description: Server ID.
type: int
ip-address:
description: Deprecated, please rename it to ip_address. Domain controller
IP address.
type: str
port:
description: Port to be used for communication with the domain controller
type: int
source-ip-address:
description: Deprecated, please rename it to source_ip_address. FortiGate
IPv4 address to be used for communication with the do...
type: str
source-port:
description: Deprecated, please rename it to source_port. 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: Deprecated, please rename it to interface_select_method. Specify
how to select outgoing interface to reach server.
type: str
ip-address:
description: Deprecated, please rename it to ip_address. Domain controller IP
address.
type: str
ip6:
description: Domain controller IPv6 address.
type: str
ldap-server:
description: (list or str) Deprecated, please rename it to ldap_server. LDAP server
name.
type: raw
name:
description: Domain controller entry name.
required: true
type: str
password:
description: (list) Password for specified username.
type: raw
port:
description: Port to be used for communication with the domain controller
type: int
replication-port:
description: Deprecated, please rename it to replication_port. Port to be used
for communication with the domain controller for replica...
type: int
source-ip-address:
description: Deprecated, please rename it to source_ip_address. FortiGate IPv4
address to be used for communication with the domain con...
type: str
source-ip6:
description: Deprecated, please rename it to source_ip6. FortiGate IPv6 address
to be used for communication with the domain controller.
type: str
source-port:
description: Deprecated, please rename it to source_port. 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.
type: str
forticloud_access_token:
description: Authenticate Ansible client with forticloud API access token.
type: str
workspace_locking_timeout:
default: 300
description: The maximum time in seconds to wait for other user to release the workspace
lock.
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