/ home / dux_fortinet / dux_fortinet.fortianalyzer_dev / 1.4.0 / module / faz_cli_system_admin_ldap

dux_fortinet.fortianalyzer_dev.faz_cli_system_admin_ldap (1.4.0) — module

LDAP server entry configuration.

| "added in version" 1.0.0 of dux_fortinet.fortianalyzer_dev"

Authors: Xinwei Du (@dux-fortinet), Link Zheng (@chillancezen), Jie Xue (@JieX19), Frank Shen (@fshen01), Hongbin Lu (@fgtdev-hblu)

preview | supported by community

Install collection

Install with ansible-galaxy collection install dux_fortinet.fortianalyzer_dev:==1.4.0

Add to requirements.yml

  collections:
    - name: dux_fortinet.fortianalyzer_dev
      version: 1.4.0

Description

This module is able to configure a FortiAnalyzer device.

Examples include all parameters and values which need to be adjusted to data sources before usage.

Usage examples

Scanned by Steampunk Spotter

- name: Example playbook
  connection: httpapi
  hosts: fortianalyzers
  tasks:
    - name: LDAP server entry configuration.
      fortinet.fortianalyzer.faz_cli_system_admin_ldap:
        cli_system_admin_ldap:
          name: fooldap
          password: foopasscode
          port: 10443
          server: 192.11.1.11
          type: simple
          username: fooldap
        state: present
  vars:
    ansible_httpapi_port: 443
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false

Inputs

state:
choices:
- present
- absent
description: The directive to create, update or delete an object
required: true
type: str

log_path:
default: /tmp/fortianalyzer.ansible.log
description:
- The path to save log. Used if enable_log is true.
- Please use absolute path instead of relative path.
- If the log_path setting is incorrect, the log will be saved in /tmp/fortianalyzer.ansible.log
required: false
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:
- set
- update
- 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 FortiAnalyzer API structure,
module continues to execute without validating parameters
required: false
type: bool

cli_system_admin_ldap:
description: The top level parameters set.
required: false
suboptions:
adom:
description: no description
elements: dict
suboptions:
adom-name:
description: Admin domain names.
type: str
type: list
adom-access:
choices:
- all
- specify
description:
- set all or specify adom access type.
- all - All ADOMs access.
- specify - Specify ADOMs access.
type: str
adom-attr:
description: Attribute used to retrieve adom
type: str
attributes:
description: Attributes used for group searching.
type: str
ca-cert:
description: CA certificate name.
type: str
cnid:
description: Common Name Identifier (default = CN).
type: str
connect-timeout:
description: LDAP connection timeout (msec).
type: int
dn:
description: Distinguished Name.
type: str
filter:
description: Filter used for group searching.
type: str
group:
description: Full base DN used for group searching.
type: str
memberof-attr:
description: Attribute used to retrieve memeberof.
type: str
name:
description: LDAP server entry name.
type: str
password:
description: no description
type: str
port:
description: Port number of LDAP server (default = 389).
type: int
profile-attr:
description: Attribute used to retrieve admin profile.
type: str
secondary-server:
description: '{<name_str|ip_str>} secondary LDAP server domain name or IP.'
type: str
secure:
choices:
- disable
- starttls
- ldaps
description:
- SSL connection.
- disable - No SSL.
- starttls - Use StartTLS.
- ldaps - Use LDAPS.
type: str
server:
description: '{<name_str|ip_str>} LDAP server domain name or IP.'
type: str
tertiary-server:
description: '{<name_str|ip_str>} tertiary LDAP server domain name or IP.'
type: str
type:
choices:
- simple
- anonymous
- regular
description:
- Type of LDAP binding.
- simple - Simple password authentication without search.
- anonymous - Bind using anonymous user search.
- regular - Bind using username/password and then search.
type: str
username:
description: Username (full DN) for initial binding.
type: str
type: dict

forticloud_access_token:
description: Authenticate Ansible client with forticloud API access token.
required: false
type: str

Outputs

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 fortianalyzer version.
  returned: complex
  type: list