path: root/ansible_collections/netapp/cloudmanager/plugins/module_utils/netapp_module.py

# This code is part of Ansible, but is an independent component.
# This particular file snippet, and this file snippet only, is BSD licensed.
# Modules you write using this snippet, which is embedded dynamically by Ansible
# still belong to the author of the module, and may assign their own license
# to the complete work.
#
# Copyright (c) 2022, Laurent Nicolas <laurentn@netapp.com>
# All rights reserved.
#
# Redistribution and use in source and binary forms, with or without modification,
# are permitted provided that the following conditions are met:
#
#    * Redistributions of source code must retain the above copyright
#      notice, this list of conditions and the following disclaimer.
#    * Redistributions in binary form must reproduce the above copyright notice,
#      this list of conditions and the following disclaimer in the documentation
#      and/or other materials provided with the distribution.
#
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
# ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
# WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
# IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
# INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
# PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
# LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE
# USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

''' Support class for NetApp ansible modules '''

from __future__ import (absolute_import, division, print_function)
__metaclass__ = type

from copy import deepcopy
import json
import re
import base64
import time


def cmp(a, b):
    '''
    Python 3 does not have a cmp function, this will do the cmp.
    :param a: first object to check
    :param b: second object to check
    :return:
    '''
    # convert to lower case for string comparison.
    if a is None:
        return -1
    if isinstance(a, str) and isinstance(b, str):
        a = a.lower()
        b = b.lower()
    # if list has string element, convert string to lower case.
    if isinstance(a, list) and isinstance(b, list):
        a = [x.lower() if isinstance(x, str) else x for x in a]
        b = [x.lower() if isinstance(x, str) else x for x in b]
        a.sort()
        b.sort()
    return (a > b) - (a < b)


class NetAppModule(object):
    '''
    Common class for NetApp modules
    set of support functions to derive actions based
    on the current state of the system, and a desired state
    '''

    def __init__(self):
        self.log = []
        self.changed = False
        self.parameters = {'name': 'not intialized'}

    def set_parameters(self, ansible_params):
        self.parameters = {}
        for param in ansible_params:
            if ansible_params[param] is not None:
                self.parameters[param] = ansible_params[param]
        return self.parameters

    def get_cd_action(self, current, desired):
        ''' takes a desired state and a current state, and return an action:
            create, delete, None
            eg:
            is_present = 'absent'
            some_object = self.get_object(source)
            if some_object is not None:
                is_present = 'present'
            action = cd_action(current=is_present, desired = self.desired.state())
        '''
        desired_state = desired['state'] if 'state' in desired else 'present'
        if current is None and desired_state == 'absent':
            return None
        if current is not None and desired_state == 'present':
            return None
        # change in state
        self.changed = True
        if current is not None:
            return 'delete'
        return 'create'

    def compare_and_update_values(self, current, desired, keys_to_compare):
        updated_values = {}
        is_changed = False
        for key in keys_to_compare:
            if key in current:
                if key in desired and desired[key] is not None:
                    if current[key] != desired[key]:
                        updated_values[key] = desired[key]
                        is_changed = True
                    else:
                        updated_values[key] = current[key]
                else:
                    updated_values[key] = current[key]

        return updated_values, is_changed

    def get_working_environments_info(self, rest_api, headers):
        '''
        Get all working environments info
        '''
        api = "/occm/api/working-environments"
        response, error, dummy = rest_api.get(api, None, header=headers)
        if error is not None:
            return response, error
        else:
            return response, None

    def look_up_working_environment_by_name_in_list(self, we_list, name):
        '''
        Look up working environment by the name in working environment list
        '''
        for we in we_list:
            if we['name'] == name:
                return we, None
        return None, "look_up_working_environment_by_name_in_list: Working environment not found"

    def get_working_environment_details_by_name(self, rest_api, headers, name, provider=None):
        '''
        Use working environment name to get working environment details including:
        name: working environment name,
        publicID: working environment ID
        cloudProviderName,
        isHA,
        svmName
        '''
        # check the working environment exist or not
        api = "/occm/api/working-environments/exists/" + name
        response, error, dummy = rest_api.get(api, None, header=headers)
        if error is not None:
            return None, error

        # get working environment lists
        api = "/occm/api/working-environments"
        response, error, dummy = rest_api.get(api, None, header=headers)
        if error is not None:
            return None, error
        # look up the working environment in the working environment lists
        if provider is None or provider == 'onPrem':
            working_environment_details, error = self.look_up_working_environment_by_name_in_list(response['onPremWorkingEnvironments'], name)
            if error is None:
                return working_environment_details, None
        if provider is None or provider == 'gcp':
            working_environment_details, error = self.look_up_working_environment_by_name_in_list(response['gcpVsaWorkingEnvironments'], name)
            if error is None:
                return working_environment_details, None
        if provider is None or provider == 'azure':
            working_environment_details, error = self.look_up_working_environment_by_name_in_list(response['azureVsaWorkingEnvironments'], name)
            if error is None:
                return working_environment_details, None
        if provider is None or provider == 'aws':
            working_environment_details, error = self.look_up_working_environment_by_name_in_list(response['vsaWorkingEnvironments'], name)
            if error is None:
                return working_environment_details, None
        return None, "get_working_environment_details_by_name: Working environment not found"

    def get_working_environment_details(self, rest_api, headers):
        '''
        Use working environment id to get working environment details including:
        name: working environment name,
        publicID: working environment ID
        cloudProviderName,
        ontapClusterProperties,
        isHA,
        status,
        userTags,
        workingEnvironmentType,
        '''
        api = "/occm/api/working-environments/"
        api += self.parameters['working_environment_id']
        response, error, dummy = rest_api.get(api, None, header=headers)
        if error:
            return None, "Error: get_working_environment_details %s" % error
        return response, None

    def get_aws_fsx_details(self, rest_api, header=None, name=None):
        '''
        Use working environment id and tenantID to get working environment details including:
        name: working environment name,
        publicID: working environment ID
        '''
        api = "/fsx-ontap/working-environments/"
        api += self.parameters['tenant_id']
        count = 0
        fsx_details = None
        if name is None:
            name = self.parameters['name']
        response, error, dummy = rest_api.get(api, None, header=header)
        if error:
            return response, "Error: get_aws_fsx_details %s" % error
        for each in response:
            if each['name'] == name:
                count += 1
                fsx_details = each
            if self.parameters.get('working_environment_id'):
                if each['id'] == self.parameters['working_environment_id']:
                    return each, None
        if count == 1:
            return fsx_details, None
        elif count > 1:
            return response, "More than one AWS FSx found for %s, use working_environment_id for delete" \
                             "or use different name for create" % name
        return None, None

    def get_aws_fsx_details_by_id(self, rest_api, header=None):
        '''
        Use working environment id and tenantID to get working environment details including:
        publicID: working environment ID
        '''
        api = "/fsx-ontap/working-environments/%s" % self.parameters['tenant_id']
        response, error, dummy = rest_api.get(api, None, header=header)
        if error:
            return response, "Error: get_aws_fsx_details %s" % error
        for each in response:
            if self.parameters.get('destination_working_environment_id') and each['id'] == self.parameters['destination_working_environment_id']:
                return each, None
        return None, None

    def get_aws_fsx_details_by_name(self, rest_api, header=None):
        '''
        Use working environment name and tenantID to get working environment details including:
        name: working environment name,
        '''
        api = "/fsx-ontap/working-environments/%s" % self.parameters['tenant_id']
        count = 0
        fsx_details = None
        response, error, dummy = rest_api.get(api, None, header=header)
        if error:
            return response, "Error: get_aws_fsx_details_by_name %s" % error
        for each in response:
            if each['name'] == self.parameters['destination_working_environment_name']:
                count += 1
                fsx_details = each
        if count == 1:
            return fsx_details['id'], None
        if count > 1:
            return response, "More than one AWS FSx found for %s" % self.parameters['name']
        return None, None

    def get_aws_fsx_svm(self, rest_api, id, header=None):
        '''
        Use working environment id and tenantID to get FSx svm details including:
        publicID: working environment ID
        '''
        api = "/occm/api/fsx/working-environments/%s/svms" % id
        response, error, dummy = rest_api.get(api, None, header=header)
        if error:
            return response, "Error: get_aws_fsx_svm %s" % error
        if len(response) == 0:
            return None, "Error: no SVM found for %s" % id
        return response[0]['name'], None

    def get_working_environment_detail_for_snapmirror(self, rest_api, headers):

        source_working_env_detail, dest_working_env_detail = {}, {}
        if self.parameters.get('source_working_environment_id'):
            api = '/occm/api/working-environments'
            working_env_details, error, dummy = rest_api.get(api, None, header=headers)
            if error:
                return None, None, "Error getting WE info: %s: %s" % (error, working_env_details)
            for dummy, values in working_env_details.items():
                for each in values:
                    if each['publicId'] == self.parameters['source_working_environment_id']:
                        source_working_env_detail = each
                        break
        elif self.parameters.get('source_working_environment_name'):
            source_working_env_detail, error = self.get_working_environment_details_by_name(rest_api, headers,
                                                                                            self.parameters['source_working_environment_name'])
            if error:
                return None, None, error
        else:
            return None, None, "Cannot find working environment by source_working_environment_id or source_working_environment_name"

        if self.parameters.get('destination_working_environment_id'):
            if self.parameters['destination_working_environment_id'].startswith('fs-'):
                if self.parameters.get('tenant_id'):
                    working_env_details, error = self.get_aws_fsx_details_by_id(rest_api, header=headers)
                    if error:
                        return None, None, "Error getting WE info for FSx: %s: %s" % (error, working_env_details)
                    dest_working_env_detail['publicId'] = self.parameters['destination_working_environment_id']
                    svm_name, error = self.get_aws_fsx_svm(rest_api, self.parameters['destination_working_environment_id'], header=headers)
                    if error:
                        return None, None, "Error getting svm name for FSx: %s" % error
                    dest_working_env_detail['svmName'] = svm_name
                else:
                    return None, None, "Cannot find FSx WE by destination WE %s, missing tenant_id" % self.parameters['destination_working_environment_id']
            else:
                api = '/occm/api/working-environments'
                working_env_details, error, dummy = rest_api.get(api, None, header=headers)
                if error:
                    return None, None, "Error getting WE info: %s: %s" % (error, working_env_details)
                for dummy, values in working_env_details.items():
                    for each in values:
                        if each['publicId'] == self.parameters['destination_working_environment_id']:
                            dest_working_env_detail = each
                            break
        elif self.parameters.get('destination_working_environment_name'):
            if self.parameters.get('tenant_id'):
                fsx_id, error = self.get_aws_fsx_details_by_name(rest_api, header=headers)
                if error:
                    return None, None, "Error getting WE info for FSx: %s" % error
                dest_working_env_detail['publicId'] = fsx_id
                svm_name, error = self.get_aws_fsx_svm(rest_api, fsx_id, header=headers)
                if error:
                    return None, None, "Error getting svm name for FSx: %s" % error
                dest_working_env_detail['svmName'] = svm_name
            else:
                dest_working_env_detail, error = self.get_working_environment_details_by_name(rest_api, headers,
                                                                                              self.parameters['destination_working_environment_name'])
                if error:
                    return None, None, error
        else:
            return None, None, "Cannot find working environment by destination_working_environment_id or destination_working_environment_name"

        return source_working_env_detail, dest_working_env_detail, None

    def create_account(self, rest_api):
        """
        Create Account
        :return: Account ID
        """
        # TODO? do we need to create an account?  And the code below is broken
        return None, 'Error: creating an account is not supported.'
        # headers = {
        #     "X-User-Token": rest_api.token_type + " " + rest_api.token,
        # }

        # api = '/tenancy/account/MyAccount'
        # account_res, error, dummy = rest_api.post(api, header=headers)
        # account_id = None if error is not None else account_res['accountPublicId']
        # return account_id, error

    def get_or_create_account(self, rest_api):
        """
        Get Account
        :return: Account ID
        """
        accounts, error = self.get_account_info(rest_api)
        if error is not None:
            return None, error
        if len(accounts) == 0:
            return None, 'Error: account cannot be located - check credentials or provide account_id.'
            # TODO? creating an account is not supported
            # return self.create_account(rest_api)

        return accounts[0]['accountPublicId'], None

    def get_account_info(self, rest_api, headers=None):
        """
        Get Account
        :return: Account ID
        """
        headers = {
            "X-User-Token": rest_api.token_type + " " + rest_api.token,
        }

        api = '/tenancy/account'
        account_res, error, dummy = rest_api.get(api, header=headers)
        if error is not None:
            return None, error
        return account_res, None

    def get_account_id(self, rest_api):
        accounts, error = self.get_account_info(rest_api)
        if error:
            return None, error
        if not accounts:
            return None, 'Error: no account found - check credentials or provide account_id.'
        return accounts[0]['accountPublicId'], None

    def get_accounts_info(self, rest_api, headers):
        '''
        Get all accounts info
        '''
        api = "/occm/api/accounts"
        response, error, dummy = rest_api.get(api, None, header=headers)
        if error is not None:
            return None, error
        else:
            return response, None

    def set_api_root_path(self, working_environment_details, rest_api):
        '''
        set API url root path based on the working environment provider
        '''
        provider = working_environment_details['cloudProviderName'] if working_environment_details.get('cloudProviderName') else None
        api_root_path = None
        if self.parameters['working_environment_id'].startswith('fs-'):
            api_root_path = "/occm/api/fsx"
        elif provider == "Amazon":
            api_root_path = "/occm/api/aws/ha" if working_environment_details['isHA'] else "/occm/api/vsa"
        elif working_environment_details['isHA']:
            api_root_path = "/occm/api/" + provider.lower() + "/ha"
        else:
            api_root_path = "/occm/api/" + provider.lower() + "/vsa"
        rest_api.api_root_path = api_root_path

    def have_required_parameters(self, action):
        '''
        Check if all the required parameters in self.params are available or not besides the mandatory parameters
        '''
        actions = {'create_aggregate': ['number_of_disks', 'disk_size_size', 'disk_size_unit', 'working_environment_id'],
                   'update_aggregate': ['number_of_disks', 'disk_size_size', 'disk_size_unit', 'working_environment_id'],
                   'delete_aggregate': ['working_environment_id'],
                   }
        missed_params = [
            parameter
            for parameter in actions[action]
            if parameter not in self.parameters
        ]

        if not missed_params:
            return True, None
        else:
            return False, missed_params

    def get_modified_attributes(self, current, desired, get_list_diff=False):
        ''' takes two dicts of attributes and return a dict of attributes that are
            not in the current state
            It is expected that all attributes of interest are listed in current and
            desired.
            :param: current: current attributes in ONTAP
            :param: desired: attributes from playbook
            :param: get_list_diff: specifies whether to have a diff of desired list w.r.t current list for an attribute
            :return: dict of attributes to be modified
            :rtype: dict

            NOTE: depending on the attribute, the caller may need to do a modify or a
            different operation (eg move volume if the modified attribute is an
            aggregate name)
        '''
        # if the object does not exist,  we can't modify it
        modified = {}
        if current is None:
            return modified

        # error out if keys do not match
        # self.check_keys(current, desired)

        # collect changed attributes
        for key, value in current.items():
            if key in desired and desired[key] is not None:
                if isinstance(value, list):
                    modified_list = self.compare_lists(value, desired[key], get_list_diff)  # get modified list from current and desired
                    if modified_list is not None:
                        modified[key] = modified_list
                elif isinstance(value, dict):
                    modified_dict = self.get_modified_attributes(value, desired[key])
                    if modified_dict:
                        modified[key] = modified_dict
                else:
                    try:
                        result = cmp(value, desired[key])
                    except TypeError as exc:
                        raise TypeError("%s, key: %s, value: %s, desired: %s" % (repr(exc), key, repr(value), repr(desired[key])))
                    else:
                        if result != 0:
                            modified[key] = desired[key]
        if modified:
            self.changed = True
        return modified

    @staticmethod
    def compare_lists(current, desired, get_list_diff):
        ''' compares two lists and return a list of elements that are either the desired elements or elements that are
            modified from the current state depending on the get_list_diff flag
            :param: current: current item attribute in ONTAP
            :param: desired: attributes from playbook
            :param: get_list_diff: specifies whether to have a diff of desired list w.r.t current list for an attribute
            :return: list of attributes to be modified
            :rtype: list
        '''
        current_copy = deepcopy(current)
        desired_copy = deepcopy(desired)

        # get what in desired and not in current
        desired_diff_list = list()
        for item in desired:
            if item in current_copy:
                current_copy.remove(item)
            else:
                desired_diff_list.append(item)

        # get what in current but not in desired
        current_diff_list = []
        for item in current:
            if item in desired_copy:
                desired_copy.remove(item)
            else:
                current_diff_list.append(item)

        if desired_diff_list or current_diff_list:
            # there are changes
            if get_list_diff:
                return desired_diff_list
            else:
                return desired
        else:
            return None

    @staticmethod
    def convert_module_args_to_api(parameters, exclusion=None):
        '''
        Convert a list of string module args to API option format.
        For example, convert test_option to testOption.
        :param parameters: dict of parameters to be converted.
        :param exclusion: list of parameters to be ignored.
        :return: dict of key value pairs.
        '''
        exclude_list = ['api_url', 'token_type', 'refresh_token', 'sa_secret_key', 'sa_client_id']
        if exclusion is not None:
            exclude_list += exclusion
        api_keys = {}
        for k, v in parameters.items():
            if k not in exclude_list:
                words = k.split("_")
                api_key = ""
                for word in words:
                    if len(api_key) > 0:
                        word = word.title()
                    api_key += word
                api_keys[api_key] = v
        return api_keys

    @staticmethod
    def convert_data_to_tabbed_jsonstring(data):
        '''
        Convert a dictionary data to json format string
        '''
        dump = json.dumps(data, indent=2, separators=(',', ': '))
        return re.sub(
            '\n +',
            lambda match: '\n' + '\t' * int(len(match.group().strip('\n')) / 2),
            dump,
        )

    @staticmethod
    def encode_certificates(certificate_file):
        '''
        Read certificate file and encode it
        '''
        try:
            with open(certificate_file, mode='rb') as fh:
                cert = fh.read()
        except (OSError, IOError) as exc:
            return None, str(exc)
        if not cert:
            return None, "Error: file is empty"
        return base64.b64encode(cert).decode('utf-8'), None

    @staticmethod
    def get_occm_agents_by_account(rest_api, account_id):
        """
        Collect a list of agents matching account_id.
        :return: list of agents, error
        """
        params = {'account_id': account_id}
        api = "/agents-mgmt/agent"
        headers = {
            "X-User-Token": rest_api.token_type + " " + rest_api.token,
        }
        agents, error, dummy = rest_api.get(api, header=headers, params=params)
        return agents, error

    def get_occm_agents_by_name(self, rest_api, account_id, name, provider):
        """
        Collect a list of agents matching account_id, name, and provider.
        :return: list of agents, error
        """
        # I tried to query by name and provider in addition to account_id, but it returned everything
        agents, error = self.get_occm_agents_by_account(rest_api, account_id)
        if isinstance(agents, dict) and 'agents' in agents:
            agents = [agent for agent in agents['agents'] if agent['name'] == name and agent['provider'] == provider]
        return agents, error

    def get_agents_info(self, rest_api, headers):
        """
        Collect a list of agents matching account_id.
        :return: list of agents, error
        """
        account_id, error = self.get_account_id(rest_api)
        if error:
            return None, error
        agents, error = self.get_occm_agents_by_account(rest_api, account_id)
        return agents, error

    def get_active_agents_info(self, rest_api, headers):
        """
        Collect a list of agents matching account_id.
        :return: list of agents, error
        """
        clients = []
        account_id, error = self.get_account_id(rest_api)
        if error:
            return None, error
        agents, error = self.get_occm_agents_by_account(rest_api, account_id)
        if isinstance(agents, dict) and 'agents' in agents:
            agents = [agent for agent in agents['agents'] if agent['status'] == 'active']
            clients = [{'name': agent['name'], 'client_id': agent['agentId'], 'provider': agent['provider']} for agent in agents]
        return clients, error

    @staticmethod
    def get_occm_agent_by_id(rest_api, client_id):
        """
        Fetch OCCM agent given its client id
        :return: agent details, error
        """
        api = "/agents-mgmt/agent/" + rest_api.format_client_id(client_id)
        headers = {
            "X-User-Token": rest_api.token_type + " " + rest_api.token,
        }
        response, error, dummy = rest_api.get(api, header=headers)
        if isinstance(response, dict) and 'agent' in response:
            agent = response['agent']
            return agent, error
        return response, error

    @staticmethod
    def check_occm_status(rest_api, client_id):
        """
        Check OCCM status
        :return: status
        DEPRECATED - use get_occm_agent_by_id but the retrun value format is different!
        """

        api = "/agents-mgmt/agent/" + rest_api.format_client_id(client_id)
        headers = {
            "X-User-Token": rest_api.token_type + " " + rest_api.token,
        }
        occm_status, error, dummy = rest_api.get(api, header=headers)
        return occm_status, error

    def register_agent_to_service(self, rest_api, provider, vpc):
        '''
        register agent to service
        '''
        api = '/agents-mgmt/connector-setup'

        headers = {
            "X-User-Token": rest_api.token_type + " " + rest_api.token,
        }
        body = {
            "accountId": self.parameters['account_id'],
            "name": self.parameters['name'],
            "company": self.parameters['company'],
            "placement": {
                "provider": provider,
                "region": self.parameters['region'],
                "network": vpc,
                "subnet": self.parameters['subnet_id'],
            },
            "extra": {
                "proxy": {
                    "proxyUrl": self.parameters.get('proxy_url'),
                    "proxyUserName": self.parameters.get('proxy_user_name'),
                    "proxyPassword": self.parameters.get('proxy_password'),
                }
            }
        }

        if provider == "AWS":
            body['placement']['network'] = vpc

        response, error, dummy = rest_api.post(api, body, header=headers)
        return response, error

    def delete_occm(self, rest_api, client_id):
        '''
        delete occm
        '''
        api = '/agents-mgmt/agent/' + rest_api.format_client_id(client_id)
        headers = {
            "X-User-Token": rest_api.token_type + " " + rest_api.token,
            "X-Tenancy-Account-Id": self.parameters['account_id'],
        }

        occm_status, error, dummy = rest_api.delete(api, None, header=headers)
        return occm_status, error

    def delete_occm_agents(self, rest_api, agents):
        '''
        delete a list of occm
        '''
        results = []
        for agent in agents:
            if 'agentId' in agent:
                occm_status, error = self.delete_occm(rest_api, agent['agentId'])
            else:
                occm_status, error = None, 'unexpected agent contents: %s' % repr(agent)
            if error:
                results.append((occm_status, error))
        return results

    @staticmethod
    def call_parameters():
        return """
        {
            "location": {
                "value": "string"
            },
            "virtualMachineName": {
                "value": "string"
            },
            "virtualMachineSize": {
                "value": "string"
            },
            "networkSecurityGroupName": {
                "value": "string"
            },
            "adminUsername": {
                "value": "string"
            },
            "virtualNetworkId": {
                "value": "string"
            },
            "adminPassword": {
                "value": "string"
            },
            "subnetId": {
                "value": "string"
            },
            "customData": {
                "value": "string"
            },
            "environment": {
                "value": "prod"
            },
            "storageAccount": {
                "value": "string"
            }
        }
        """

    @staticmethod
    def call_template():
        return """
        {
        "$schema": "http://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#",
        "contentVersion": "1.0.0.0",
        "parameters": {
            "location": {
                "type": "string",
                "defaultValue": "eastus"
            },
            "virtualMachineName": {
                "type": "string"
            },
            "virtualMachineSize":{
                "type": "string"
            },
            "adminUsername": {
                "type": "string"
            },
            "virtualNetworkId": {
                "type": "string"
            },
            "networkSecurityGroupName": {
                "type": "string"
            },
            "adminPassword": {
                "type": "securestring"
            },
            "subnetId": {
                "type": "string"
            },
            "customData": {
                "type": "string"
            },
            "environment": {
                "type": "string",
                "defaultValue": "prod"
            },
            "storageAccount": {
                "type": "string"
            }
        },
        "variables": {
            "vnetId": "[parameters('virtualNetworkId')]",
            "subnetRef": "[parameters('subnetId')]",
            "networkInterfaceName": "[concat(parameters('virtualMachineName'),'-nic')]",
            "diagnosticsStorageAccountName": "[parameters('storageAccount')]",
            "diagnosticsStorageAccountId": "[concat('Microsoft.Storage/storageAccounts/', variables('diagnosticsStorageAccountName'))]",
            "diagnosticsStorageAccountType": "Standard_LRS",
            "publicIpAddressName": "[concat(parameters('virtualMachineName'),'-ip')]",
            "publicIpAddressType": "Dynamic",
            "publicIpAddressSku": "Basic",
            "msiExtensionName": "ManagedIdentityExtensionForLinux",
            "occmOffer": "[if(equals(parameters('environment'), 'stage'), 'netapp-oncommand-cloud-manager-staging-preview', 'netapp-oncommand-cloud-manager')]"
        },
        "resources": [
            {
                "name": "[parameters('virtualMachineName')]",
                "type": "Microsoft.Compute/virtualMachines",
                "apiVersion": "2018-04-01",
                "location": "[parameters('location')]",
                "dependsOn": [
                    "[concat('Microsoft.Network/networkInterfaces/', variables('networkInterfaceName'))]",
                    "[concat('Microsoft.Storage/storageAccounts/', variables('diagnosticsStorageAccountName'))]"
                ],
                "properties": {
                    "osProfile": {
                        "computerName": "[parameters('virtualMachineName')]",
                        "adminUsername": "[parameters('adminUsername')]",
                        "adminPassword": "[parameters('adminPassword')]",
                        "customData": "[base64(parameters('customData'))]"
                    },
                    "hardwareProfile": {
                        "vmSize": "[parameters('virtualMachineSize')]"
                    },
                    "storageProfile": {
                        "imageReference": {
                            "publisher": "netapp",
                            "offer": "[variables('occmOffer')]",
                            "sku": "occm-byol",
                            "version": "latest"
                        },
                        "osDisk": {
                            "createOption": "fromImage",
                            "managedDisk": {
                                "storageAccountType": "Premium_LRS"
                            }
                        },
                        "dataDisks": []
                    },
                    "networkProfile": {
                        "networkInterfaces": [
                            {
                                "id": "[resourceId('Microsoft.Network/networkInterfaces', variables('networkInterfaceName'))]"
                            }
                        ]
                    },
                    "diagnosticsProfile": {
                      "bootDiagnostics": {
                        "enabled": true,
                        "storageUri":
                          "[concat('https://', variables('diagnosticsStorageAccountName'), '.blob.core.windows.net/')]"
                      }
                    }
                },
                "plan": {
                    "name": "occm-byol",
                    "publisher": "netapp",
                    "product": "[variables('occmOffer')]"
                },
                "identity": {
                    "type": "systemAssigned"
                }
            },
            {
                "apiVersion": "2017-12-01",
                "type": "Microsoft.Compute/virtualMachines/extensions",
                "name": "[concat(parameters('virtualMachineName'),'/', variables('msiExtensionName'))]",
                "location": "[parameters('location')]",
                "dependsOn": [
                    "[concat('Microsoft.Compute/virtualMachines/', parameters('virtualMachineName'))]"
                ],
                "properties": {
                    "publisher": "Microsoft.ManagedIdentity",
                    "type": "[variables('msiExtensionName')]",
                    "typeHandlerVersion": "1.0",
                    "autoUpgradeMinorVersion": true,
                    "settings": {
                        "port": 50342
                    }
                }
            },
            {
                "name": "[variables('diagnosticsStorageAccountName')]",
                "type": "Microsoft.Storage/storageAccounts",
                "apiVersion": "2015-06-15",
                "location": "[parameters('location')]",
                "properties": {
                  "accountType": "[variables('diagnosticsStorageAccountType')]"
                }
            },
            {
                "name": "[variables('networkInterfaceName')]",
                "type": "Microsoft.Network/networkInterfaces",
                "apiVersion": "2018-04-01",
                "location": "[parameters('location')]",
                "dependsOn": [
                    "[concat('Microsoft.Network/publicIpAddresses/', variables('publicIpAddressName'))]"
                ],
                "properties": {
                    "ipConfigurations": [
                        {
                            "name": "ipconfig1",
                            "properties": {
                                "subnet": {
                                    "id": "[variables('subnetRef')]"
                                },
                                "privateIPAllocationMethod": "Dynamic",
                                "publicIpAddress": {
                                    "id": "[resourceId(resourceGroup().name,'Microsoft.Network/publicIpAddresses', variables('publicIpAddressName'))]"
                                }
                            }
                        }
                    ],
                    "networkSecurityGroup": {
                        "id": "[parameters('networkSecurityGroupName')]"
                    }
                }
            },
            {
                "name": "[variables('publicIpAddressName')]",
                "type": "Microsoft.Network/publicIpAddresses",
                "apiVersion": "2017-08-01",
                "location": "[parameters('location')]",
                "properties": {
                    "publicIpAllocationMethod": "[variables('publicIpAddressType')]"
                },
                "sku": {
                    "name": "[variables('publicIpAddressSku')]"
                }
            }
        ],
        "outputs": {
            "publicIpAddressName": {
                "type": "string",
                "value": "[variables('publicIpAddressName')]"
            }
        }
    }
    """

    def get_tenant(self, rest_api, headers):
        """
        Get workspace ID (tenant)
        """
        api = '/occm/api/tenants'
        response, error, dummy = rest_api.get(api, header=headers)
        if error is not None:
            return None, 'Error: unexpected response on getting tenant for cvo: %s, %s' % (str(error), str(response))

        return response[0]['publicId'], None

    def get_nss(self, rest_api, headers):
        """
        Get nss account
        """
        api = '/occm/api/accounts'
        response, error, dummy = rest_api.get(api, header=headers)
        if error is not None:
            return None, 'Error: unexpected response on getting nss for cvo: %s, %s' % (str(error), str(response))

        if len(response['nssAccounts']) == 0:
            return None, "Error: could not find any NSS account"

        return response['nssAccounts'][0]['publicId'], None

    def get_working_environment_property(self, rest_api, headers, fields):
        # GET /vsa/working-environments/{workingEnvironmentId}?fields=status,awsProperties,ontapClusterProperties
        api = '%s/working-environments/%s' % (rest_api.api_root_path, self.parameters['working_environment_id'])
        params = {'fields': ','.join(fields)}
        response, error, dummy = rest_api.get(api, params=params, header=headers)
        if error:
            return None, "Error: get_working_environment_property %s" % error
        return response, None

    def user_tag_key_unique(self, tag_list, key_name):
        checked_keys = []
        for t in tag_list:
            if t[key_name] in checked_keys:
                return False, 'Error: %s %s must be unique' % (key_name, t[key_name])
            else:
                checked_keys.append(t[key_name])
        return True, None

    def current_label_exist(self, current, desired, is_ha=False):
        current_key_set = set(current.keys())
        # Ignore auto generated gcp label in CVO GCP HA
        current_key_set.discard('gcp_resource_id')
        current_key_set.discard('count-down')
        if is_ha:
            current_key_set.discard('partner-platform-serial-number')
        # python 2.6 doe snot support set comprehension
        desired_keys = set([a_dict['label_key'] for a_dict in desired])
        if current_key_set.issubset(desired_keys):
            return True, None
        else:
            return False, 'Error: label_key %s in gcp_label cannot be removed' % str(current_key_set)

    def is_label_value_changed(self, current_tags, desired_tags):
        tag_keys = list(current_tags.keys())
        user_tag_keys = [key for key in tag_keys if
                         key not in ('count-down', 'gcp_resource_id', 'partner-platform-serial-number')]
        desired_keys = [a_dict['label_key'] for a_dict in desired_tags]
        if user_tag_keys == desired_keys:
            for tag in desired_tags:
                if current_tags[tag['label_key']] != tag['label_value']:
                    return True
            return False
        else:
            return True

    def compare_gcp_labels(self, current_tags, user_tags, is_ha):
        '''
        Update user-tag API behaves differently in GCP CVO.
        It only supports adding gcp_labels and modifying the values of gcp_labels. Removing gcp_label is not allowed.
        '''
        # check if any current gcp_labels are going to be removed or not
        # gcp HA has one extra gcp_label created automatically
        resp, error = self.user_tag_key_unique(user_tags, 'label_key')
        if error is not None:
            return None, error
        # check if any current key labels are in the desired key labels
        resp, error = self.current_label_exist(current_tags, user_tags, is_ha)
        if error is not None:
            return None, error
        if self.is_label_value_changed(current_tags, user_tags):
            return True, None
        else:
            # no change
            return None, None

    def compare_cvo_tags_labels(self, current_tags, user_tags):
        '''
        Compare exiting tags/labels and user input tags/labels to see if there is a change
        gcp_labels: label_key, label_value
        aws_tag/azure_tag: tag_key, tag_label
        '''
        # azure has one extra azure_tag DeployedByOccm created automatically and it cannot be modified.
        tag_keys = list(current_tags.keys())
        user_tag_keys = [key for key in tag_keys if key != 'DeployedByOccm']
        current_len = len(user_tag_keys)
        resp, error = self.user_tag_key_unique(user_tags, 'tag_key')
        if error is not None:
            return None, error
        if len(user_tags) != current_len:
            return True, None
        # Check if tags/labels of desired configuration in current working environment
        for item in user_tags:
            if item['tag_key'] in current_tags and item['tag_value'] != current_tags[item['tag_key']]:
                return True, None
            elif item['tag_key'] not in current_tags:
                return True, None
        return False, None

    def is_cvo_tags_changed(self, rest_api, headers, parameters, tag_name):
        '''
        Since tags/laabels are CVO optional parameters, this function needs to cover with/without tags/labels on both lists
        '''
        # get working environment details by working environment ID
        current, error = self.get_working_environment_details(rest_api, headers)
        if error is not None:
            return None, 'Error:  Cannot find working environment %s error: %s' % (self.parameters['working_environment_id'], str(error))
        self.set_api_root_path(current, rest_api)
        # compare tags
        # no tags in current cvo
        if 'userTags' not in current or len(current['userTags']) == 0:
            return tag_name in parameters, None

        if tag_name == 'gcp_labels':
            if tag_name in parameters:
                return self.compare_gcp_labels(current['userTags'], parameters[tag_name], current['isHA'])
            # if both are empty, no need to update
            # Ignore auto generated gcp label in CVO GCP
            # 'count-down', 'gcp_resource_id', and 'partner-platform-serial-number'(HA)
            tag_keys = list(current['userTags'].keys())
            user_tag_keys = [key for key in tag_keys if key not in ('count-down', 'gcp_resource_id', 'partner-platform-serial-number')]
            if not user_tag_keys:
                return False, None
            else:
                return None, 'Error:  Cannot remove current gcp_labels'
        # no tags in input parameters
        if tag_name not in parameters:
            return True, None
        else:
            # has tags in input parameters and existing CVO
            return self.compare_cvo_tags_labels(current['userTags'], parameters[tag_name])

    def get_license_type(self, rest_api, headers, provider, region, instance_type, ontap_version, license_name):
        # Permutation query example:
        # aws: /metadata/permutations?region=us-east-1&instance_type=m5.xlarge&version=ONTAP-9.10.1.T1
        # azure: /metadata/permutations?region=westus&instance_type=Standard_E4s_v3&version=ONTAP-9.10.1.T1.azure
        # gcp: /metadata/permutations?region=us-east1&instance_type=n2-standard-4&version=ONTAP-9.10.1.T1.gcp
        # The examples of the ontapVersion in ontapClusterProperties response:
        # AWS for both single and HA: 9.10.1RC1, 9.8
        # AZURE single: 9.10.1RC1.T1.azure. For HA: 9.10.1RC1.T1.azureha
        # GCP for both single and HA: 9.10.1RC1.T1, 9.8.T1
        # To be used in permutation:
        # AWS ontap_version format: ONTAP-x.x.x.T1 or ONTAP-x.x.x.T1.ha for Ha
        # AZURE ontap_version format: ONTAP-x.x.x.T1.azure or ONTAP-x.x.x.T1.azureha for HA
        # GCP ontap_version format: ONTAP-x.x.x.T1.gcp or ONTAP-x.x.x.T1.gcpha for HA
        version = 'ONTAP-' + ontap_version
        if provider == 'aws':
            version += '.T1.ha' if self.parameters['is_ha'] else '.T1'
        elif provider == 'gcp':
            version += '.T1' if not ontap_version.endswith('T1') else ''
            version += '.gcpha' if self.parameters['is_ha'] else '.gcp'
        api = '%s/metadata/permutations' % rest_api.api_root_path
        params = {'region': region,
                  'version': version,
                  'instance_type': instance_type
                  }
        response, error, dummy = rest_api.get(api, params=params, header=headers)
        if error:
            return None, "Error: get_license_type %s %s" % (response, error)
        for item in response:
            if item['license']['name'] == license_name:
                return item['license']['type'], None

        return None, "Error: get_license_type cannot get license type %s" % response

    def get_modify_cvo_params(self, rest_api, headers, desired, provider):
        modified = []
        if desired['update_svm_password']:
            modified = ['svm_password']
        # Get current working environment property
        properties = ['status', 'ontapClusterProperties.fields(upgradeVersions)']
        # instanceType in aws case is stored in awsProperties['instances'][0]['instanceType']
        if provider == 'aws':
            properties.append('awsProperties')
        else:
            properties.append('providerProperties')

        we, err = self.get_working_environment_property(rest_api, headers, properties)

        if err is not None:
            return None, err

        if we['status'] is None or we['status']['status'] != 'ON':
            return None, "Error: get_modify_cvo_params working environment %s status is not ON. Operation cannot be performed." % we['publicId']

        tier_level = None
        if we['ontapClusterProperties']['capacityTierInfo'] is not None:
            tier_level = we['ontapClusterProperties']['capacityTierInfo']['tierLevel']

        # collect changed attributes
        if tier_level is not None and tier_level != desired['tier_level']:
            if provider == 'azure':
                if desired['capacity_tier'] == 'Blob':
                    modified.append('tier_level')
            elif provider == 'aws':
                if desired['capacity_tier'] == 'S3':
                    modified.append('tier_level')
            elif provider == 'gcp':
                if desired['capacity_tier'] == 'cloudStorage':
                    modified.append('tier_level')

        if 'svm_name' in desired and we['svmName'] != desired['svm_name']:
            modified.append('svm_name')

        if 'writing_speed_state' in desired:
            if we['ontapClusterProperties']['writingSpeedState'] != desired['writing_speed_state'].upper():
                modified.append('writing_speed_state')

        if provider == 'aws':
            current_instance_type = we['awsProperties']['instances'][0]['instanceType']
            region = we['awsProperties']['regionName']
        else:
            current_instance_type = we['providerProperties']['instanceType']
            region = we['providerProperties']['regionName']

        if current_instance_type != desired['instance_type']:
            modified.append('instance_type')

        # check if license type is changed
        current_license_type, error = self.get_license_type(rest_api, headers, provider, region, current_instance_type,
                                                            we['ontapClusterProperties']['ontapVersion'],
                                                            we['ontapClusterProperties']['licenseType']['name'])
        if err is not None:
            return None, error
        if current_license_type != desired['license_type']:
            modified.append('license_type')

        if desired['upgrade_ontap_version'] is True:
            if desired['use_latest_version'] or desired['ontap_version'] == 'latest':
                return None, "Error: To upgrade ONTAP image, the ontap_version must be a specific version"
            current_version = 'ONTAP-' + we['ontapClusterProperties']['ontapVersion']
            if not desired['ontap_version'].startswith(current_version):
                if we['ontapClusterProperties']['upgradeVersions'] is not None:
                    available_versions = []
                    for image_info in we['ontapClusterProperties']['upgradeVersions']:
                        available_versions.append(image_info['imageVersion'])
                        # AWS ontap_version format: ONTAP-x.x.x.Tx or ONTAP-x.x.x.Tx.ha for Ha
                        # AZURE ontap_version format: ONTAP-x.x.x.Tx.azure or .azureha for HA
                        # GCP ontap_version format: ONTAP-x.x.x.Tx.gcp or .gcpha for HA
                        # Tx is not relevant for ONTAP version. But it is needed for the CVO creation
                        # upgradeVersion imageVersion format: ONTAP-x.x.x
                        if desired['ontap_version'].startswith(image_info['imageVersion']):
                            modified.append('ontap_version')
                            break
                    else:
                        return None, "Error: No ONTAP image available for version %s. Available versions: %s" % (desired['ontap_version'], available_versions)

        tag_name = {
            'aws': 'aws_tag',
            'azure': 'azure_tag',
            'gcp': 'gcp_labels'
        }

        need_change, error = self.is_cvo_tags_changed(rest_api, headers, desired, tag_name[provider])
        if error is not None:
            return None, error
        if need_change:
            modified.append(tag_name[provider])

        # The updates of followings are not supported. Will response failure.
        for key, value in desired.items():
            if key == 'project_id' and we['providerProperties']['projectName'] != value:
                modified.append('project_id')
            if key == 'zone' and we['providerProperties']['zoneName'][0] != value:
                modified.append('zone')
            if key == 'cidr' and we['providerProperties']['vnetCidr'] != value:
                modified.append('cidr')
            if key == 'location' and we['providerProperties']['regionName'] != value:
                modified.append('location')
            if key == 'availability_zone' and we['providerProperties']['availabilityZone'] != value:
                modified.append('availability_zone')

        if modified:
            self.changed = True
        return modified, None

    def is_cvo_update_needed(self, rest_api, headers, parameters, changeable_params, provider):
        modify, error = self.get_modify_cvo_params(rest_api, headers, parameters, provider)
        if error is not None:
            return None, error
        unmodifiable = [attr for attr in modify if attr not in changeable_params]
        if unmodifiable:
            return None, "%s cannot be modified." % str(unmodifiable)

        return modify, None

    def wait_cvo_update_complete(self, rest_api, headers):
        retry_count = 65
        if self.parameters['is_ha'] is True:
            retry_count *= 2
        for count in range(retry_count):
            # get CVO status
            we, err = self.get_working_environment_property(rest_api, headers, ['status'])
            if err is not None:
                return False, 'Error: get_working_environment_property failed: %s' % (str(err))
            if we['status']['status'] != "UPDATING":
                return True, None
            time.sleep(60)

        return False, 'Error: Taking too long for CVO to be active after update or not properly setup'

    def update_cvo_tags(self, api_root, rest_api, headers, tag_name, tag_list):
        body = {}
        tags = []
        if tag_list is not None:
            for tag in tag_list:
                atag = {
                    'tagKey': tag['label_key'] if tag_name == "gcp_labels" else tag['tag_key'],
                    'tagValue': tag['label_value'] if tag_name == "gcp_labels" else tag['tag_value']
                }
                tags.append(atag)
        body['tags'] = tags

        response, err, dummy = rest_api.put(api_root + "user-tags", body, header=headers)
        if err is not None:
            return False, 'Error: unexpected response on modifying tags: %s, %s' % (str(err), str(response))

        return True, None

    def update_svm_password(self, api_root, rest_api, headers, svm_password):
        body = {'password': svm_password}
        response, err, dummy = rest_api.put(api_root + "set-password", body, header=headers)
        if err is not None:
            return False, 'Error: unexpected response on modifying svm_password: %s, %s' % (str(err), str(response))

        return True, None

    def update_svm_name(self, api_root, rest_api, headers, svm_name):
        # get current svmName
        we, err = self.get_working_environment_property(rest_api, headers, ['ontapClusterProperties.fields(upgradeVersions)'])
        if err is not None:
            return False, 'Error: get_working_environment_property failed: %s' % (str(err))
        body = {'svmNewName': svm_name,
                'svmName': we['svmName']}
        response, err, dummy = rest_api.put(api_root + "svm", body, header=headers)
        if err is not None:
            return False, "update svm_name error"
        return True, None

    def update_tier_level(self, api_root, rest_api, headers, tier_level):
        body = {'level': tier_level}
        response, err, dummy = rest_api.post(api_root + "change-tier-level", body, header=headers)
        if err is not None:
            return False, 'Error: unexpected response on modify tier_level: %s, %s' % (str(err), str(response))

        return True, None

    def update_writing_speed_state(self, api_root, rest_api, headers, writing_speed_state):
        body = {'writingSpeedState': writing_speed_state.upper()}
        response, err, dummy = rest_api.put(api_root + "writing-speed", body, header=headers)
        if err is not None:
            return False, 'Error: unexpected response on modify writing_speed_state: %s, %s' % (str(err), str(response))
        # check upgrade status
        dummy, err = self.wait_cvo_update_complete(rest_api, headers)
        return err is None, err

    def update_instance_license_type(self, api_root, rest_api, headers, instance_type, license_type):
        body = {'instanceType': instance_type,
                'licenseType': license_type}
        response, err, dummy = rest_api.put(api_root + "license-instance-type", body, header=headers)
        if err is not None:
            return False, 'Error: unexpected response on modify instance_type and license_type: %s, %s' % (str(err), str(response))
        # check upgrade status
        dummy, err = self.wait_cvo_update_complete(rest_api, headers)
        return err is None, err

    def set_config_flag(self, rest_api, headers):
        body = {'value': True, 'valueType': 'BOOLEAN'}
        base_url = '/occm/api/occm/config/skip-eligibility-paygo-upgrade'
        response, err, dummy = rest_api.put(base_url, body, header=headers)
        if err is not None:
            return False, "set_config_flag error"

        return True, None

    def do_ontap_image_upgrade(self, rest_api, headers, desired):
        # get ONTAP image version
        we, err = self.get_working_environment_property(rest_api, headers, ['ontapClusterProperties.fields(upgradeVersions)'])
        if err is not None:
            return False, 'Error: get_working_environment_property failed: %s' % (str(err))
        body = {'updateType': "OCCM_PROVIDED"}
        for image_info in we['ontapClusterProperties']['upgradeVersions']:
            if image_info['imageVersion'] in desired:
                body['updateParameter'] = image_info['imageVersion']
                break
        # upgrade
        base_url = "%s/working-environments/%s/update-image" % (rest_api.api_root_path, self.parameters['working_environment_id'])
        response, err, dummy = rest_api.post(base_url, body, header=headers)
        if err is not None:
            return False, 'Error: unexpected response on do_ontap_image_upgrade: %s, %s' % (str(err), str(response))
        else:
            return True, None

    def wait_ontap_image_upgrade_complete(self, rest_api, headers, desired):
        retry_count = 65
        if self.parameters['is_ha'] is True:
            retry_count *= 2
        for count in range(retry_count):
            # get CVO status
            we, err = self.get_working_environment_property(rest_api, headers, ['status', 'ontapClusterProperties'])
            if err is not None:
                return False, 'Error: get_working_environment_property failed: %s' % (str(err))
            if we['status']['status'] != "UPDATING" and we['ontapClusterProperties']['ontapVersion'] != "":
                if we['ontapClusterProperties']['ontapVersion'] in desired:
                    return True, None
            time.sleep(60)

        return False, 'Error: Taking too long for CVO to be active or not properly setup'

    def upgrade_ontap_image(self, rest_api, headers, desired):
        # set flag
        dummy, err = self.set_config_flag(rest_api, headers)
        if err is not None:
            return False, err
        # upgrade
        dummy, err = self.do_ontap_image_upgrade(rest_api, headers, desired)
        if err is not None:
            return False, err
        # check upgrade status
        dummy, err = self.wait_ontap_image_upgrade_complete(rest_api, headers, desired)
        return err is None, err