purestorage.flashblade.purefb_proxy module – Configure FlashBlade phonehome HTTPs proxy settings

Note

This module is part of the purestorage.flashblade collection (version 1.17.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_proxy.

New in purestorage.flashblade 1.0.0

Synopsis

  • Set or erase configuration for the phonehome proxy settings.

Requirements

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

  • python >= 2.7

  • purity_fb >= 1.9

  • netaddr

  • pytz

Parameters

Parameter

Comments

api_token

string

FlashBlade API token for admin privileged user.

fb_url

string

FlashBlade management IP address or Hostname.

host

string

The proxy host name.

port

integer

The proxy TCP/IP port number.

secure

boolean

added in purestorage.flashblade 1.11.0

Use http or https as the proxy protocol.

True uses https, false uses http.

Choices:

  • false

  • true ← (default)

state

string

Set or delete proxy configuration

Choices:

  • "absent"

  • "present" ← (default)

Notes

Note

  • This module requires the purity_fb Python library

  • 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: Delete exisitng proxy settings
  purestorage.flashblade.purefb_proxy:
    state: absent
    fb_url: 10.10.10.2
    api_token: e31060a7-21fc-e277-6240-25983c6c4592

- name: Set proxy settings
  purestorage.flashblade.purefb_proxy:
    host: purestorage.com
    port: 8080
    fb_url: 10.10.10.2
    api_token: e31060a7-21fc-e277-6240-25983c6c4592

Authors

  • Pure Storage ansible Team (@sdodsley)