ansible.builtin.purefb_ds (v2.8.20) — module

Configure FlashBlade Directory Service

| "added in version" 2.8 of ansible.builtin"

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

preview | supported by community

Install Ansible via pip

Install with pip install ansible==2.8.20

Description

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

To modify an existing directory service configuration you must first delete an existing configuration and then recreate with new settings.


Requirements

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Delete existing management directory service
  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)
  purefb_ds:
    dstype: nfs
    uri: "ldap://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
  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
  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)
  purefb_ds:
    dstype: nfs
    enable: true
    uri: "ldap://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.
    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
    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.
    required: true
    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

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