purestorage.flashblade.purefb_ds (1.17.0) — module

Configure FlashBlade Directory Service

| "added in version" 1.0.0 of purestorage.flashblade"

Authors: Pure Storage Ansible Team (@sdodsley) <pure-ansible-team@purestorage.com>

preview | supported by community

Install collection

Install with ansible-galaxy collection install purestorage.flashblade:==1.17.0


Add to requirements.yml

  collections:
    - name: purestorage.flashblade
      version: 1.17.0

Description

Create, modify or erase directory services configurations. There is no facility to SSL certificates at this time. Use the FlashBlade GUI for this additional configuration work.

If updating a directory service and i(bind_password) is provided this will always cause a change, even if the password given isn't different from the current. This makes this part of the module non-idempotent..


Requirements

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Delete existing management directory service
  purestorage.flashblade.purefb_ds:
    dstype: management
    state: absent
    fb_url: 10.10.10.2
    api_token: e31060a7-21fc-e277-6240-25983c6c4592
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Create NFS directory service (disabled)
  purestorage.flashblade.purefb_ds:
    dstype: nfs
    uri: "ldaps://lab.purestorage.com"
    base_dn: "DC=lab,DC=purestorage,DC=com"
    bind_user: Administrator
    bind_password: password
    fb_url: 10.10.10.2
    api_token: e31060a7-21fc-e277-6240-25983c6c4592
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Enable existing SMB directory service
  purestorage.flashblade.purefb_ds:
    dstypr: smb
    enable: true
    fb_url: 10.10.10.2
    api_token: e31060a7-21fc-e277-6240-25983c6c4592
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Disable existing management directory service
  purestorage.flashblade.purefb_ds:
    dstype: management
    enable: false
    fb_url: 10.10.10.2
    api_token: e31060a7-21fc-e277-6240-25983c6c4592
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Create NFS directory service (enabled)
  purestorage.flashblade.purefb_ds:
    dstype: nfs
    enable: true
    uri: "ldaps://lab.purestorage.com"
    base_dn: "DC=lab,DC=purestorage,DC=com"
    bind_user: Administrator
    bind_password: password
    fb_url: 10.10.10.2
    api_token: e31060a7-21fc-e277-6240-25983c6c4592

Inputs

    
uri:
    description:
    - A list of up to 30 URIs of the directory servers. Each URI must include the scheme
      ldap:// or ldaps:// (for LDAP over SSL), a hostname, and a domain name or IP address.
      For example, ldap://ad.company.com configures the directory service with the hostname
      "ad" in the domain "company.com" while specifying the unencrypted LDAP protocol.
    elements: str
    type: list

state:
    choices:
    - absent
    - present
    default: present
    description:
    - Create or delete directory service configuration
    type: str

dstype:
    choices:
    - management
    - nfs
    - smb
    description:
    - The type of directory service to work on
    required: true
    type: str

enable:
    default: false
    description:
    - Whether to enable or disable directory service support.
    type: bool

fb_url:
    description:
    - FlashBlade management IP address or Hostname.
    type: str

base_dn:
    description:
    - Sets the base of the Distinguished Name (DN) of the directory service groups. The
      base should consist of only Domain Components (DCs). The base_dn will populate with
      a default value when a URI is entered by parsing domain components from the URI.
      The base DN should specify DC= for each domain component and multiple DCs should
      be separated by commas.
    type: str

join_ou:
    description:
    - The optional organizational unit (OU) where the machine account for the directory
      service will be created.
    type: str

api_token:
    description:
    - FlashBlade API token for admin privileged user.
    type: str

bind_user:
    description:
    - Sets the user name that can be used to bind to and query the directory.
    - For Active Directory, enter the username - often referred to as sAMAccountName or
      User Logon Name - of the account that is used to perform directory lookups.
    - For OpenLDAP, enter the full DN of the user.
    type: str

nis_domain:
    description:
    - The NIS domain to search
    - This cannot be used in conjunction with LDAP configurations.
    type: str

nis_servers:
    description:
    - A list of up to 30 IP addresses or FQDNs for NIS servers.
    - This cannot be used in conjunction with LDAP configurations.
    elements: str
    type: list

bind_password:
    description:
    - Sets the password of the bind_user user name account.
    type: str

force_bind_password:
    default: true
    description:
    - Will force the bind password to be reset even if the bind user password is unchanged.
    - If set to I(false) and I(bind_user) is unchanged the password will not be reset.
    type: bool
    version_added: 1.16.0
    version_added_collection: purestorage.flashblade