Module cvpysdk.subclients.virtualserver.livesync.amazon_live_sync

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

AmazonLiveSync is the only class defined in this file.

AmazonLiveSync: Class for configuring and monitoring Amazon subclient live sync

Amazonlivesync

configure_live_sync() – To configure live sync from supplied parameters

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 amazon subclient.

AmazonLiveSync is the only class defined in this file.

AmazonLiveSync: Class for configuring and monitoring Amazon subclient live sync

AmazonLiveSync:

    configure_live_sync()     -- To configure live sync from supplied parameters

"""
from cvpysdk.subclients.virtualserver.livesync.vsa_live_sync import VsaLiveSync
from cvpysdk.exception import SDKException


class AmazonLiveSync(VsaLiveSync):
    """Class for configuring and monitoring Amazon live sync operations"""
    def configure_live_sync(self,
                            schedule_name=None,
                            destination_client=None,
                            proxy_client=None,
                            copy_precedence=0,
                            power_on=True,
                            unconditional_overwrite=False,
                            pattern_dict=None,
                            vm_to_restore=None,
                            restored_vm_name=None,
                            restore_option=None,
                            networkdisplayname=None,
                            region=None,
                            data_center=None,
                            security_groups=None,
                            network=None,
                            volume_type="",
                            ):
        """To configure live

                Args:

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

                    destination_client          (str)   -- Client Name where VM needs to be restored

                    proxy_client                (str)   -- Name of the proxy client to be used

                    copy_precedence             (int)   -- Copy id from which restore needs to be performed
                                                            default: 0

                    power_on                    (bool)  -- To validate destination VM power on and off
                                                            default: True

                    unconditional_overwrite     (bool)  -- To overwrite VM and disk in destination
                                                            default: False

                    vm_to_restore               (list)  -- VM's to be restored

                    restored_vm_name            (str)   -- Name used for the VM when restored

                    restore_option              (dict)  -- Restore options dictionary with advanced options

                    networkdisplayname          (str)   -- Network Display name
                                                    which has used for destination VM

                    region                      (str)   -- region of the destination vm

                    datacenter                  (str)   -- esx host

                    securityGroups              (dict)  -- security groups to associate with replicated vm

                    network                     (dict)  -- network, subnet to associate with replicated vm

                    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, February...
                                 "on_day": Day to run schedule (int)
                            }

                Returns:
                    object - instance of the Schedule class for this Live sync
                    :param restored_vm_name:
                    :param vm_to_restore:
                    :param pattern_dict:
                    :param unconditional_overwrite:
                    :param power_on:
                    :param copy_precedence:
                    :param proxy_client:
                    :param networkdisplayname:
                    :param destination_client:
                    :param schedule_name:
                    :param security_groups:

                """
        # restore options
        if restore_option is None:
            restore_option = {}

        if vm_to_restore and not isinstance(vm_to_restore, str):
            raise SDKException('Subclient', '101')

        if not restored_vm_name:
            restored_vm_name = "LiveSync_"
        restore_option['restore_new_name'] = restored_vm_name

        if copy_precedence:
            restore_option["copy_precedence_applicable"] = True

        if vm_to_restore:
            vm_to_restore = [vm_to_restore]

        # check mandatory input parameters are correct
        if bool(restore_option):
            if not (isinstance(unconditional_overwrite, bool) and
                    isinstance(power_on, bool)):
                raise SDKException('Subclient', '101')

        # set attr for all the option in restore xml from user inputs
        self._subclient_object._set_restore_inputs(
            restore_option,
            vm_to_restore=self._subclient_object._set_vm_to_restore(vm_to_restore),
            vcenter_client=destination_client,
            unconditional_overwrite=unconditional_overwrite,
            power_on=power_on,
            copy_precedence=copy_precedence,
            volume_level_restore=1,
            client_name=proxy_client,
            esx_host=region,
            in_place=False,
            networkDisplayName=networkdisplayname,
            datacenter=data_center,
            securityGroups=security_groups,
            volumeType=volume_type,
            live_sync=True,
            nics=network
        )

        return self._configure_live_sync(schedule_name, restore_option, pattern_dict)

Classes

class AmazonLiveSync (subclient_object)

Class for configuring and monitoring Amazon live sync operations

Initializing instance of the VsaLiveSync class

Args

subclient_object (obj) – Instance of Subclient class

Expand source code Browse git
class AmazonLiveSync(VsaLiveSync):
    """Class for configuring and monitoring Amazon live sync operations"""
    def configure_live_sync(self,
                            schedule_name=None,
                            destination_client=None,
                            proxy_client=None,
                            copy_precedence=0,
                            power_on=True,
                            unconditional_overwrite=False,
                            pattern_dict=None,
                            vm_to_restore=None,
                            restored_vm_name=None,
                            restore_option=None,
                            networkdisplayname=None,
                            region=None,
                            data_center=None,
                            security_groups=None,
                            network=None,
                            volume_type="",
                            ):
        """To configure live

                Args:

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

                    destination_client          (str)   -- Client Name where VM needs to be restored

                    proxy_client                (str)   -- Name of the proxy client to be used

                    copy_precedence             (int)   -- Copy id from which restore needs to be performed
                                                            default: 0

                    power_on                    (bool)  -- To validate destination VM power on and off
                                                            default: True

                    unconditional_overwrite     (bool)  -- To overwrite VM and disk in destination
                                                            default: False

                    vm_to_restore               (list)  -- VM's to be restored

                    restored_vm_name            (str)   -- Name used for the VM when restored

                    restore_option              (dict)  -- Restore options dictionary with advanced options

                    networkdisplayname          (str)   -- Network Display name
                                                    which has used for destination VM

                    region                      (str)   -- region of the destination vm

                    datacenter                  (str)   -- esx host

                    securityGroups              (dict)  -- security groups to associate with replicated vm

                    network                     (dict)  -- network, subnet to associate with replicated vm

                    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, February...
                                 "on_day": Day to run schedule (int)
                            }

                Returns:
                    object - instance of the Schedule class for this Live sync
                    :param restored_vm_name:
                    :param vm_to_restore:
                    :param pattern_dict:
                    :param unconditional_overwrite:
                    :param power_on:
                    :param copy_precedence:
                    :param proxy_client:
                    :param networkdisplayname:
                    :param destination_client:
                    :param schedule_name:
                    :param security_groups:

                """
        # restore options
        if restore_option is None:
            restore_option = {}

        if vm_to_restore and not isinstance(vm_to_restore, str):
            raise SDKException('Subclient', '101')

        if not restored_vm_name:
            restored_vm_name = "LiveSync_"
        restore_option['restore_new_name'] = restored_vm_name

        if copy_precedence:
            restore_option["copy_precedence_applicable"] = True

        if vm_to_restore:
            vm_to_restore = [vm_to_restore]

        # check mandatory input parameters are correct
        if bool(restore_option):
            if not (isinstance(unconditional_overwrite, bool) and
                    isinstance(power_on, bool)):
                raise SDKException('Subclient', '101')

        # set attr for all the option in restore xml from user inputs
        self._subclient_object._set_restore_inputs(
            restore_option,
            vm_to_restore=self._subclient_object._set_vm_to_restore(vm_to_restore),
            vcenter_client=destination_client,
            unconditional_overwrite=unconditional_overwrite,
            power_on=power_on,
            copy_precedence=copy_precedence,
            volume_level_restore=1,
            client_name=proxy_client,
            esx_host=region,
            in_place=False,
            networkDisplayName=networkdisplayname,
            datacenter=data_center,
            securityGroups=security_groups,
            volumeType=volume_type,
            live_sync=True,
            nics=network
        )

        return self._configure_live_sync(schedule_name, restore_option, pattern_dict)

Ancestors

Methods

def configure_live_sync(self, schedule_name=None, destination_client=None, proxy_client=None, copy_precedence=0, power_on=True, unconditional_overwrite=False, pattern_dict=None, vm_to_restore=None, restored_vm_name=None, restore_option=None, networkdisplayname=None, region=None, data_center=None, security_groups=None, network=None, volume_type='')

To configure live

Args

schedule_name (str) – Name of the Live sync schedule to be created

destination_client (str) – Client Name where VM needs to be restored

proxy_client (str) – Name of the proxy client to be used

copy_precedence (int) – Copy id from which restore needs to be performed default: 0

power_on (bool) – To validate destination VM power on and off default: True

unconditional_overwrite (bool) – To overwrite VM and disk in destination default: False

vm_to_restore (list) – VM's to be restored

restored_vm_name (str) – Name used for the VM when restored

restore_option (dict) – Restore options dictionary with advanced options

networkdisplayname (str) – Network Display name which has used for destination VM

region (str) – region of the destination vm

datacenter (str) – esx host

securityGroups (dict) – security groups to associate with replicated vm

network (dict) – network, subnet to associate with replicated vm

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, February...
         "on_day": Day to run schedule (int)
    }

Returns

object - instance of the Schedule class for this Live sync :param restored_vm_name: :param vm_to_restore: :param pattern_dict: :param unconditional_overwrite: :param power_on: :param copy_precedence: :param proxy_client: :param networkdisplayname: :param destination_client: :param schedule_name: :param security_groups:

Expand source code Browse git
def configure_live_sync(self,
                        schedule_name=None,
                        destination_client=None,
                        proxy_client=None,
                        copy_precedence=0,
                        power_on=True,
                        unconditional_overwrite=False,
                        pattern_dict=None,
                        vm_to_restore=None,
                        restored_vm_name=None,
                        restore_option=None,
                        networkdisplayname=None,
                        region=None,
                        data_center=None,
                        security_groups=None,
                        network=None,
                        volume_type="",
                        ):
    """To configure live

            Args:

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

                destination_client          (str)   -- Client Name where VM needs to be restored

                proxy_client                (str)   -- Name of the proxy client to be used

                copy_precedence             (int)   -- Copy id from which restore needs to be performed
                                                        default: 0

                power_on                    (bool)  -- To validate destination VM power on and off
                                                        default: True

                unconditional_overwrite     (bool)  -- To overwrite VM and disk in destination
                                                        default: False

                vm_to_restore               (list)  -- VM's to be restored

                restored_vm_name            (str)   -- Name used for the VM when restored

                restore_option              (dict)  -- Restore options dictionary with advanced options

                networkdisplayname          (str)   -- Network Display name
                                                which has used for destination VM

                region                      (str)   -- region of the destination vm

                datacenter                  (str)   -- esx host

                securityGroups              (dict)  -- security groups to associate with replicated vm

                network                     (dict)  -- network, subnet to associate with replicated vm

                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, February...
                             "on_day": Day to run schedule (int)
                        }

            Returns:
                object - instance of the Schedule class for this Live sync
                :param restored_vm_name:
                :param vm_to_restore:
                :param pattern_dict:
                :param unconditional_overwrite:
                :param power_on:
                :param copy_precedence:
                :param proxy_client:
                :param networkdisplayname:
                :param destination_client:
                :param schedule_name:
                :param security_groups:

            """
    # restore options
    if restore_option is None:
        restore_option = {}

    if vm_to_restore and not isinstance(vm_to_restore, str):
        raise SDKException('Subclient', '101')

    if not restored_vm_name:
        restored_vm_name = "LiveSync_"
    restore_option['restore_new_name'] = restored_vm_name

    if copy_precedence:
        restore_option["copy_precedence_applicable"] = True

    if vm_to_restore:
        vm_to_restore = [vm_to_restore]

    # check mandatory input parameters are correct
    if bool(restore_option):
        if not (isinstance(unconditional_overwrite, bool) and
                isinstance(power_on, bool)):
            raise SDKException('Subclient', '101')

    # set attr for all the option in restore xml from user inputs
    self._subclient_object._set_restore_inputs(
        restore_option,
        vm_to_restore=self._subclient_object._set_vm_to_restore(vm_to_restore),
        vcenter_client=destination_client,
        unconditional_overwrite=unconditional_overwrite,
        power_on=power_on,
        copy_precedence=copy_precedence,
        volume_level_restore=1,
        client_name=proxy_client,
        esx_host=region,
        in_place=False,
        networkDisplayName=networkdisplayname,
        datacenter=data_center,
        securityGroups=security_groups,
        volumeType=volume_type,
        live_sync=True,
        nics=network
    )

    return self._configure_live_sync(schedule_name, restore_option, pattern_dict)

Inherited members