Module cvpysdk.instances.virtualserver.azure_stack
File for operating on a Virtual Server Azure Stack Instance.
AzureStackInstance is the only class defined in this file.
AzureStackInstance: Derived class from VirtualServer Base class, representing a Azure Stack instance, and to perform operations on that instance
__init__(self, agent,_name,iid) -- initialize object of azure Stack
Instance object associated with the
VirtualServer Instance
_get_instance_properties() -- VirtualServer Instance class method
overwritten to get azure Stack
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 Stack Instance.
AzureStackInstance is the only class defined in this file.
AzureStackInstance: Derived class from VirtualServer
Base class, representing a Azure Stack
instance, and to perform operations on that
instance
__init__(self, agent,_name,iid) -- initialize object of azure Stack
Instance object associated with the
VirtualServer Instance
_get_instance_properties() -- VirtualServer Instance class method
overwritten to get azure Stack
Specific instance properties as well
_get_instance_properties_json() -- get the all instance related
properties of this subclient.
"""
from ..vsinstance import VirtualServerInstance
class AzureStackInstance(VirtualServerInstance):
"""Class for representing Azure stack instance of the Virtual Server agent"""
def __init__(self, agent, name, iid):
""" Initialize the Instance object for the given Virtual Server instance
Args:
agent (object) -- the instance of the agent class
name (str) -- the name of the instance
iid (int) -- the instance id
"""
self._subscriptionid = None
self._applicationid = None
self._server_name = []
self._vendor_id = 403
super(AzureStackInstance, self).__init__(agent, name, iid)
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(AzureStackInstance, self)._get_instance_properties()
if "vmwareVendor" in self._virtualserverinstance:
self._subscriptionid = self._virtualserverinstance['vmwareVendor'][
'virtualCenter']['domainName']
self._applicationid = self._virtualserverinstance['vmwareVendor'][
'virtualCenter']['userName']
if 'virtualServerInstance' in self._properties:
_member_servers = self._properties["virtualServerInstance"][
"associatedClients"]["memberServers"]
for _each_client in _member_servers:
client = _each_client['client']
if 'clientName' in client.keys():
self._server_name.append(str(client['clientName']))
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
@property
def server_host_name(self):
"""return the associated clients with the instance"""
return self._server_name
@property
def subscriptionid(self):
"""
returns the subcriptionID of the instance
"""
return self._subscriptionid
@property
def applicationid(self):
"""
returns the applciationID of the instance
"""
return self._applicationid
Classes
class AzureStackInstance (agent, name, iid)
-
Class for representing Azure stack instance of the Virtual Server agent
Initialize the Instance object for the given Virtual Server instance
Args
agent (object) – the instance of the agent class
name (str) – the name of the instance
iid (int) – the instance id
Expand source code Browse git
class AzureStackInstance(VirtualServerInstance): """Class for representing Azure stack instance of the Virtual Server agent""" def __init__(self, agent, name, iid): """ Initialize the Instance object for the given Virtual Server instance Args: agent (object) -- the instance of the agent class name (str) -- the name of the instance iid (int) -- the instance id """ self._subscriptionid = None self._applicationid = None self._server_name = [] self._vendor_id = 403 super(AzureStackInstance, self).__init__(agent, name, iid) 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(AzureStackInstance, self)._get_instance_properties() if "vmwareVendor" in self._virtualserverinstance: self._subscriptionid = self._virtualserverinstance['vmwareVendor'][ 'virtualCenter']['domainName'] self._applicationid = self._virtualserverinstance['vmwareVendor'][ 'virtualCenter']['userName'] if 'virtualServerInstance' in self._properties: _member_servers = self._properties["virtualServerInstance"][ "associatedClients"]["memberServers"] for _each_client in _member_servers: client = _each_client['client'] if 'clientName' in client.keys(): self._server_name.append(str(client['clientName'])) 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 @property def server_host_name(self): """return the associated clients with the instance""" return self._server_name @property def subscriptionid(self): """ returns the subcriptionID of the instance """ return self._subscriptionid @property def applicationid(self): """ returns the applciationID of the instance """ return self._applicationid
Ancestors
Instance variables
var applicationid
-
returns the applciationID of the instance
Expand source code Browse git
@property def applicationid(self): """ returns the applciationID of the instance """ return self._applicationid
var server_host_name
-
return the associated clients with the instance
Expand source code Browse git
@property def server_host_name(self): """return the associated clients with the instance""" return self._server_name
var subscriptionid
-
returns the subcriptionID of the instance
Expand source code Browse git
@property def subscriptionid(self): """ returns the subcriptionID of the instance """ return self._subscriptionid
Inherited members