Repository URL to install this package:
|
Version:
6.0.0 ▾
|
#!/usr/bin/python
# -*- coding: utf-8 -*-
# (c) 2020, Simon Dodsley (simon@purestorage.com)
# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
from __future__ import absolute_import, division, print_function
__metaclass__ = type
ANSIBLE_METADATA = {
"metadata_version": "1.1",
"status": ["preview"],
"supported_by": "community",
}
DOCUMENTATION = r"""
---
module: purefa_vnc
version_added: '1.0.0'
short_description: Enable or Disable VNC port for installed apps
description:
- Enablke or Disable VNC access for installed apps
author:
- Pure Storage Ansible Team (@sdodsley) <pure-ansible-team@purestorage.com>
options:
state:
description:
- Define state of VNC
type: str
default: present
choices: [ present, absent ]
name:
description:
- Name od app
type: str
required: True
extends_documentation_fragment:
- purestorage.flasharray.purestorage.fa
"""
EXAMPLES = r"""
- name: Enable VNC for application test
purestorage.flasharray.purefa_vnc:
name: test
fa_url: 10.10.10.2
api_token: e31060a7-21fc-e277-6240-25983c6c4592
- name: Disable VNC for application test
purestorage.flasharray.purefa_vnc:
name: test
state: absent
fa_url: 10.10.10.2
api_token: e31060a7-21fc-e277-6240-25983c6c4592
"""
RETURN = r"""
vnc:
description: VNC port information for application
type: dict
returned: success
contains:
status:
description: Status of application
type: str
sample: 'healthy'
index:
description: Application index number
type: int
version:
description: Application version installed
type: str
sample: '5.2.1'
vnc:
description: IP address and port number for VNC connection
type: dict
sample: ['10.21.200.34:5900']
name:
description: Application name
type: str
"""
from ansible.module_utils.basic import AnsibleModule
from ansible_collections.purestorage.flasharray.plugins.module_utils.purefa import (
get_system,
purefa_argument_spec,
)
MIN_REQUIRED_API_VERSION = "1.17"
def enable_vnc(module, array, app):
"""Enable VNC port"""
changed = False
vnc_fact = []
if not app["vnc_enabled"]:
try:
if not module.check_mode:
array.enable_app_vnc(module.params["name"])
vnc_fact = array.get_app_node(module.params["name"])
changed = True
except Exception:
module.fail_json(
msg="Enabling VNC for {0} failed".format(module.params["name"])
)
module.exit_json(changed=changed, vnc=vnc_fact)
def disable_vnc(module, array, app):
"""Disable VNC port"""
changed = False
if app["vnc_enabled"]:
try:
if not module.check_mode:
array.disable_app_vnc(module.params["name"])
changed = True
except Exception:
module.fail_json(
msg="Disabling VNC for {0} failed".format(module.params["name"])
)
module.exit_json(changed=changed)
def main():
argument_spec = purefa_argument_spec()
argument_spec.update(
dict(
state=dict(type="str", default="present", choices=["present", "absent"]),
name=dict(type="str", required=True),
)
)
module = AnsibleModule(argument_spec, supports_check_mode=True)
array = get_system(module)
api_version = array._list_available_rest_versions()
if MIN_REQUIRED_API_VERSION not in api_version:
module.fail_json(
msg="FlashArray REST version not supported. "
"Minimum version required: {0}".format(MIN_REQUIRED_API_VERSION)
)
try:
app = array.get_app(module.params["name"])
except Exception:
module.fail_json(
msg="Selected application {0} does not exist".format(module.params["name"])
)
if not app["enabled"]:
module.fail_json(
msg="Application {0} is not enabled".format(module.params["name"])
)
if module.params["state"] == "present":
enable_vnc(module, array, app)
else:
disable_vnc(module, array, app)
module.exit_json(changed=False)
if __name__ == "__main__":
main()