purestorage.flashblade.purefb_kmip module – Manage FlashBlade KMIP server objects

Note

This module is part of the purestorage.flashblade collection (version 1.22.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install purestorage.flashblade. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: purestorage.flashblade.purefb_kmip.

New in purestorage.flashblade 1.22.0

Synopsis

  • Manage FlashBlade KMIP Server objects

Requirements

The below requirements are needed on the host that executes this module.

  • python >= 3.9

  • py-pure-client

  • netaddr

  • datetime

  • pytz

  • distro

  • pycountry

  • urllib3

Parameters

Parameter

Comments

api_token

string

FlashBlade API token for admin privileged user.

ca_certificate

string

The text of the CA certificate for the KMIP server.

Includes the “-----BEGIN CERTIFICATE-----” and “-----END CERTIFICATE-----” lines

Does not exceed 3000 characters in length

certificate

string

Name of existing certifcate used to verify FlashBlade authenticity to the KMIP server.

Use the purestorage.flashblade.purefb_certs module to create certificates.

disable_warnings

boolean

added in purestorage.flashblade 1.18.0

Disable insecure certificate warnings

Choices:

  • false ← (default)

  • true

fb_url

string

FlashBlade management IP address or Hostname.

name

string / required

Name of the KMIP server object

state

string

Action for the module to perform

Choices:

  • "absent"

  • "present" ← (default)

  • "test"

uris

list / elements=string

A list of URIs for the configured KMIP servers.

Notes

Note

  • You must set PUREFB_URL and PUREFB_API environment variables if fb_url and api_token arguments are not passed to the module directly

Examples

- name: Create KMIP obejct
  purestorage.flashblade.purefb_kmip:
    name: foo
    certificate: bar
    ca_certificate: "{{lookup('file', 'example.crt') }}"
    uris:
    - 1.1.1.1:8888
    - 2.3.3.3:9999
    fb_url: 10.10.10.2
    api_token: T-9f276a18-50ab-446e-8a0c-666a3529a1b6

- name: Delete KMIP object
  purestorage.flashblade.purefb_kmip:
    name: foo
    state: absent
    fb_url: 10.10.10.2
    api_token: T-9f276a18-50ab-446e-8a0c-666a3529a1b6

- name: Update KMIP object
  purestorage.flashblade.purefb_kmip:
    name: foo
    ca_certificate: "{{lookup('file', 'example2.crt') }}"
    uris:
    - 3.3.3.3:8888
    - 4.4.4.4:9999
    fb_url: 10.10.10.2
    api_token: T-9f276a18-50ab-446e-8a0c-666a3529a1b6

Authors

  • Pure Storage Ansible Team (@sdodsley)