lix_fortinet.fortios.fortios_user_ldap (102.2.120) — module

Install collection

Install with ansible-galaxy collection install lix_fortinet.fortios:==102.2.120

Add to requirements.yml

  collections:
    - name: lix_fortinet.fortios
      version: 102.2.120

Description

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify user feature and ldap category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0

Requirements

• ansible>=2.9

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- hosts: fortigates
  collections:
    - fortinet.fortios
  connection: httpapi
  vars:
   vdom: "root"
   ansible_httpapi_use_ssl: yes
   ansible_httpapi_validate_certs: no
   ansible_httpapi_port: 443
  tasks:
  - name: Configure LDAP server entries.
    fortios_user_ldap:
      vdom:  "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      user_ldap:
        account_key_filter: "<your_own_value>"
        account_key_processing: "same"
        antiphish: "enable"
        ca_cert: "<your_own_value> (source vpn.certificate.ca.name)"
        client_cert: "<your_own_value> (source vpn.certificate.local.name)"
        client_cert_auth: "enable"
        cnid: "<your_own_value>"
        dn: "<your_own_value>"
        group_filter: "<your_own_value>"
        group_member_check: "user-attr"
        group_object_filter: "<your_own_value>"
        group_search_base: "<your_own_value>"
        interface: "<your_own_value> (source system.interface.name)"
        interface_select_method: "auto"
        member_attr: "<your_own_value>"
        name: "default_name_18"
        obtain_user_info: "enable"
        password: "<your_own_value>"
        password_attr: "<your_own_value>"
        password_expiry_warning: "enable"
        password_renewal: "enable"
        port: "389"
        search_type: "recursive"
        secondary_server: "<your_own_value>"
        secure: "disable"
        server: "192.168.100.40"
        server_identity_check: "enable"
        source_ip: "84.230.14.43"
        source_port: "0"
        ssl_min_proto_version: "default"
        tertiary_server: "<your_own_value>"
        two_factor: "disable"
        two_factor_authentication: "fortitoken"
        two_factor_filter: "<your_own_value>"
        two_factor_notification: "email"
        type: "simple"
        user_info_exchange_server: "<your_own_value> (source user.exchange.name)"
        username: "<your_own_value>"

Inputs

    
vdom:
    default: root
    description:
    - Virtual domain, among those defined previously. A vdom is a virtual instance of
      the FortiGate that can be configured and used as a different unit.
    type: str

state:
    choices:
    - present
    - absent
    description:
    - Indicates whether to create or remove the object.
    required: true
    type: str

user_ldap:
    default: null
    description:
    - Configure LDAP server entries.
    suboptions:
      account_key_filter:
        description:
        - Account key filter, using the UPN as the search filter.
        type: str
      account_key_processing:
        choices:
        - same
        - strip
        description:
        - Account key processing operation, either keep or strip domain string of UPN
          in the token.
        type: str
      antiphish:
        choices:
        - enable
        - disable
        description:
        - Enable/disable AntiPhishing credential backend.
        type: str
      ca_cert:
        description:
        - CA certificate name. Source vpn.certificate.ca.name.
        type: str
      client_cert:
        description:
        - Client certificate name. Source vpn.certificate.local.name.
        type: str
      client_cert_auth:
        choices:
        - enable
        - disable
        description:
        - Enable/disable using client certificate for TLS authentication.
        type: str
      cnid:
        description:
        - Common name identifier for the LDAP server. The common name identifier for most
          LDAP servers is "cn".
        type: str
      dn:
        description:
        - Distinguished name used to look up entries on the LDAP server.
        type: str
      group_filter:
        description:
        - Filter used for group matching.
        type: str
      group_member_check:
        choices:
        - user-attr
        - group-object
        - posix-group-object
        description:
        - Group member checking methods.
        type: str
      group_object_filter:
        description:
        - Filter used for group searching.
        type: str
      group_search_base:
        description:
        - Search base used for group searching.
        type: str
      interface:
        description:
        - Specify outgoing interface to reach server. Source system.interface.name.
        type: str
      interface_select_method:
        choices:
        - auto
        - sdwan
        - specify
        description:
        - Specify how to select outgoing interface to reach server.
        type: str
      member_attr:
        description:
        - Name of attribute from which to get group membership.
        type: str
      name:
        description:
        - LDAP server entry name.
        required: true
        type: str
      obtain_user_info:
        choices:
        - enable
        - disable
        description:
        - Enable/disable obtaining of user information.
        type: str
      password:
        description:
        - Password for initial binding.
        type: str
      password_attr:
        description:
        - Name of attribute to get password hash.
        type: str
      password_expiry_warning:
        choices:
        - enable
        - disable
        description:
        - Enable/disable password expiry warnings.
        type: str
      password_renewal:
        choices:
        - enable
        - disable
        description:
        - Enable/disable online password renewal.
        type: str
      port:
        description:
        - Port to be used for communication with the LDAP server .
        type: int
      search_type:
        choices:
        - recursive
        description:
        - Search type.
        elements: str
        type: list
      secondary_server:
        description:
        - Secondary LDAP server CN domain name or IP.
        type: str
      secure:
        choices:
        - disable
        - starttls
        - ldaps
        description:
        - Port to be used for authentication.
        type: str
      server:
        description:
        - LDAP server CN domain name or IP.
        type: str
      server_identity_check:
        choices:
        - enable
        - disable
        description:
        - Enable/disable LDAP server identity check (verify server domain name/IP address
          against the server certificate).
        type: str
      source_ip:
        description:
        - FortiGate IP address to be used for communication with the LDAP server.
        type: str
      source_port:
        description:
        - Source port to be used for communication with the LDAP server.
        type: int
      ssl_min_proto_version:
        choices:
        - default
        - SSLv3
        - TLSv1
        - TLSv1-1
        - TLSv1-2
        description:
        - Minimum supported protocol version for SSL/TLS connections .
        type: str
      tertiary_server:
        description:
        - Tertiary LDAP server CN domain name or IP.
        type: str
      two_factor:
        choices:
        - disable
        - fortitoken-cloud
        description:
        - Enable/disable two-factor authentication.
        type: str
      two_factor_authentication:
        choices:
        - fortitoken
        - email
        - sms
        description:
        - Authentication method by FortiToken Cloud.
        type: str
      two_factor_filter:
        description:
        - Filter used to synchronize users to FortiToken Cloud.
        type: str
      two_factor_notification:
        choices:
        - email
        - sms
        description:
        - Notification method for user activation by FortiToken Cloud.
        type: str
      type:
        choices:
        - simple
        - anonymous
        - regular
        description:
        - Authentication type for LDAP searches.
        type: str
      user_info_exchange_server:
        description:
        - MS Exchange server from which to fetch user information. Source user.exchange.name.
        type: str
      username:
        description:
        - Username (full DN) for initial binding.
        type: str
    type: dict

enable_log:
    default: false
    description:
    - Enable/Disable logging for task.
    required: false
    type: bool

member_path:
    description:
    - Member attribute path to operate on.
    - Delimited by a slash character if there are more than one attribute.
    - Parameter marked with member_path is legitimate for doing member operation.
    type: str

access_token:
    description:
    - Token-based authentication. Generated from GUI of Fortigate.
    required: false
    type: str

member_state:
    choices:
    - present
    - absent
    description:
    - Add or delete a member under specified attribute path.
    - When member_state is specified, the state option is ignored.
    type: str

Outputs

build:
  description: Build number of the fortigate image
  returned: always
  sample: '1547'
  type: str
http_method:
  description: Last method used to provision the content into FortiGate
  returned: always
  sample: PUT
  type: str
http_status:
  description: Last result given by FortiGate on last operation applied
  returned: always
  sample: '200'
  type: str
mkey:
  description: Master key (id) used in the last call to FortiGate
  returned: success
  sample: id
  type: str
name:
  description: Name of the table used to fulfill the request
  returned: always
  sample: urlfilter
  type: str
path:
  description: Path of the table used to fulfill the request
  returned: always
  sample: webfilter
  type: str
revision:
  description: Internal revision number
  returned: always
  sample: 17.0.2.10658
  type: str
serial:
  description: Serial number of the unit
  returned: always
  sample: FGVMEVYYQT3AB5352
  type: str
status:
  description: Indication of the operation's result
  returned: always
  sample: success
  type: str
vdom:
  description: Virtual domain used
  returned: always
  sample: root
  type: str
version:
  description: Version of the FortiGate
  returned: always
  sample: v5.6.3
  type: str