Module cvpysdk.subclients.virtualserver.livesync.vsa_live_sync

File for configuring and monitoring live sync on the VSA subclient.

VsaLiveSync, LiveSyncPairs and LiveSyncVMPair are the 3 classes defined in this file.

VsaLiveSync: Class for configuring virtual server agent live sync

LiveSyncPairs: Class for all live sync pairs under a subclient

LiveSyncVMPair: Class for monitoring and configuring a Live sync VM pair

VsaLiveSync:

__init__(subclient_object)      -- Initializing instance of the VsaLiveSync class

 __str__()                      -- Returns all the Live sync pairs associated with the subclient

__repr__()                      -- Returns the string to represent the instance of the VsaLiveSync class

_get_live_sync_pairs()          -- Gets all the live sync pairs associated with the subclient

_live_sync_subtask_json()       -- Returns subtask JSON for live sync

_configure_live_sync()          -- To configure live sync

get()                           -- Returns a LiveSyncPairs object for the given live sync name

has_live_sync_pair()            -- Checks if a live sync pair exists with the given name

refresh()                       -- Refresh the live sync pairs associated with the subclient

VsaLiveSync Attributes:

**live_sync_pairs**     -- Returns the dictionary of all the live sync pairs and their info

LiveSyncPairs:

__init__(subclient_object)      -- Initializing instance of the LiveSyncPairs class

__str__()                       -- Returns all the Live sync VM pairs associated with this live sync

__repr__()                      -- Returns the string to represent the instance of the LiveSyncPairs class

_get_live_sync_id()             -- Gets the live sync pair id associated with this subclient

_get_live_sync_vm_pairs()       -- Gets the live sync VM pairs associated with the Live sync pair

get()                           -- Returns a LiveSyncVMPair object for the given live sync VM pair name

has_vm_pair()                   -- Checks if a live sync VM pair exists with the given name

refresh()                       -- Refreshes the properties of the live sync

LiveSyncPairs Attributes:

**vm_pairs**            -- Returns the dictionary of all the live sync VM pairs and their info

**live_sync_id**        -- Returns the ID of the live sync pair

**live_sync_name**      -- Returns the name of the live sync pair

LiveSyncVMPair:

__init__()              -- Initializing instance of the LiveSyncVMPair class

__repr__()              -- Returns the string to represent the instance of the LiveSyncVMPair class

_get_vm_pair_id()       -- Gets the VM pair id associated with the LiveSyncPair

_get_vm_pair_properties()   -- Gets the live sync properties for this VM pair

LiveSyncVMPair Attributes:

**vm_pair_id**          -- Returns the live sync VM pair ID

**vm_pair_name**        -- Returns the live sync VM pair name

**replication_guid**    -- Returns the replication guid of the live sync pair

**source_vm**           -- Returns the name of the source virtual machine

**destination_vm**      -- Returns the name of the destination virtual machine

**destination_client**  -- Returns the destination client of the Live sync VM pair

**destination_proxy**   -- Returns the destination proxy of the Live sync VM pair

**destination_instance**-- Returns the destination instance of the Live sync VM pair

**status**              -- Returns the status of the live sync pair

**last_synced_backup_job** -- Returns the last synced backup job ID

**latest_replication_job** -- Returns the latest replication job ID

**last_replication_job**   -- Returns the last replication job ID

**reverse_replication_schedule_id -- Returns the ID of the reverse replication schedule

**replication_group_name** -- Returns the name of the replication group associated
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 configuring and monitoring live sync on the VSA subclient.

VsaLiveSync, LiveSyncPairs and LiveSyncVMPair are the 3 classes defined in this file.

VsaLiveSync: Class for configuring virtual server agent live sync

LiveSyncPairs: Class for all live sync pairs under a subclient

LiveSyncVMPair: Class for monitoring and configuring a Live sync VM pair


VsaLiveSync:
============

    __init__(subclient_object)      -- Initializing instance of the VsaLiveSync class

     __str__()                      -- Returns all the Live sync pairs associated with the subclient

    __repr__()                      -- Returns the string to represent the instance of the VsaLiveSync class

    _get_live_sync_pairs()          -- Gets all the live sync pairs associated with the subclient

    _live_sync_subtask_json()       -- Returns subtask JSON for live sync

    _configure_live_sync()          -- To configure live sync

    get()                           -- Returns a LiveSyncPairs object for the given live sync name

    has_live_sync_pair()            -- Checks if a live sync pair exists with the given name

    refresh()                       -- Refresh the live sync pairs associated with the subclient


VsaLiveSync Attributes:
-----------------------

    **live_sync_pairs**     -- Returns the dictionary of all the live sync pairs and their info


LiveSyncPairs:
=============

    __init__(subclient_object)      -- Initializing instance of the LiveSyncPairs class

    __str__()                       -- Returns all the Live sync VM pairs associated with this live sync

    __repr__()                      -- Returns the string to represent the instance of the LiveSyncPairs class

    _get_live_sync_id()             -- Gets the live sync pair id associated with this subclient

    _get_live_sync_vm_pairs()       -- Gets the live sync VM pairs associated with the Live sync pair

    get()                           -- Returns a LiveSyncVMPair object for the given live sync VM pair name

    has_vm_pair()                   -- Checks if a live sync VM pair exists with the given name

    refresh()                       -- Refreshes the properties of the live sync


LiveSyncPairs Attributes:
-------------------------

    **vm_pairs**            -- Returns the dictionary of all the live sync VM pairs and their info

    **live_sync_id**        -- Returns the ID of the live sync pair

    **live_sync_name**      -- Returns the name of the live sync pair


LiveSyncVMPair:
===============

    __init__()              -- Initializing instance of the LiveSyncVMPair class

    __repr__()              -- Returns the string to represent the instance of the LiveSyncVMPair class

    _get_vm_pair_id()       -- Gets the VM pair id associated with the LiveSyncPair

    _get_vm_pair_properties()   -- Gets the live sync properties for this VM pair


LiveSyncVMPair Attributes:
--------------------------

    **vm_pair_id**          -- Returns the live sync VM pair ID

    **vm_pair_name**        -- Returns the live sync VM pair name

    **replication_guid**    -- Returns the replication guid of the live sync pair

    **source_vm**           -- Returns the name of the source virtual machine

    **destination_vm**      -- Returns the name of the destination virtual machine

    **destination_client**  -- Returns the destination client of the Live sync VM pair

    **destination_proxy**   -- Returns the destination proxy of the Live sync VM pair

    **destination_instance**-- Returns the destination instance of the Live sync VM pair

    **status**              -- Returns the status of the live sync pair

    **last_synced_backup_job** -- Returns the last synced backup job ID

    **latest_replication_job** -- Returns the latest replication job ID

    **last_replication_job**   -- Returns the last replication job ID

    **reverse_replication_schedule_id -- Returns the ID of the reverse replication schedule

    **replication_group_name** -- Returns the name of the replication group associated

"""

import uuid

from ....constants import HypervisorType as hv_type
from ....constants import VSALiveSyncStatus as sync_status
from ....constants import VSAFailOverStatus as failover_status
from ....exception import SDKException
from ....schedules import SchedulePattern


class VsaLiveSync:
    """Class for configuring and monitoring virtual server live sync operations"""

    def __new__(cls, subclient_object):
        """Decides which instance object needs to be created"""
        instance_name = subclient_object._instance_object.instance_name

        if instance_name == hv_type.MS_VIRTUAL_SERVER.value.lower():
            from .hyperv_live_sync import HyperVLiveSync
            return object.__new__(HyperVLiveSync)
        if instance_name == hv_type.AZURE_V2.value.lower():
            from .azure_live_sync import AzureLiveSync
            return object.__new__(AzureLiveSync)

        if instance_name == hv_type.VIRTUAL_CENTER.value.lower():
            from .vmware_live_sync import VMWareLiveSync
            return object.__new__(VMWareLiveSync)

        if instance_name == hv_type.AMAZON_AWS.value.lower():
            from .amazon_live_sync import AmazonLiveSync
            return object.__new__(AmazonLiveSync)

        raise SDKException(
            'LiveSync',
            '102',
            'Virtual server Live Sync for Instance: "{0}" is not yet supported'.format(instance_name)
        )

    def __init__(self, subclient_object):
        """Initializing instance of the VsaLiveSync class

        Args:
            subclient_object    (obj)   -- Instance of Subclient class

        """
        self._subclient_object = subclient_object
        self._subclient_id = self._subclient_object.subclient_id
        self._subclient_name = self._subclient_object.name

        self.schedule_pattern = SchedulePattern()

        self._live_sync_pairs = None

        self._commcell_object = self._subclient_object._commcell_object
        self._cvpysdk_object = self._commcell_object._cvpysdk_object
        self._services = self._commcell_object._services
        self._update_response_ = self._commcell_object._update_response_

        self._ALL_LIVE_SYNC_PAIRS = self._services['GET_ALL_LIVE_SYNC_PAIRS'] % self._subclient_id

        self.refresh()

    def __str__(self):
        """Representation string consisting of all Live sync pairs of the subclient.

        Returns:
            str - string of all the live sync pairs associated with the subclient

        """
        representation_string = '{:^5}\t{:^20}\n\n'.format('S. No.', 'LiveSyncPair')

        for index, live_sync in enumerate(self.live_sync_pairs):
            sub_str = '{:^5}\t{:20}\n'.format(index + 1, live_sync)
            representation_string += sub_str

        return representation_string.strip()

    def __repr__(self):
        """String representation of the instance of this class.

        Returns:
            str - string about the details of the VSALiveSync class instance

        """
        return 'VSALiveSync class instance for the Subclient: "{0}"'.format(self._subclient_name)

    def _get_live_sync_pairs(self):
        """Gets all the live sync pairs associated with the subclient

        Returns:
            dict    -- consists of all the live sync pairs in the subclient

                {
                    "live_sync_pair1_name": {
                                "id": live_sync_pair1_id
                    },
                    "live_sync_pair2_name": {
                                "id": live_sync_pair2_id
                    },
                }

        Raises:
                SDKException:
                    if response is empty

                    if response is not success

        """
        flag, response = self._cvpysdk_object.make_request('GET', self._ALL_LIVE_SYNC_PAIRS)

        if flag:
            live_sync_pairs_dict = {}
            if not bool(response.json()):
                return live_sync_pairs_dict
            if response.json() and 'siteInfo' not in response.json():
                return live_sync_pairs_dict
            elif response.json() and 'siteInfo' in response.json():
                for dictionary in response.json()['siteInfo']:
                    if dictionary["replicationGroup"]["replicationGroupName"] != "":
                        temp_name = dictionary["replicationGroup"]["replicationGroupName"]
                    else:
                        temp_name = dictionary['subTask']['subtaskName']
                    temp_id = str(dictionary['subTask']['taskId'])
                    live_sync_pairs_dict[temp_name.lower()] = {
                        'id': temp_id
                    }

                return live_sync_pairs_dict

            raise SDKException('Response', '102')

        raise SDKException('Response', '101', self._update_response_(response.text))

    @staticmethod
    def _live_sync_subtask_json(schedule_name):
        """setter for the subtask in live sync JSON

        Args:
            schedule_name   (str)   -- Name of the Live sync schedule to be created

        """
        return {
            "subTaskType": "RESTORE",
            "operationType": "SITE_REPLICATION",
            "subTaskName": schedule_name
        }

    def _configure_live_sync(self, schedule_name, restore_options, pattern_dict=None):
        """Configures Live sync after generating the full live sync json

        Args:
            schedule_name       (str)   -- Name of the Live sync schedule to be created

            restore_options     (dict)  -- Dictionary with all necessary values for Live sync

            pattern_dict        (dict)  -- Dictionary to generate the live sync schedule

                Sample:

                    for after_job_completes :
                    {
                        "freq_type": 'after_job_completes',
                        "active_start_date": date_in_%m/%d/%y (str),
                        "active_start_time": time_in_%H/%S (str),
                        "repeat_days": days_to_repeat (int)
                    }

                    for daily:
                    {
                         "freq_type": 'daily',
                         "active_start_time": time_in_%H/%S (str),
                         "repeat_days": days_to_repeat (int)
                    }

                    for weekly:
                    {
                         "freq_type": 'weekly',
                         "active_start_time": time_in_%H/%S (str),
                         "repeat_weeks": weeks_to_repeat (int)
                         "weekdays": list of weekdays ['Monday','Tuesday']
                    }

                    for monthly:
                    {
                         "freq_type": 'monthly',
                         "active_start_time": time_in_%H/%S (str),
                         "repeat_months": weeks_to_repeat (int)
                         "on_day": Day to run schedule (int)
                    }

                    for yearly:
                    {
                         "active_start_time": time_in_%H/%S (str),
                         "on_month": month to run schedule (str) January, Febuary...
                         "on_day": Day to run schedule (int)
                    }

        Returns:
            object - instance of the Schedule class for this Live sync

        **Note** use this method to generate full Live sync JSON and to post the API call in derived class

        """
        # To generate a random UUID for replication
        restore_options['replication_guid'] = str(uuid.uuid1())

        request_json = self._subclient_object._prepare_fullvm_restore_json(restore_options)

        # To include the schedule pattern
        request_json = self.schedule_pattern.create_schedule(
            request_json,
            pattern_dict or {'freq_type': 'after_job_completes'})

        request_json['taskInfo']['subTasks'][0]['subTask'] = self._live_sync_subtask_json(schedule_name)

        return self._subclient_object._process_restore_response(request_json)

    @property
    def live_sync_pairs(self):
        """Returns the dictionary of all the live sync pairs and their info

        Returns:
            dict    -- consists of all the live sync pairs in the subclient

                {
                    "live_sync_pair1_name": {
                                "id": live_sync_pair1_id
                    },
                    "live_sync_pair2_name": {
                                "id": live_sync_pair2_id
                    },
                }

        """
        return self._live_sync_pairs

    def get(self, live_sync_name):
        """Returns a LiveSyncPairs object for the given live sync name

        Args:
             live_sync_name     (str)   -- Name of the live sync

        Returns:
            object  - Instance of the LiveSyncPairs class for the given live sync name

        Raises:
            SDKException:
                if type of the live sync name argument is not string

        """
        if not isinstance(live_sync_name, str):
            raise SDKException('LiveSync', '101')
        live_sync_name = live_sync_name.lower()
        if self.has_live_sync_pair(live_sync_name):
            return LiveSyncPairs(
                self._subclient_object,
                live_sync_name,
                self.live_sync_pairs[live_sync_name]['id'])
        raise SDKException(
            'LiveSync', '102', 'No Live Sync exists with given name: {0}'.format(live_sync_name)
        )

    def has_live_sync_pair(self, live_sync_name):
        """Checks if a live sync pair exists with the given name

        Args:
            live_sync_name      (str)   -- Name of the live sync

        Returns:
                bool    -   boolean output whether the live sync pair exists in the subclient or not

        Raises:
            SDKException:
                if type of the live sync name argument is not string

        """
        return self.live_sync_pairs and live_sync_name.lower() in self.live_sync_pairs

    def refresh(self):
        """Refresh the live sync pairs associated with the subclient"""
        self._live_sync_pairs = self._get_live_sync_pairs()


class LiveSyncPairs:
    """Class for all live sync pairs under a subclient"""

    def __init__(self, subclient_object, live_sync_name, live_sync_id=None):
        """Initializing instance of the LiveSyncPairs class

         Args:
            subclient_object    (obj)   -- Instance of Subclient class

            live_sync_name      (str)   -- Name of the Live sync

            live_sync_id        (str)   -- Task ID of the live sync

        """
        self._subclient_object = subclient_object
        self._subclient_id = self._subclient_object.subclient_id
        self._subclient_name = self._subclient_object.name

        self._live_sync_name = live_sync_name.lower()

        self._commcell_object = self._subclient_object._commcell_object
        self._cvpysdk_object = self._commcell_object._cvpysdk_object
        self._services = self._commcell_object._services
        self._update_response_ = self._commcell_object._update_response_

        self._live_sync_id = live_sync_id or self._get_live_sync_id()

        self._LIVE_SYNC_VM_PAIRS = self._services['GET_ALL_LIVE_SYNC_VM_PAIRS'] % (
            self._subclient_id,
            self.live_sync_id
        )

        self._vm_pairs = None

        self.refresh()

    def __str__(self):
        """Representation string consisting of all Live sync VM pairs of the subclient.

        Returns:
            str - string of all the live sync pairs associated with the subclient

        """
        representation_string = '{:^5}\t{:^20}\n\n'.format('S. No.', 'LiveSyncVMPair')

        for index, vm_pair in enumerate(self.vm_pairs):
            sub_str = '{:^5}\t{:20}\n'.format(index + 1, vm_pair)
            representation_string += sub_str

        return representation_string.strip()

    def __repr__(self):
        """String representation of the instance of this class."""
        representation_string = 'LiveSyncPairs class instance for Subclient: "{0}"'
        return representation_string.format(self._subclient_name)

    def _get_live_sync_id(self):
        """Gets the live sync pair id associated with this subclient

        Returns:
            str - id associated with this Live sync pair

        """
        return self._subclient_object.live_sync.get(self.live_sync_name).live_sync_id

    def _get_live_sync_vm_pairs(self):
        """Gets the live sync VM pairs associated with the live sync pair

        Returns:
            dict    -- consists of all the live sync vm pairs for the Live sync pair

                {
                    "vm_pair1_name": {
                                "id": vm_pair1_id
                    },
                    "vm_pair2_name": {
                                "id": vm_pair2_id
                    },
                }

        Raises:
            SDKException:
                if response is empty

                if response is not success

        """
        flag, response = self._cvpysdk_object.make_request('GET', self._LIVE_SYNC_VM_PAIRS)

        if flag:
            live_sync_vm_pairs = {}
            if not bool(response.json()):
                return live_sync_vm_pairs
            elif response.json() and 'siteInfo' in response.json():
                for dictionary in response.json()['siteInfo']:
                    temp_name = dictionary['sourceName']
                    temp_id = str(dictionary['replicationId'])
                    live_sync_vm_pairs[temp_name] = {
                        'id': temp_id
                    }

                return live_sync_vm_pairs

            raise SDKException('Response', '102')

        raise SDKException('Response', '101', self._update_response_(response.text))

    @property
    def vm_pairs(self):
        """Returns the dictionary of all the live sync vm pairs and their info

        Returns:
            dict    -- consists of all the live sync vm pairs for the Live sync pair

                {
                    "vm_pair1_name": {
                                "id": vm_pair1_id
                    },
                    "vm_pair2_name": {
                                "id": vm_pair2_id
                    },
                }

        """
        return self._vm_pairs

    def get(self, vm_pair_name):
        """Returns the LiveSyncVMPair object assoicated with the subclient

        Args:
            vm_pair_name    (str)   -- Name of the vm pair

        Returns:
             object  - Instance of the LiveSyncVMPair class for the given vm pair name

        Raises:
            SDKException:
                if type of the vm pair name argument is not string

        """
        if not isinstance(vm_pair_name, str):
            raise SDKException('LiveSync', '101')
        if self.has_vm_pair(vm_pair_name):
            return LiveSyncVMPair(
                self,
                vm_pair_name,
                self.vm_pairs[vm_pair_name]['id']
            )
        raise SDKException(
            'LiveSync', '102', 'No VM pair exists with given name: {0}'.format(vm_pair_name)
        )

    def has_vm_pair(self, vm_pair_name):
        """Checks if a live sync pair exists with the given name

        Args:
            vm_pair_name      (str)   -- Name of the vm pair

        Returns:
                bool    -   boolean output whether the vm pair is there in the live sync pair or not

        Raises:
            SDKException:
                if type of the live sync name argument is not string

        """
        return self.vm_pairs and vm_pair_name in self.vm_pairs

    @property
    def live_sync_id(self):
        """Treats the live sync id as a read-only attribute."""
        return self._live_sync_id

    @property
    def live_sync_name(self):
        """Treats the live sync name as a read-only attribute."""
        return self._live_sync_name

    def refresh(self):
        """Refreshes the VM pairs associated with the subclient"""
        self._vm_pairs = self._get_live_sync_vm_pairs()


class LiveSyncVMPair:
    """Class for monitoring a live sync VM pair"""

    def __init__(self, live_sync_pair_object, vm_pair_name, vm_pair_id=None):
        """Initializing instance of the LiveSyncPair class

         Args:
            live_sync_pair_object   (obj)   -- Instance of LiveSyncPairs class

            vm_pair_name            (str)   -- Name of the vm pair

            vm_pair_id              (str)   -- ID of the live sync VM pair

        """
        self.live_sync_pair = live_sync_pair_object
        self._subclient_object = self.live_sync_pair._subclient_object
        self._subclient_id = self._subclient_object.subclient_id
        self._subclient_name = self._subclient_object.name

        self._vm_pair_name = vm_pair_name

        self._commcell_object = self._subclient_object._commcell_object
        self._agent_object = self._subclient_object._agent_object
        self._cvpysdk_object = self._commcell_object._cvpysdk_object
        self._services = self._commcell_object._services
        self._update_response_ = self._commcell_object._update_response_

        self._vm_pair_id = vm_pair_id or self._get_vm_pair_id()

        self._VM_PAIR = self._services['GET_LIVE_SYNC_VM_PAIR'] % (
            self._subclient_id,
            self._vm_pair_id
        )

        self._properties = None
        self._replication_guid = None
        self._status = None
        self._failover_status = None
        self._source_vm = None
        self._destination_vm = None
        self._destination_client = None
        self._destination_proxy = None
        self._destination_instance = None
        self._last_backup_job = None
        self._latest_replication_job = None
        self._is_warm_sync_pair = None

        self.refresh()

    def __repr__(self):
        """String representation of the instance of this class."""
        representation_string = 'LiveSyncVMPair class instance for Live Sync: "{0}"'
        return representation_string.format(self.live_sync_pair.live_sync_name)

    def __str__(self):
        """String representation of the instance of BLR pair"""
        return f'Live sync pair: {self._source_vm} -> {self._destination_vm}'

    def _get_vm_pair_id(self):
        """Gets the VM pair id associated with the LiveSyncPair

        Returns:
            str - id associated with this VM pair

        """
        return self.live_sync_pair.get(self.vm_pair_name).vm_pair_id

    def _get_vm_pair_properties(self):
        """Gets the live sync properties for this VM pair

        Raises:
            SDKException:
                if response is empty

                if response is not success

        """
        flag, response = self._cvpysdk_object.make_request('GET', self._VM_PAIR)

        if flag:
            if not bool(response.json()):
                pass
            elif response.json() and 'siteInfo' in response.json():
                self._properties = response.json()['siteInfo'][0]
                self._replication_guid = self._properties['replicationGuid']
                self._status = self._properties['status']
                self._failover_status = self._properties['FailoverStatus']
                self._source_vm = self._properties['sourceName']
                self._destination_vm = self._properties['destinationName']
                self._destination_client = self._properties['destinationInstance'].get(
                    'clientName') or self._commcell_object.clients.get(
                        self._properties['destinationInstance'].get('clientId')).name
                self._destination_proxy = self._properties['destProxy'].get(
                    'clientName') or self._commcell_object.clients.get(
                        self._properties['destProxy'].get('clientId')).name
                self._destination_instance = self._properties['destinationInstance'].get(
                    'instanceName') or self._agent_object.instances.get(
                        self._properties['destinationInstance'].get('instanceId')).name
                self._last_backup_job = self._properties['lastSyncedBkpJob']
                self._is_warm_sync_pair = self._properties.get('isWarmSyncPair', False)

            else:
                raise SDKException('Response', '102')
        else:
            raise SDKException('Response', '101', self._update_response_(response.text))

    @property
    def task_id(self):
        """ Returns: (int) The ID of the replication schedule task"""
        return self._properties.get('subTask', {}).get('taskId')

    @property
    def vm_pair_id(self):
        """Treats the live sync id as a read-only attribute."""
        return self._vm_pair_id

    @property
    def vm_pair_name(self):
        """Treats the live sync name as a read-only attribute."""
        return self._vm_pair_name

    @property
    def replication_guid(self):
        """Treats the replication guid as a read-only attribute."""
        return self._replication_guid

    @property
    def source_vm(self):
        """Treats the source VM as a read-only attribute."""
        return self._source_vm

    @property
    def source_vm_guid(self):
        """ Returns (str): The GUID of the source VM """
        return self._properties.get('sourceGuid')

    @property
    def destination_vm(self):
        """Treats the destination VM as a read-only attribute."""
        return self._destination_vm

    @property
    def destination_vm_guid(self):
        """ Returns (str): The GUID of the destination VM """
        return self._properties.get('destinationGuid')

    @property
    def destination_client(self):
        """Treats the destination VM as a read-only attribute."""
        return self._destination_client

    @property
    def destination_proxy(self):
        """Treats the destination VM as a read-only attribute."""
        return self._destination_proxy

    @property
    def destination_instance(self):
        """Treats the destination instance as a read-only attribute."""
        return self._destination_instance

    @property
    def status(self):
        """Treats the status as a read-only attribute."""
        return sync_status(self._status).name

    @property
    def failover_status(self):
        """Treats the failover_status as a read-only attribute."""
        return failover_status(self._failover_status).name

    @property
    def last_synced_backup_job(self):
        """Treats the synced backup job as a read-only attribute."""
        return self._last_backup_job

    @property
    def last_replication_job(self):
        """Returns (int): the last replication job that has been run for the Live sync VM pair"""
        for prop in self._properties.get('VMReplInfoProperties', []):
            if prop.get('propertyId', 0) == 2215 and prop.get('propertyValue'):
                return int(prop.get('propertyValue'))
        return None

    @property
    def latest_replication_job(self):
        """Returns (int): the latest successful replication job for the Live sync VM pair"""
        for prop in self._properties.get('VMReplInfoProperties', []):
            if prop.get('propertyId', 0) == 2208 and prop.get('propertyValue'):
                self._latest_replication_job = int(prop.get('propertyValue'))
                return self._latest_replication_job
        return None

    @property
    def failover_job_id(self):
        """Returns (int): the job ID of the failover job"""
        for prop in self._properties.get('VMReplInfoProperties', []):
            if prop.get('propertyId', 0) == 2216 and prop.get('propertyValue'):
                return int(prop.get('propertyValue'))
        return None

    @property
    def reverse_replication_schedule_id(self):
        """Returns (int): The schedule ID of the reverse replication schedule"""
        for prop in self._properties.get('VMReplInfoProperties', []):
            if prop.get('propertyId', 0) == 2212 and prop.get('propertyValue'):
                return int(prop.get('propertyValue'))
        return None

    @property
    def replication_group_name(self):
        """Returns (str): The name of the replication group associated to the VM pair
        Note: This also removes the CV prefix for new replication groups
        """
        group_name = (self._properties.get('replicationGroup', {}).get('replicationGroupName')
                      or self._properties.get('subTask', {}).get('subTaskName'))
        return group_name.replace('_ReplicationPlan__ReplicationGroup', '')

    @property
    def is_warm_sync_pair(self):
        """Returns (bool): Warm Sync enabled/disabled"""
        return self._is_warm_sync_pair

    def refresh(self):
        """Refreshes the properties of the live sync"""
        self._get_vm_pair_properties()

Classes

class LiveSyncPairs (subclient_object, live_sync_name, live_sync_id=None)

Class for all live sync pairs under a subclient

Initializing instance of the LiveSyncPairs class

Args

subclient_object (obj) – Instance of Subclient class

live_sync_name (str) – Name of the Live sync

live_sync_id (str) – Task ID of the live sync

Expand source code Browse git
class LiveSyncPairs:
    """Class for all live sync pairs under a subclient"""

    def __init__(self, subclient_object, live_sync_name, live_sync_id=None):
        """Initializing instance of the LiveSyncPairs class

         Args:
            subclient_object    (obj)   -- Instance of Subclient class

            live_sync_name      (str)   -- Name of the Live sync

            live_sync_id        (str)   -- Task ID of the live sync

        """
        self._subclient_object = subclient_object
        self._subclient_id = self._subclient_object.subclient_id
        self._subclient_name = self._subclient_object.name

        self._live_sync_name = live_sync_name.lower()

        self._commcell_object = self._subclient_object._commcell_object
        self._cvpysdk_object = self._commcell_object._cvpysdk_object
        self._services = self._commcell_object._services
        self._update_response_ = self._commcell_object._update_response_

        self._live_sync_id = live_sync_id or self._get_live_sync_id()

        self._LIVE_SYNC_VM_PAIRS = self._services['GET_ALL_LIVE_SYNC_VM_PAIRS'] % (
            self._subclient_id,
            self.live_sync_id
        )

        self._vm_pairs = None

        self.refresh()

    def __str__(self):
        """Representation string consisting of all Live sync VM pairs of the subclient.

        Returns:
            str - string of all the live sync pairs associated with the subclient

        """
        representation_string = '{:^5}\t{:^20}\n\n'.format('S. No.', 'LiveSyncVMPair')

        for index, vm_pair in enumerate(self.vm_pairs):
            sub_str = '{:^5}\t{:20}\n'.format(index + 1, vm_pair)
            representation_string += sub_str

        return representation_string.strip()

    def __repr__(self):
        """String representation of the instance of this class."""
        representation_string = 'LiveSyncPairs class instance for Subclient: "{0}"'
        return representation_string.format(self._subclient_name)

    def _get_live_sync_id(self):
        """Gets the live sync pair id associated with this subclient

        Returns:
            str - id associated with this Live sync pair

        """
        return self._subclient_object.live_sync.get(self.live_sync_name).live_sync_id

    def _get_live_sync_vm_pairs(self):
        """Gets the live sync VM pairs associated with the live sync pair

        Returns:
            dict    -- consists of all the live sync vm pairs for the Live sync pair

                {
                    "vm_pair1_name": {
                                "id": vm_pair1_id
                    },
                    "vm_pair2_name": {
                                "id": vm_pair2_id
                    },
                }

        Raises:
            SDKException:
                if response is empty

                if response is not success

        """
        flag, response = self._cvpysdk_object.make_request('GET', self._LIVE_SYNC_VM_PAIRS)

        if flag:
            live_sync_vm_pairs = {}
            if not bool(response.json()):
                return live_sync_vm_pairs
            elif response.json() and 'siteInfo' in response.json():
                for dictionary in response.json()['siteInfo']:
                    temp_name = dictionary['sourceName']
                    temp_id = str(dictionary['replicationId'])
                    live_sync_vm_pairs[temp_name] = {
                        'id': temp_id
                    }

                return live_sync_vm_pairs

            raise SDKException('Response', '102')

        raise SDKException('Response', '101', self._update_response_(response.text))

    @property
    def vm_pairs(self):
        """Returns the dictionary of all the live sync vm pairs and their info

        Returns:
            dict    -- consists of all the live sync vm pairs for the Live sync pair

                {
                    "vm_pair1_name": {
                                "id": vm_pair1_id
                    },
                    "vm_pair2_name": {
                                "id": vm_pair2_id
                    },
                }

        """
        return self._vm_pairs

    def get(self, vm_pair_name):
        """Returns the LiveSyncVMPair object assoicated with the subclient

        Args:
            vm_pair_name    (str)   -- Name of the vm pair

        Returns:
             object  - Instance of the LiveSyncVMPair class for the given vm pair name

        Raises:
            SDKException:
                if type of the vm pair name argument is not string

        """
        if not isinstance(vm_pair_name, str):
            raise SDKException('LiveSync', '101')
        if self.has_vm_pair(vm_pair_name):
            return LiveSyncVMPair(
                self,
                vm_pair_name,
                self.vm_pairs[vm_pair_name]['id']
            )
        raise SDKException(
            'LiveSync', '102', 'No VM pair exists with given name: {0}'.format(vm_pair_name)
        )

    def has_vm_pair(self, vm_pair_name):
        """Checks if a live sync pair exists with the given name

        Args:
            vm_pair_name      (str)   -- Name of the vm pair

        Returns:
                bool    -   boolean output whether the vm pair is there in the live sync pair or not

        Raises:
            SDKException:
                if type of the live sync name argument is not string

        """
        return self.vm_pairs and vm_pair_name in self.vm_pairs

    @property
    def live_sync_id(self):
        """Treats the live sync id as a read-only attribute."""
        return self._live_sync_id

    @property
    def live_sync_name(self):
        """Treats the live sync name as a read-only attribute."""
        return self._live_sync_name

    def refresh(self):
        """Refreshes the VM pairs associated with the subclient"""
        self._vm_pairs = self._get_live_sync_vm_pairs()

Instance variables

var live_sync_id

Treats the live sync id as a read-only attribute.

Expand source code Browse git
@property
def live_sync_id(self):
    """Treats the live sync id as a read-only attribute."""
    return self._live_sync_id
var live_sync_name

Treats the live sync name as a read-only attribute.

Expand source code Browse git
@property
def live_sync_name(self):
    """Treats the live sync name as a read-only attribute."""
    return self._live_sync_name
var vm_pairs

Returns the dictionary of all the live sync vm pairs and their info

Returns

dict – consists of all the live sync vm pairs for the Live sync pair

{
    "vm_pair1_name": {
                "id": vm_pair1_id
    },
    "vm_pair2_name": {
                "id": vm_pair2_id
    },
}
Expand source code Browse git
@property
def vm_pairs(self):
    """Returns the dictionary of all the live sync vm pairs and their info

    Returns:
        dict    -- consists of all the live sync vm pairs for the Live sync pair

            {
                "vm_pair1_name": {
                            "id": vm_pair1_id
                },
                "vm_pair2_name": {
                            "id": vm_pair2_id
                },
            }

    """
    return self._vm_pairs

Methods

def get(self, vm_pair_name)

Returns the LiveSyncVMPair object assoicated with the subclient

Args

vm_pair_name (str) – Name of the vm pair

Returns

object - Instance of the LiveSyncVMPair class for the given vm pair name

Raises

SDKException: if type of the vm pair name argument is not string

Expand source code Browse git
def get(self, vm_pair_name):
    """Returns the LiveSyncVMPair object assoicated with the subclient

    Args:
        vm_pair_name    (str)   -- Name of the vm pair

    Returns:
         object  - Instance of the LiveSyncVMPair class for the given vm pair name

    Raises:
        SDKException:
            if type of the vm pair name argument is not string

    """
    if not isinstance(vm_pair_name, str):
        raise SDKException('LiveSync', '101')
    if self.has_vm_pair(vm_pair_name):
        return LiveSyncVMPair(
            self,
            vm_pair_name,
            self.vm_pairs[vm_pair_name]['id']
        )
    raise SDKException(
        'LiveSync', '102', 'No VM pair exists with given name: {0}'.format(vm_pair_name)
    )
def has_vm_pair(self, vm_pair_name)

Checks if a live sync pair exists with the given name

Args

vm_pair_name (str) – Name of the vm pair

Returns

bool - boolean output whether the vm pair is there in the live sync pair or not

Raises

SDKException: if type of the live sync name argument is not string

Expand source code Browse git
def has_vm_pair(self, vm_pair_name):
    """Checks if a live sync pair exists with the given name

    Args:
        vm_pair_name      (str)   -- Name of the vm pair

    Returns:
            bool    -   boolean output whether the vm pair is there in the live sync pair or not

    Raises:
        SDKException:
            if type of the live sync name argument is not string

    """
    return self.vm_pairs and vm_pair_name in self.vm_pairs
def refresh(self)

Refreshes the VM pairs associated with the subclient

Expand source code Browse git
def refresh(self):
    """Refreshes the VM pairs associated with the subclient"""
    self._vm_pairs = self._get_live_sync_vm_pairs()
class LiveSyncVMPair (live_sync_pair_object, vm_pair_name, vm_pair_id=None)

Class for monitoring a live sync VM pair

Initializing instance of the LiveSyncPair class

Args

live_sync_pair_object (obj) – Instance of LiveSyncPairs class

vm_pair_name (str) – Name of the vm pair

vm_pair_id (str) – ID of the live sync VM pair

Expand source code Browse git
class LiveSyncVMPair:
    """Class for monitoring a live sync VM pair"""

    def __init__(self, live_sync_pair_object, vm_pair_name, vm_pair_id=None):
        """Initializing instance of the LiveSyncPair class

         Args:
            live_sync_pair_object   (obj)   -- Instance of LiveSyncPairs class

            vm_pair_name            (str)   -- Name of the vm pair

            vm_pair_id              (str)   -- ID of the live sync VM pair

        """
        self.live_sync_pair = live_sync_pair_object
        self._subclient_object = self.live_sync_pair._subclient_object
        self._subclient_id = self._subclient_object.subclient_id
        self._subclient_name = self._subclient_object.name

        self._vm_pair_name = vm_pair_name

        self._commcell_object = self._subclient_object._commcell_object
        self._agent_object = self._subclient_object._agent_object
        self._cvpysdk_object = self._commcell_object._cvpysdk_object
        self._services = self._commcell_object._services
        self._update_response_ = self._commcell_object._update_response_

        self._vm_pair_id = vm_pair_id or self._get_vm_pair_id()

        self._VM_PAIR = self._services['GET_LIVE_SYNC_VM_PAIR'] % (
            self._subclient_id,
            self._vm_pair_id
        )

        self._properties = None
        self._replication_guid = None
        self._status = None
        self._failover_status = None
        self._source_vm = None
        self._destination_vm = None
        self._destination_client = None
        self._destination_proxy = None
        self._destination_instance = None
        self._last_backup_job = None
        self._latest_replication_job = None
        self._is_warm_sync_pair = None

        self.refresh()

    def __repr__(self):
        """String representation of the instance of this class."""
        representation_string = 'LiveSyncVMPair class instance for Live Sync: "{0}"'
        return representation_string.format(self.live_sync_pair.live_sync_name)

    def __str__(self):
        """String representation of the instance of BLR pair"""
        return f'Live sync pair: {self._source_vm} -> {self._destination_vm}'

    def _get_vm_pair_id(self):
        """Gets the VM pair id associated with the LiveSyncPair

        Returns:
            str - id associated with this VM pair

        """
        return self.live_sync_pair.get(self.vm_pair_name).vm_pair_id

    def _get_vm_pair_properties(self):
        """Gets the live sync properties for this VM pair

        Raises:
            SDKException:
                if response is empty

                if response is not success

        """
        flag, response = self._cvpysdk_object.make_request('GET', self._VM_PAIR)

        if flag:
            if not bool(response.json()):
                pass
            elif response.json() and 'siteInfo' in response.json():
                self._properties = response.json()['siteInfo'][0]
                self._replication_guid = self._properties['replicationGuid']
                self._status = self._properties['status']
                self._failover_status = self._properties['FailoverStatus']
                self._source_vm = self._properties['sourceName']
                self._destination_vm = self._properties['destinationName']
                self._destination_client = self._properties['destinationInstance'].get(
                    'clientName') or self._commcell_object.clients.get(
                        self._properties['destinationInstance'].get('clientId')).name
                self._destination_proxy = self._properties['destProxy'].get(
                    'clientName') or self._commcell_object.clients.get(
                        self._properties['destProxy'].get('clientId')).name
                self._destination_instance = self._properties['destinationInstance'].get(
                    'instanceName') or self._agent_object.instances.get(
                        self._properties['destinationInstance'].get('instanceId')).name
                self._last_backup_job = self._properties['lastSyncedBkpJob']
                self._is_warm_sync_pair = self._properties.get('isWarmSyncPair', False)

            else:
                raise SDKException('Response', '102')
        else:
            raise SDKException('Response', '101', self._update_response_(response.text))

    @property
    def task_id(self):
        """ Returns: (int) The ID of the replication schedule task"""
        return self._properties.get('subTask', {}).get('taskId')

    @property
    def vm_pair_id(self):
        """Treats the live sync id as a read-only attribute."""
        return self._vm_pair_id

    @property
    def vm_pair_name(self):
        """Treats the live sync name as a read-only attribute."""
        return self._vm_pair_name

    @property
    def replication_guid(self):
        """Treats the replication guid as a read-only attribute."""
        return self._replication_guid

    @property
    def source_vm(self):
        """Treats the source VM as a read-only attribute."""
        return self._source_vm

    @property
    def source_vm_guid(self):
        """ Returns (str): The GUID of the source VM """
        return self._properties.get('sourceGuid')

    @property
    def destination_vm(self):
        """Treats the destination VM as a read-only attribute."""
        return self._destination_vm

    @property
    def destination_vm_guid(self):
        """ Returns (str): The GUID of the destination VM """
        return self._properties.get('destinationGuid')

    @property
    def destination_client(self):
        """Treats the destination VM as a read-only attribute."""
        return self._destination_client

    @property
    def destination_proxy(self):
        """Treats the destination VM as a read-only attribute."""
        return self._destination_proxy

    @property
    def destination_instance(self):
        """Treats the destination instance as a read-only attribute."""
        return self._destination_instance

    @property
    def status(self):
        """Treats the status as a read-only attribute."""
        return sync_status(self._status).name

    @property
    def failover_status(self):
        """Treats the failover_status as a read-only attribute."""
        return failover_status(self._failover_status).name

    @property
    def last_synced_backup_job(self):
        """Treats the synced backup job as a read-only attribute."""
        return self._last_backup_job

    @property
    def last_replication_job(self):
        """Returns (int): the last replication job that has been run for the Live sync VM pair"""
        for prop in self._properties.get('VMReplInfoProperties', []):
            if prop.get('propertyId', 0) == 2215 and prop.get('propertyValue'):
                return int(prop.get('propertyValue'))
        return None

    @property
    def latest_replication_job(self):
        """Returns (int): the latest successful replication job for the Live sync VM pair"""
        for prop in self._properties.get('VMReplInfoProperties', []):
            if prop.get('propertyId', 0) == 2208 and prop.get('propertyValue'):
                self._latest_replication_job = int(prop.get('propertyValue'))
                return self._latest_replication_job
        return None

    @property
    def failover_job_id(self):
        """Returns (int): the job ID of the failover job"""
        for prop in self._properties.get('VMReplInfoProperties', []):
            if prop.get('propertyId', 0) == 2216 and prop.get('propertyValue'):
                return int(prop.get('propertyValue'))
        return None

    @property
    def reverse_replication_schedule_id(self):
        """Returns (int): The schedule ID of the reverse replication schedule"""
        for prop in self._properties.get('VMReplInfoProperties', []):
            if prop.get('propertyId', 0) == 2212 and prop.get('propertyValue'):
                return int(prop.get('propertyValue'))
        return None

    @property
    def replication_group_name(self):
        """Returns (str): The name of the replication group associated to the VM pair
        Note: This also removes the CV prefix for new replication groups
        """
        group_name = (self._properties.get('replicationGroup', {}).get('replicationGroupName')
                      or self._properties.get('subTask', {}).get('subTaskName'))
        return group_name.replace('_ReplicationPlan__ReplicationGroup', '')

    @property
    def is_warm_sync_pair(self):
        """Returns (bool): Warm Sync enabled/disabled"""
        return self._is_warm_sync_pair

    def refresh(self):
        """Refreshes the properties of the live sync"""
        self._get_vm_pair_properties()

Subclasses

Instance variables

var destination_client

Treats the destination VM as a read-only attribute.

Expand source code Browse git
@property
def destination_client(self):
    """Treats the destination VM as a read-only attribute."""
    return self._destination_client
var destination_instance

Treats the destination instance as a read-only attribute.

Expand source code Browse git
@property
def destination_instance(self):
    """Treats the destination instance as a read-only attribute."""
    return self._destination_instance
var destination_proxy

Treats the destination VM as a read-only attribute.

Expand source code Browse git
@property
def destination_proxy(self):
    """Treats the destination VM as a read-only attribute."""
    return self._destination_proxy
var destination_vm

Treats the destination VM as a read-only attribute.

Expand source code Browse git
@property
def destination_vm(self):
    """Treats the destination VM as a read-only attribute."""
    return self._destination_vm
var destination_vm_guid

Returns (str): The GUID of the destination VM

Expand source code Browse git
@property
def destination_vm_guid(self):
    """ Returns (str): The GUID of the destination VM """
    return self._properties.get('destinationGuid')
var failover_job_id

Returns (int): the job ID of the failover job

Expand source code Browse git
@property
def failover_job_id(self):
    """Returns (int): the job ID of the failover job"""
    for prop in self._properties.get('VMReplInfoProperties', []):
        if prop.get('propertyId', 0) == 2216 and prop.get('propertyValue'):
            return int(prop.get('propertyValue'))
    return None
var failover_status

Treats the failover_status as a read-only attribute.

Expand source code Browse git
@property
def failover_status(self):
    """Treats the failover_status as a read-only attribute."""
    return failover_status(self._failover_status).name
var is_warm_sync_pair

Returns (bool): Warm Sync enabled/disabled

Expand source code Browse git
@property
def is_warm_sync_pair(self):
    """Returns (bool): Warm Sync enabled/disabled"""
    return self._is_warm_sync_pair
var last_replication_job

Returns (int): the last replication job that has been run for the Live sync VM pair

Expand source code Browse git
@property
def last_replication_job(self):
    """Returns (int): the last replication job that has been run for the Live sync VM pair"""
    for prop in self._properties.get('VMReplInfoProperties', []):
        if prop.get('propertyId', 0) == 2215 and prop.get('propertyValue'):
            return int(prop.get('propertyValue'))
    return None
var last_synced_backup_job

Treats the synced backup job as a read-only attribute.

Expand source code Browse git
@property
def last_synced_backup_job(self):
    """Treats the synced backup job as a read-only attribute."""
    return self._last_backup_job
var latest_replication_job

Returns (int): the latest successful replication job for the Live sync VM pair

Expand source code Browse git
@property
def latest_replication_job(self):
    """Returns (int): the latest successful replication job for the Live sync VM pair"""
    for prop in self._properties.get('VMReplInfoProperties', []):
        if prop.get('propertyId', 0) == 2208 and prop.get('propertyValue'):
            self._latest_replication_job = int(prop.get('propertyValue'))
            return self._latest_replication_job
    return None
var replication_group_name

Returns (str): The name of the replication group associated to the VM pair Note: This also removes the CV prefix for new replication groups

Expand source code Browse git
@property
def replication_group_name(self):
    """Returns (str): The name of the replication group associated to the VM pair
    Note: This also removes the CV prefix for new replication groups
    """
    group_name = (self._properties.get('replicationGroup', {}).get('replicationGroupName')
                  or self._properties.get('subTask', {}).get('subTaskName'))
    return group_name.replace('_ReplicationPlan__ReplicationGroup', '')
var replication_guid

Treats the replication guid as a read-only attribute.

Expand source code Browse git
@property
def replication_guid(self):
    """Treats the replication guid as a read-only attribute."""
    return self._replication_guid
var reverse_replication_schedule_id

Returns (int): The schedule ID of the reverse replication schedule

Expand source code Browse git
@property
def reverse_replication_schedule_id(self):
    """Returns (int): The schedule ID of the reverse replication schedule"""
    for prop in self._properties.get('VMReplInfoProperties', []):
        if prop.get('propertyId', 0) == 2212 and prop.get('propertyValue'):
            return int(prop.get('propertyValue'))
    return None
var source_vm

Treats the source VM as a read-only attribute.

Expand source code Browse git
@property
def source_vm(self):
    """Treats the source VM as a read-only attribute."""
    return self._source_vm
var source_vm_guid

Returns (str): The GUID of the source VM

Expand source code Browse git
@property
def source_vm_guid(self):
    """ Returns (str): The GUID of the source VM """
    return self._properties.get('sourceGuid')
var status

Treats the status as a read-only attribute.

Expand source code Browse git
@property
def status(self):
    """Treats the status as a read-only attribute."""
    return sync_status(self._status).name
var task_id

Returns: (int) The ID of the replication schedule task

Expand source code Browse git
@property
def task_id(self):
    """ Returns: (int) The ID of the replication schedule task"""
    return self._properties.get('subTask', {}).get('taskId')
var vm_pair_id

Treats the live sync id as a read-only attribute.

Expand source code Browse git
@property
def vm_pair_id(self):
    """Treats the live sync id as a read-only attribute."""
    return self._vm_pair_id
var vm_pair_name

Treats the live sync name as a read-only attribute.

Expand source code Browse git
@property
def vm_pair_name(self):
    """Treats the live sync name as a read-only attribute."""
    return self._vm_pair_name

Methods

def refresh(self)

Refreshes the properties of the live sync

Expand source code Browse git
def refresh(self):
    """Refreshes the properties of the live sync"""
    self._get_vm_pair_properties()
class VsaLiveSync (subclient_object)

Class for configuring and monitoring virtual server live sync operations

Initializing instance of the VsaLiveSync class

Args

subclient_object (obj) – Instance of Subclient class

Expand source code Browse git
class VsaLiveSync:
    """Class for configuring and monitoring virtual server live sync operations"""

    def __new__(cls, subclient_object):
        """Decides which instance object needs to be created"""
        instance_name = subclient_object._instance_object.instance_name

        if instance_name == hv_type.MS_VIRTUAL_SERVER.value.lower():
            from .hyperv_live_sync import HyperVLiveSync
            return object.__new__(HyperVLiveSync)
        if instance_name == hv_type.AZURE_V2.value.lower():
            from .azure_live_sync import AzureLiveSync
            return object.__new__(AzureLiveSync)

        if instance_name == hv_type.VIRTUAL_CENTER.value.lower():
            from .vmware_live_sync import VMWareLiveSync
            return object.__new__(VMWareLiveSync)

        if instance_name == hv_type.AMAZON_AWS.value.lower():
            from .amazon_live_sync import AmazonLiveSync
            return object.__new__(AmazonLiveSync)

        raise SDKException(
            'LiveSync',
            '102',
            'Virtual server Live Sync for Instance: "{0}" is not yet supported'.format(instance_name)
        )

    def __init__(self, subclient_object):
        """Initializing instance of the VsaLiveSync class

        Args:
            subclient_object    (obj)   -- Instance of Subclient class

        """
        self._subclient_object = subclient_object
        self._subclient_id = self._subclient_object.subclient_id
        self._subclient_name = self._subclient_object.name

        self.schedule_pattern = SchedulePattern()

        self._live_sync_pairs = None

        self._commcell_object = self._subclient_object._commcell_object
        self._cvpysdk_object = self._commcell_object._cvpysdk_object
        self._services = self._commcell_object._services
        self._update_response_ = self._commcell_object._update_response_

        self._ALL_LIVE_SYNC_PAIRS = self._services['GET_ALL_LIVE_SYNC_PAIRS'] % self._subclient_id

        self.refresh()

    def __str__(self):
        """Representation string consisting of all Live sync pairs of the subclient.

        Returns:
            str - string of all the live sync pairs associated with the subclient

        """
        representation_string = '{:^5}\t{:^20}\n\n'.format('S. No.', 'LiveSyncPair')

        for index, live_sync in enumerate(self.live_sync_pairs):
            sub_str = '{:^5}\t{:20}\n'.format(index + 1, live_sync)
            representation_string += sub_str

        return representation_string.strip()

    def __repr__(self):
        """String representation of the instance of this class.

        Returns:
            str - string about the details of the VSALiveSync class instance

        """
        return 'VSALiveSync class instance for the Subclient: "{0}"'.format(self._subclient_name)

    def _get_live_sync_pairs(self):
        """Gets all the live sync pairs associated with the subclient

        Returns:
            dict    -- consists of all the live sync pairs in the subclient

                {
                    "live_sync_pair1_name": {
                                "id": live_sync_pair1_id
                    },
                    "live_sync_pair2_name": {
                                "id": live_sync_pair2_id
                    },
                }

        Raises:
                SDKException:
                    if response is empty

                    if response is not success

        """
        flag, response = self._cvpysdk_object.make_request('GET', self._ALL_LIVE_SYNC_PAIRS)

        if flag:
            live_sync_pairs_dict = {}
            if not bool(response.json()):
                return live_sync_pairs_dict
            if response.json() and 'siteInfo' not in response.json():
                return live_sync_pairs_dict
            elif response.json() and 'siteInfo' in response.json():
                for dictionary in response.json()['siteInfo']:
                    if dictionary["replicationGroup"]["replicationGroupName"] != "":
                        temp_name = dictionary["replicationGroup"]["replicationGroupName"]
                    else:
                        temp_name = dictionary['subTask']['subtaskName']
                    temp_id = str(dictionary['subTask']['taskId'])
                    live_sync_pairs_dict[temp_name.lower()] = {
                        'id': temp_id
                    }

                return live_sync_pairs_dict

            raise SDKException('Response', '102')

        raise SDKException('Response', '101', self._update_response_(response.text))

    @staticmethod
    def _live_sync_subtask_json(schedule_name):
        """setter for the subtask in live sync JSON

        Args:
            schedule_name   (str)   -- Name of the Live sync schedule to be created

        """
        return {
            "subTaskType": "RESTORE",
            "operationType": "SITE_REPLICATION",
            "subTaskName": schedule_name
        }

    def _configure_live_sync(self, schedule_name, restore_options, pattern_dict=None):
        """Configures Live sync after generating the full live sync json

        Args:
            schedule_name       (str)   -- Name of the Live sync schedule to be created

            restore_options     (dict)  -- Dictionary with all necessary values for Live sync

            pattern_dict        (dict)  -- Dictionary to generate the live sync schedule

                Sample:

                    for after_job_completes :
                    {
                        "freq_type": 'after_job_completes',
                        "active_start_date": date_in_%m/%d/%y (str),
                        "active_start_time": time_in_%H/%S (str),
                        "repeat_days": days_to_repeat (int)
                    }

                    for daily:
                    {
                         "freq_type": 'daily',
                         "active_start_time": time_in_%H/%S (str),
                         "repeat_days": days_to_repeat (int)
                    }

                    for weekly:
                    {
                         "freq_type": 'weekly',
                         "active_start_time": time_in_%H/%S (str),
                         "repeat_weeks": weeks_to_repeat (int)
                         "weekdays": list of weekdays ['Monday','Tuesday']
                    }

                    for monthly:
                    {
                         "freq_type": 'monthly',
                         "active_start_time": time_in_%H/%S (str),
                         "repeat_months": weeks_to_repeat (int)
                         "on_day": Day to run schedule (int)
                    }

                    for yearly:
                    {
                         "active_start_time": time_in_%H/%S (str),
                         "on_month": month to run schedule (str) January, Febuary...
                         "on_day": Day to run schedule (int)
                    }

        Returns:
            object - instance of the Schedule class for this Live sync

        **Note** use this method to generate full Live sync JSON and to post the API call in derived class

        """
        # To generate a random UUID for replication
        restore_options['replication_guid'] = str(uuid.uuid1())

        request_json = self._subclient_object._prepare_fullvm_restore_json(restore_options)

        # To include the schedule pattern
        request_json = self.schedule_pattern.create_schedule(
            request_json,
            pattern_dict or {'freq_type': 'after_job_completes'})

        request_json['taskInfo']['subTasks'][0]['subTask'] = self._live_sync_subtask_json(schedule_name)

        return self._subclient_object._process_restore_response(request_json)

    @property
    def live_sync_pairs(self):
        """Returns the dictionary of all the live sync pairs and their info

        Returns:
            dict    -- consists of all the live sync pairs in the subclient

                {
                    "live_sync_pair1_name": {
                                "id": live_sync_pair1_id
                    },
                    "live_sync_pair2_name": {
                                "id": live_sync_pair2_id
                    },
                }

        """
        return self._live_sync_pairs

    def get(self, live_sync_name):
        """Returns a LiveSyncPairs object for the given live sync name

        Args:
             live_sync_name     (str)   -- Name of the live sync

        Returns:
            object  - Instance of the LiveSyncPairs class for the given live sync name

        Raises:
            SDKException:
                if type of the live sync name argument is not string

        """
        if not isinstance(live_sync_name, str):
            raise SDKException('LiveSync', '101')
        live_sync_name = live_sync_name.lower()
        if self.has_live_sync_pair(live_sync_name):
            return LiveSyncPairs(
                self._subclient_object,
                live_sync_name,
                self.live_sync_pairs[live_sync_name]['id'])
        raise SDKException(
            'LiveSync', '102', 'No Live Sync exists with given name: {0}'.format(live_sync_name)
        )

    def has_live_sync_pair(self, live_sync_name):
        """Checks if a live sync pair exists with the given name

        Args:
            live_sync_name      (str)   -- Name of the live sync

        Returns:
                bool    -   boolean output whether the live sync pair exists in the subclient or not

        Raises:
            SDKException:
                if type of the live sync name argument is not string

        """
        return self.live_sync_pairs and live_sync_name.lower() in self.live_sync_pairs

    def refresh(self):
        """Refresh the live sync pairs associated with the subclient"""
        self._live_sync_pairs = self._get_live_sync_pairs()

Subclasses

Instance variables

var live_sync_pairs

Returns the dictionary of all the live sync pairs and their info

Returns

dict – consists of all the live sync pairs in the subclient

{
    "live_sync_pair1_name": {
                "id": live_sync_pair1_id
    },
    "live_sync_pair2_name": {
                "id": live_sync_pair2_id
    },
}
Expand source code Browse git
@property
def live_sync_pairs(self):
    """Returns the dictionary of all the live sync pairs and their info

    Returns:
        dict    -- consists of all the live sync pairs in the subclient

            {
                "live_sync_pair1_name": {
                            "id": live_sync_pair1_id
                },
                "live_sync_pair2_name": {
                            "id": live_sync_pair2_id
                },
            }

    """
    return self._live_sync_pairs

Methods

def get(self, live_sync_name)

Returns a LiveSyncPairs object for the given live sync name

Args

live_sync_name (str) – Name of the live sync

Returns

object - Instance of the LiveSyncPairs class for the given live sync name

Raises

SDKException: if type of the live sync name argument is not string

Expand source code Browse git
def get(self, live_sync_name):
    """Returns a LiveSyncPairs object for the given live sync name

    Args:
         live_sync_name     (str)   -- Name of the live sync

    Returns:
        object  - Instance of the LiveSyncPairs class for the given live sync name

    Raises:
        SDKException:
            if type of the live sync name argument is not string

    """
    if not isinstance(live_sync_name, str):
        raise SDKException('LiveSync', '101')
    live_sync_name = live_sync_name.lower()
    if self.has_live_sync_pair(live_sync_name):
        return LiveSyncPairs(
            self._subclient_object,
            live_sync_name,
            self.live_sync_pairs[live_sync_name]['id'])
    raise SDKException(
        'LiveSync', '102', 'No Live Sync exists with given name: {0}'.format(live_sync_name)
    )
def has_live_sync_pair(self, live_sync_name)

Checks if a live sync pair exists with the given name

Args

live_sync_name (str) – Name of the live sync

Returns

bool - boolean output whether the live sync pair exists in the subclient or not

Raises

SDKException: if type of the live sync name argument is not string

Expand source code Browse git
def has_live_sync_pair(self, live_sync_name):
    """Checks if a live sync pair exists with the given name

    Args:
        live_sync_name      (str)   -- Name of the live sync

    Returns:
            bool    -   boolean output whether the live sync pair exists in the subclient or not

    Raises:
        SDKException:
            if type of the live sync name argument is not string

    """
    return self.live_sync_pairs and live_sync_name.lower() in self.live_sync_pairs
def refresh(self)

Refresh the live sync pairs associated with the subclient

Expand source code Browse git
def refresh(self):
    """Refresh the live sync pairs associated with the subclient"""
    self._live_sync_pairs = self._get_live_sync_pairs()