purestorage.flasharray.purefa_vnc – Enable or Disable VNC port for installed apps

Note

This plugin is part of the purestorage.flasharray collection (version 1.5.1).

To install it use: ansible-galaxy collection install purestorage.flasharray.

To use it in a playbook, specify: purestorage.flasharray.purefa_vnc.

New in version 1.0.0: of purestorage.flasharray

Synopsis
Requirements
Parameters
Notes
Examples
Return Values

Synopsis

Enablke or Disable VNC access for installed apps

Requirements

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

python >= 2.7
purestorage >= 1.19
py-pure-client >= 1.6.0
netaddr
requests

Parameters

Parameter	Choices/Defaults	Comments
api_token string		FlashArray API token for admin privileged user.
fa_url string		FlashArray management IPv4 address or Hostname.
name string / required		Name od app
state string	present ← absent	Define state of VNC

Notes

Note

This module requires the purestorage Python library
You must set PUREFA_URL and PUREFA_API environment variables if fa_url and api_token arguments are not passed to the module directly

Examples

- name: Enable VNC for application test
  purefa_vnc:
    name: test
    fa_url: 10.10.10.2
    api_token: e31060a7-21fc-e277-6240-25983c6c4592

- name: Disable VNC for application test
  purefa_vnc:
    name: test
    state: absent
    fa_url: 10.10.10.2
    api_token: e31060a7-21fc-e277-6240-25983c6c4592

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key		Returned	Description
vnc dictionary		success	VNC port information for application
	index integer	success	Application index number
	name string	success	Application name
	status string	success	Status of application Sample: healthy
	version string	success	Application version installed Sample: 5.2.1
	vnc dictionary	success	IP address and port number for VNC connection Sample: ['10.21.200.34:5900']

Authors

Pure Storage Ansible Team (@sdodsley) <[email protected]>

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/purestorage/flasharray/purefa_vnc_module.html