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

Note

This module is part of the everpure.flashblade collection (version 1.29.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 everpure.flashblade. You need further requirements to be able to use this module, see Requirements for details.

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

New in everpure.flashblade 1.22.0

Synopsis

  • Manage FlashBlade KMIP Server objects

  • A KMIP server object names one or more KMIP servers and the CA certificate, or certificate group, used to validate their authenticity.

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

Name of an existing certificate on the array, used to validate the authenticity of the configured KMIP servers.

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

One of ca_certificate or ca_certificate_group is required when creating a new KMIP object.

ca_certificate_group

string

Name of an existing certificate group on the array, containing CA certificates that can validate the authenticity of the configured KMIP servers.

The group must contain at least one certificate.

Use the everpure.flashblade.purefb_certgrp module to create certificate groups.

One of ca_certificate or ca_certificate_group is required when creating a new KMIP object.

client_id

string

added in everpure.flashblade 1.26.0

ID of the API Client that issues the identity token.

Used with private_key_file.

disable_warnings

boolean

added in everpure.flashblade 1.18.0

Disable insecure certificate warnings

Choices:

  • false ← (default)

  • true

fb_url

string

FlashBlade management IP address or Hostname.

id_token

string

added in everpure.flashblade 1.26.0

A pre-signed JWT to authenticate with, as an alternative to api_token.

The token is exchanged by the array for a short-lived access token.

Requires a matching API Client to be registered on the array (see everpure.flashblade.purefb_apiclient).

issuer

string

added in everpure.flashblade 1.26.0

The API Client’s trusted identity issuer registered on the array.

Used with private_key_file.

key_id

string

added in everpure.flashblade 1.26.0

Key ID of the API Client that issues the identity token.

Used with private_key_file.

name

string / required

Name of the KMIP server object

private_key_file

string

added in everpure.flashblade 1.26.0

Path to the PEM RSA private key used to sign an identity token, as an alternative to api_token.

Requires client_id, key_id, issuer and username.

private_key_password

string

added in everpure.flashblade 1.26.0

Password protecting private_key_file, if encrypted.

state

string

Action for the module to perform

test reports the results of the array’s KMIP connectivity tests and makes no changes

Choices:

  • "absent"

  • "present" ← (default)

  • "test"

uris

list / elements=string

A list of URIs for the configured KMIP servers, in the format [protocol://]hostname:port.

Required when creating a new KMIP server object.

username

string

added in everpure.flashblade 1.26.0

Username the issued token should be granted to.

Must be a valid user on the array. Used with private_key_file.

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

  • Token-based authentication (id_token, or private_key_file with client_id, key_id, issuer and username) may be used as an alternative to api_token, and requires a matching API Client registered on the array via everpure.flashblade.purefb_apiclient

Examples

- name: Create KMIP object
  everpure.flashblade.purefb_kmip:
    name: foo
    ca_certificate: kmip_ca_cert
    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: Update the servers in an existing KMIP object
  everpure.flashblade.purefb_kmip:
    name: foo
    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

- name: Point a KMIP object at a certificate group instead
  everpure.flashblade.purefb_kmip:
    name: foo
    ca_certificate_group: kmip_ca_group
    fb_url: 10.10.10.2
    api_token: T-9f276a18-50ab-446e-8a0c-666a3529a1b6

- name: Test KMIP object connectivity
  everpure.flashblade.purefb_kmip:
    name: foo
    state: test
    fb_url: 10.10.10.2
    api_token: T-9f276a18-50ab-446e-8a0c-666a3529a1b6

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

Authors

  • Everpure Ansible Team (@sdodsley)