Module cvpysdk.drorchestration.drjob

Main file for getting DR orchestration/sync job details and phases

DRJob: Class for representing all the DR jobs

DRJob(Job): init(commcell_object, job_id) – Initialise object of DRJob _get_replication_job_stats() – Gets the DR job statistics get_phases() – Gets the phases of the DR job get_vm_list() – Gets the list of all VMs and their properties

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.
# --------------------------------------------------------------------------

"""Main file for getting DR orchestration/sync job details and phases

DRJob: Class for representing all the DR jobs

DRJob(Job):
    __init__(commcell_object,
            job_id)                 -- Initialise object of DRJob
    _get_replication_job_stats()    -- Gets the DR job statistics
    get_phases()                    -- Gets the phases of the DR job
    get_vm_list()                   -- Gets the list of all VMs and their properties
"""

from cvpysdk.exception import SDKException
from cvpysdk.job import Job
from cvpysdk.drorchestration.dr_orchestration_job_phase import DRJobPhases, DRJobPhaseToText


class DRJob(Job):
    """Class for performing DR orchestration operations on ReplicationMonitor."""

    def __init__(self, commcell_object, job_id):
        """Initialise the DR job"""
        self._replication_job_stats = None

        service_url = (commcell_object._services['DRORCHESTRATION_JOB_STATS']
                       if commcell_object.commserv_version > 30
                       else commcell_object._services['DR_JOB_STATS'])
        self._REPLICATION_STATS = service_url % job_id

        Job.__init__(self, commcell_object, job_id)

    def __repr__(self):
        representation_string = 'DRJob class instance for job id: "{0}"'
        return representation_string.format(self.job_id)

    def _get_replication_job_stats(self):
        """Gets the statistics for the DR Job
        Returns:
                [{
                    'jobId': 123,
                    'replicationId': 1,
                    'phase': [{
                            'phase': 1,
                            'status': 0,
                            'startTime': {
                                '_type_': 0,
                                'time': 0
                            },
                            'endTime': {
                                '_type_': 0,
                                'time': 0
                            },
                            'entity': {
                                'clientName': 'vm1'
                            },
                            'phaseInfo': {
                                'job': [
                                    {
                                        'jobid': 123,
                                        'opType': 1,
                                        'failure': {
                                            'errorMessage': 'Error message'
                                        },
                                        'entity': {
                                            'clientName': 'vm1',
                                            '_type_': 0
                                        }
                                    }
                                ]
                            }
                        }]
                    'client': {
                        'clientId': 0,
                        'clientName': 'vm1'
                    },
                    'vapp': {
                        'vAppId': 1
                    }
                }]
        """
        flag, response = self._commcell_object._cvpysdk_object.make_request(
            'GET', self._REPLICATION_STATS)

        if flag:
            if response.json() and 'job' in response.json():
                return response.json()['job'] or []
            elif response.json() and 'errors' in response.json():
                errors = response.json().get('errors', [{}])
                error_list = errors[0].get('errList', [{}])
                error_code = error_list[0].get('errorCode', 0)
                error_message = error_list.get('errLogMessage', '').strip()
                if error_code != 0:
                    response_string = self._commcell_object._update_response_(
                        error_message)
                    raise SDKException('Response', '101', response_string)
            else:
                if response.json():
                    raise SDKException('Response', '102')
        else:
            response_string = self._commcell_object._update_response_(
                response.text)
            raise SDKException('Response', '101', response_string)

    def _initialize_job_properties(self):
        """Initialises the job properties and then initialises the DR job details"""
        Job._initialize_job_properties(self)
        self._replication_job_stats = self._get_replication_job_stats()

    def blobs_retained(self):
        """Returns True if blobs to be retained chosen in failover job for Azure destination"""
        task_details_json = self.task_details
        dr_opts = task_details_json['subTasks'][0]['options']['adminOpts'].get('drOrchestrationOption')
        blobs_retained = dr_opts.get('retainIntegritySnapshot') if dr_opts else None
        return blobs_retained

    def get_phases(self):
        """
        Gets the DR phases of the job
        Returns: dictionaries of phases for each source and destination VM pair
            {"source_vm_1": [{
                'phase_name': enum - Enum of phase short name and full name mapping,
                'phase_status': int - 0 for success, 1 for failed,
                'start_time': int - timestamp of start of job,
                'end_time': int - timestamp of end of job,
                'machine_name': str - The name of the machine Job is executing on,
                'error_message': str - Error message, if any,
            }],
            }
        """
        job_stats = {}
        if not self._replication_job_stats:
            return job_stats
        for pair_stats in self._replication_job_stats:
            phases = []
            for phase in pair_stats.get('phase', []):
                phases.append({
                    'phase_name': DRJobPhaseToText[DRJobPhases(phase.get('phase', '')).name]
                    if phase.get('phase', '') else '',
                    'phase_status': phase.get('status', 1),
                    'start_time': phase.get('startTime', {}).get('time', ''),
                    'end_time': phase.get('endTime', {}).get('time', ''),
                    'machine_name': phase.get('entity', {}).get('clientName', ''),
                    'error_message': phase.get('phaseInfo', {}).get('job', [{}])[0].get('failure', {})
                                     .get('errorMessage', ''),
                    'job_id': str(phase.get('phaseInfo', {}).get('job', [{}])[0].get('jobid', '')),
                })
            job_stats[str(pair_stats.get('client', {}).get('clientName', ''))] = phases
        return job_stats

Classes

class DRJob (commcell_object, job_id)

Class for performing DR orchestration operations on ReplicationMonitor.

Initialise the DR job

Expand source code Browse git
class DRJob(Job):
    """Class for performing DR orchestration operations on ReplicationMonitor."""

    def __init__(self, commcell_object, job_id):
        """Initialise the DR job"""
        self._replication_job_stats = None

        service_url = (commcell_object._services['DRORCHESTRATION_JOB_STATS']
                       if commcell_object.commserv_version > 30
                       else commcell_object._services['DR_JOB_STATS'])
        self._REPLICATION_STATS = service_url % job_id

        Job.__init__(self, commcell_object, job_id)

    def __repr__(self):
        representation_string = 'DRJob class instance for job id: "{0}"'
        return representation_string.format(self.job_id)

    def _get_replication_job_stats(self):
        """Gets the statistics for the DR Job
        Returns:
                [{
                    'jobId': 123,
                    'replicationId': 1,
                    'phase': [{
                            'phase': 1,
                            'status': 0,
                            'startTime': {
                                '_type_': 0,
                                'time': 0
                            },
                            'endTime': {
                                '_type_': 0,
                                'time': 0
                            },
                            'entity': {
                                'clientName': 'vm1'
                            },
                            'phaseInfo': {
                                'job': [
                                    {
                                        'jobid': 123,
                                        'opType': 1,
                                        'failure': {
                                            'errorMessage': 'Error message'
                                        },
                                        'entity': {
                                            'clientName': 'vm1',
                                            '_type_': 0
                                        }
                                    }
                                ]
                            }
                        }]
                    'client': {
                        'clientId': 0,
                        'clientName': 'vm1'
                    },
                    'vapp': {
                        'vAppId': 1
                    }
                }]
        """
        flag, response = self._commcell_object._cvpysdk_object.make_request(
            'GET', self._REPLICATION_STATS)

        if flag:
            if response.json() and 'job' in response.json():
                return response.json()['job'] or []
            elif response.json() and 'errors' in response.json():
                errors = response.json().get('errors', [{}])
                error_list = errors[0].get('errList', [{}])
                error_code = error_list[0].get('errorCode', 0)
                error_message = error_list.get('errLogMessage', '').strip()
                if error_code != 0:
                    response_string = self._commcell_object._update_response_(
                        error_message)
                    raise SDKException('Response', '101', response_string)
            else:
                if response.json():
                    raise SDKException('Response', '102')
        else:
            response_string = self._commcell_object._update_response_(
                response.text)
            raise SDKException('Response', '101', response_string)

    def _initialize_job_properties(self):
        """Initialises the job properties and then initialises the DR job details"""
        Job._initialize_job_properties(self)
        self._replication_job_stats = self._get_replication_job_stats()

    def blobs_retained(self):
        """Returns True if blobs to be retained chosen in failover job for Azure destination"""
        task_details_json = self.task_details
        dr_opts = task_details_json['subTasks'][0]['options']['adminOpts'].get('drOrchestrationOption')
        blobs_retained = dr_opts.get('retainIntegritySnapshot') if dr_opts else None
        return blobs_retained

    def get_phases(self):
        """
        Gets the DR phases of the job
        Returns: dictionaries of phases for each source and destination VM pair
            {"source_vm_1": [{
                'phase_name': enum - Enum of phase short name and full name mapping,
                'phase_status': int - 0 for success, 1 for failed,
                'start_time': int - timestamp of start of job,
                'end_time': int - timestamp of end of job,
                'machine_name': str - The name of the machine Job is executing on,
                'error_message': str - Error message, if any,
            }],
            }
        """
        job_stats = {}
        if not self._replication_job_stats:
            return job_stats
        for pair_stats in self._replication_job_stats:
            phases = []
            for phase in pair_stats.get('phase', []):
                phases.append({
                    'phase_name': DRJobPhaseToText[DRJobPhases(phase.get('phase', '')).name]
                    if phase.get('phase', '') else '',
                    'phase_status': phase.get('status', 1),
                    'start_time': phase.get('startTime', {}).get('time', ''),
                    'end_time': phase.get('endTime', {}).get('time', ''),
                    'machine_name': phase.get('entity', {}).get('clientName', ''),
                    'error_message': phase.get('phaseInfo', {}).get('job', [{}])[0].get('failure', {})
                                     .get('errorMessage', ''),
                    'job_id': str(phase.get('phaseInfo', {}).get('job', [{}])[0].get('jobid', '')),
                })
            job_stats[str(pair_stats.get('client', {}).get('clientName', ''))] = phases
        return job_stats

Ancestors

Methods

def blobs_retained(self)

Returns True if blobs to be retained chosen in failover job for Azure destination

Expand source code Browse git
def blobs_retained(self):
    """Returns True if blobs to be retained chosen in failover job for Azure destination"""
    task_details_json = self.task_details
    dr_opts = task_details_json['subTasks'][0]['options']['adminOpts'].get('drOrchestrationOption')
    blobs_retained = dr_opts.get('retainIntegritySnapshot') if dr_opts else None
    return blobs_retained
def get_phases(self)

Gets the DR phases of the job Returns: dictionaries of phases for each source and destination VM pair {"source_vm_1": [{ 'phase_name': enum - Enum of phase short name and full name mapping, 'phase_status': int - 0 for success, 1 for failed, 'start_time': int - timestamp of start of job, 'end_time': int - timestamp of end of job, 'machine_name': str - The name of the machine Job is executing on, 'error_message': str - Error message, if any, }], }

Expand source code Browse git
def get_phases(self):
    """
    Gets the DR phases of the job
    Returns: dictionaries of phases for each source and destination VM pair
        {"source_vm_1": [{
            'phase_name': enum - Enum of phase short name and full name mapping,
            'phase_status': int - 0 for success, 1 for failed,
            'start_time': int - timestamp of start of job,
            'end_time': int - timestamp of end of job,
            'machine_name': str - The name of the machine Job is executing on,
            'error_message': str - Error message, if any,
        }],
        }
    """
    job_stats = {}
    if not self._replication_job_stats:
        return job_stats
    for pair_stats in self._replication_job_stats:
        phases = []
        for phase in pair_stats.get('phase', []):
            phases.append({
                'phase_name': DRJobPhaseToText[DRJobPhases(phase.get('phase', '')).name]
                if phase.get('phase', '') else '',
                'phase_status': phase.get('status', 1),
                'start_time': phase.get('startTime', {}).get('time', ''),
                'end_time': phase.get('endTime', {}).get('time', ''),
                'machine_name': phase.get('entity', {}).get('clientName', ''),
                'error_message': phase.get('phaseInfo', {}).get('job', [{}])[0].get('failure', {})
                                 .get('errorMessage', ''),
                'job_id': str(phase.get('phaseInfo', {}).get('job', [{}])[0].get('jobid', '')),
            })
        job_stats[str(pair_stats.get('client', {}).get('clientName', ''))] = phases
    return job_stats

Inherited members