Update README.md

README.md

@@ -1,2 +1,12 @@
 # decort-ansible
-Ansible modules for Digital Energy Orchestration Technology (DECORT) platform v3.4.0 and above
+Ansible modules for Digital Energy Orchestration Technology (DECORT) platform v3.6.1 and above.
+
+Note that this module may produce unreliable results when used with older DECORT API versions. 
+
+Requirements:
+* Ansible 2.7 or higher
+* Python 2.6 or higher
+* PyJWT 1.7.1 Python module
+* requests Python module
+* netaddr Python module
+* DECORT cloud platform version 3.5.0 or higher

examples/inventory

@@ -0,0 +1,2 @@
+[all]
+ansible_master ansible_host=<ansible host IP address> ansible_port=<SSH port on ansible host> ansible_user=root

examples/jwt.yaml

@@ -0,0 +1,18 @@
+#
+# More details on how to use DECORT Ansible module can be found at:
+#    https://github.com/rudecs/decort-ansible/wiki
+# 
+
+- hosts: ansible_master
+  tasks:
+  - name: obtain JWT
+    decort_jwt:
+      oauth2_url: "{{ decort_sso }}" # "https://sso.digitalenergy.online"
+      validity: 1200
+    register: my_jwt
+    delegate_to: localhost
+
+  - name: print out JWT
+    debug:
+      var: my_jwt.jwt
+    delegate_to: localhost

examples/main.yaml

@@ -0,0 +1,190 @@
+#
+# More details on how to use DECORT Ansible module can be found at:
+#    https://github.com/rudecs/decort-ansible/wiki
+# 
+
+- hosts: ansible_master
+  vars_files:
+  - vars.yaml
+  tasks:
+  - name: obtain JWT
+    decort_jwt:
+       oauth2_url: "{{ decort_sso }}"
+       validity: 1200
+    register: token
+    delegate_to: localhost
+
+  - name: obtain OS image
+    decort_osimage:
+       authenticator: jwt
+       jwt: "{{ token.jwt }}"
+       oauth2_url: "{{ decort_sso }}"
+       controller_url: "{{ decort_ctrl }}"
+       image_name: "{{ os_image_name }}"
+       account_name: "{{ target_account_name }}"
+       verify_ssl: false
+    register: my_image
+    delegate_to: localhost
+
+  - name: print out the result
+    debug:
+       var: my_image.facts
+    delegate_to: localhost
+
+  - name: manage RG
+    decort_rg:
+       authenticator: jwt
+       jwt: "{{ token.jwt }}"
+       oauth2_url: "{{ decort_sso }}"
+       controller_url: "{{ decort_ctrl }}"
+       account_id: 32
+       rg_name: "{{ target_rg_name }}"
+       state: present
+       verify_ssl: false
+    register: my_rg
+    delegate_to: localhost
+
+  - name: print out the result
+    debug:
+       var: my_rg.facts
+    delegate_to: localhost
+
+  - name: manage ViNS 01
+    decort_vins:
+       authenticator: jwt
+       jwt: "{{ token.jwt }}"
+       oauth2_url: "{{ decort_sso }}"
+       controller_url: "{{ decort_ctrl }}"
+       vins_name: "{{ vins01_name }}"
+       rg_id: "{{ my_rg.facts.id }}"
+       ext_net_id: "{{ target_ext_net_id }}"
+       state: present
+       verify_ssl: false
+    register: my_vins01
+    delegate_to: localhost
+
+  - name: print out the result
+    debug:
+       var: my_vins01.facts
+    delegate_to: localhost
+
+  - name: manage ViNS 02
+    decort_vins:
+       authenticator: jwt
+       jwt: "{{ token.jwt }}"
+       oauth2_url: "{{ decort_sso }}"
+       controller_url: "{{ decort_ctrl }}"
+       vins_name: "{{ vins02_name }}"
+       rg_id: "{{ my_rg.facts.id }}"
+       ext_net_id: -1
+       state: present
+       verify_ssl: false
+    register: my_vins02
+    delegate_to: localhost
+
+  - name: print out the result
+    debug:
+       var: my_vins02.facts
+    delegate_to: localhost
+
+  - name: manage data disk 01
+    decort_disk:
+       authenticator: jwt
+       jwt: "{{ token.jwt }}"
+       oauth2_url: "{{ decort_sso }}"
+       controller_url: "{{ decort_ctrl }}"
+       name: "{{ datadisk01_name }}"
+       size: "{{ datadisk01_size }}"
+       account_name: "{{ target_account_name }}"
+       pool: data01
+       place_with: "{{ my_image.facts.id }}"
+       state: present
+       verify_ssl: false
+    register: my_disk01
+    delegate_to: localhost
+
+  - name: print out the result
+    debug:
+       var: my_disk01.facts
+    delegate_to: localhost
+
+  - name: manage data disk 02
+    decort_disk:
+       authenticator: jwt
+       jwt: "{{ token.jwt }}"
+       oauth2_url: "{{ decort_sso }}"
+       controller_url: "{{ decort_ctrl }}"
+       name: "{{ datadisk02_name }}"
+       size: "{{ datadisk02_size }}"
+       account_name: "{{ target_account_name }}"
+       pool: data01
+       place_with: "{{ my_image.facts.id }}"
+       state: present
+       verify_ssl: false
+    register: my_disk02
+    delegate_to: localhost
+
+  - name: print out the result
+    debug:
+       var: my_disk02.facts
+    delegate_to: localhost
+
+  - name: manage KVM X86 VM
+    decort_kvmvm:
+       authenticator: jwt
+       jwt: "{{ token.jwt }}"
+       oauth2_url: "{{ decort_sso }}"
+       controller_url: "{{ decort_ctrl }}"
+       name: "{{ vm01_name }}"
+       arch: KVM_X86
+       ram: "{{ vm01_ram }}"
+       cpu: "{{ vm01_cpu }}"
+       image_id: "{{ my_image.facts.id }}"
+       boot_disk: "{{ vm01_boot_disk }}"
+       data_disks:
+         - "{{ my_disk01.facts.id }}"
+         - "{{ my_disk02.facts.id }}"
+       networks:
+         - type: VINS
+           id: "{{ my_vins01.facts.id }}"
+         - type: VINS
+           id: "{{ my_vins02.facts.id }}"
+         - type: EXTNET
+           id: "{{ target_ext_net_id }}"
+       rg_id: "{{ my_rg.facts.id }}"
+       state: present
+       verify_ssl: false
+    register: my_kvmvm
+    delegate_to: localhost
+
+  - name: print out the result
+    debug:
+       var: my_kvmvm.facts
+    delegate_to: localhost
+
+  - name: manage PFW rules on Compute
+    decort_pfw:
+       authenticator: jwt
+       jwt: "{{ token.jwt }}"
+       oauth2_url: "{{ decort_sso }}"
+       controller_url: "{{ decort_ctrl }}"
+       compute_id: "{{ my_kvmvm.facts.id }}"
+       vins_id: "{{ my_vins01.facts.id }}"
+       rules:
+         - public_port_start: 30022
+           local_port: 22
+           proto: tcp
+         - public_port_start: 30080
+           public_port_end: 30085
+           local_port: 30080
+           proto: tcp
+       state: present
+       verify_ssl: false
+    register: my_pfw
+    delegate_to: localhost
+
+  - name: print out the result
+    debug:
+       var: my_pfw.facts
+    delegate_to: localhost
+

examples/prepenv.sh

@@ -0,0 +1,21 @@
+#!/bin/bash
+
+# 1. As this file will contain sensitive data (application ID & Secret pair) put this file 
+#    in a directory, where only you will have access to it, e.g. your ~/.ssh directory.
+# 2. Make sure this file is not readable by anybody else (chmod 400).
+# 3. Paste your Application ID (obtained from DECORT SSO application) to DECORT_APP_ID.
+# 4. Paste your Application Secret (obtained from DECORT SSO application) to DECORT_APP_SECRET.
+# 5. Paste DECORT SSO application URL to DECORT_OAUTH2_URL.
+#
+# Source this file into shell to prepare environment for running DECORT Ansible module, e.g.
+# . ~/.ssh/prepenv.sh
+#
+# More informaiton on DECORT Ansible module can be found at:
+#   https://github.com/rudecs/decort-ansible/wiki
+#
+
+export DECORT_APP_ID="put your application ID here"
+export DECORT_APP_SECRET="put your application secret here"
+export DECORT_OAUTH2_URL="put DECORT SSO URL here" # "https://sso.digitalenergy.online"
+
+export ANSIBLE_HOST_KEY_CHEKCING=False

examples/vars.yaml

@@ -0,0 +1,26 @@
+#
+# More details on how to use DECORT Ansible module can be found at:
+#    https://github.com/rudecs/decort-ansible/wiki
+# 
+
+decort_sso: "put DECORT SSO application URL here" # "https://sso.digitalenergy.online"
+decort_ctrl: "put DECORT controller URL here" # "https://ds1.digitalenergy.online"
+
+target_account_name: "your account name"
+target_rg_name: "target resource group name"
+os_image_name: "OS image name"
+
+vins01_name: "Vins01-ansible"
+vins02_name: "Vins02-ansible"
+target_ext_net_id: 0
+
+datadisk01_name: "Data01-ansible"
+datadisk01_size: 5
+
+datadisk02_name: "Data02-ansible"
+datadisk02_size: 5
+
+vm01_name: "Vm01-ansible"
+vm01_cpu: 1
+vm01_ram: 1024
+vm01_boot_disk: 10

library/decort_disk.py

@@ -0,0 +1,541 @@
+#!/usr/bin/python
+#
+# Digital Enegry Cloud Orchestration Technology (DECORT) modules for Ansible
+# Copyright: (c) 2018-2021 Digital Energy Cloud Solutions LLC
+#
+# Apache License 2.0 (see http://www.apache.org/licenses/LICENSE-2.0.txt)
+#
+
+#
+# Author: Sergey Shubin (sergey.shubin@digitalenergy.online)
+#
+
+ANSIBLE_METADATA = {'metadata_version': '1.1',
+                    'status': ['preview'],
+                    'supported_by': 'community'}
+
+DOCUMENTATION = '''
+---
+module: decort_disk
+short_description: Manage Disks (virtualized storage resources) in DECORT cloud
+description: >
+     This module can be used to create new disk in DECORT cloud platform, obtain or 
+     modify its characteristics, and delete it.
+version_added: "2.2"
+author:
+     - Sergey Shubin <sergey.shubin@digitalenergy.online>
+requirements:
+     - python >= 2.6
+     - PyJWT Python module
+     - requests Python module
+     - netaddr Python module
+     - decort_utils utility library (module)
+     - DECORT cloud platform version 3.6.1 or higher
+notes:
+     - Environment variables can be used to pass selected parameters to the module, see details below.
+     - Specified Oauth2 provider must be trusted by the DECORT cloud controller on which JWT will be used.
+     - 'Similarly, JWT supplied in I(authenticator=jwt) mode should be received from Oauth2 provider trusted by
+       the DECORT cloud controller on which this JWT will be used.'
+options:
+    account_id:
+        description:
+        - ID of the account, which owns this disk. This is the alternative to I(account_name) option.
+        - If both I(account_id) and I(account_name) specified, then I(account_name) is ignored.
+        default: 0
+        required: no
+    account_name:
+        description:
+        - 'Name of the account, which will own this disk.'
+        - 'This parameter is ignored if I(account_id) is specified.'
+        default: empty string
+        required: no
+    annotation:
+        description:
+        - Optional text description of this disk.
+        default: empty string
+        required: no
+    app_id:
+        description:
+        - 'Application ID for authenticating to the DECORT controller when I(authenticator=oauth2).'
+        - 'Required if I(authenticator=oauth2).'
+        - 'If not found in the playbook or command line arguments, the value will be taken from DECORT_APP_ID
+           environment variable.'
+        required: no
+    app_secret:
+        description:
+        - 'Application API secret used for authenticating to the DECORT controller when I(authenticator=oauth2).'
+        - This parameter is required when I(authenticator=oauth2) and ignored in other modes.
+        - 'If not found in the playbook or command line arguments, the value will be taken from DECORT_APP_SECRET
+           environment variable.'
+        required: no
+    authenticator:
+        description:
+        - Authentication mechanism to be used when accessing DECORT controller and authorizing API call.
+        default: jwt
+        choices: [ jwt, oauth2, legacy ]
+        required: yes
+    controller_url:
+        description:
+        - URL of the DECORT controller that will be contacted to manage the RG according to the specification.
+        - 'This parameter is always required regardless of the specified I(authenticator) type.'
+        required: yes
+    id:
+        description:
+        - `ID of the disk to manage. If I(id) is specified it is assumed, that this disk already
+          exists. In other words, you cannot create new disk by specifying its ID, use I(name)
+          when creating new disk.`
+        - `If non-zero I(id) is specified, then I(name), I(account_id) and I(account_name) 
+          are ignored.`
+        default: 0
+        required: no
+    name:
+        description:
+        - `Name of the disk to manage. To manage disk by name you also need to specify either
+          I(account_id) or I(account_name).`
+        - If non-zero I(id) is specified, I(name) is ignored.
+        - `Note that the platform does not enforce uniqueness of disk names, so if more than one
+          disk with this name exists under the specified account, module will return the first
+          occurence.`
+        default: empty string
+        required: no
+    force_detach:
+        description:
+        - `By default it is not allowed to delete or destroy disk that is currently attached to a compute
+          instance (e.g. virtual machine or bare metal server). Set this argument to true to change this
+          behavior.`
+        - This argument is meaningful for I(state=absent) operations only and ignored otherwise.
+        default: false
+        required: no
+    jwt:
+        description:
+        - 'JWT (access token) for authenticating to the DECORT controller when I(authenticator=jwt).'
+        - 'This parameter is required if I(authenticator=jwt) and ignored for other authentication modes.'
+        - If not specified in the playbook, the value will be taken from DECORT_JWT environment variable.
+        required: no
+    oauth2_url:
+        description:
+        - 'URL of the oauth2 authentication provider to use when I(authenticator=oauth2).'
+        - 'This parameter is required when when I(authenticator=oauth2).'
+        - 'If not specified in the playbook, the value will be taken from DECORT_OAUTH2_URL environment variable.'
+    password:
+        description:
+        - 'Password for authenticating to the DECORT controller when I(authenticator=legacy).'
+        - 'This parameter is required if I(authenticator=legacy) and ignored in other authentication modes.'
+        - If not specified in the playbook, the value will be taken from DECORT_PASSWORD environment variable.
+        required: no
+    place_with:
+        description:
+        - `This argument can be used to simplify data disks creation along with a new compute, by placing
+          disks in the same storage, where corresponding OS image is deployed.`
+        - `Specify ID of an OS image, and the newly created disk will be provisioned from the same
+          storage, where this OS image is located. You may optionally specify I(pool) to control
+          actual disk placement within that storage, or leave I(pool=default) to let platform manage
+          it automatically.`
+        - This parameter is used when creating new disks and ignored for all other operations.
+        - This is an alternative to specifying I(sep_id).
+        default: 0
+        required: no
+    pool:
+        description:
+        - Name of the pool where to place new disk. Once disk is created, its pool cannot be changed.
+        - This parameter is used when creating new disk and igonred for all other operations.
+        default: empty string
+        required: no
+    sep_id:
+        description:
+        - `ID of the Storage Endpoint Provider (SEP) where to place new disk. Once disk is created, 
+          its SEP cannot be changed.`
+        - `You may think of SEP as an identifier of a storage system connected to DECORT platform. There
+          may be several different storage systems and, consequently, several SEPs available to choose from.`
+        - This parameter is used when creating new disk and igonred for all other operations.
+        - See also I(place_with) for an alternative way to specify disk placement.
+        default: 0
+        required: no
+    size:
+        description:
+        - Size of the disk in GB. This parameter is mandatory when creating new disk.
+        - `If specified for an existing disk, and it is greater than current disk size, platform will try to resize
+          the disk on the fly. Downsizing disk is not allowed.`
+        required: no
+    state:
+        description:
+        - Specify the desired state of the disk at the exit of the module.
+        - 'If desired I(state=present):'
+        - ' - Disk does not exist or is in [DESTROYED, PURGED] states, create new disk according to the specifications.'
+        - ' - Disk is in DELETED state, restore it and change size if necessary.'
+        - ' - Disk is in one of [CREATED, ASSIGNED] states, do nothing.'
+        - ' - Disk in any other state, abort with an error.'
+        - 'If desired I(state=absent):'
+        - ' - Disk is in one of [CREATED, ASSIGNED, DELETED] states, destroy it.'
+        - ' - Disk not found or in [DESTROYED, PURGED] states, do nothing.' 
+        - ' - Disk in any other state, abort with an error.'
+        default: present
+        choices: [ absent, present ]
+    user:
+        description:
+        - 'Name of the legacy user for authenticating to the DECORT controller when I(authenticator=legacy).'
+        - 'This parameter is required when I(authenticator=legacy) and ignored for other authentication modes.'
+        - If not specified in the playbook, the value will be taken from DECORT_USER environment variable.
+        required: no
+    verify_ssl:
+        description:
+        - 'Controls SSL verification mode when making API calls to DECORT controller. Set it to False if you
+         want to disable SSL certificate verification. Intended use case is when you run module in a trusted
+         environment that uses self-signed certificates. Note that disabling SSL verification in any other
+         scenario can lead to security issues, so please know what you are doing.'
+        default: True
+        required: no
+    workflow_callback:
+        description:
+        - 'Callback URL that represents an application, which invokes this module (e.g. up-level orchestrator or
+          end-user portal) and may except out-of-band updates on progress / exit status of the module run.'
+        - API call at this URL will be used to relay such information to the application.
+        - 'API call payload will include module-specific details about this module run and I(workflow_context).'
+        required: no
+    workflow_context:
+        description:
+        - 'Context data that will be included into the payload of the API call directed at I(workflow_callback) URL.'
+        - 'This context data is expected to uniquely identify the task carried out by this module invocation so
+           that up-level orchestrator could match returned information to the its internal entities.'
+        required: no
+'''
+
+EXAMPLES = '''
+- name: create new Disk named "MyDataDisk01" of size 50 GB, on SEP ID 1, in default pool, under the account "MyAccount".
+    decort_vins:
+      authenticator: oauth2
+      app_id: "{{ MY_APP_ID }}"
+      app_secret: "{{ MY_APP_SECRET }}"
+      controller_url: "https://cloud.digitalenergy.online"
+      name: "MyDataDisk01"
+      sep_id: 1
+      size: 50
+      account_name: "MyAccount"
+      state: present
+    delegate_to: localhost
+    register: my_disk
+'''
+
+RETURN = '''
+facts:
+    description: facts about the disk
+    returned: always
+    type: dict
+    sample:
+      facts:
+        id: 50
+        name: data01
+        size: 10
+        sep_id: 1
+        pool: datastore
+        state: ASSIGNED
+        account_id: 7
+        attached_to: 18
+        gid: 1001
+'''
+
+from ansible.module_utils.basic import AnsibleModule
+from ansible.module_utils.basic import env_fallback
+
+from ansible.module_utils.decort_utils import *
+
+
+def decort_disk_package_facts(disk_facts, check_mode=False):
+    """Package a dictionary of disk facts according to the decort_disk module specification. 
+    This dictionary will be returned to the upstream Ansible engine at the completion of 
+    the module run.
+
+    @param (dict) disk_facts: dictionary with Disk facts as returned by API call to .../disks/get
+    @param (bool) check_mode: boolean that tells if this Ansible module is run in check mode
+    """
+
+    ret_dict = dict(id=0,
+                    name="none",
+                    state="CHECK_MODE",
+                    size=0,
+                    account_id=0,
+                    sep_id=0,
+                    pool="none",
+                    attached_to=0,
+                    gid=0
+                    )
+
+    if check_mode:
+        # in check mode return immediately with the default values
+        return ret_dict
+
+    if disk_facts is None:
+        # if void facts provided - change state value to ABSENT and return
+        ret_dict['state'] = "ABSENT"
+        return ret_dict
+
+    ret_dict['id'] = disk_facts['id']
+    ret_dict['name'] = disk_facts['name']
+    ret_dict['size'] = disk_facts['sizeMax']
+    ret_dict['state'] = disk_facts['status']
+    ret_dict['account_id'] = disk_facts['accountId']
+    ret_dict['sep_id'] = disk_facts['sepId']
+    ret_dict['pool'] = disk_facts['pool']
+    ret_dict['attached_to'] = disk_facts['vmid']
+    ret_dict['gid'] = disk_facts['gid']
+
+    return ret_dict
+
+def decort_disk_parameters():
+    """Build and return a dictionary of parameters expected by decort_disk module in a form accepted
+    by AnsibleModule utility class."""
+
+    return dict(
+        account_id=dict(type='int', required=False, default=0),
+        account_name=dict(type='str', required=False, default=''),
+        annotation=dict(type='str', required=False, default='Disk by decort_disk'),
+        app_id=dict(type='str',
+                    required=False,
+                    fallback=(env_fallback, ['DECORT_APP_ID'])),
+        app_secret=dict(type='str',
+                        required=False,
+                        fallback=(env_fallback, ['DECORT_APP_SECRET']),
+                        no_log=True),
+        authenticator=dict(type='str',
+                           required=True,
+                           choices=['legacy', 'oauth2', 'jwt']),
+        controller_url=dict(type='str', required=True),
+        id=dict(type='int', required=False, default=0),
+        name=dict(type='str', required=False),
+        force_detach=dict(type='bool', required=False, default=False),
+        jwt=dict(type='str',
+                 required=False,
+                 fallback=(env_fallback, ['DECORT_JWT']),
+                 no_log=True),
+        oauth2_url=dict(type='str',
+                        required=False,
+                        fallback=(env_fallback, ['DECORT_OAUTH2_URL'])),
+        password=dict(type='str',
+                      required=False,
+                      fallback=(env_fallback, ['DECORT_PASSWORD']),
+                      no_log=True),
+        place_with=dict(type='int', required=False, default=0),
+        pool=dict(type='str', required=False, default=''),
+        sep_id=dict(type='int', required=False, default=0),
+        size=dict(type='int', required=False),
+        state=dict(type='str',
+                   default='present',
+                   choices=['absent', 'present']),
+        user=dict(type='str',
+                  required=False,
+                  fallback=(env_fallback, ['DECORT_USER'])),
+        verify_ssl=dict(type='bool', required=False, default=True),
+        workflow_callback=dict(type='str', required=False),
+        workflow_context=dict(type='str', required=False),
+    )
+
+def main():
+    module_parameters = decort_disk_parameters()
+
+    amodule = AnsibleModule(argument_spec=module_parameters,
+                            supports_check_mode=True,
+                            mutually_exclusive=[
+                                ['oauth2', 'password'],
+                                ['password', 'jwt'],
+                                ['jwt', 'oauth2'],
+                            ],
+                            required_together=[
+                                ['app_id', 'app_secret'],
+                                ['user', 'password'],
+                            ],
+                            )
+
+    decon = DecortController(amodule)
+
+    disk_id = 0
+    disk_facts = None # will hold Disk facts
+    validated_acc_id = 0
+    acc_facts = None # will hold Account facts
+
+    if amodule.params['id']:
+        # expect existing Disk with the specified ID
+        # This call to disk_find will abort the module if no Disk with such ID is present
+        disk_id, disk_facts = decon.disk_find(amodule.params['id'])
+        if not disk_id:
+            decon.result['failed'] = True
+            decon.result['msg'] = "Specified Disk ID {} not found.".format(amodule.params['id'])
+            amodule.fail_json(**decon.result)
+        validated_acc_id =disk_facts['accountId']
+    elif amodule.params['account_id'] > 0 or amodule.params['account_name'] != "":
+        # Make sure disk name is specified, if not - fail the module
+        if amodule.params['name'] == "":
+            decon.result['failed'] = True
+            decon.result['msg'] = ("Cannot manage disk if both ID is 0 and disk name is empty.")
+            amodule.fail_json(**decon.result)
+        # Specified account must be present and accessible by the user, otherwise abort the module 
+        validated_acc_id, acc_facts = decon.account_find(amodule.params['account_name'], amodule.params['account_id'])
+        if not validated_acc_id:
+            decon.result['failed'] = True
+            decon.result['msg'] = ("Current user does not have access to the requested account "
+                                    "or non-existent account specified.")
+            amodule.fail_json(**decon.result)
+        # This call to disk_find may return disk_id=0 if no Disk with this name found in 
+        disk_id, disk_facts = decon.disk_find(disk_id=0, disk_name=amodule.params['name'],
+                                                account_id=validated_acc_id,
+                                                check_state=False)
+    else: 
+        # this is "invalid arguments combination" sink
+        # if we end up here, it means that module was invoked with disk_id=0 and undefined account
+        decon.result['failed'] = True
+        if amodule.params['account_id'] == 0 and amodule.params['account_name'] == "":
+            decon.result['msg'] = "Cannot find Disk by name when account name is empty and account ID is 0."
+        if amodule.params['name'] == "":
+            decon.result['msg'] = "Cannot find Disk by empty name."
+        amodule.fail_json(**decon.result)
+
+    #
+    # Initial validation of module arguments is complete
+    #
+    # At this point non-zero disk_id means that we will be managing pre-existing Disk
+    # Otherwise we are about to create a new disk
+    #
+    # Valid Disk model statii are as follows:
+    # 
+    # "CREATED", "ASSIGNED", DELETED", "DESTROYED", "PURGED"
+    # 
+
+    disk_should_exist = False
+    target_sep_id = 0
+    # target_pool = ""
+    
+    if disk_id:
+        disk_should_exist = True
+        if disk_facts['status'] in ["MODELED", "CREATING" ]:
+            # error: nothing can be done to existing Disk in the listed statii regardless of
+            # the requested state
+            decon.result['failed'] = True
+            decon.result['changed'] = False
+            decon.result['msg'] = ("No change can be done for existing Disk ID {} because of its current "
+                                   "status '{}'").format(disk_id, disk_facts['status'])
+        elif disk_facts['status'] in ["CREATED", "ASSIGNED"]:
+            if amodule.params['state'] == 'absent':
+                decon.disk_delete(disk_id, True, amodule.params['force_detach']) # delete permanently
+                disk_facts['status'] = 'DESTROYED'
+                disk_should_exist = False
+            elif amodule.params['state'] == 'present':
+                # resize Disk as necessary & if possible
+                if decon.check_amodule_argument('size', False):
+                    decon.disk_resize(disk_facts, amodule.params['size'])
+        elif disk_facts['status'] == "DELETED":
+            if amodule.params['state'] == 'present':
+                # restore
+                decon.disk_restore(disk_id)
+                _, disk_facts = decon.disk_find(disk_id)
+                decon.disk_resize(disk_facts, amodule.params['size'])
+                disk_should_exist = True
+            elif amodule.params['state'] == 'absent':
+                # destroy permanently
+                decon.disk_delete(disk_id, permanently=True)
+                disk_facts['status'] = 'DESTROYED'
+                disk_should_exist = False
+        elif disk_facts['status'] in ["DESTROYED", "PURGED"]:
+            if amodule.params['state'] == 'present':
+                # Need to re-provision this Disk.
+                # Some attributes may change, some must stay the same:
+                # - disk name  - stays, take from disk_facts
+                # - account ID - stays, take from validated account ID
+                # - size       - may change, take from module arguments
+                # - SEP ID     - may change, build based on module arguments
+                # - pool       - may change, take from module arguments
+                # - annotation - may change, take from module arguments
+                #
+                # First validate required parameters:
+                decon.check_amodule_argument('size') # this will fail the module if size is not specified
+                target_sep_id = 0
+                if decon.check_amodule_argument('sep_id', False) and amodule.params['sep_id'] > 0:
+                    # non-zero sep_id is explicitly passed in module arguments
+                    target_sep_id = amodule.params['sep_id']
+                elif decon.check_amodule_argument('place_with', False) and amodule.params['place_with'] > 0:
+                    # request to place this disk on the same SEP as the specified OS image
+                    # validate specified OS image and assign SEP ID accordingly
+                    image_id, image_facts = decon.image_find(amodule.params['place_with'], "", 0)
+                    target_sep_id = image_facts['sepId']
+                else:
+                    # no new SEP ID is explicitly specified, and no place_with option - use sepId from the disk_facts
+                    target_sep_id = disk_facts['sepId']
+                disk_id = decon.disk_provision(disk_name=disk_facts['name'], # as this disk was found, its name is in the facts
+                                               size=amodule.params['size'],
+                                               account_id=validated_acc_id, 
+                                               sep_id=target_sep_id,
+                                               pool=amodule.params['pool'],
+                                               desc=amodule.params['annotation'],
+                                               location="")
+                disk_should_exist = True
+            elif amodule.params['state'] == 'absent':
+                # nop
+                decon.result['failed'] = False
+                decon.result['changed'] = False
+                decon.result['msg'] = ("No state change required for Disk ID {} because of its "
+                                       "current status '{}'").format(disk_id,
+                                                                     disk_facts['status'])
+                disk_should_exist = False
+    else:
+        # disk_id =0 -> pre-existing Disk was not found.
+        disk_should_exist = False  # we will change it back to True if Disk is created successfully
+        # If requested state is 'absent' - nothing to do
+        if amodule.params['state'] == 'absent':
+            decon.result['failed'] = False
+            decon.result['changed'] = False
+            decon.result['msg'] = ("Nothing to do as target state 'absent' was requested for "
+                                   "non-existent Disk name '{}'").format(amodule.params['name'])
+        elif amodule.params['state'] == 'present':
+            decon.check_amodule_argument('name') # if disk name not specified, fail the module 
+            decon.check_amodule_argument('size') # if disk size not specified, fail the module
+
+            # as we already have account ID, we can create Disk and get disk id on success
+            if decon.check_amodule_argument('sep_id', False) and amodule.params['sep_id'] > 0:
+                # non-zero sep_id is explicitly passed in module arguments
+                target_sep_id = amodule.params['sep_id']
+            elif decon.check_amodule_argument('place_with', False) and amodule.params['place_with'] > 0:
+                # request to place this disk on the same SEP as the specified OS image
+                # validate specified OS image and assign SEP ID accordingly
+                image_id, image_facts = decon.image_find(amodule.params['place_with'], "", 0)
+                target_sep_id = image_facts['sepId']
+            else:
+                # no SEP ID is explicitly specified, and no place_with option - we do not know where
+                # to place the new disk - fail the module
+                decon.result['failed'] = True
+                decon.result['msg'] = ("Cannot create new Disk name '{}': no SEP ID specified and "
+                                       "no 'place_with' option used.").format(amodule.params['name'])
+                amodule.fail_json(**decon.result)
+            
+            disk_id = decon.disk_provision(disk_name=amodule.params['name'],
+                                            size=amodule.params['size'],
+                                            account_id=validated_acc_id, 
+                                            sep_id=target_sep_id,
+                                            pool_name=amodule.params['pool'],
+                                            desc=amodule.params['annotation'],
+                                            location="")
+            disk_should_exist = True            
+        elif amodule.params['state'] == 'disabled':
+            decon.result['failed'] = True
+            decon.result['changed'] = False
+            decon.result['msg'] = ("Invalid target state '{}' requested for non-existent "
+                                   "Disk name '{}'").format(amodule.params['state'],
+                                                            amodule.params['name'])
+    
+    #
+    # conditional switch end - complete module run
+    #
+    if decon.result['failed']:
+        amodule.fail_json(**decon.result)
+    else:
+        # prepare Disk facts to be returned as part of decon.result and then call exit_json(...)
+        if disk_should_exist:
+            if decon.result['changed']:
+                # If we arrive here, there is a good chance that the Disk is present - get fresh Disk
+                # facts by Disk ID.
+                # Otherwise, Disk facts from previous call (when the Disk was still in existence) will
+                # be returned.
+                _, disk_facts = decon.disk_find(disk_id)
+        decon.result['facts'] = decort_disk_package_facts(disk_facts, amodule.check_mode)
+        amodule.exit_json(**decon.result)
+
+
+if __name__ == "__main__":
+    main()

library/decort_jwt.py

@@ -0,0 +1,157 @@
+#!/usr/bin/python
+#
+# Digital Enegry Cloud Orchestration Technology (DECORT) modules for Ansible
+# Copyright: (c) 2018-2021 Digital Energy Cloud Solutions LLC
+#
+# Apache License 2.0 (see http://www.apache.org/licenses/LICENSE-2.0.txt)
+#
+
+#
+# Author: Sergey Shubin (sergey.shubin@digitalenergy.online)
+#
+
+ANSIBLE_METADATA = {'metadata_version': '1.1',
+                    'status': ['preview'],
+                    'supported_by': 'community'}
+
+DOCUMENTATION = '''
+---
+module: decort_jwt
+short_description: Obtain access token to be used for authentication to DECORT cloud controller
+description:
+     - Obtain JWT (JSON Web Token) from the specified Oauth2 provider. This JWT can be used in subsequent DECS modules'
+       invocations to authenticate them to the DECS cloud controller.
+version_added: "2.4"
+author: "Sergey Shubin (sergey.shubin@digitalenergy.online)"
+notes:
+     - Environment variables can be used to pass parameters to the module (see options below for details).
+     - Specified Oauth2 provider must be trusted by the DECORT cloud controller on which JWT will be used.
+     - 'If you register module output as I(my_jwt), the JWT value is accessed as I(my_jwt.jwt)'
+requirements:
+     - python >= 2.6
+     - PyJWT module
+     - requests module
+     - decort_utils utility library (module)
+     - DECORT cloud platform version 3.6.1 or higher
+options:
+    app_id:
+        description:
+        - 'Application ID for authenticating to the Oauth2 provider specified in I(oauth2_url).'
+        - 'If not found in the playbook or command line arguments, the value will be taken from DECORT_APP_ID
+           environment variable.'
+        required: no
+    app_secret:
+        description:
+        - 'Application API secret used for authenticating to the Oauth2 provider specified in I(oauth2_url).'
+        - 'If not found in the playbook or command line arguments, the value will be taken from DECORT_APP_SECRET
+           environment variable.'
+        required: no
+    oauth2_url:
+        description:
+        - 'URL of the oauth2 authentication provider to obtain JWT from.'
+        - If not specified in the playbook, the value will be taken from DECORT_OAUTH2_URL environment variable.
+    validity:
+        description:
+        - Validity of the JWT in seconds. Default value is 3600 (one hour).
+        required: no
+    verify_ssl:
+        description:
+        - 'Controls SSL verification mode when making API calls to DECS controller. Set it to False if you
+         want to disable SSL certificate verification.'
+        - `Intended use case is when you run module in a trusted environment that uses self-signed certificates. 
+         Note that disabling SSL verification in any other scenario can lead to security issues, so please use 
+         with caution.'
+        default: True
+        required: no
+'''
+
+EXAMPLES = '''
+- name: Obtain JWT and store it as my_jwt for authenticating subsequent task to DECORT cloud controller
+  decort_jwt:
+    app_id: "{{ my_app_id }}"
+    app_secret: "{{ my_app_secret }}"
+    oauth2_url: https://sso.decs.online
+    delegate_to: localhost
+    register: my_jwt
+'''
+
+RETURN = '''
+jwt:
+    description: JSON Web Token that can be used to access DECS cloud controller
+    returned: always
+    type: string
+    sample: None
+'''
+
+import requests
+
+from ansible.module_utils.basic import AnsibleModule
+from ansible.module_utils.basic import env_fallback
+
+def decort_jwt_parameters():
+    """Build and return a dictionary of parameters expected by decort_jwt module in a form accepted
+    by AnsibleModule utility class"""
+
+    return dict(
+        app_id=dict(type='str',
+                    required=True,
+                    fallback=(env_fallback, ['DECORT_APP_ID'])),
+        app_secret=dict(type='str',
+                        required=True,
+                        fallback=(env_fallback, ['DECORT_APP_SECRET']),
+                        no_log=True),
+        oauth2_url=dict(type='str',
+                        required=True,
+                        fallback=(env_fallback, ['DECORT_OAUTH2_URL'])),
+        validity=dict(type='int',
+                      required=False,
+                      default=3600),
+        verify_ssl=dict(type='bool', required=False, default=True),
+        workflow_callback=dict(type='str', required=False),
+        workflow_context=dict(type='str', required=False),
+    )
+
+def main():
+    module_parameters = decort_jwt_parameters()
+
+    amodule = AnsibleModule(argument_spec=module_parameters,
+                            supports_check_mode=True,)
+
+    result = {'failed': False, 'changed': False}
+
+    token_get_url = amodule.params['oauth2_url'] + "/v1/oauth/access_token"
+    req_data = dict(grant_type="client_credentials",
+                    client_id=amodule.params['app_id'],
+                    client_secret=amodule.params['app_secret'],
+                    response_type="id_token",
+                    validity=amodule.params['validity'],)
+    # TODO: Need standard code snippet to handle server timeouts gracefully
+    # Consider a few retries before giving up or use requests.Session & requests.HTTPAdapter
+    # see https://stackoverflow.com/questions/15431044/can-i-set-max-retries-for-requests-request
+
+    # catch requests.exceptions.ConnectionError to handle incorrect oauth2_url case
+    try:
+        token_get_resp = requests.post(token_get_url, data=req_data, verify=amodule.params['verify_ssl'])
+    except requests.exceptions.ConnectionError as errco:
+        result.update(failed=True)
+        result['msg'] = "Failed to connect to {}: {}".format(token_get_url, errco)
+        amodule.fail_json(**result)
+    except requests.exceptions.Timeout as errti:
+        result.update(failed=True)
+        result['msg'] = "Timeout when trying to connect to {}: {}".format(token_get_url, errti)
+        amodule.fail_json(**result)
+
+    # alternative -- if resp == requests.codes.ok
+    if token_get_resp.status_code != 200:
+        result.update(failed=True)
+        result['msg'] = "Failed to obtain JWT access token from oauth2_url {} for app_id {}: {} {}".format(
+            token_get_url, amodule.params['app_id'],
+            token_get_resp.status_code, token_get_resp.reason)
+        amodule.fail_json(**result)
+
+    # Common return values: https://docs.ansible.com/ansible/2.3/common_return_values.html
+    result['jwt'] = token_get_resp.content.decode('utf8')
+    amodule.exit_json(**result)
+
+if __name__ == '__main__':
+    main()

library/decort_kvmvm.py

@@ -0,0 +1,906 @@
+#!/usr/bin/python
+#
+# Digital Enegry Cloud Orchestration Technology (DECORT) modules for Ansible
+# Copyright: (c) 2018-2021 Digital Energy Cloud Solutions LLC
+#
+# Apache License 2.0 (see http://www.apache.org/licenses/LICENSE-2.0.txt)
+#
+
+#
+# Author: Sergey Shubin (sergey.shubin@digitalenergy.online)
+#
+
+ANSIBLE_METADATA = {'metadata_version': '1.1',
+                    'status': ['preview'],
+                    'supported_by': 'community'}
+
+DOCUMENTATION = '''
+---
+module: decort_kvmvm
+short_description: Manage KVM virtual machine in DECORT cloud
+description: >
+     This module can be used to create a KVM based virtual machine in Digital Energy cloud platform from a 
+     specified OS image, modify virtual machine's CPU and RAM allocation, change its power state, configure
+     network port forwarding rules, restart guest OS and delete a virtual machine thus releasing
+     corresponding cloud resources.
+version_added: "2.2"
+author:
+     - Sergey Shubin <sergey.shubin@digitalenergy.online>
+requirements:
+     - python >= 2.6
+     - PyJWT Python module
+     - requests Python module
+     - netaddr Python module
+     - decort_utils utility library (module)
+     - DECORT cloud platform version 3.6.1 or higher
+notes:
+     - Environment variables can be used to pass selected parameters to the module, see details below.
+     - Specified Oauth2 provider must be trusted by the DECORT cloud controller on which JWT will be used.
+     - 'Similarly, JWT supplied in I(authenticator=jwt) mode should be received from Oauth2 provider trusted by
+       the DECORT cloud controller on which this JWT will be used.'
+options:
+    account_id:
+        description:
+        - 'ID of the account in which this VM will be created (for new VMs) or is located (for already
+          existing VMs). This is the alternative to I(account_name) option.'
+        - If both I(account_id) and I(account_name) specified, then I(account_name) is ignored.
+        - If any one of I(vm_id) or I(rg_id) specified, I(account_id) is ignored.
+        required: no
+    account_name:
+        description:
+        - 'Name of the account in which this VM will be created (for new VMs) or is located (for already
+           existing VMs).'
+        - This parameter is ignored if I(account_id) is specified.
+        - If any one of I(vm_id) or I(rg_id) specified, I(account_name) is ignored.
+        required: no
+    annotation:
+        description:
+        - Optional text description of this VM.
+        default: empty string
+        required: no
+    app_id:
+        description:
+        - 'Application ID for authenticating to the DECORT controller when I(authenticator=oauth2).'
+        - 'Required if I(authenticator=oauth2).'
+        - 'If not found in the playbook or command line arguments, the value will be taken from DECORT_APP_ID
+           environment variable.'
+        required: no
+    app_secret:
+        description:
+        - 'Application API secret used for authenticating to the DECORT controller when I(authenticator=oauth2).'
+        - This parameter is required when I(authenticator=oauth2) and ignored in other modes.
+        - 'If not found in the playbook or command line arguments, the value will be taken from DECORT_APP_SECRET
+           environment variable.'
+        required: no
+    arch:
+        description:
+        - Architecture of the KVM VM. DECORT supports KVM hosts based on Intel x86 and IBM PowerPC hardware.
+        - This parameter is used when new KVM VM is created and ignored for all other operations.
+        - Module may fail if your DECORT installation does not have physical nodes of specified architecture.
+        default: X86_64
+        choices: [ X86_64, PPC64_LE ]
+        required: yes
+    authenticator:
+        description:
+        - Authentication mechanism to be used when accessing DECORT controller and authorizing API call.
+        default: jwt
+        choices: [ jwt, oauth2, legacy ]
+        required: yes
+    boot_disk:
+        description:
+        - 'Boot disk size in GB. If this parameter is not specified for a new VM, the size of the boot disk 
+          will be set to the size of the OS image, which this VM is based on.'
+        - Boot disk is always created in the same storage and pool, as the OS image, which this VM is based on.
+        - Boot disk cannot be detached from VM.
+        required: no
+    controller_url:
+        description:
+        - URL of the DECORT controller that will be contacted to manage the VM according to the specification.
+        - 'This parameter is always required regardless of the specified I(authenticator) type.'
+        required: yes
+    cpu:
+        description:
+        - Number of virtual CPUs to allocate for the VM.
+        - This parameter is required for creating new VM and optional for other operations.
+        - 'If you set this parameter for an existing VM, then the module will check if VM resize is necessary and do
+          it accordingly. Note that resize operation on a running VM may generate errors as not all OS images support
+          hot resize feature.'
+        required: no
+    data_disks:
+        description:
+        - Optional list of integer IDs of the pre-existing disks that will be attached to this VM.
+        - These are additional disks (aka data disks) besides boot disk, which is created and attached automatically.
+        required: no
+    id:
+        description:
+        - ID of the KVM VM to manage.
+        - 'Either I(id) or a combination of VM name I(name) and RG related parameters (either I(rg_id) or a pair of
+           I(account_name) and I(rg_name) is required to manage an existing VM.'
+        - 'This parameter is not required (and ignored) when creating new VM as VM ID is assigned by cloud platform
+           automatically and cannot be changed afterwards. If existing VM is identified by I(id), then I(account_id),
+           I(account_name), I(rg_name) or I(rg_id) parameters will be ignored.'
+        required: no
+    image_id:
+        description:
+        - ID of the OS image to use for VM provisioning.
+        - 'This parameter is valid at VM creation time only and is ignored for operations on existing VMs.'
+        - 'You need to know image ID, e.g. by extracting it with decort_osimage module and storing
+           in a variable prior to calling decort_kvmvm.'
+        - 'If both I(image_id) and I(image_name) are specified, I(image_name) will be ignored.'
+        required: no
+    image_name:
+        description:
+        - Name of the OS image to use for a new VM provisioning.
+        - 'This parameter is valid at VM creation time only and is ignored for operations on existing VMs.'
+        - 'The specified image name will be looked up in the target DECORT controller and error will be generated if
+          no matching image is found.'
+        - 'If both I(image_id) and I(image_name) are specified, I(image_name) will be ignored.'
+        required: no
+    jwt:
+        description:
+        - 'JWT (access token) for authenticating to the DECORT controller when I(authenticator=jwt).'
+        - 'This parameter is required if I(authenticator=jwt) and ignored for other authentication modes.'
+        - If not specified in the playbook, the value will be taken from DECORT_JWT environment variable.
+        required: no
+    name:
+        description:
+        - Name of the VM.
+        - 'To manage VM by I(name) you also need to specify either I(rg_id) or a pair of I(rg_name) and I(account_name).'
+        - 'If both I(name) and I(id) are specified, I(name) will be ignored and I(id) used to locate the VM.'
+        required: no
+    networks:
+        description:
+        - List of dictionaries that specifies network connections for this VM.
+        - Structure of each element is as follows:
+        - ' - (string) type - type of the network connection. Supported types are VINS and EXTNET.'
+        - ' - (int)    id - ID of the target network segment. It is ViNS ID for I(net_type=VINS) and
+              external network segment ID for I(net_type=EXTNET)'
+        - ' - (string) ip_addr - optional IP address to request for this connection. If not specified, the 
+              platform will assign valid IP address automatically.'
+        - 'If you call decort_kvmvm module for an existing VM, the module will try to reconfigure existing network
+          connections according to the new specification.'
+        - If this parameter is not specified, the VM will have no connections to the network(s).
+        required: no
+    oauth2_url:
+        description:
+        - 'URL of the oauth2 authentication provider to use when I(authenticator=oauth2).'
+        - 'This parameter is required when when I(authenticator=oauth2).'
+        - If not specified in the playbook, the value will be taken from DECORT_OAUTH2_URL environment variable.
+    password:
+        description:
+        - 'Password for authenticating to the DECORT controller when I(authenticator=legacy).'
+        - 'This parameter is required if I(authenticator=legacy) and ignored in other authentication modes.'
+        - If not specified in the playbook, the value will be taken from DECORT_PASSWORD environment variable.
+        required: no
+    ram:
+        description:
+        - Size of RAM in MB to allocate to the VM.
+        - This parameter is required for creating new VM and optional for other operations.
+        - 'If you set this parameter for an existing VM, then the module will check if VM resize is necessary and do
+          it accordingly. Note that resize operation on a running VM may generate errors as not all OS images support
+          hot resize feature.'
+        required: no
+    ssh_key:
+        description:
+        - 'SSH public key to be deployed on to the new VM for I(ssh_key_user). If I(ssh_key_user) is not specified,
+          the key will not be deployed, and a warning is generated.'
+        - This parameter is valid at VM creation time only and ignored for any operation on existing VMs.
+        required: no
+    ssh_key_user:
+        description:
+        - User for which I(ssh_key) should be deployed.
+        - If I(ssh_key) is not specified, this parameter is ignored and a warning is generated.
+        - This parameter is valid at VM creation time only and ignored for any operation on existing VMs.
+        required: no
+    state:
+        description:
+        - Specify the desired state of the virtual machine at the exit of the module.
+        - 'Regardless of I(state), if VM exists and is in one of [MIGRATING, DESTROYING, ERROR] states, do nothing.'
+        - 'If desired I(state=check):'
+        - ' - Just check if VM exists in any state and return its current specifications.'
+        - ' - If VM does not exist, fail the task.'
+        - 'If desired I(state=present):'
+        - ' - VM does not exist, create the VM according to the specifications and start it.'
+        - ' - VM in one of [RUNNING, PAUSED, HALTED] states, attempt resize if necessary, change network if necessary.'
+        - ' - VM in DELETED state, restore and start it.'
+        - ' - VM in DESTROYED state, recreate the VM according to the specifications and start it.'
+        - 'If desired I(state=poweredon):'
+        - ' - VM does not exist, create it according to the specifications.'
+        - ' - VM in RUNNING state, attempt resize if necessary, change network if necessary.'
+        - ' - VM in one of [PAUSED, HALTED] states, attempt resize if necessary, change network if necessary, next
+              start the VM.'
+        - ' - VM in DELETED state, restore it.'
+        - ' - VM in DESTROYED state, create it according to the specifications.'
+        - 'If desired I(state=absent):'
+        - ' - VM in one of [RUNNING, PAUSED, HALTED] states, destroy it.'
+        - ' - VM in one of [DELETED, DESTROYED] states, do nothing.'
+        - 'If desired I(state=paused):'
+        - ' - VM in RUNNING state, pause the VM, resize if necessary, change network if necessary.'
+        - ' - VM in one of [PAUSED, HALTED] states, resize if necessary, change network if necessary.'
+        - ' - VM in one of [DELETED, DESTROYED] states, abort with an error.'
+        - 'If desired I(state=poweredoff) or I(state=halted):'
+        - ' - VM does not exist, create the VM according to the specifications and leave it in HALTED state.'
+        - ' - VM in RUNNING state, stop the VM, resize if necessary, change network if necessary.'
+        - ' - VM in one of [PAUSED, HALTED] states, resize if necessary, change network if necessary.'
+        - ' - VM in DELETED state, abort with an error.'
+        - ' - VM in DESTROYED state, recreate the VM according to the specifications and leave it in HALTED state.'
+        default: present
+        choices: [ present, absent, poweredon, poweredoff, halted, paused, check ]
+    tags:
+        description:
+        - String of custom tags to be assigned to the VM (This feature is not implemented yet!).
+        - These tags are arbitrary text that can be used for grouping or indexing the VMs by other applications.
+        required: no
+    user:
+        description:
+        - 'Name of the legacy user for authenticating to the DECORT controller when I(authenticator=legacy).'
+        - 'This parameter is required when I(authenticator=legacy) and ignored for other authentication modes.'
+        - If not specified in the playbook, the value will be taken from DECORT_USER environment variable.
+        required: no
+    rg_id:
+        description:
+        - ID of the Resource Group where a new VM will be deployed or an existing VM can be found.
+        - 'This parameter may be required when managing VM by its I(name). If you specify I(rg_id), then
+          I(account_name), I(account_id) and I(rg_name) will be ignored.'
+        required: no
+    rg_name:
+        description:
+        - Name of the RG where the VM will be deployed (for new VMs) or can be found (for existing VMs).
+        - This parameter is required when managing VM by its I(name).
+        - If both I(rg_id) and I(rg_name) are specified, I(rg_name) will be ignored.
+        - If I(rg_name) is specified, then either I(account_name) or I(account_id) must also be set.
+        required: no
+    verify_ssl:
+        description:
+        - 'Controls SSL verification mode when making API calls to DECORT controller. Set it to False if you
+         want to disable SSL certificate verification. Intended use case is when you run module in a trusted
+         environment that uses self-signed certificates. Note that disabling SSL verification in any other
+         scenario can lead to security issues, so please know what you are doing.'
+        default: True
+        required: no
+    workflow_callback:
+        description:
+        - 'Callback URL that represents an application, which invokes this module (e.g. up-level orchestrator or
+          end-user portal) and may except out-of-band updates on progress / exit status of the module run.'
+        - API call at this URL will be used to relay such information to the application.
+        - 'API call payload will include module-specific details about this module run and I(workflow_context).'
+        required: no
+    workflow_context:
+        description:
+        - 'Context data that will be included into the payload of the API call directed at I(workflow_callback) URL.'
+        - 'This context data is expected to uniquely identify the task carried out by this module invocation so
+           that up-level orchestrator could match returned information to the its internal entities.'
+        required: no
+'''
+
+EXAMPLES = '''
+- name: create a VM named "SimpleVM" in the DECORT cloud along with VDC named "ANewVDC" if it does not exist yet.
+    decort_kvmvm:
+      annotation: "VM managed by decort_kvmvm module"
+      authenticator: oauth2
+      app_id: "{{ MY_APP_ID }}"
+      app_secret: "{{ MY_APP_SECRET }}"
+      controller_url: "https://ds1.digitalenergy.online"
+      name: SimpleVM
+      cpu: 2
+      ram: 4096
+      boot_disk:
+        size: 10
+        model: ovs
+        pool: boot
+      image_name: "Ubuntu 16.04 v1.1"
+      data_disks:
+        - size: 50
+          model: ovs
+          pool: data
+      port_forwards:
+        - ext_port: 21022
+          int_port: 22
+          proto: tcp
+        - ext_port: 80
+          int_port: 80
+          proto: tcp
+      state: present
+      tags: "PROJECT:Ansible STATUS:Test"
+      account_name: "Development"
+      rg_name: "ANewVDC"
+    delegate_to: localhost
+    register: simple_vm
+- name: resize the above VM to CPU 4 and remove port forward rule for port number 80.
+    decort_kvmvm:
+      authenticator: jwt
+      jwt: "{{ MY_JWT }}"
+      controller_url: "https://ds1.digitalenergy.online"
+      name: SimpleVM
+      cpu: 4
+      ram: 4096
+      port_forwards:
+        - ext_port: 21022
+          int_port: 22
+          proto: tcp
+      state: present
+      account_name: "Development"
+      rg_name: "ANewVDC"
+    delegate_to: localhost
+    register: simple_vm
+- name: stop existing VM identified by the VM ID and down size it to CPU:RAM 1:2048 along the way.
+    decort_kvmvm:
+      authenticator: jwt
+      jwt: "{{ MY_JWT }}"
+      controller_url: "https://ds1.digitalenergy.online"
+      id: "{{ TARGET_VM_ID }}"
+      cpu: 1
+      ram: 2048
+      state: poweredoff
+    delegate_to: localhost
+    register: simple_vm
+- name: check if VM exists and read in its specs.
+    decort_kvmvm:
+      authenticator: oauth2
+      app_id: "{{ MY_APP_ID }}"
+      app_secret: "{{ MY_APP_SECRET }}"
+      controller_url: "https://ds1.digitalenergy.online"
+      name: "{{ TARGET_VM_NAME }}"
+      rg_name: "{{ TARGET_VDC_NAME }}"
+      account_name: "{{ TRAGET_TENANT }}"
+      state: check
+    delegate_to: localhost
+    register: existing_vm
+'''
+
+RETURN = '''
+facts:
+    description: facts about the virtual machine that may be useful in the playbook
+    returned: always
+    type: dict
+    sample:
+      facts:
+        id: 9454
+        name: TestVM
+        state: RUNNING
+        username: testuser
+        password: Yab!tWbyPF
+        int_ip: 192.168.103.253
+        rg_name: SandboxVDC
+        rg_id: 2883
+        vdc_ext_ip: 185.193.143.151
+        ext_ip: 185.193.143.106
+        ext_netmask: 24
+        ext_gateway: 185.193.143.1
+        ext_mac: 52:54:00:00:1a:24
+'''
+
+from ansible.module_utils.basic import AnsibleModule
+from ansible.module_utils.basic import env_fallback
+from ansible.module_utils.decort_utils import *
+
+class decort_kvmvm(DecortController):
+    def __init__(self, arg_amodule):
+        # call superclass constructor first
+        super(decort_kvmvm, self).__init__(arg_amodule)
+
+        self.comp_should_exist = False
+        # This following flag is used to avoid extra (and unnecessary) get of compute details prior to 
+        # packaging facts before the module completes. As ""
+        self.skip_final_get = False
+        self.comp_id = 0
+        self.comp_info = None
+        self.acc_id = 0
+        self.rg_id = 0
+
+        validated_acc_id =0
+        validated_rg_id = 0
+        validated_rg_facts = None
+
+        # Analyze Compute name & ID, RG name & ID and build arguments to compute_find accordingly.
+        if arg_amodule.params['name'] == "" and arg_amodule.params['id'] == 0:
+            self.result['failed'] = True
+            self.result['changed'] = False
+            self.result['msg'] = "Cannot manage Compute when its ID is 0 and name is empty."
+            self.fail_json(**self.result)
+            # fail the module - exit
+
+        if not arg_amodule.params['id']: # manage Compute by name -> need RG identity
+            if not arg_amodule.params['rg_id']: # RG ID is not set -> locate RG by name -> need account ID
+                validated_acc_id, _ = self.account_find(arg_amodule.params['account_name'],
+                                                        arg_amodule.params['account_id'])
+                if not validated_acc_id:
+                    self.result['failed'] = True
+                    self.result['changed'] = False
+                    self.result['msg'] = ("Current user does not have access to the account ID {} / "
+                                          "name '{}' or non-existent account specified.").format(arg_amodule.params['account_id'],
+                                                                                                 arg_amodule.params['account_name'])
+                    self.fail_json(**self.result)
+                    # fail the module -> exit
+            # now validate RG
+            validated_rg_id, validated_rg_facts = self.rg_find(validated_acc_id,
+                                                               arg_amodule.params['rg_id'],
+                                                               arg_amodule.params['rg_name'])
+            if not validated_rg_id:
+                self.result['failed'] = True
+                self.result['changed'] = False
+                self.result['msg'] = "Cannot find RG ID {} / name '{}'.".format(arg_amodule.params['rg_id'],
+                                                                                arg_amodule.params['rg_name'])
+                self.fail_json(**self.result)
+                # fail the module - exit
+
+            self.rg_id = validated_rg_id
+            arg_amodule.params['rg_id'] = validated_rg_id
+            arg_amodule.params['rg_name'] = validated_rg_facts['name']
+            self.acc_id = validated_rg_facts['accountId']
+
+        # at this point we are ready to locate Compute, and if anything fails now, then it must be
+        # because this Compute does not exist or something goes wrong in the upstream API
+        # We call compute_find with check_state=False as we also consider the case when a Compute
+        # specified by account / RG / compute name never existed and will be created for the first time.
+        self.comp_id, self.comp_info, self.rg_id = self.compute_find(comp_id=arg_amodule.params['id'],
+                                                                     comp_name=arg_amodule.params['name'],
+                                                                     rg_id=validated_rg_id,
+                                                                     check_state=False)
+
+        if self.comp_id:
+            if self.comp_info['status'] != 'DESTROYED' and self.comp_info['arch'] not in ["X86_64", "PPC64_LE"]:
+                # If we found a Compute in a non-DESTROYED state and it is not of type valid arch, abort the module
+                self.result['failed'] = True
+                self.result['msg'] = ("Compute ID {} architecture '{}' is not supported by "
+                                      "decort_kvmvm module.").format(self.comp_id, 
+                                                                     self.amodule.params['arch'])
+                self.amodule.fail_json(**self.result)
+                # fail the module - exit
+            self.comp_should_exist = True
+            self.acc_id = self.comp_info['accountId']
+
+        return
+
+    def nop(self):
+        """No operation (NOP) handler for Compute management by decort_kvmvm module.
+        This function is intended to be called from the main switch construct of the module
+        when current state -> desired state change logic does not require any changes to
+        the actual Compute state.
+        """
+        self.result['failed'] = False
+        self.result['changed'] = False
+        if self.comp_id:
+            self.result['msg'] = ("No state change required for Compute ID {} because of its "
+                                   "current status '{}'.").format(self.comp_id, self.comp_info['status'])
+        else:
+            self.result['msg'] = ("No state change to '{}' can be done for "
+                                  "non-existent Compute instance.").format(self.amodule.params['state'])
+        return
+
+    def error(self):
+        """Error handler for Compute instance management by decort_kvmvm module.
+        This function is intended to be called when an invalid state change is requested.
+        Invalid means that the current is invalid for any operations on the Compute or the 
+        transition from current to desired state is not technically possible.
+        """
+        self.result['failed'] = True
+        self.result['changed'] = False
+        if self.comp_id:
+            self.result['msg'] = ("Invalid target state '{}' requested for Compute ID {} in the "
+                                   "current status '{}'.").format(self.comp_id,
+                                                                  self.amodule.params['state'],
+                                                                  self.comp_info['status'])
+        else:
+            self.result['msg'] = ("Invalid target state '{}' requested for non-existent Compute name '{}' "
+                                   "in RG ID {} / name '{}'").format(self.amodule.params['state'],
+                                                                    self.amodule.params['name'],
+                                                                    self.amodule.params['rg_id'],
+                                                                    self.amodule.params['rg_name'])
+        return
+
+    def create(self):
+        """New Compute instance creation handler for decort_kvmvm module.
+        This function checks for the presence of required parameters and deploys a new KVM VM
+        Compute instance with the specified characteristics into the target Resource Group.
+        The target RG must exist.
+        """
+        # the following parameters must be present: cpu, ram, image_id or image_name
+        # each of the following calls will abort if argument is missing
+        self.check_amodule_argument('cpu')
+        self.check_amodule_argument('ram')
+
+        if self.amodule.params['arch'] not in ["X86_64", "PPC64_LE"]:
+            self.result['failed'] = True
+            self.result['msg'] = ("Unsupported architecture '{}' is specified for "
+                                  "KVM VM create.").format(self.amodule.params['arch'])
+            self.amodule.fail_json(**self.result)
+            # fail the module - exit
+
+        validated_bdisk_size = 0
+
+        image_facts = None
+        # either image_name or image_id must be present
+        if self.check_amodule_argument('image_id', abort=False) and self.amodule.params['image_id'] > 0 :
+            # find image by image ID and account ID
+            # image_find(self, image_id, image_name, account_id, rg_id=0, sepid=0, pool=""):
+            _, image_facts = self.image_find(image_id=self.amodule.params['image_id'],
+                                             image_name="",
+                                             account_id=self.acc_id)
+        elif self.check_amodule_argument('image_name', abort=False) and self.amodule.params['image_name'] != "":
+            # find image by image name and account ID
+            _, image_facts = self.image_find(image_id=0,
+                                             image_name=self.amodule.params['image_name'],
+                                             account_id=self.acc_id)
+        else:
+            # neither image_name nor image_id are set - abort the script
+            self.result['failed'] = True
+            self.result['msg'] = "Missing both 'image_name' and 'image_id'. You need to specify one to create a Compute."
+            self.amodule.fail_json(**self.result)
+            # fail the module - exit
+
+        if ((not self.check_amodule_argument('boot_disk', False)) or 
+            self.amodule.params['boot_disk'] <= image_facts['size']):
+            # adjust disk size to the minimum allowed by OS image, which will be used to spin off this Compute
+            validated_bdisk_size = image_facts['size']
+        else:
+            validated_bdisk_size =self.amodule.params['boot_disk']
+
+        # NOTE: due to a libvirt "feature", that impacts management of a VM created without any network interfaces,
+        # we create KVM VM in HALTED state.
+        # Consequently, if desired state is different from 'halted' or 'porewedoff", we should explicitly start it
+        # in the upstream code.
+        # See corresponding NOTE below for another place where this "feature" is redressed for.
+        #
+        # Once this "feature" is fixed, make sure VM is created according to the actual desired state
+        #
+        start_compute = False # change this once a workaround for the aforementioned libvirt "feature" is implemented 
+        if self.amodule.params['state'] in ('halted', 'poweredoff'):
+            start_compute = False
+        
+        if self.amodule.params['ssh_key'] and self.amodule.params['ssh_key_user']:
+            cloud_init_params = {'users': [
+                {"name": self.amodule.params['ssh_key_user'],
+                    "ssh-authorized-keys": [self.amodule.params['ssh_key']],
+                    "shell": '/bin/bash'}
+                ]}
+        else:
+            cloud_init_params = None
+
+        # if we get through here, all parameters required to create new Compute instance should be at hand
+
+        # NOTE: KVM VM is created in HALTED state and must be explicitly started
+        self.comp_id = self.kvmvm_provision(rg_id=self.rg_id, 
+                                    comp_name=self.amodule.params['name'], arch=self.amodule.params['arch'],
+                                    cpu=self.amodule.params['cpu'], ram=self.amodule.params['ram'],
+                                    boot_disk=validated_bdisk_size,
+                                    image_id=image_facts['id'],
+                                    annotation=self.amodule.params['annotation'],
+                                    userdata=cloud_init_params,
+                                    start_on_create=start_compute) 
+        self.comp_should_exist = True
+        
+        # Originally we would have had to re-read comp_info after VM was provisioned
+        # _, self.comp_info, _ = self.compute_find(self.comp_id)
+
+        # However, to avoid extra call to compute/get API we need to construct comp_info so that
+        # the below calls to compute_networks and compute_data_disks work properly.
+        # 
+        # Here we are imitating comp_info structure as if it has been returned by a real call 
+        # to API compute/get 
+        self.comp_info = {
+            'id':  self.comp_id,
+            'accountId': self.acc_id,
+            'status': "ENABLED",
+            'techStatus': "STOPPED",
+            'interfaces': [], # new compute instance is created network-less
+            'disks': [], # new compute instance is created without any data disks attached
+        }
+
+        # 
+        # Compute was created
+        #
+        # Setup network connections
+        self.compute_networks(self.comp_info, self.amodule.params['networks']) 
+        # Next manage data disks
+        self.compute_data_disks(self.comp_info, self.amodule.params['data_disks'])
+
+        # NOTE: see NOTE above regarding libvirt "feature" and new VMs created in HALTED state
+        if self.amodule.params['state'] not in ('halted', 'poweredoff'):
+            self.compute_powerstate(self.comp_info, 'started')
+        
+        # read in Compute facts once more after all initial setup is complete
+        _, self.comp_info, _ = self.compute_find(comp_id=self.comp_id)
+
+        self.skip_final_get = True
+
+        return
+
+    def destroy(self):
+        """Compute destroy handler for VM management by decort_kvmvm module.
+        Note that this handler deletes the VM permanently together with all assigned disk resources.
+        """
+        self.compute_delete(comp_id=self.comp_id, permanently=True)
+        self.comp_info['status'] = 'DESTROYED'
+        self.comp_should_exist = False
+        return
+
+    def restore(self):
+        """Compute restore handler for Compute instance management by decort_kvmvm module.
+        Note that restoring Compute is only possible if it is in DELETED state. If called on a 
+        Compute instance in any other state, the method will throw an error and abort the execution
+        of the module.
+        """
+        self.compute_restore(comp_id=self.comp_id)
+        # TODO - do we need updated comp_info to manage port forwards and size after VM is restored?
+        _, self.comp_info, _ = self.compute_find(comp_id=self.comp_id)
+        self.modify()
+        self.comp_should_exist = True
+        return
+
+    def modify(self, arg_wait_cycles=0):
+        """Compute modify handler for KVM VM management by decort_kvmvm module.
+        This method is a convenience wrapper that calls individual Compute modification functions from
+        DECORT utility library (module).
+
+        Note that it does not modify power state of KVM VM.
+        """
+        self.compute_networks(self.comp_info, self.amodule.params['networks'])
+        self.compute_bootdisk_size(self.comp_info, self.amodule.params['boot_disk'])
+        self.compute_data_disks(self.comp_info, self.amodule.params['data_disks'])
+        self.compute_resize(self.comp_info,
+                            self.amodule.params['cpu'], self.amodule.params['ram'],
+                            wait_for_state_change=arg_wait_cycles)
+        return
+
+    def package_facts(self, check_mode=False):
+        """Package a dictionary of KVM VM facts according to the decort_kvmvm module specification. 
+        This dictionary will be returned to the upstream Ansible engine at the completion of decort_kvmvm 
+        module run.
+
+        @param check_mode: boolean that tells if this Ansible module is run in check mode
+
+        @return: dictionary of KVM VM facts, containing suffucient information to manage the KVM VM in
+        subsequent Ansible tasks.
+        """
+
+        ret_dict = dict(id=0,
+                    name="",
+                    arch="",
+                    cpu="",
+                    ram="",
+                    disk_size=0,
+                    data_disks=[],  # IDs of attached data disks; this list can be emty
+                    state="CHECK_MODE",
+                    tech_status="",
+                    account_id=0,
+                    rg_id=0,
+                    username="",
+                    password="",
+                    public_ips=[],  # direct IPs; this list can be empty
+                    private_ips=[], # IPs on ViNSes; usually, at least one IP is listed
+                    nat_ip="",      # IP of the external ViNS interface; can be empty.
+                    )
+
+        if check_mode or self.comp_info is None:
+            # if in check mode (or void facts provided) return immediately with the default values
+            return ret_dict
+
+        # if not self.comp_should_exist:
+        #    ret_dict['state'] = "ABSENT"
+        #    return ret_dict
+
+        ret_dict['id'] = self.comp_info['id']
+        ret_dict['name'] = self.comp_info['name']
+        ret_dict['arch'] = self.comp_info['arch']
+        ret_dict['state'] = self.comp_info['status']
+        ret_dict['tech_status'] = self.comp_info['techStatus']
+        ret_dict['account_id'] = self.comp_info['accountId']
+        ret_dict['rg_id'] = self.comp_info['rgId']
+        # if the VM is an imported VM, then the 'accounts' list may be empty,
+        # so check for this case before trying to access login and passowrd values
+        if len(self.comp_info['osUsers']):
+            ret_dict['username'] = self.comp_info['osUsers'][0]['login']
+            ret_dict['password'] = self.comp_info['osUsers'][0]['password']
+
+        if self.comp_info['interfaces']:
+            # We need a list of all ViNSes in the account, which owns this Compute
+            # to find a ViNS, which may have active external connection. Then
+            # we will save external IP address of that connection in ret_dict['nat_ip']
+
+            for iface in self.comp_info['interfaces']:
+                if iface['connType'] == "VXLAN": # This is ViNS connection
+                    ret_dict['private_ips'].append(iface['ipAddress'])
+                    # if iface['connId']
+                    # Now we need to check if this ViNS has GW function and external connection.
+                    # If it does - save public IP address of GW VNF in ret_dict['nat_ip']
+                elif iface['connType'] == "VLAN": # This is direct external network connection
+                    ret_dict['public_ips'].append(iface['ipAddress'])
+            
+        ret_dict['cpu'] = self.comp_info['cpus']
+        ret_dict['ram'] = self.comp_info['ram']
+
+        ret_dict['image_id'] = self.comp_info['imageId']
+
+        for ddisk in self.comp_info['disks']:
+            if ddisk['type'] == 'B':
+                # if it is a boot disk - store its size
+                ret_dict['disk_size'] = ddisk['sizeMax']
+            elif ddisk['type'] == 'D':
+                # if it is a data disk - append its ID to the list of data disks IDs
+                ret_dict['data_disks'].append(ddisk['id'])
+
+        return ret_dict
+
+    @staticmethod
+    def build_parameters():
+        """Build and return a dictionary of parameters expected by decort_kvmvm module in a form
+        accepted by AnsibleModule utility class.
+        This dictionary is then used y AnsibleModule class instance to parse and validate parameters
+        passed to the module from the playbook.
+        """
+
+        return dict(
+            account_id=dict(type='int', required=False, default=0),
+            account_name=dict(type='str', required=False, default=''),
+            annotation=dict(type='str',
+                            default='',
+                            required=False),
+            app_id=dict(type='str',
+                        required=False,
+                        fallback=(env_fallback, ['DECORT_APP_ID'])),
+            app_secret=dict(type='str',
+                            required=False,
+                            fallback=(env_fallback, ['DECORT_APP_SECRET']),
+                            no_log=True),
+            arch=dict(type='str', choices=['X86_64', 'PPC64_LE'], default='X86_64'),
+            authenticator=dict(type='str',
+                               required=True,
+                               choices=['legacy', 'oauth2', 'jwt']),
+            boot_disk=dict(type='int', required=False),
+            controller_url=dict(type='str', required=True),
+            # count=dict(type='int', required=False, default=1),
+            cpu=dict(type='int', required=False),
+            # datacenter=dict(type='str', required=False, default=''),
+            data_disks=dict(type='list', default=[], required=False), # list of integer disk IDs
+            id=dict(type='int', required=False, default=0),
+            image_id=dict(type='int', required=False),
+            image_name=dict(type='str', required=False),
+            jwt=dict(type='str',
+                     required=False,
+                     fallback=(env_fallback, ['DECORT_JWT']),
+                     no_log=True),
+            name=dict(type='str'),
+            networks=dict(type='list', default=[], required=False), # list of dictionaries
+            oauth2_url=dict(type='str',
+                            required=False,
+                            fallback=(env_fallback, ['DECORT_OAUTH2_URL'])),
+            password=dict(type='str',
+                          required=False,
+                          fallback=(env_fallback, ['DECORT_PASSWORD']),
+                          no_log=True),
+            ram=dict(type='int', required=False),
+            rg_id=dict(type='int', default=0),
+            rg_name=dict(type='str', default=""),
+            ssh_key=dict(type='str', required=False),
+            ssh_key_user=dict(type='str', required=False),
+            state=dict(type='str',
+                       default='present',
+                       choices=['absent', 'paused', 'poweredoff', 'halted', 'poweredon', 'present', 'check']),
+            tags=dict(type='str', required=False),
+            user=dict(type='str',
+                      required=False,
+                      fallback=(env_fallback, ['DECORT_USER'])),
+            verify_ssl=dict(type='bool', required=False, default=True),
+            # wait_for_ip_address=dict(type='bool', required=False, default=False),
+            workflow_callback=dict(type='str', required=False),
+            workflow_context=dict(type='str', required=False),
+        )
+
+# Workflow digest:
+# 1) authenticate to DECORT controller & validate authentication by issuing API call - done when creating DECSController
+# 2) check if the VM with the specified id or rg_name:name exists
+# 3) if VM does not exist, check if there is enough resources to deploy it in the target account / vdc
+# 4) if VM exists: check desired state, desired configuration -> initiate action accordingly
+# 5) VM does not exist: check desired state -> initiate action accordingly
+#       - create VM: check if target VDC exists, create VDC as necessary, create VM
+#       - delete VM: delete VM
+#       - change power state: change as required
+#       - change guest OS state: change as required
+# 6) report result to Ansible
+
+def main():
+    module_parameters = decort_kvmvm.build_parameters()
+
+    amodule = AnsibleModule(argument_spec=module_parameters,
+                            supports_check_mode=True,
+                            mutually_exclusive=[
+                                ['oauth2', 'password'],
+                                ['password', 'jwt'],
+                                ['jwt', 'oauth2'],
+                            ],
+                            required_together=[
+                                ['app_id', 'app_secret'],
+                                ['user', 'password'],
+                            ],
+                            required_one_of=[
+                                ['id', 'name'],
+                            ],
+                            )
+
+    # Initialize DECORT KVM VM instance object
+    # This object does not necessarily represent an existing KVM VM
+    subj = decort_kvmvm(amodule)
+
+    # handle state=check before any other logic
+    if amodule.params['state'] == 'check':
+        subj.result['changed'] = False
+        if subj.comp_id:
+            # Compute is found - package facts and report success to Ansible
+            subj.result['failed'] = False
+            # _, subj.comp_info, _ = subj.compute_find(comp_id=subj.comp_id)
+            # _, rg_facts = subj.rg_find(arg_account_id=0, arg_rg_id=subj.rg_id)
+            subj.result['facts'] = subj.package_facts(amodule.check_mode)
+            amodule.exit_json(**subj.result)
+            # we exit the module at this point
+        else:
+            subj.result['failed'] = True
+            subj.result['msg'] = ("Cannot locate Compute name '{}'. Other arguments are: Compute ID {}, "
+                                  "RG name '{}', RG ID {}, Account '{}'.").format(amodule.params['name'],
+                                                                                amodule.params['id'],
+                                                                                amodule.params['rg_name'],
+                                                                                amodule.params['rg_id'],
+                                                                                amodule.params['account_name'])
+            amodule.fail_json(**subj.result)
+            pass
+
+    if subj.comp_id:
+        if subj.comp_info['status'] in ("DISABLED", "MIGRATING", "DELETING", "DESTROYING", "ERROR", "REDEPLOYING"):
+            # cannot do anything on the existing Compute in the listed states
+            subj.error() # was subj.nop()
+        elif subj.comp_info['status'] in ("ENABLED", "DISABLED"):
+            if amodule.params['state'] == 'absent':
+                subj.destroy()
+            elif amodule.params['state'] in ('present', 'paused', 'poweredon', 'poweredoff', 'halted'):
+                subj.compute_powerstate(subj.comp_info, amodule.params['state'])
+                subj.modify(arg_wait_cycles=7)
+        elif subj.comp_info['status'] == "DELETED":
+            if amodule.params['state'] in ('present', 'poweredon'):
+                # TODO - check if restore API returns VM ID (similarly to VM create API)
+                subj.compute_restore(comp_id=subj.comp_id)
+                # TODO - do we need updated comp_info to manage port forwards and size after VM is restored?
+                _, subj.comp_info, _ = subj.compute_find(comp_id=subj.comp_id)
+                subj.modify()
+            elif amodule.params['state'] == 'absent':
+                # subj.nop()
+                # subj.comp_should_exist = False
+                subj.destroy()
+            elif amodule.params['state'] in ('paused', 'poweredoff', 'halted'):
+                subj.error()
+        elif subj.comp_info['status'] == "DESTROYED":
+            if amodule.params['state'] in ('present', 'poweredon', 'poweredoff', 'halted'):
+                subj.create() # this call will also handle data disk & network connection
+            elif amodule.params['state'] == 'absent':
+                subj.nop()
+                subj.comp_should_exist = False
+            elif amodule.params['state'] == 'paused':
+                subj.error()
+    else:
+        # Preexisting Compute of specified identity was not found.
+        # If requested state is 'absent' - nothing to do
+        if amodule.params['state'] == 'absent':
+            subj.nop()
+        elif amodule.params['state'] in ('present', 'poweredon', 'poweredoff', 'halted'):
+            subj.create() # this call will also handle data disk & network connection
+        elif amodule.params['state'] == 'paused':
+            subj.error()
+
+    if subj.result['failed']:
+        amodule.fail_json(**subj.result)
+    else:
+        # prepare Compute facts to be returned as part of decon.result and then call exit_json(...)
+        rg_facts = None
+        if subj.comp_should_exist:
+            if subj.result['changed'] and not subj.skip_final_get:
+                # There were changes to the Compute - refresh Compute facts.
+                _, subj.comp_info, _ = subj.compute_find(comp_id=subj.comp_id)
+            #
+            # We no longer need to re-read RG facts, as all network info is now available inside
+            # compute structure
+            # _, rg_facts = subj.rg_find(arg_account_id=0, arg_rg_id=subj.rg_id)
+        subj.result['facts'] = subj.package_facts(amodule.check_mode)
+        amodule.exit_json(**subj.result)
+
+
+if __name__ == "__main__":
+    main()

library/decort_osimage.py

@@ -0,0 +1,302 @@
+#!/usr/bin/python
+#
+# Digital Enegry Cloud Orchestration Technology (DECORT) modules for Ansible
+# Copyright: (c) 2018-2021 Digital Energy Cloud Solutions LLC
+#
+# Apache License 2.0 (see http://www.apache.org/licenses/LICENSE-2.0.txt)
+#
+
+#
+# Author: Sergey Shubin (sergey.shubin@digitalenergy.online)
+#
+
+ANSIBLE_METADATA = {'metadata_version': '1.1',
+                    'status': ['preview'],
+                    'supported_by': 'community'}
+
+DOCUMENTATION = '''
+---
+module: decort_osimage
+short_description: Locate OS image in DCORT cloud by its name and return image ID
+description: >
+     This module can be used to obtain image ID of an OS image in DECORT cloud to use with subsequent calls to
+     decort_vm module for batch VM provisioning. It will speed up VM creation and save a bunch of extra calls to
+     DECORT cloud controller on each VM creation act.
+     Note that this module is effectively an information provisioner. It is not designed to and does not manage 
+     nor change state of OS image (or any other) objects in DECORT cloud.
+version_added: "2.2"
+author:
+     - Sergey Shubin <sergey.shubin@digitalenergy.online>
+requirements:
+     - python >= 2.6
+     - PyJWT Python module
+     - requests Python module
+     - netaddr Python module
+     - decort_utils utility library (module)
+     - DECORT cloud platform version 3.6.1 or higher.
+notes:
+     - Environment variables can be used to pass selected parameters to the module, see details below.
+     - Specified Oauth2 provider must be trusted by the DECORT cloud controller on which JWT will be used.
+     - 'Similarly, JWT supplied in I(authenticator=jwt) mode should be received from Oauth2 provider trusted by
+       the DECORT cloud controller on which this JWT will be used.'
+options:
+    app_id:
+        description:
+        - 'Application ID for authenticating to the DECORT controller when I(authenticator=oauth2).'
+        - 'Required if I(authenticator=oauth2).'
+        - 'If not found in the playbook or command line arguments, the value will be taken from DECORT_APP_ID
+           environment variable.'
+        required: no
+    app_secret:
+        description:
+        - 'Application API secret used for authenticating to the DECORT controller when I(authenticator=oauth2).'
+        - This parameter is required when I(authenticator=oauth2) and ignored in other modes.
+        - 'If not found in the playbook or command line arguments, the value will be taken from DECORT_APP_SECRET
+           environment variable.'
+        required: no
+    authenticator:
+        description:
+        - Authentication mechanism to be used when accessing DECORT controller and authorizing API call.
+        default: jwt
+        choices: [ jwt, oauth2, legacy ]
+        required: yes
+    controller_url:
+        description:
+        - URL of the DECORT controller that will be contacted to obtain OS image details.
+        - 'This parameter is always required regardless of the specified I(authenticator) type.'
+        required: yes
+    image_name:
+        description:
+        - Name of the OS image to use. Module will return the ID of this image.
+        - 'The specified image name will be looked up in the target DECORT controller and error will be generated if
+          no matching image is found.'
+        required: yes
+    jwt:
+        description:
+        - 'JWT (access token) for authenticating to the DECORT controller when I(authenticator=jwt).'
+        - 'This parameter is required if I(authenticator=jwt) and ignored for other authentication modes.'
+        - If not specified in the playbook, the value will be taken from DECORT_JWT environment variable.
+        required: no
+    oauth2_url:
+        description:
+        - 'URL of the oauth2 authentication provider to use when I(authenticator=oauth2).'
+        - 'This parameter is required when when I(authenticator=oauth2).'
+        - If not specified in the playbook, the value will be taken from DECORT_OAUTH2_URL environment variable.
+    password:
+        description:
+        - 'Password for authenticating to the DECORT controller when I(authenticator=legacy).'
+        - 'This parameter is required if I(authenticator=legacy) and ignored in other authentication modes.'
+        - If not specified in the playbook, the value will be taken from DECORT_PASSWORD environment variable.
+        required: no
+    pool:
+        description:
+        - 'Name of the storage pool, where the image should be found.'
+        - 'Omit this option if no matching by pool name is required. The first matching image will be returned."
+        required: no
+    sep_id:
+        description:
+        - 'ID of the SEP (Storage End-point Provider), where the image should be found.'
+        - 'Omit this option if no matching by SEP ID is required. The first matching image will be returned."
+        required: no
+    account_name:
+        description:
+        - 'Name of the account for which the specified OS image will be looked up.'
+        - 'This parameter is required for listing OS images.'
+        required: yes
+    user:
+        description:
+        - 'Name of the legacy user for authenticating to the DECORT controller when I(authenticator=legacy).'
+        - 'This parameter is required when I(authenticator=legacy) and ignored for other authentication modes.'
+        - If not specified in the playbook, the value will be taken from DECORT_USER environment variable.
+        required: no
+    vdc_id:
+        description:
+        - ID of the VDC to limit the search of the OS image to.
+        required: no
+    verify_ssl:
+        description:
+        - 'Controls SSL verification mode when making API calls to DECORT controller. Set it to False if you
+         want to disable SSL certificate verification. Intended use case is when you run module in a trusted
+         environment that uses self-signed certificates. Note that disabling SSL verification in any other
+         scenario can lead to security issues, so please know what you are doing.'
+        default: True
+        required: no
+    workflow_callback:
+        description:
+        - 'Callback URL that represents an application, which invokes this module (e.g. up-level orchestrator or
+          end-user portal) and may except out-of-band updates on progress / exit status of the module run.'
+        - API call at this URL will be used to relay such information to the application.
+        - 'API call payload will include module-specific details about this module run and I(workflow_context).'
+        required: no
+    workflow_context:
+        description:
+        - 'Context data that will be included into the payload of the API call directed at I(workflow_callback) URL.'
+        - 'This context data is expected to uniquely identify the task carried out by this module invocation so
+           that up-level orchestrator could match returned information to the its internal entities.'
+        required: no
+'''
+
+EXAMPLES = '''
+- name: locate OS image specified by its name, store result in image_to_use variable.
+    decort_osimage:
+      authenticator: oauth2
+      app_id: "{{ MY_APP_ID }}"
+      app_secret: "{{ MY_APP_SECRET }}"
+      controller_url: "https://ds1.digitalenergy.online"
+      image_name: "Ubuntu 18.04 v1.2.5"
+      account_name: "GreyseDevelopment"
+    delegate_to: localhost
+    register: image_to_use
+'''
+
+RETURN = '''
+facts:
+    description: facts about the specified OS image
+    returned: always
+    type: dict
+    sample:
+      facts:
+        id: 100
+        name: "Ubuntu 16.04 v1.0"
+        size: 3
+        sep_id: 1
+        pool: "vmstore"
+        type: Linux
+        arch: x86_64
+        state: CREATED
+'''
+
+from ansible.module_utils.basic import AnsibleModule
+from ansible.module_utils.basic import env_fallback
+
+from ansible.module_utils.decort_utils import *
+
+
+def decort_osimage_package_facts(arg_osimage_facts, arg_check_mode=False):
+    """Package a dictionary of OS image according to the decort_osimage module specification. This 
+    dictionary will be returned to the upstream Ansible engine at the completion of the module run.
+
+    @param arg_osimage_facts: dictionary with OS image facts as returned by API call to .../images/list
+    @param arg_check_mode: boolean that tells if this Ansible module is run in check mode.
+
+    @return: dictionary with OS image specs populated from arg_osimage_facts.
+    """
+
+    ret_dict = dict(id=0,
+                    name="none",
+                    size=0,
+                    type="none",
+                    state="CHECK_MODE",
+                    )
+
+    if arg_check_mode:
+        # in check mode return immediately with the default values
+        return ret_dict
+
+    if arg_osimage_facts is None:
+        # if void facts provided - change state value to ABSENT and return
+        ret_dict['state'] = "ABSENT"
+        return ret_dict
+    
+    ret_dict['id'] = arg_osimage_facts['id']
+    ret_dict['name'] = arg_osimage_facts['name']
+    ret_dict['size'] = arg_osimage_facts['size']
+    ret_dict['type'] = arg_osimage_facts['type']
+    # ret_dict['arch'] = arg_osimage_facts['architecture']
+    ret_dict['sep_id'] = arg_osimage_facts['sepId']
+    ret_dict['pool'] = arg_osimage_facts['pool']
+    ret_dict['state'] = arg_osimage_facts['status']
+
+    return ret_dict
+
+def decort_osimage_parameters():
+    """Build and return a dictionary of parameters expected by decort_osimage module in a form accepted
+    by AnsibleModule utility class."""
+
+    return dict(
+        app_id=dict(type='str',
+                    required=False,
+                    fallback=(env_fallback, ['DECORT_APP_ID'])),
+        app_secret=dict(type='str',
+                        required=False,
+                        fallback=(env_fallback, ['DECORT_APP_SECRET']),
+                        no_log=True),
+        authenticator=dict(type='str',
+                           required=True,
+                           choices=['legacy', 'oauth2', 'jwt']),
+        controller_url=dict(type='str', required=True),
+        image_name=dict(type='str', required=True),
+        jwt=dict(type='str',
+                 required=False,
+                 fallback=(env_fallback, ['DECORT_JWT']),
+                 no_log=True),
+        oauth2_url=dict(type='str',
+                        required=False,
+                        fallback=(env_fallback, ['DECORT_OAUTH2_URL'])),
+        password=dict(type='str',
+                      required=False,
+                      fallback=(env_fallback, ['DECORT_PASSWORD']),
+                      no_log=True),
+        pool=dict(type='str', required=False, default=""),
+        sep_id=dict(type='int', required=False, default=0),
+        account_name=dict(type='str', required=True),
+        user=dict(type='str',
+                  required=False,
+                  fallback=(env_fallback, ['DECORT_USER'])),
+        vdc_id=dict(type='int', required=False, default=0),
+        verify_ssl=dict(type='bool', required=False, default=True),
+        workflow_callback=dict(type='str', required=False),
+        workflow_context=dict(type='str', required=False),
+    )
+
+# Workflow digest:
+# 1) authenticate to DECORT controller & validate authentication by issuing API call - done when 
+#    creating DecortController
+# 2) obtain a list of OS images accessible to the specified account (and optionally - within 
+#    the specified VDC)
+# 3) match specified OS image by its name - if image is not found abort the module
+# 5) report result to Ansible
+
+def main():
+    module_parameters = decort_osimage_parameters()
+
+    amodule = AnsibleModule(argument_spec=module_parameters,
+                            supports_check_mode=True,
+                            mutually_exclusive=[
+                                ['oauth2', 'password'],
+                                ['password', 'jwt'],
+                                ['jwt', 'oauth2'],
+                            ],
+                            required_together=[
+                                ['app_id', 'app_secret'],
+                                ['user', 'password'],
+                            ],
+                            )
+
+    decon = DecortController(amodule)
+
+    # we need account ID to locate OS images - find the account by the specified name and get its ID
+    validated_account_id, _ = decon.account_find(amodule.params['account_name'])
+    if validated_account_id == 0:
+        # we failed either to find or access the specified account - fail the module
+        decon.result['failed'] = True
+        decon.result['changed'] = False
+        decon.result['msg'] = ("Cannot find account '{}'").format(amodule.params['account_name'])
+        amodule.fail_json(**decon.result)
+
+    image_id, image_facts = decon.image_find(image_id=0, image_name=amodule.params['image_name'], 
+                                             account_id=validated_account_id, rg_id=0,
+                                             sepid=amodule.params['sep_id'],
+                                             pool=amodule.params['pool'])
+    if decon.result['failed'] == True:
+        # we failed to find the specified image - fail the module
+        decon.result['changed'] = False
+        amodule.fail_json(**decon.result)
+
+    decon.result['facts'] = decort_osimage_package_facts(image_facts, amodule.check_mode)
+    decon.result['changed'] = False # decort_osimage is a read-only module - make sure the 'changed' flag is set to False
+    amodule.exit_json(**decon.result)
+
+
+if __name__ == "__main__":
+    main()

library/decort_pfw.py

@@ -0,0 +1,332 @@
+#!/usr/bin/python
+#
+# Digital Enegry Cloud Orchestration Technology (DECORT) modules for Ansible
+# Copyright: (c) 2018-2021 Digital Energy Cloud Solutions LLC
+#
+# Apache License 2.0 (see http://www.apache.org/licenses/LICENSE-2.0.txt)
+#
+
+#
+# Author: Sergey Shubin (sergey.shubin@digitalenergy.online)
+#
+
+ANSIBLE_METADATA = {'metadata_version': '1.1',
+                    'status': ['preview'],
+                    'supported_by': 'community'}
+
+DOCUMENTATION = '''
+---
+module: decort_pfw
+short_description: Manage network Port Forward rules for Compute instances in DECORT cloud
+description: >
+     This module can be used to create new port forwarding rules in DECORT cloud platform, 
+     modify and delete them.
+version_added: "2.2"
+author:
+     - Sergey Shubin <sergey.shubin@digitalenergy.online>
+requirements:
+     - python >= 2.6
+     - PyJWT Python module
+     - requests Python module
+     - netaddr Python module
+     - decort_utils utility library (module)
+     - DECORT cloud platform version 3.6.1 or higher
+notes:
+     - Environment variables can be used to pass selected parameters to the module, see details below.
+     - Specified Oauth2 provider must be trusted by the DECORT cloud controller on which JWT will be used.
+     - 'Similarly, JWT supplied in I(authenticator=jwt) mode should be received from Oauth2 provider trusted by
+       the DECORT cloud controller on which this JWT will be used.'
+options:
+    account_id:
+        description:
+        - ID of the account, which owns this disk. This is the alternative to I(account_name) option.
+        - If both I(account_id) and I(account_name) specified, then I(account_name) is ignored.
+        default: 0
+        required: no
+    account_name:
+        description:
+        - 'Name of the account, which will own this disk.'
+        - 'This parameter is ignored if I(account_id) is specified.'
+        default: empty string
+        required: no
+    app_id:
+        description:
+        - 'Application ID for authenticating to the DECORT controller when I(authenticator=oauth2).'
+        - 'Required if I(authenticator=oauth2).'
+        - 'If not found in the playbook or command line arguments, the value will be taken from DECORT_APP_ID
+           environment variable.'
+        required: no
+    app_secret:
+        description:
+        - 'Application API secret used for authenticating to the DECORT controller when I(authenticator=oauth2).'
+        - This parameter is required when I(authenticator=oauth2) and ignored in other modes.
+        - 'If not found in the playbook or command line arguments, the value will be taken from DECORT_APP_SECRET
+           environment variable.'
+        required: no
+    authenticator:
+        description:
+        - Authentication mechanism to be used when accessing DECORT controller and authorizing API call.
+        default: jwt
+        choices: [ jwt, oauth2, legacy ]
+        required: yes
+    controller_url:
+        description:
+        - URL of the DECORT controller that will be contacted to manage the RG according to the specification.
+        - 'This parameter is always required regardless of the specified I(authenticator) type.'
+        required: yes
+    compute_id:
+        description:
+        - ID of the Compute instance to manage network port forwarding rules for.
+        required: yes
+    jwt:
+        description:
+        - 'JWT (access token) for authenticating to the DECORT controller when I(authenticator=jwt).'
+        - 'This parameter is required if I(authenticator=jwt) and ignored for other authentication modes.'
+        - If not specified in the playbook, the value will be taken from DECORT_JWT environment variable.
+        required: no
+    oauth2_url:
+        description:
+        - 'URL of the oauth2 authentication provider to use when I(authenticator=oauth2).'
+        - 'This parameter is required when when I(authenticator=oauth2).'
+        - 'If not specified in the playbook, the value will be taken from DECORT_OAUTH2_URL environment variable.'
+    password:
+        description:
+        - 'Password for authenticating to the DECORT controller when I(authenticator=legacy).'
+        - 'This parameter is required if I(authenticator=legacy) and ignored in other authentication modes.'
+        - If not specified in the playbook, the value will be taken from DECORT_PASSWORD environment variable.
+        required: no
+    rules:
+        description:
+        - 'Set of rules to configure for the Compute instance identidied by I(compute_id) in the virtual
+          network segment identidied by I(vins_id).'
+        - The set is specified as a list of dictionaries with the following structure:
+        - '  - (int) public_port_start - starting port number on the ViNS external interface.'
+        - '  - (int) public_port_end - optional end port number of the ViNS external interface. If not specified
+               or set equal to I(public_port_start), a one-to-one rule is created. Otherwise a ranged rule will
+               be created, which maps specified external port range to local ports starting from I(local_port).'
+        - '  - (int) local_port - port number on the local interface of the Compute. For ranged rule it is
+               interpreted as a base port to translate public port range to internal port range.'
+        - '  - (string) proto - protocol, specify either I(tcp) or I(udp).'
+        - 'Note that rules are meaningful only if I(state=present). If I(state=absent) is specified, rules set
+           will be ignored, and all rules for the specified Compute will be deleted.'
+    state:
+        description:
+        - 'Specify the desired state of the port forwarding rules set for the Compute instance identified by
+          I(compute_id).'
+        - 'If I(state=present), the rules will be applied according to the I(rules) parameter.'
+        - 'If I(state=absent), all rules for the specified Compute instance will be deleted regardless of
+           I(rules) parameter.'
+        default: present
+        choices: [ absent, present ]
+    verify_ssl:
+        description:
+        - 'Controls SSL verification mode when making API calls to DECORT controller. Set it to False if you
+         want to disable SSL certificate verification. Intended use case is when you run module in a trusted
+         environment that uses self-signed certificates. Note that disabling SSL verification in any other
+         scenario can lead to security issues, so please know what you are doing.'
+        default: True
+        required: no
+    vins_id:
+        description:
+        - ID of the virtual network segment (ViNS), where port forwarding rules will be set up.
+        - This ViNS must have connection to external network.
+        - Compute instance specified by I(compute_id) must be connected to this ViNS.
+    workflow_callback:
+        description:
+        - 'Callback URL that represents an application, which invokes this module (e.g. up-level orchestrator or
+          end-user portal) and may except out-of-band updates on progress / exit status of the module run.'
+        - API call at this URL will be used to relay such information to the application.
+        - 'API call payload will include module-specific details about this module run and I(workflow_context).'
+        required: no
+    workflow_context:
+        description:
+        - 'Context data that will be included into the payload of the API call directed at I(workflow_callback) URL.'
+        - 'This context data is expected to uniquely identify the task carried out by this module invocation so
+           that up-level orchestrator could match returned information to the its internal entities.'
+        required: no
+'''
+
+EXAMPLES = '''
+- name: configure one-toone rule for SSH protocol on Compute ID 100 connected to ViNS ID 5.
+    decort_pfw:
+      authenticator: oauth2
+      app_id: "{{ MY_APP_ID }}"
+      app_secret: "{{ MY_APP_SECRET }}"
+      controller_url: "https://cloud.digitalenergy.online"
+      compute_id: 100
+      vins_id: 5
+      rules:
+        - public_port_start: 10022
+          local_port: 22
+          proto: tcp
+      state: present
+    delegate_to: localhost
+    register: my_pfw
+'''
+
+RETURN = '''
+facts:
+    description: facts about created PFW rules
+    returned: always
+    type: dict
+    sample:
+      facts:
+        compute_id: 100
+        vins_id: 5
+        rules:
+          - 
+'''
+
+from ansible.module_utils.basic import AnsibleModule
+from ansible.module_utils.basic import env_fallback
+
+from ansible.module_utils.decort_utils import *
+
+
+def decort_pfw_package_facts(comp_facts, vins_facts, pfw_facts, check_mode=False):
+    """Package a dictionary of PFW rules facts according to the decort_pfw module specification. 
+    This dictionary will be returned to the upstream Ansible engine at the completion of 
+    the module run.
+
+    @param (dict) pfw_facts: dictionary with PFW facts as returned by API call to .../???/get
+    @param (bool) check_mode: boolean that tells if this Ansible module is run in check mode
+    """
+
+    ret_dict = dict(state="CHECK_MODE",
+                    compute_id=0,
+                    public_ip="",
+                    rules=[],
+                    vins_id=0,
+                    )
+
+    if check_mode:
+        # in check mode return immediately with the default values
+        return ret_dict
+
+    if pfw_facts is None:
+        # if void facts provided - change state value to ABSENT and return
+        ret_dict['state'] = "ABSENT"
+        return ret_dict
+
+    ret_dict['compute_id'] = comp_facts['id']
+    ret_dict['vins_id'] = vins_facts['id']
+    ret_dict['public_ip'] = vins_facts['vnfs']['GW']['config']['ext_net_ip']
+    
+    if len(pfw_facts) != 0:
+        ret_dict['state'] = 'PRESENT'
+        ret_dict['rules'] = pfw_facts
+    else:
+        ret_dict['state'] = 'ABSENT'
+
+    return ret_dict
+
+def decort_pfw_parameters():
+    """Build and return a dictionary of parameters expected by decort_pfw module in a form accepted
+    by AnsibleModule utility class."""
+
+    return dict(
+        app_id=dict(type='str',
+                    required=False,
+                    fallback=(env_fallback, ['DECORT_APP_ID'])),
+        app_secret=dict(type='str',
+                        required=False,
+                        fallback=(env_fallback, ['DECORT_APP_SECRET']),
+                        no_log=True),
+        authenticator=dict(type='str',
+                           required=True,
+                           choices=['legacy', 'oauth2', 'jwt']),
+        compute_id=dict(type='int', required=True),
+        controller_url=dict(type='str', required=True),
+        jwt=dict(type='str',
+                 required=False,
+                 fallback=(env_fallback, ['DECORT_JWT']),
+                 no_log=True),
+        oauth2_url=dict(type='str',
+                        required=False,
+                        fallback=(env_fallback, ['DECORT_OAUTH2_URL'])),
+        password=dict(type='str',
+                      required=False,
+                      fallback=(env_fallback, ['DECORT_PASSWORD']),
+                      no_log=True),
+        rules=dict(type='list', required=False, default=[]),
+        state=dict(type='str',
+                   default='present',
+                   choices=['absent', 'present']),
+        user=dict(type='str',
+                  required=False,
+                  fallback=(env_fallback, ['DECORT_USER'])),
+        verify_ssl=dict(type='bool', required=False, default=True),
+        vins_id=dict(type='int', required=True),
+        workflow_callback=dict(type='str', required=False),
+        workflow_context=dict(type='str', required=False),
+    )
+
+def main():
+    module_parameters = decort_pfw_parameters()
+
+    amodule = AnsibleModule(argument_spec=module_parameters,
+                            supports_check_mode=True,
+                            mutually_exclusive=[
+                                ['oauth2', 'password'],
+                                ['password', 'jwt'],
+                                ['jwt', 'oauth2'],
+                            ],
+                            required_together=[
+                                ['app_id', 'app_secret'],
+                                ['user', 'password'],
+                            ],
+                            )
+
+    decon = DecortController(amodule)
+
+    pfw_facts = None # will hold PFW facts as returned by pfw_configure
+
+    #
+    # Validate module arguments:
+    # 1) specified Compute instance exists in correct state
+    # 2) specified ViNS exists
+    # 3) ViNS has GW function
+    # 4) Compute is connected to this ViNS
+    #
+
+    validated_comp_id, comp_facts, rg_id = decon.compute_find(amodule.params['compute_id'])
+    if not validated_comp_id:
+        decon.result['failed'] = True
+        decon.result['msg'] = "Cannot find specified Compute ID {}.".format(amodule.params['compute_id'])
+        amodule.fail_json(**decon.result)
+
+    validated_vins_id, vins_facts = decon.vins_find(amodule.params['vins_id'])
+    if not validated_vins_id:
+        decon.result['failed'] = True
+        decon.result['msg'] = "Cannot find specified ViNS ID {}.".format(amodule.params['vins_id'])
+        amodule.fail_json(**decon.result)
+
+    gw_vnf_facts = vins_facts['vnfs'].get('GW')
+    if not gw_vnf_facts or gw_vnf_facts['status'] == "DESTROYED":
+        decon.result['failed'] = True
+        decon.result['msg'] = "ViNS ID {} does not have a configured external connection.".format(validated_vins_id)
+        amodule.fail_json(**decon.result)
+
+    #
+    # Initial validation of module arguments is complete
+    # 
+
+    if amodule.params['state'] == 'absent':
+        # ignore amodule.params['rules'] and remove all rules associated with this Compute
+        pfw_facts = decon.pfw_configure(comp_facts, vins_facts, None) 
+    else:
+        # manage PFW rules accodring to the module arguments
+        pfw_facts = decon.pfw_configure(comp_facts, vins_facts, amodule.params['rules'])
+    
+    #
+    # complete module run
+    #
+    if decon.result['failed']:
+        amodule.fail_json(**decon.result)
+    else:
+        # prepare PFW facts to be returned as part of decon.result and then call exit_json(...)
+        decon.result['facts'] = decort_pfw_package_facts(comp_facts, vins_facts, pfw_facts, amodule.check_mode)
+        amodule.exit_json(**decon.result)
+
+if __name__ == "__main__":
+    main()

library/decort_rg.py

@@ -0,0 +1,463 @@
+#!/usr/bin/python
+#
+# Digital Enegry Cloud Orchestration Technology (DECORT) modules for Ansible
+# Copyright: (c) 2018-2021 Digital Energy Cloud Solutions LLC
+#
+# Apache License 2.0 (see http://www.apache.org/licenses/LICENSE-2.0.txt)
+#
+
+#
+# Author: Sergey Shubin (sergey.shubin@digitalenergy.online)
+#
+
+ANSIBLE_METADATA = {'metadata_version': '1.1',
+                    'status': ['preview'],
+                    'supported_by': 'community'}
+
+DOCUMENTATION = '''
+---
+module: decort_rg
+short_description: Manage resource groups (RGs) in DECORT cloud
+description: >
+     This module can be used to create a new resource group in DECORT cloud platform, modify its
+     characteristics, and delete it.
+version_added: "2.2"
+author:
+     - Sergey Shubin <sergey.shubin@digitalenergy.online>
+requirements:
+     - python >= 2.6
+     - PyJWT Python module
+     - requests Python module
+     - netaddr Python module
+     - decort_utils utility library (module)
+     - DECORT cloud platform version 3.6.1 or higher
+notes:
+     - Environment variables can be used to pass selected parameters to the module, see details below.
+     - Specified Oauth2 provider must be trusted by the DECORT cloud controller on which JWT will be used.
+     - 'Similarly, JWT supplied in I(authenticator=jwt) mode should be received from Oauth2 provider trusted by
+       the DECORT cloud controller on which this JWT will be used.'
+     - New RGs provisioned with this module will be deployed to the first location under specified DECORT 
+       controller (if there is more than one location).
+options:
+    account_id:
+        description:
+        - ID of the account under which this RG will be created. This is the alternative to I(account_name)
+          option. If both I(account_id) and I(account_name) specified, the latter is ignored.
+    account_name:
+        description:
+        - 'Name of the account under which this RG will be created (for new RGs) or is located.'
+        - 'This parameter is ignored if I(account_id) is specified.'
+        required: no
+    annotation:
+        description:
+        - Optional text description of this resource group.
+        default: empty string
+        required: no
+    app_id:
+        description:
+        - 'Application ID for authenticating to the DECORT controller when I(authenticator=oauth2).'
+        - 'Required if I(authenticator=oauth2).'
+        - 'If not found in the playbook or command line arguments, the value will be taken from DECORT_APP_ID
+           environment variable.'
+        required: no
+    app_secret:
+        description:
+        - 'Application API secret used for authenticating to the DECORT controller when I(authenticator=oauth2).'
+        - This parameter is required when I(authenticator=oauth2) and ignored in other modes.
+        - 'If not found in the playbook or command line arguments, the value will be taken from DECORT_APP_SECRET
+           environment variable.'
+        required: no
+    authenticator:
+        description:
+        - Authentication mechanism to be used when accessing DECORT controller and authorizing API call.
+        default: jwt
+        choices: [ jwt, oauth2, legacy ]
+        required: yes
+    controller_url:
+        description:
+        - URL of the DECORT controller that will be contacted to manage the RG according to the specification.
+        - 'This parameter is always required regardless of the specified I(authenticator) type.'
+        required: yes
+    jwt:
+        description:
+        - 'JWT (access token) for authenticating to the DECORT controller when I(authenticator=jwt).'
+        - 'This parameter is required if I(authenticator=jwt) and ignored for other authentication modes.'
+        - If not specified in the playbook, the value will be taken from DECORT_JWT environment variable.
+        required: no
+    oauth2_url:
+        description:
+        - 'URL of the oauth2 authentication provider to use when I(authenticator=oauth2).'
+        - 'This parameter is required when when I(authenticator=oauth2).'
+        - If not specified in the playbook, the value will be taken from DECORT_OAUTH2_URL environment variable.
+    password:
+        description:
+        - 'Password for authenticating to the DECORT controller when I(authenticator=legacy).'
+        - 'This parameter is required if I(authenticator=legacy) and ignored in other authentication modes.'
+        - If not specified in the playbook, the value will be taken from DECORT_PASSWORD environment variable.
+        required: no
+    quotas:
+        description:
+        - Dictionary that defines resource quotas to be set on a newly created RG.
+        - 'This parameter is optional and only used when creating new RG. It is ignored for any operations on an
+          existing RG.'
+        - 'The following keys are valid to set the resource quotas:'
+        - ' - I(cpu) (integer) - limit on the total number of CPUs that can be consumed by all compute instances 
+          in this RG.'
+        - ' - I(ram) (integer) - limit on the total amount of RAM in GB that can be consumed by compute instances
+          in this RG.'
+        - ' - I(disk) (integer) - limit on the total volume of disk space in GB that can be consumed by all
+          compute instances in this RG.'
+        - ' - I(ext_ips) (integer) - maximum number of external IP addresses that can be allocated to the compute
+          instances and virtual network segments (ViNS) in this RG.'
+        - 'Each of the above keys is optional. For example, you may specify I(cpu) and I(ram) while omitting the
+        other two keys. Then the quotas will be set on RAM and CPU leaving disk volume and the number of external
+        IP addresses unlimited.'
+        required: no
+    rg_name:
+        description:
+        - Name of the RG to manage.
+        required: yes
+    state:
+        description:
+        - Specify the desired state of the resource group at the exit of the module.
+        - 'Regardless of I(state), if RG exists and is in one of [DEPLOYING, DESTROYING, MIGRATING, ] states,
+          do nothing.'
+        - 'If desired I(state=present):'
+        - ' - RG does not exist or is in DESTROYED state, create new RG according to the specifications.'
+        - ' - RG is in one of [CREATED, DISABLED] states, change quotas if necessary.'
+        - ' - RG is in DELETED state, restore it and change quotas if necessary. RG will be left in DISABLED state.'
+        - ' - RG in any other state, abort with an error.'
+        - 'If desired I(state=enabled):'
+        - ' - RG does not exist or is in DESTROYED state, create new RG according to the specifications.'
+        - ' - RG is in CREATED state, change quotas if necessary.'
+        - ' - RG is in DELETED state, restore it, change quotas if necessary and enable.'
+        - ' - RG is in any other state, abort with an error.'
+        - 'If desired I(state=absent):'
+        - ' - RG is in one of [CREATED, DISABLED, DELETED] states, destroy it.'
+        - ' - RG in DESTROYED state, do nothing.' 
+        - ' - RG in any other state, abort with an error.'
+        - 'If desired I(state=disabled):'
+        - ' - RG does not exist or is in one of [ENABLING, DISABLING, DELETING, DELETED, DESTROYING, DESTROYED] 
+              states, abort with an error.'
+        - ' - RG is DISABLED state, change quotas if necessary.'
+        - ' - RG is in CREATED state, change quotas if necessary and disable the RG.'
+        default: present
+        choices: [ absent, disabled, enabled, present ]
+    user:
+        description:
+        - 'Name of the legacy user for authenticating to the DECORT controller when I(authenticator=legacy).'
+        - 'This parameter is required when I(authenticator=legacy) and ignored for other authentication modes.'
+        - If not specified in the playbook, the value will be taken from DECORT_USER environment variable.
+        required: no
+    verify_ssl:
+        description:
+        - 'Controls SSL verification mode when making API calls to DECORT controller. Set it to False if you
+         want to disable SSL certificate verification. Intended use case is when you run module in a trusted
+         environment that uses self-signed certificates. Note that disabling SSL verification in any other
+         scenario can lead to security issues, so please know what you are doing.'
+        default: True
+        required: no
+    workflow_callback:
+        description:
+        - 'Callback URL that represents an application, which invokes this module (e.g. up-level orchestrator or
+          end-user portal) and may except out-of-band updates on progress / exit status of the module run.'
+        - API call at this URL will be used to relay such information to the application.
+        - 'API call payload will include module-specific details about this module run and I(workflow_context).'
+        required: no
+    workflow_context:
+        description:
+        - 'Context data that will be included into the payload of the API call directed at I(workflow_callback) URL.'
+        - 'This context data is expected to uniquely identify the task carried out by this module invocation so
+           that up-level orchestrator could match returned information to the its internal entities.'
+        required: no
+'''
+
+EXAMPLES = '''
+- name: create a new RG named "MyFirstRG" if it does not exist yet, set quotas on CPU and the number of exteranl IPs.
+    decort_rg:
+      authenticator: oauth2
+      app_id: "{{ MY_APP_ID }}"
+      app_secret: "{{ MY_APP_SECRET }}"
+      controller_url: "https://cloud.digitalenergy.online"
+      rg_name: "MyFirstRG"
+      account_name: "MyMainAccount"
+      quotas:
+        cpu: 16
+        ext_ips: 4
+      annotation: "My first RG created with Ansible module"
+      state: present
+    delegate_to: localhost
+    register: my_rg
+'''
+
+RETURN = '''
+facts:
+    description: facts about the resource group
+    returned: always
+    type: dict
+    sample:
+      facts:
+        id: 100
+        name: MyFirstRG
+        state: CREATED
+        account_id: 10
+        gid: 1001
+'''
+
+from ansible.module_utils.basic import AnsibleModule
+from ansible.module_utils.basic import env_fallback
+
+from ansible.module_utils.decort_utils import *
+
+
+def decort_rg_package_facts(arg_rg_facts, arg_check_mode=False):
+    """Package a dictionary of RG facts according to the decort_rg module specification. This dictionary will
+    be returned to the upstream Ansible engine at the completion of the module run.
+
+    @param arg_rg_facts: dictionary with RG facts as returned by API call to .../rg/get
+    @param arg_check_mode: boolean that tells if this Ansible module is run in check mode
+    """
+
+    ret_dict = dict(id=0,
+                    name="none",
+                    state="CHECK_MODE",
+                    )
+
+    if arg_check_mode:
+        # in check mode return immediately with the default values
+        return ret_dict
+
+    if arg_rg_facts is None:
+        # if void facts provided - change state value to ABSENT and return
+        ret_dict['state'] = "ABSENT"
+        return ret_dict
+
+    ret_dict['id'] = arg_rg_facts['id']
+    ret_dict['name'] = arg_rg_facts['name']
+    ret_dict['state'] = arg_rg_facts['status']
+    ret_dict['account_id'] = arg_rg_facts['accountId']
+    ret_dict['gid'] = arg_rg_facts['gid']
+
+    return ret_dict
+
+def decort_rg_parameters():
+    """Build and return a dictionary of parameters expected by decort_rg module in a form accepted
+    by AnsibleModule utility class."""
+
+    return dict(
+        account_id=dict(type='int', required=False),
+        account_name=dict(type='str', required=False, default=''),
+        annotation=dict(type='str', required=False, default=''),
+        app_id=dict(type='str',
+                    required=False,
+                    fallback=(env_fallback, ['DECORT_APP_ID'])),
+        app_secret=dict(type='str',
+                        required=False,
+                        fallback=(env_fallback, ['DECORT_APP_SECRET']),
+                        no_log=True),
+        authenticator=dict(type='str',
+                           required=True,
+                           choices=['legacy', 'oauth2', 'jwt']),
+        controller_url=dict(type='str', required=True),
+        # datacenter=dict(type='str', required=False, default=''),
+        jwt=dict(type='str',
+                 required=False,
+                 fallback=(env_fallback, ['DECORT_JWT']),
+                 no_log=True),
+        oauth2_url=dict(type='str',
+                        required=False,
+                        fallback=(env_fallback, ['DECORT_OAUTH2_URL'])),
+        password=dict(type='str',
+                      required=False,
+                      fallback=(env_fallback, ['DECORT_PASSWORD']),
+                      no_log=True),
+        quotas=dict(type='dict', required=False),
+        state=dict(type='str',
+                   default='present',
+                   choices=['absent', 'disabled', 'enabled', 'present']),
+        user=dict(type='str',
+                  required=False,
+                  fallback=(env_fallback, ['DECORT_USER'])),
+        rg_name=dict(type='str', required=True,),
+        verify_ssl=dict(type='bool', required=False, default=True),
+        workflow_callback=dict(type='str', required=False),
+        workflow_context=dict(type='str', required=False),
+    )
+
+# Workflow digest:
+# 1) authenticate to DECORT controller & validate authentication by issuing API call - done when creating DECORTController
+# 2) check if the RG with the specified id or rg_name:name exists
+# 3) if RG does not exist -> deploy
+# 4) if RG exists: check desired state, desired configuration -> initiate action accordingly
+# 5) report result to Ansible
+
+def main():
+    module_parameters = decort_rg_parameters()
+
+    amodule = AnsibleModule(argument_spec=module_parameters,
+                            supports_check_mode=True,
+                            mutually_exclusive=[
+                                ['oauth2', 'password'],
+                                ['password', 'jwt'],
+                                ['jwt', 'oauth2'],
+                            ],
+                            required_together=[
+                                ['app_id', 'app_secret'],
+                                ['user', 'password'],
+                            ],
+                            )
+
+    decon = DecortController(amodule)
+
+    # We need valid Account ID to manage RG.
+    # Account may be specified either by account_id or account_name. In both cases we
+    # have to validate account presence and accesibility by the current user.
+    validated_acc_id = 0
+    if decon.check_amodule_argument('account_id', False):
+        validated_acc_id, _ = decon.account_find("", amodule.params['account_id'])
+    else:
+        decon.check_amodule_argument('account_name') # if no account_name, this function will abort module
+        validated_acc_id, _ = decon.account_find(amodule.params['account_name'])
+
+    if not validated_acc_id:
+        # we failed to locate account by either name or ID - abort with an error
+        decon.result['failed'] = True
+        decon.result['msg'] = ("Current user does not have access to the requested account "
+                                "or non-existent account specified.")
+        decon.fail_json(**decon.result)
+
+    # Check if the RG with the specified parameters already exists
+    rg_id, rg_facts = decon.rg_find(validated_acc_id,
+                                    0, arg_rg_name=amodule.params['rg_name'],
+                                    arg_check_state=False)
+    rg_should_exist = True
+
+    if rg_id:
+        if rg_facts['status'] in ["MODELED", "DISABLING", "ENABLING", "DELETING", "DESTROYING"]:
+            # error: nothing can be done to existing RG in the listed statii regardless of
+            # the requested state
+            decon.result['failed'] = True
+            decon.result['changed'] = False
+            decon.result['msg'] = ("No change can be done for existing RG ID {} because of its current "
+                                   "status '{}'").format(rg_id, rg_facts['status'])
+        elif rg_facts['status'] == "DISABLED":
+            if amodule.params['state'] == 'absent':
+                decon.rg_delete(arg_rg_id=rg_id, arg_permanently=True)
+                rg_facts['status'] = 'DESTROYED'
+                rg_should_exist = False
+            elif amodule.params['state'] in ('present', 'disabled'):
+                # update quotas
+                decon.rg_quotas(rg_facts, amodule.params['quotas'])
+            elif amodule.params['state'] == 'enabled':
+                # update quotas and enable
+                decon.rg_quotas(rg_facts, amodule.params['quotas'])
+                decon.rg_state(rg_facts, 'enabled')
+        elif rg_facts['status'] == "CREATED":
+            if amodule.params['state'] == 'absent':
+                decon.rg_delete(arg_rg_id=rg_id, arg_permanently=True)
+                rg_facts['status'] = 'DESTROYED'
+                rg_should_exist = False
+            elif amodule.params['state'] in ('present', 'enabled'):
+                # update quotas
+                decon.rg_quotas(rg_facts, amodule.params['quotas'])
+            elif amodule.params['state'] == 'disabled':
+                # disable and update quotas
+                decon.rg_state(rg_facts, 'disabled')
+                decon.rg_quotas(rg_facts, amodule.params['quotas'])
+        elif rg_facts['status'] == "DELETED":
+            if amodule.params['state'] in ['present', 'enabled']:
+                # restore and enable
+                # TODO: check if restore RG API returns the new RG ID of the restored RG instance.
+                decon.rg_restore(arg_rg_id=rg_id)
+                decon.rg_state(rg_facts, 'enabled')
+                # TODO: Not sure what to do with the quotas after RG is restored. May need to update rg_facts.
+                rg_should_exist = True
+            elif amodule.params['state'] == 'absent':
+                # destroy permanently
+                decon.rg_delete(arg_rg_id=rg_id, arg_permanently=True)
+                rg_facts['status'] = 'DESTROYED'
+                rg_should_exist = False
+            elif amodule.params['state'] == 'disabled':
+                # error
+                decon.result['failed'] = True
+                decon.result['changed'] = False
+                decon.result['msg'] = ("Invalid target state '{}' requested for RG ID {} in the "
+                                       "current status '{}'").format(rg_id,
+                                                                     amodule.params['state'],
+                                                                     rg_facts['status'])
+                rg_should_exist = False
+        elif rg_facts['status'] == "DESTROYED":
+            if amodule.params['state'] in ('present', 'enabled'):
+                # need to re-provision RG
+                decon.check_amodule_argument('rg_name')
+                # As we already have validated account ID we can create RG and get rg_id on success
+                # pass empty string for location code, rg_provision will select the 1st location  
+                rg_id = decon.rg_provision(validated_acc_id,
+                                            amodule.params['rg_name'], decon.decort_username,
+                                            amodule.params['quotas'],
+                                            "", # this is location code. TODO: add module argument
+                                            amodule.params['annotation'])
+                rg_should_exist = True
+            elif amodule.params['state'] == 'absent':
+                # nop
+                decon.result['failed'] = False
+                decon.result['changed'] = False
+                decon.result['msg'] = ("No state change required for RG ID {} because of its "
+                                       "current status '{}'").format(rg_id,
+                                                                     rg_facts['status'])
+                rg_should_exist = False
+            elif amodule.params['state'] == 'disabled':
+                # error
+                decon.result['failed'] = True
+                decon.result['changed'] = False
+                decon.result['msg'] = ("Invalid target state '{}' requested for RG ID {} in the "
+                                       "current status '{}'").format(rg_id,
+                                                                     amodule.params['state'],
+                                                                     rg_facts['status'])
+    else:
+        # Preexisting RG was not found.
+        rg_should_exist = False  # we will change it back to True if RG is explicitly created or restored
+        # If requested state is 'absent' - nothing to do
+        if amodule.params['state'] == 'absent':
+            decon.result['failed'] = False
+            decon.result['changed'] = False
+            decon.result['msg'] = ("Nothing to do as target state 'absent' was requested for "
+                                   "non-existent RG name '{}'").format(amodule.params['rg_name'])
+        elif amodule.params['state'] in ('present', 'enabled'):
+            # Target RG does not exist yet - create it and store the returned ID in rg_id variable for later use
+            # To create RG we need account name (or account ID) and RG name - check
+            # that these parameters are present and proceed.
+            decon.check_amodule_argument('rg_name')
+            # as we already have account ID we can create RG and get rg_id on success
+            # pass empty string for location code, rg_provision will select the 1st location 
+            rg_id = decon.rg_provision(validated_acc_id,
+                                        amodule.params['rg_name'], decon.decort_username,
+                                        amodule.params['quotas'],
+                                        "", # this is location code. TODO: add module argument
+                                        amodule.params['annotation'])
+            rg_should_exist = True            
+        elif amodule.params['state'] == 'disabled':
+            decon.result['failed'] = True
+            decon.result['changed'] = False
+            decon.result['msg'] = ("Invalid target state '{}' requested for non-existent "
+                                   "RG name '{}' ").format(amodule.params['state'],
+                                                            amodule.params['rg_name'])
+    #
+    # conditional switch end - complete module run
+    if decon.result['failed']:
+        amodule.fail_json(**decon.result)
+    else:
+        # prepare RG facts to be returned as part of decon.result and then call exit_json(...)
+        # rg_facts = None
+        if rg_should_exist:
+            if decon.result['changed']:
+                # If we arrive here, there is a good chance that the RG is present - get fresh RG facts from
+                # the cloud by RG ID.
+                # Otherwise, RG facts from previous call (when the RG was still in existence) will be returned.
+                _, rg_facts = decon.rg_find(arg_account_id=0, arg_rg_id=rg_id)
+        decon.result['facts'] = decort_rg_package_facts(rg_facts, amodule.check_mode)
+        amodule.exit_json(**decon.result)
+
+
+if __name__ == "__main__":
+    main()

library/decort_vins.py

@@ -0,0 +1,593 @@
+#!/usr/bin/python
+#
+# Digital Enegry Cloud Orchestration Technology (DECORT) modules for Ansible
+# Copyright: (c) 2018-2021 Digital Energy Cloud Solutions LLC
+#
+# Apache License 2.0 (see http://www.apache.org/licenses/LICENSE-2.0.txt)
+#
+
+#
+# Author: Sergey Shubin (sergey.shubin@digitalenergy.online)
+#
+
+ANSIBLE_METADATA = {'metadata_version': '1.1',
+                    'status': ['preview'],
+                    'supported_by': 'community'}
+
+DOCUMENTATION = '''
+---
+module: decort_vins
+short_description: Manage Virtual Network Segments (ViNS) in DECORT cloud
+description: >
+     This module can be used to create new ViNS in DECORT cloud platform, obtain or 
+     modify its characteristics, and delete it.
+version_added: "2.2"
+author:
+     - Sergey Shubin <sergey.shubin@digitalenergy.online>
+requirements:
+     - python >= 2.6
+     - PyJWT Python module
+     - requests Python module
+     - netaddr Python module
+     - decort_utils utility library (module)
+     - DECORT cloud platform version 3.6.1 or higher
+notes:
+     - Environment variables can be used to pass selected parameters to the module, see details below.
+     - Specified Oauth2 provider must be trusted by the DECORT cloud controller on which JWT will be used.
+     - 'Similarly, JWT supplied in I(authenticator=jwt) mode should be received from Oauth2 provider trusted by
+       the DECORT cloud controller on which this JWT will be used.'
+options:
+    account_id:
+        description:
+        - 'ID of the account under which this ViNS will be created (for new ViNS) or is located (for already
+          existing ViNS). This is the alternative to I(account_name) option.'
+        - If both I(account_id) and I(account_name) specified, then I(account_name) is ignored.
+        required: no
+    account_name:
+        description:
+        - 'Name of the account under which this ViNS will be created (for new RGs) or is located (for already
+           existing ViNS).'
+        - 'This parameter is ignored if I(account_id) is specified.'
+        required: no
+    annotation:
+        description:
+        - Optional text description of this virtual network segment.
+        default: empty string
+        required: no
+    app_id:
+        description:
+        - 'Application ID for authenticating to the DECORT controller when I(authenticator=oauth2).'
+        - 'Required if I(authenticator=oauth2).'
+        - 'If not found in the playbook or command line arguments, the value will be taken from DECORT_APP_ID
+           environment variable.'
+        required: no
+    app_secret:
+        description:
+        - 'Application API secret used for authenticating to the DECORT controller when I(authenticator=oauth2).'
+        - This parameter is required when I(authenticator=oauth2) and ignored in other modes.
+        - 'If not found in the playbook or command line arguments, the value will be taken from DECORT_APP_SECRET
+           environment variable.'
+        required: no
+    authenticator:
+        description:
+        - Authentication mechanism to be used when accessing DECORT controller and authorizing API call.
+        default: jwt
+        choices: [ jwt, oauth2, legacy ]
+        required: yes
+    controller_url:
+        description:
+        - URL of the DECORT controller that will be contacted to manage the RG according to the specification.
+        - 'This parameter is always required regardless of the specified I(authenticator) type.'
+        required: yes
+    ext_net_id:
+        description:
+        - 'Controls ViNS connection to an external network. This argument is optional with default value of -1,
+          which means no external connection.'
+        - Specify 0 to connect ViNS to external network and let platform select external network Id automatically.
+        - Specify positive value to request ViNS connection to the external network with corresponding ID.
+        - You may also control external IP address selection with I(ext_ip_addr) argument.
+        default: -1
+        required: no
+    ext_ip_addr:
+        description:
+        - IP address to assign to the external interface of this ViNS when connecting to the external net.
+        - If empty string is passed, the platform will assign free IP address automatically.
+        - 'Note that if invalid IP address or an address already occupied by another client is specified, 
+           the module will abort with an error.'
+        - 'This argument is used only for new connection to the specified network. You cannot select another 
+           external IP address without changing external network ID.'
+        - ViNS connection to the external network is controlled by I(ext_net_id) argument.
+        default: empty string
+        required: no
+    ipcidr:
+        description:
+        - Internal ViNS network address in a format XXX.XXX.XXX.XXX/XX (includes address and netmask).
+        - If empty string is passed, the platform will assign network address automatically.
+        - 'When selecting this address manually, note that this address must be unique amomng all ViNSes in 
+           the target account.'
+        default: empty string
+        required: no
+    jwt:
+        description:
+        - 'JWT (access token) for authenticating to the DECORT controller when I(authenticator=jwt).'
+        - 'This parameter is required if I(authenticator=jwt) and ignored for other authentication modes.'
+        - If not specified in the playbook, the value will be taken from DECORT_JWT environment variable.
+        required: no
+    oauth2_url:
+        description:
+        - 'URL of the oauth2 authentication provider to use when I(authenticator=oauth2).'
+        - 'This parameter is required when when I(authenticator=oauth2).'
+        - 'If not specified in the playbook, the value will be taken from DECORT_OAUTH2_URL environment variable.'
+    password:
+        description:
+        - 'Password for authenticating to the DECORT controller when I(authenticator=legacy).'
+        - 'This parameter is required if I(authenticator=legacy) and ignored in other authentication modes.'
+        - If not specified in the playbook, the value will be taken from DECORT_PASSWORD environment variable.
+        required: no
+    rg_id:
+        description:
+        - 'ID of the resource group (RG), where this ViNS will be created (for a new ViNS) or located 
+           (for already existing ViNS).'
+        - If ViNS is created at the account level, I(rg_id) should be omitted or set to 0.
+        - If both I(rg_id) and I(rg_name) are specified, then I(rg_name) is ignored.
+        default: 0
+        required: no
+    rg_name:
+        description:
+        - 'Name of the resource group (RG), where this ViNS will be created (for new ViNS) or 
+          located (for already existing ViNS).'
+        - If ViNS is created at the account level, I(rg_name) should be omitted or set to emtpy string.
+        - If both I(rg_name) and I(rg_id) are specified, then I(rg_name) is ignored. 
+        default: empty string
+        required: no
+    state:
+        description:
+        - Specify the desired state of the ViNS at the exit of the module.
+        - 'Regardless of I(state), if ViNS exists and is in one of [DEPLOYING, DESTROYING, MIGRATING] states,
+          do nothing.'
+        - 'If desired I(state=present):'
+        - ' - ViNS does not exist or is in DESTROYED state, create new ViNS according to the specifications.'
+        - ' - ViNS is in DELETED state, restore it and change quotas if necessary. Note that on successful 
+              restore ViNS will be left in DISABLED state.'
+        - ' - ViNS is in one of [CREATED, ENABLED, DISABLED] states, do nothing.'
+        - ' - ViNS in any other state, abort with an error.'
+        - 'If desired I(state=enabled):'
+        - ' - ViNS does not exist or is in DESTROYED state, create new ViNS according to the specifications.'
+        - ' - ViNS is in DELETED state, restore and enable it.'
+        - ' - ViNS is in one of [CREATED, ENABLED] states, do nothing.'
+        - ' - viNS is in any other state, abort with an error.'
+        - 'If desired I(state=absent):'
+        - ' - ViNS is in one of [CREATED, ENABLED, DISABLED, DELETED] states, destroy it.'
+        - ' - ViNS in DESTROYED state, do nothing.' 
+        - ' - ViNS in any other state, abort with an error.'
+        - 'If desired I(state=disabled):'
+        - ' - ViNS is in one of [CREATED, ENABLED] states, disable it.'
+        - ' - ViNS is DISABLED state, do nothing.'
+        - ' - ViNS does not exist or is in one of [ENABLING, DISABLING, DELETING, DELETED, DESTROYING, DESTROYED] 
+              states, abort with an error.'
+        default: present
+        choices: [ absent, disabled, enabled, present ]
+    user:
+        description:
+        - 'Name of the legacy user for authenticating to the DECORT controller when I(authenticator=legacy).'
+        - 'This parameter is required when I(authenticator=legacy) and ignored for other authentication modes.'
+        - If not specified in the playbook, the value will be taken from DECORT_USER environment variable.
+        required: no
+    verify_ssl:
+        description:
+        - 'Controls SSL verification mode when making API calls to DECORT controller. Set it to False if you
+         want to disable SSL certificate verification. Intended use case is when you run module in a trusted
+         environment that uses self-signed certificates. Note that disabling SSL verification in any other
+         scenario can lead to security issues, so please know what you are doing.'
+        default: True
+        required: no
+    vins_id:
+        description:
+        - ID of the ViNs to manage. If ViNS is identified by ID it must be present.
+        - If ViNS ID is specified, I(account_id), I(account_name), I(rg_id) and I(rg_name) are ignored.
+    vins_name:
+        description:
+        - Name of the ViNS.
+        - ViNS can exist at either account or resource group level.
+        - ViNS name is unique only within its parent (i.e. account or resource group).
+        - 'To create ViNS at account level omit both I(rg_id) and I(rg_name), or set them to 0 and empty
+           string respectively.'
+        required: yes
+    workflow_callback:
+        description:
+        - 'Callback URL that represents an application, which invokes this module (e.g. up-level orchestrator or
+          end-user portal) and may except out-of-band updates on progress / exit status of the module run.'
+        - API call at this URL will be used to relay such information to the application.
+        - 'API call payload will include module-specific details about this module run and I(workflow_context).'
+        required: no
+    workflow_context:
+        description:
+        - 'Context data that will be included into the payload of the API call directed at I(workflow_callback) URL.'
+        - 'This context data is expected to uniquely identify the task carried out by this module invocation so
+           that up-level orchestrator could match returned information to the its internal entities.'
+        required: no
+'''
+
+EXAMPLES = '''
+- name: create a new ViNS named "MyViNS" if it does not exist yet under RG "MyRG" in the account "MyAccount".
+    decort_vins:
+      authenticator: oauth2
+      app_id: "{{ MY_APP_ID }}"
+      app_secret: "{{ MY_APP_SECRET }}"
+      controller_url: "https://cloud.digitalenergy.online"
+      vins_name: "MyViNS"
+      rg_name: "MyRG"
+      account_name: "MyAccount"
+      state: present
+    delegate_to: localhost
+    register: my_vins
+'''
+
+RETURN = '''
+facts:
+    description: facts about the virtual network segment
+    returned: always
+    type: dict
+    sample:
+      facts:
+        id: 5
+        name: MyViNS
+        int_net_addr: 192.168.1.0
+        ext_net_addr: 10.50.11.118
+        state: CREATED
+        account_id: 7
+        rg_id: 19
+        gid: 1001
+'''
+
+from ansible.module_utils.basic import AnsibleModule
+from ansible.module_utils.basic import env_fallback
+
+from ansible.module_utils.decort_utils import *
+
+
+def decort_vins_package_facts(arg_vins_facts, arg_check_mode=False):
+    """Package a dictionary of ViNS facts according to the decort_vins module specification. 
+    This dictionary will be returned to the upstream Ansible engine at the completion of 
+    the module run.
+
+    @param arg_vins_facts: dictionary with viNS facts as returned by API call to .../vins/get
+    @param arg_check_mode: boolean that tells if this Ansible module is run in check mode
+    """
+
+    ret_dict = dict(id=0,
+                    name="none",
+                    state="CHECK_MODE",
+                    )
+
+    if arg_check_mode:
+        # in check mode return immediately with the default values
+        return ret_dict
+
+    if arg_vins_facts is None:
+        # if void facts provided - change state value to ABSENT and return
+        ret_dict['state'] = "ABSENT"
+        return ret_dict
+
+    ret_dict['id'] = arg_vins_facts['id']
+    ret_dict['name'] = arg_vins_facts['name']
+    ret_dict['state'] = arg_vins_facts['status']
+    ret_dict['account_id'] = arg_vins_facts['accountId']
+    ret_dict['rg_id'] = arg_vins_facts['rgId']
+    ret_dict['int_net_addr'] = arg_vins_facts['network']
+    ret_dict['gid'] = arg_vins_facts['gid']
+
+    if arg_vins_facts['vnfs'].get('GW'):
+        gw_config = arg_vins_facts['vnfs']['GW']['config']
+        ret_dict['ext_ip_addr'] = gw_config['ext_net_ip']
+        ret_dict['ext_net_id'] = gw_config['ext_net_id']
+    else:
+        ret_dict['ext_ip_addr'] = ""
+        ret_dict['ext_net_id'] = -1
+    
+    # arg_vins_facts['vnfs']['GW']['config']
+    #   ext_ip_addr -> ext_net_ip
+    #   ???         -> ext_net_id
+    # tech_status   -> techStatus
+
+
+    return ret_dict
+
+def decort_vins_parameters():
+    """Build and return a dictionary of parameters expected by decort_vins module in a form accepted
+    by AnsibleModule utility class."""
+
+    return dict(
+        account_id=dict(type='int', required=False),
+        account_name=dict(type='str', required=False, default=''),
+        annotation=dict(type='str', required=False, default=''),
+        app_id=dict(type='str',
+                    required=False,
+                    fallback=(env_fallback, ['DECORT_APP_ID'])),
+        app_secret=dict(type='str',
+                        required=False,
+                        fallback=(env_fallback, ['DECORT_APP_SECRET']),
+                        no_log=True),
+        authenticator=dict(type='str',
+                           required=True,
+                           choices=['legacy', 'oauth2', 'jwt']),
+        controller_url=dict(type='str', required=True),
+        # datacenter=dict(type='str', required=False, default=''),
+        ext_net_id=dict(type='int', required=False, default=-1),
+        ext_ip_addr=dict(type='str', required=False, default=''),
+        ipcidr=dict(type='str', required=False, default=''),
+        jwt=dict(type='str',
+                 required=False,
+                 fallback=(env_fallback, ['DECORT_JWT']),
+                 no_log=True),
+        oauth2_url=dict(type='str',
+                        required=False,
+                        fallback=(env_fallback, ['DECORT_OAUTH2_URL'])),
+        password=dict(type='str',
+                      required=False,
+                      fallback=(env_fallback, ['DECORT_PASSWORD']),
+                      no_log=True),
+        state=dict(type='str',
+                   default='present',
+                   choices=['absent', 'disabled', 'enabled', 'present']),
+        user=dict(type='str',
+                  required=False,
+                  fallback=(env_fallback, ['DECORT_USER'])),
+        rg_id=dict(type='int', required=False, default=0),
+        rg_name=dict(type='str', required=False, default=''),
+        verify_ssl=dict(type='bool', required=False, default=True),
+        vins_id=dict(type='int', required=False, default=0),
+        vins_name=dict(type='str', required=True),
+        workflow_callback=dict(type='str', required=False),
+        workflow_context=dict(type='str', required=False),
+    )
+
+# Workflow digest:
+# 1) authenticate to DECORT controller & validate authentication by issuing API call - done when creating DECORTController
+# 2) check if the ViNS with this id or name exists under specified account / resource group
+# 3) if ViNS does not exist -> deploy
+# 4) if ViNS exists: check desired state, desired configuration -> initiate action(s) accordingly
+# 5) report result to Ansible
+
+def main():
+    module_parameters = decort_vins_parameters()
+
+    amodule = AnsibleModule(argument_spec=module_parameters,
+                            supports_check_mode=True,
+                            mutually_exclusive=[
+                                ['oauth2', 'password'],
+                                ['password', 'jwt'],
+                                ['jwt', 'oauth2'],
+                            ],
+                            required_together=[
+                                ['app_id', 'app_secret'],
+                                ['user', 'password'],
+                            ],
+                            )
+
+    decon = DecortController(amodule)
+
+    vins_id = 0
+    vins_level = "" # "ID" if specified by ID, "RG" - at resource group, "ACC" - at account level
+    vins_facts = None # will hold ViNS facts
+    validated_rg_id = 0
+    rg_facts = None # will hold RG facts
+    validated_acc_id = 0
+    acc_facts = None # will hold Account facts
+
+    if amodule.params['vins_id']:
+        # expect existing ViNS with the specified ID
+        # This call to vins_find will abort the module if no ViNS with such ID is present
+        vins_id, vins_facts = decon.vins_find(amodule.params['vins_id'])
+        if not vins_id:
+            decon.result['failed'] = True
+            decon.result['msg'] = "Specified ViNS ID {} not found.".format(amodule.params['vins_id'])
+            decon.fail_json(**decon.result)
+        vins_level="ID"
+        validated_acc_id = vins_facts['accountId']
+        validated_rg_id = vins_facts['rgId']
+    elif amodule.params['rg_id']:
+        # expect ViNS @ RG level in the RG with specified ID
+        vins_level="RG"
+        # This call to rg_find will abort the module if no RG with such ID is present 
+        validated_rg_id, rg_facts = decon.rg_find(0, # account ID set to 0 as we search for RG by RG ID
+                                    amodule.params['rg_id'], arg_rg_name="")
+        # This call to vins_find may return vins_id=0 if no ViNS found
+        vins_id, vins_facts = decon.vins_find(vins_id=0, vins_name=amodule.params['vins_name'],
+                                                account_id=0, 
+                                                rg_id=amodule.params['rg_id'],
+                                                check_state=False)
+        # TODO: add checks and setup ViNS presence flags accordingly
+        pass
+    elif amodule.params['account_id'] or amodule.params['account_name'] != "":
+        # Specified account must be present and accessible by the user, otherwise abort the module 
+        validated_acc_id, acc_facts = decon.account_find(amodule.params['account_name'], amodule.params['account_id'])
+        if not validated_acc_id:
+            decon.result['failed'] = True
+            decon.result['msg'] = ("Current user does not have access to the requested account "
+                                    "or non-existent account specified.")
+            decon.fail_json(**decon.result)
+        if amodule.params['rg_name'] != "": # at this point we know that rg_id=0
+            # expect ViNS @ RG level in the RG with specified name under specified account
+            # RG with the specified name must be present under the account, otherwise abort the module    
+            validated_rg_id, rg_facts = decon.rg_find(validated_acc_id, 0, amodule.params['rg_name'])
+            if (not validated_rg_id or 
+                rg_facts['status'] in ["DESTROYING", "DESTROYED", "DELETING", "DELETED", "DISABLING", "ENABLING"]):
+                decon.result['failed'] = True
+                decon.result['msg'] = "RG name '{}' not found or has invalid state.".format(amodule.params['rg_name'])
+                decon.fail_json(**decon.result)
+            # This call to vins_find may return vins_id=0 if no ViNS with this name found under specified RG
+            vins_id, vins_facts = decon.vins_find(vins_id=0, vins_name=amodule.params['vins_name'],
+                                                    account_id=0, # set to 0, as we are looking for ViNS under RG 
+                                                    rg_id=validated_rg_id,
+                                                    check_state=False)
+            vins_level = "RG"
+            # TODO: add checks and setup ViNS presence flags accordingly
+        else: # At this point we know for sure that rg_name="" and rg_id=0
+            # So we expect ViNS @ account level
+            # This call to vins_find may return vins_id=0 if no ViNS found
+            vins_id, vins_facts = decon.vins_find(vins_id=0, vins_name=amodule.params['vins_name'],
+                                                    account_id=validated_acc_id, 
+                                                    rg_id=0,
+                                                    check_state=False)
+            vins_level = "ACC"
+            # TODO: add checks and setup ViNS presence flags accordingly
+    else: 
+        # this is "invalid arguments combination" sink
+        # if we end up here, it means that module was invoked with vins_id=0 and rg_id=0
+        decon.result['failed'] = True
+        if amodule.params['account_id'] == 0 and amodule.params['account_name'] == "":
+            decon.result['msg'] = "Cannot find ViNS by name when account name is empty and account ID is 0."
+        if amodule.params['rg_name'] == "":
+            # rg_name without account specified
+            decon.result['msg'] = "Cannot find ViNS by name when RG name is empty and RG ID is 0."
+        decon.fail_json(**decon.result)
+
+    #
+    # Initial validation of module arguments is complete
+    #
+    # At this point non-zero vins_id means that we will be managing pre-existing ViNS
+    # Otherwise we are about to create a new one as follows:
+    # - if validated_rg_id is non-zero, create ViNS @ RG level
+    # - if validated_rg_id is zero, create ViNS @ account level
+    #
+    # When managing existing ViNS we need to account for both "static" and "transient"
+    # status. Full range of ViNS statii is as follows:
+    # 
+    # "MODELED", "CREATED", "ENABLED", "ENABLING", "DISABLED", "DISABLING", "DELETED", "DELETING", "DESTROYED", "DESTROYING"
+    # 
+
+    vins_should_exist = False
+    
+    if vins_id:
+        vins_should_exist = True
+        if vins_facts['status'] in ["MODELED", "DISABLING", "ENABLING", "DELETING", "DESTROYING"]:
+            # error: nothing can be done to existing ViNS in the listed statii regardless of
+            # the requested state
+            decon.result['failed'] = True
+            decon.result['changed'] = False
+            decon.result['msg'] = ("No change can be done for existing ViNS ID {} because of its current "
+                                   "status '{}'").format(vins_id, vins_facts['status'])
+        elif vins_facts['status'] == "DISABLED":
+            if amodule.params['state'] == 'absent':
+                decon.vins_delete(vins_id, permanently=True)
+                vins_facts['status'] = 'DESTROYED'
+                vins_should_exist = False
+            elif amodule.params['state'] in ('present', 'disabled'):
+                # update ViNS, leave in disabled state
+                decon.vins_update(vins_facts,
+                                  amodule.params['ext_net_id'], amodule.params['ext_ip_addr'])
+            elif amodule.params['state'] == 'enabled':
+                # update ViNS and enable
+                decon.vins_update(vins_facts,
+                                  amodule.params['ext_net_id'], amodule.params['ext_ip_addr'])
+                decon.vins_state(vins_facts, 'enabled')
+        elif vins_facts['status'] in ["CREATED", "ENABLED"]:
+            if amodule.params['state'] == 'absent':
+                decon.vins_delete(vins_id, permanently=True)
+                vins_facts['status'] = 'DESTROYED'
+                vins_should_exist = False
+            elif amodule.params['state'] in ('present', 'enabled'):
+                # update ViNS
+                decon.vins_update(vins_facts,
+                                  amodule.params['ext_net_id'], amodule.params['ext_ip_addr'])
+            elif amodule.params['state'] == 'disabled':
+                # disable and update ViNS
+                decon.vins_state(vins_facts, 'disabled')
+                decon.vins_update(vins_facts,
+                                  amodule.params['ext_net_id'], amodule.params['ext_ip_addr'])
+        elif vins_facts['status'] == "DELETED":
+            if amodule.params['state'] in ['present', 'enabled']:
+                # restore and enable
+                decon.vins_restore(arg_vins_id=vins_id)
+                decon.vins_state(vins_facts, 'enabled')
+                vins_should_exist = True
+            elif amodule.params['state'] == 'absent':
+                # destroy permanently
+                decon.vins_delete(vins_id, permanently=True)
+                vins_facts['status'] = 'DESTROYED'
+                vins_should_exist = False
+            elif amodule.params['state'] == 'disabled':
+                # error
+                decon.result['failed'] = True
+                decon.result['changed'] = False
+                decon.result['msg'] = ("Invalid target state '{}' requested for ViNS ID {} in the "
+                                       "current status '{}'").format(vins_id,
+                                                                     amodule.params['state'],
+                                                                     vins_facts['status'])
+                vins_should_exist = False
+        elif vins_facts['status'] == "DESTROYED":
+            if amodule.params['state'] in ('present', 'enabled'):
+                # need to re-provision ViNS; some attributes may be changed, some stay the same.
+                # account and RG - stays the same
+                # vins_name - stays the same
+                # IPcidr - take from module arguments
+                # ext IP address - take from module arguments
+                # annotation - take from module arguments
+                vins_id = decon.vins_provision(vins_facts['name'],
+                                               validated_acc_id, validated_rg_id,
+                                               amodule.params['ipcidr'], 
+                                               amodule.params['ext_net_id'], amodule.params['ext_ip_addr'],
+                                               amodule.params['annotation'])
+                vins_should_exist = True
+            elif amodule.params['state'] == 'absent':
+                # nop
+                decon.result['failed'] = False
+                decon.result['changed'] = False
+                decon.result['msg'] = ("No state change required for ViNS ID {} because of its "
+                                       "current status '{}'").format(vins_id,
+                                                                     vins_facts['status'])
+                vins_should_exist = False
+            elif amodule.params['state'] == 'disabled':
+                # error
+                decon.result['failed'] = True
+                decon.result['changed'] = False
+                decon.result['msg'] = ("Invalid target state '{}' requested for ViNS ID {} in the "
+                                       "current status '{}'").format(vins_id,
+                                                                     amodule.params['state'],
+                                                                     vins_facts['status'])
+    else:
+        # Preexisting ViNS was not found.
+        vins_should_exist = False  # we will change it back to True if ViNS is created or restored
+        # If requested state is 'absent' - nothing to do
+        if amodule.params['state'] == 'absent':
+            decon.result['failed'] = False
+            decon.result['changed'] = False
+            decon.result['msg'] = ("Nothing to do as target state 'absent' was requested for "
+                                   "non-existent ViNS name '{}'").format(amodule.params['vins_name'])
+        elif amodule.params['state'] in ('present', 'enabled'):
+            decon.check_amodule_argument('vins_name')
+            # as we already have account ID and RG ID we can create ViNS and get vins_id on success
+            vins_id = decon.vins_provision(amodule.params['vins_name'],
+                                            validated_acc_id, validated_rg_id,
+                                            amodule.params['ipcidr'], 
+                                            amodule.params['ext_net_id'], amodule.params['ext_ip_addr'],
+                                            amodule.params['annotation'])
+            vins_should_exist = True            
+        elif amodule.params['state'] == 'disabled':
+            decon.result['failed'] = True
+            decon.result['changed'] = False
+            decon.result['msg'] = ("Invalid target state '{}' requested for non-existent "
+                                   "ViNS name '{}'").format(amodule.params['state'],
+                                                            amodule.params['vins_name'])
+    
+    #
+    # conditional switch end - complete module run
+    #
+    if decon.result['failed']:
+        amodule.fail_json(**decon.result)
+    else:
+        # prepare ViNS facts to be returned as part of decon.result and then call exit_json(...)
+        if vins_should_exist:
+            if decon.result['changed']:
+                # If we arrive here, there is a good chance that the ViNS is present - get fresh ViNS
+                # facts from # the cloud by ViNS ID.
+                # Otherwise, ViNS facts from previous call (when the ViNS was still in existence) will
+                # be returned.
+                _, vins_facts = decon.vins_find(vins_id)
+        decon.result['facts'] = decort_vins_package_facts(vins_facts, amodule.check_mode)
+        amodule.exit_json(**decon.result)
+
+
+if __name__ == "__main__":
+    main()