Module cvpysdk.instances.virtualserver.azure_resource_manager

File for operating on a Virtual Server Azure Resource Manager Instance.

AzureResoureceManagerInstance is the only class defined in this file.

AzureResoureceManagerInstance: Derived class from VirtualServer Base class, representing a Azure Resource Manager instance, and to perform operations on that instance

__init__(self, agent,_name,iid)      --     initialize object of azure RM
                                        Instance object associated with the
                                        VirtualServer Instance

_get_instance_properties()     --  VirtualServer Instance class method
                                    overwritten to get azure RM
                                    Specific instance properties as well

    _get_instance_properties_json()                 --  get the all instance related
                                                                                                            properties of this subclient.
Expand source code Browse git
# -*- coding: utf-8 -*-

# --------------------------------------------------------------------------
# Copyright Commvault Systems, Inc.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#     http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
# --------------------------------------------------------------------------

"""File for operating on a Virtual Server Azure Resource Manager Instance.

AzureResoureceManagerInstance is the only class defined in this file.

AzureResoureceManagerInstance: Derived class from VirtualServer
                            Base class, representing a Azure Resource Manager
                            instance, and to perform operations on that
                            instance

    __init__(self, agent,_name,iid)      --     initialize object of azure RM
                                            Instance object associated with the
                                            VirtualServer Instance              

    _get_instance_properties()     --  VirtualServer Instance class method
                                        overwritten to get azure RM
                                        Specific instance properties as well

        _get_instance_properties_json()                 --  get the all instance related
                                                                                                                properties of this subclient.

"""

from ..vsinstance import VirtualServerInstance
from ...exception import SDKException
from ...instance import Instance

class AzureRMInstance(VirtualServerInstance):

    '''
    AzureResoureceManagerInstance:

        __init__(agent_object,instance_name,instance_id)    --  initialize object
    of azure resource manager Instance object associated with
                the VirtualServer Instance
    '''

    def __init__(self, agent, name, iid):
        """Initialize the Instance object for the given Virtual Server instance.

            Args:
                class_object (agent_object,instance_name,instance_id)  --  instance of the
                                                                                Agent class,
                                                                                instance name,
                                                                                instance id

        """


        super(VirtualServerInstance, self).__init__(agent, name, iid)
        self._vendor_id = 7
        self._subscription_id = None



    def  _get_instance_properties(self):
        """
        Get the properties of this instance

        Raise:
            SDK Exception:
                if response is not empty
                if response is not success
        """

        super(AzureRMInstance, self)._get_instance_properties()
        self._server_name = []
        if 'virtualServerInstance' in self._properties:
            if self._properties["virtualServerInstance"]["associatedClients"].get("memberServers"):
                _member_servers = self._properties["virtualServerInstance"] \
                                                ["associatedClients"]["memberServers"]
            else:
                _member_servers=[]
            for _each_client in _member_servers:
                client = _each_client['client']
                if 'clientName' in client.keys():
                    self._server_name.append(str(client['clientName']))
        # waiting for praveen form


    def _get_instance_properties_json(self):
        """get the all instance related properties of this subclient.

          Returns:
               dict - all instance properties put inside a dict

        """
        instance_json = {
            "instanceProperties":{
                "isDeleted": False,
                "instance": self._instance,
                "instanceActivityControl": self._instanceActivityControl,
                "virtualServerInstance": {
                    "vsInstanceType": self._virtualserverinstance['vsInstanceType'],
                    "associatedClients": self._virtualserverinstance['associatedClients'],
                    "vmwareVendor": {}
                    }
                       }
               }
        return instance_json

    def _get_application_properties(self):
        """
            Get the properties of this instance

            Raise:
                SDK Exception:
                    if response is not empty
                    if response is not success
        """
        super(AzureRMInstance, self)._get_application_properties()
        if 'azureResourceManager' in self._application_properties:
            self._subscription_id = self._application_properties['azureResourceManager']['subscriptionId']

    def _update_azure_credentials(self, credential_id, credential_name=None, usemanaged_identity=False):
        """
        To update the credentials in azure hypervisor
        Args:
                credential_id (int)  --  Credential ID to update in hypervisor
                credential_name(str) -- Credential name to update in hypervisor
                usemanaged_identity( bool) -- to use managed identity
        """

        self._get_application_properties()

        self._credential_json = {
            "hypervisorType": self._vendor_id,
            "skipCredentialValidation": False,
            "credentials": {
                "id": credential_id,
                "name": credential_name
            },
            "subscriptionId": self._subscription_id,
         "useManagedIdentity": usemanaged_identity
        }

        super(AzureRMInstance, self)._update_hypervisor_credentials(self._credential_json)


    @property
    def server_name(self):
        """getter for the domain name in the Hyper-V json"""
        return self._server_name

    @property
    def server_host_name(self):
        """getter for the domain name in the vmware vendor json"""
        return self._server_name
    #return self._server_name
    # TODO will change with Praveen Form(jmalik)

Classes

class AzureRMInstance (agent, name, iid)

Azureresourecemanagerinstance

init(agent_object,instance_name,instance_id) – initialize object of azure resource manager Instance object associated with the VirtualServer Instance

Initialize the Instance object for the given Virtual Server instance.

Args

class_object (agent_object,instance_name,instance_id) – instance of the Agent class, instance name, instance id

Expand source code Browse git
class AzureRMInstance(VirtualServerInstance):

    '''
    AzureResoureceManagerInstance:

        __init__(agent_object,instance_name,instance_id)    --  initialize object
    of azure resource manager Instance object associated with
                the VirtualServer Instance
    '''

    def __init__(self, agent, name, iid):
        """Initialize the Instance object for the given Virtual Server instance.

            Args:
                class_object (agent_object,instance_name,instance_id)  --  instance of the
                                                                                Agent class,
                                                                                instance name,
                                                                                instance id

        """


        super(VirtualServerInstance, self).__init__(agent, name, iid)
        self._vendor_id = 7
        self._subscription_id = None



    def  _get_instance_properties(self):
        """
        Get the properties of this instance

        Raise:
            SDK Exception:
                if response is not empty
                if response is not success
        """

        super(AzureRMInstance, self)._get_instance_properties()
        self._server_name = []
        if 'virtualServerInstance' in self._properties:
            if self._properties["virtualServerInstance"]["associatedClients"].get("memberServers"):
                _member_servers = self._properties["virtualServerInstance"] \
                                                ["associatedClients"]["memberServers"]
            else:
                _member_servers=[]
            for _each_client in _member_servers:
                client = _each_client['client']
                if 'clientName' in client.keys():
                    self._server_name.append(str(client['clientName']))
        # waiting for praveen form


    def _get_instance_properties_json(self):
        """get the all instance related properties of this subclient.

          Returns:
               dict - all instance properties put inside a dict

        """
        instance_json = {
            "instanceProperties":{
                "isDeleted": False,
                "instance": self._instance,
                "instanceActivityControl": self._instanceActivityControl,
                "virtualServerInstance": {
                    "vsInstanceType": self._virtualserverinstance['vsInstanceType'],
                    "associatedClients": self._virtualserverinstance['associatedClients'],
                    "vmwareVendor": {}
                    }
                       }
               }
        return instance_json

    def _get_application_properties(self):
        """
            Get the properties of this instance

            Raise:
                SDK Exception:
                    if response is not empty
                    if response is not success
        """
        super(AzureRMInstance, self)._get_application_properties()
        if 'azureResourceManager' in self._application_properties:
            self._subscription_id = self._application_properties['azureResourceManager']['subscriptionId']

    def _update_azure_credentials(self, credential_id, credential_name=None, usemanaged_identity=False):
        """
        To update the credentials in azure hypervisor
        Args:
                credential_id (int)  --  Credential ID to update in hypervisor
                credential_name(str) -- Credential name to update in hypervisor
                usemanaged_identity( bool) -- to use managed identity
        """

        self._get_application_properties()

        self._credential_json = {
            "hypervisorType": self._vendor_id,
            "skipCredentialValidation": False,
            "credentials": {
                "id": credential_id,
                "name": credential_name
            },
            "subscriptionId": self._subscription_id,
         "useManagedIdentity": usemanaged_identity
        }

        super(AzureRMInstance, self)._update_hypervisor_credentials(self._credential_json)


    @property
    def server_name(self):
        """getter for the domain name in the Hyper-V json"""
        return self._server_name

    @property
    def server_host_name(self):
        """getter for the domain name in the vmware vendor json"""
        return self._server_name
    #return self._server_name
    # TODO will change with Praveen Form(jmalik)

Ancestors

Instance variables

var server_host_name

getter for the domain name in the vmware vendor json

Expand source code Browse git
@property
def server_host_name(self):
    """getter for the domain name in the vmware vendor json"""
    return self._server_name
var server_name

getter for the domain name in the Hyper-V json

Expand source code Browse git
@property
def server_name(self):
    """getter for the domain name in the Hyper-V json"""
    return self._server_name

Inherited members