fortinet.fortimanager.fmgr_user_ldap_dynamicmapping (2.4.0) — module

Install collection

Install with ansible-galaxy collection install fortinet.fortimanager:==2.4.0

Add to requirements.yml

  collections:
    - name: fortinet.fortimanager
      version: 2.4.0

Description

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.

Usage examples

Scanned by Steampunk Spotter

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

- name: Example playbook
  hosts: fortimanagers
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Configure dynamic mappings of LDAP server
      fortinet.fortimanager.fmgr_user_ldap_dynamicmapping:
        bypass_validation: false
        adom: ansible
        ldap: ansible-test-ldap # name
        state: present
        user_ldap_dynamicmapping:
          _scope:
            - name: FGT_AWS # need a valid device name
              vdom: root # need a valid vdom name under the device
          dn: ansible-test-dn
          password: fortinet
          port: 9000
          server: ansible
          username: ansible-test-dyn

Scanned by Steampunk Spotter

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

- name: Gathering fortimanager facts
  hosts: fortimanagers
  gather_facts: false
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Retrieve all the dynamic mappings of LDAP server
      fortinet.fortimanager.fmgr_fact:
        facts:
          selector: "user_ldap_dynamicmapping"
          params:
            adom: "ansible"
            ldap: "ansible-test-ldap" # name
            dynamic_mapping: "your_value"

Inputs

    
adom:
    description: The parameter (adom) in requested url.
    required: true
    type: str

ldap:
    description: The parameter (ldap) 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

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

user_ldap_dynamicmapping:
    description: The top level parameters set.
    required: false
    suboptions:
      _scope:
        description: No description.
        elements: dict
        suboptions:
          name:
            description: No description.
            type: str
          vdom:
            description: No description.
            type: str
        type: list
      account-key-cert-field:
        choices:
        - othername
        - rfc822name
        - dnsname
        description: Deprecated, please rename it to account_key_cert_field. Define subject
          identity field in certificate for user access right...
        type: str
      account-key-filter:
        description: Deprecated, please rename it to account_key_filter.
        type: str
      account-key-name:
        description: Deprecated, please rename it to account_key_name.
        type: str
      account-key-processing:
        choices:
        - same
        - strip
        description: Deprecated, please rename it to account_key_processing.
        type: str
      account-key-upn-san:
        choices:
        - othername
        - rfc822name
        - dnsname
        description: Deprecated, please rename it to account_key_upn_san. Define SAN in
          certificate for user principle name matching.
        type: str
      antiphish:
        choices:
        - disable
        - enable
        description: Enable/disable AntiPhishing credential backend.
        type: str
      ca-cert:
        description: Deprecated, please rename it to ca_cert.
        type: str
      client-cert:
        description: Deprecated, please rename it to client_cert. Client certificate name.
        type: str
      client-cert-auth:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to client_cert_auth. Enable/disable
          using client certificate for TLS authentication.
        type: str
      cnid:
        description: No description.
        type: str
      dn:
        description: No description.
        type: str
      filter:
        description: No description.
        type: str
      group:
        description: No description.
        type: str
      group-filter:
        description: Deprecated, please rename it to group_filter.
        type: str
      group-member-check:
        choices:
        - user-attr
        - group-object
        - posix-group-object
        description: Deprecated, please rename it to group_member_check.
        type: str
      group-object-filter:
        description: Deprecated, please rename it to group_object_filter.
        type: str
      group-object-search-base:
        description: Deprecated, please rename it to group_object_search_base.
        type: str
      group-search-base:
        description: Deprecated, please rename it to group_search_base.
        type: str
      interface:
        description: No description.
        type: str
      interface-select-method:
        choices:
        - auto
        - sdwan
        - specify
        description: Deprecated, please rename it to interface_select_method.
        type: str
      max-connections:
        description: Deprecated, please rename it to max_connections.
        type: int
      member-attr:
        description: Deprecated, please rename it to member_attr.
        type: str
      obtain-user-info:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to obtain_user_info.
        type: str
      password:
        description: (list) No description.
        type: raw
      password-attr:
        description: Deprecated, please rename it to password_attr. Name of attribute
          to get password hash.
        type: str
      password-expiry-warning:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to password_expiry_warning.
        type: str
      password-renewal:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to password_renewal.
        type: str
      port:
        description: No description.
        type: int
      retrieve-protection-profile:
        description: Deprecated, please rename it to retrieve_protection_profile.
        type: str
      search-type:
        choices:
        - nested
        - recursive
        description: Deprecated, please rename it to search_type.
        elements: str
        type: list
      secondary-server:
        description: Deprecated, please rename it to secondary_server.
        type: str
      secure:
        choices:
        - disable
        - starttls
        - ldaps
        description: No description.
        type: str
      server:
        description: No description.
        type: str
      server-identity-check:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to server_identity_check.
        type: str
      source-ip:
        description: Deprecated, please rename it to source_ip.
        type: str
      source-port:
        description: Deprecated, please rename it to source_port. Source port to be used
          for communication with the LDAP server.
        type: int
      ssl-min-proto-version:
        choices:
        - default
        - TLSv1
        - TLSv1-1
        - TLSv1-2
        - SSLv3
        - TLSv1-3
        description: Deprecated, please rename it to ssl_min_proto_version.
        type: str
      tertiary-server:
        description: Deprecated, please rename it to tertiary_server.
        type: str
      two-factor:
        choices:
        - disable
        - fortitoken-cloud
        description: Deprecated, please rename it to two_factor.
        type: str
      two-factor-authentication:
        choices:
        - fortitoken
        - email
        - sms
        description: Deprecated, please rename it to two_factor_authentication.
        type: str
      two-factor-filter:
        description: Deprecated, please rename it to two_factor_filter. Filter used to
          synchronize users to FortiToken Cloud.
        type: str
      two-factor-notification:
        choices:
        - email
        - sms
        description: Deprecated, please rename it to two_factor_notification.
        type: str
      type:
        choices:
        - simple
        - anonymous
        - regular
        description: No description.
        type: str
      user-info-exchange-server:
        description: Deprecated, please rename it to user_info_exchange_server.
        type: str
      username:
        description: No description.
        type: str
    type: dict

workspace_locking_timeout:
    default: 300
    description: The maximum time in seconds to wait for other user to release the workspace
      lock.
    type: int

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