def save(self, context, folder_path, configuration_type, vrf_management_name):
"""Save selected file to the provided destination
:param ResourceCommandContext context: ResourceCommandContext object with all Resource Attributes inside
:param configuration_type: source file, which will be saved
:param folder_path: destination path where file will be saved
:param vrf_management_name: VRF management Name
:return str saved configuration file name:
"""
if not configuration_type:
configuration_type = 'running'
if not vrf_management_name:
vrf_management_name = get_attribute_by_name(context=context, attribute_name='VRF Management Name')
logger = get_logger_with_thread_id(context)
api = get_api(context)
configuration_operations = ConfigurationRunner(logger=logger, cli=self._cli, context=context, api=api)
logger.info('Save started')
response = configuration_operations.save(folder_path=folder_path, configuration_type=configuration_type,
vrf_management_name=vrf_management_name)
logger.info('Save completed')
return response
def restore(self, context, path, configuration_type, restore_method,
vrf_management_name):
"""Restore selected file to the provided destination
:param ResourceCommandContext context: ResourceCommandContext object with all Resource Attributes inside
:param path: source config file
:param configuration_type: running or startup configs
:param restore_method: append or override methods
:param vrf_management_name: VRF management Name
"""
if not configuration_type:
configuration_type = 'running'
if not restore_method:
restore_method = 'override'
if not vrf_management_name:
vrf_management_name = get_attribute_by_name(
context=context, attribute_name='VRF Management Name')
logger = get_logger_with_thread_id(context)
api = get_api(context)
configuration_operations = ConfigurationRunner(logger=logger,
api=api,
cli=self._cli,
context=context)
logger.info('Restore started')
configuration_operations.restore(
path=path,
restore_method=restore_method,
configuration_type=configuration_type,
vrf_management_name=vrf_management_name)
logger.info('Restore completed')
def ApplyConnectivityChanges(self, context, request):
"""
Create vlan and add or remove it to/from network interface
:param ResourceCommandContext context: ResourceCommandContext object with all Resource Attributes inside
:param str request: request json
:return:
"""
logger = get_logger_with_thread_id(context)
api = get_api(context)
connectivity_operations = ConnectivityRunner(cli=self._cli,
context=context,
api=api,
logger=logger)
logger.info(
'Start applying connectivity changes, request is: {0}'.format(
str(request)))
result = connectivity_operations.apply_connectivity_changes(
request=request)
logger.info(
'Finished applying connectivity changes, response is: {0}'.format(
str(result)))
logger.info('Apply Connectivity changes completed')
return result
def save(self, context, folder_path, configuration_type,
vrf_management_name):
"""Save selected file to the provided destination
:param ResourceCommandContext context: ResourceCommandContext object with all Resource Attributes inside
:param configuration_type: source file, which will be saved
:param folder_path: destination path where file will be saved
:param vrf_management_name: VRF management Name
:return str saved configuration file name:
"""
if not configuration_type:
configuration_type = 'running'
if not vrf_management_name:
vrf_management_name = get_attribute_by_name(
context=context, attribute_name='VRF Management Name')
logger = get_logger_with_thread_id(context)
api = get_api(context)
configuration_operations = ConfigurationRunner(logger=logger,
cli=self._cli,
context=context,
api=api)
logger.info('Save started')
response = configuration_operations.save(
folder_path=folder_path,
configuration_type=configuration_type,
vrf_management_name=vrf_management_name)
logger.info('Save completed')
return response
def orchestration_save(self, context, mode, custom_params):
"""
:param ResourceCommandContext context: ResourceCommandContext object with all Resource Attributes inside
:param mode: mode
:param custom_params: json with custom save parameters
:return str response: response json
"""
if not mode:
mode = 'shallow'
logger = get_logger_with_thread_id(context)
api = get_api(context)
configuration_operations = ConfigurationRunner(logger=logger,
api=api,
cli=self._cli,
context=context)
logger.info(
'Orchestration save started, request is: {}'.format(custom_params))
response = configuration_operations.orchestration_save(
mode=mode, custom_params=custom_params)
logger.info(
'Orchestration save completed, response is: {}'.format(response))
return response
def restore(self, context, path, configuration_type, restore_method, vrf_management_name):
"""Restore selected file to the provided destination
:param ResourceCommandContext context: ResourceCommandContext object with all Resource Attributes inside
:param path: source config file
:param configuration_type: running or startup configs
:param restore_method: append or override methods
:param vrf_management_name: VRF management Name
"""
if not configuration_type:
configuration_type = 'running'
if not restore_method:
restore_method = 'override'
if not vrf_management_name:
vrf_management_name = get_attribute_by_name(context=context, attribute_name='VRF Management Name')
logger = get_logger_with_thread_id(context)
api = get_api(context)
configuration_operations = ConfigurationRunner(logger=logger, api=api, cli=self._cli, context=context)
logger.info('Restore started')
configuration_operations.restore(path=path, restore_method=restore_method,
configuration_type=configuration_type,
vrf_management_name=vrf_management_name)
logger.info('Restore completed')
def ApplyConnectivityChanges(self, context, request):
logger = get_logger_with_thread_id(context)
api = get_api(context)
connectivity_operations = ConnectivityRunner(cli=self._cli, context=context, api=api, logger=logger)
logger.info('Start applying connectivity changes, request is: {0}'.format(str(request)))
result = connectivity_operations.apply_connectivity_changes(request=request)
logger.info('Finished applying connectivity changes, response is: {0}'.format(str(
result)))
logger.info('Apply Connectivity changes completed')
return result
def health_check(self, context):
"""Performs device health check
:param ResourceCommandContext context: ResourceCommandContext object with all Resource Attributes inside
:return: Success or Error message
:rtype: str
"""
logger = get_logger_with_thread_id(context)
api = get_api(context)
state_operations = StateRunner(cli=self._cli, logger=logger, api=api, context=context)
return state_operations.health_check()
def shutdown(self, context):
"""
Request power off
:param context:
:return:
"""
logger = get_logger_with_thread_id(context)
api = get_api(context)
state_operations = StateRunner(cli=self._cli,
logger=logger,
api=api,
context=context)
return state_operations.shutdown()
def send_custom_config_command(self, context, custom_command):
"""Send custom command in configuration mode
:param ResourceCommandContext context: ResourceCommandContext object with all Resource Attributes inside
:return: result
:rtype: str
"""
logger = get_logger_with_thread_id(context)
api = get_api(context)
send_command_operations = CommandRunner(cli=self._cli, logger=logger, context=context, api=api)
result_str = send_command_operations.run_custom_config_command(custom_command=custom_command)
return result_str
def health_check(self, context):
"""Performs device health check
:param ResourceCommandContext context: ResourceCommandContext object with all Resource Attributes inside
:return: Success or Error message
:rtype: str
"""
logger = get_logger_with_thread_id(context)
api = get_api(context)
state_operations = StateRunner(cli=self._cli,
logger=logger,
api=api,
context=context)
return state_operations.health_check()
def orchestration_restore(self, context, saved_artifact_info, custom_params):
"""
:param ResourceCommandContext context: ResourceCommandContext object with all Resource Attributes inside
:param saved_artifact_info: OrchestrationSavedArtifactInfo json
:param custom_params: json with custom restore parameters
"""
logger = get_logger_with_thread_id(context)
api = get_api(context)
configuration_operations = ConfigurationRunner(logger=logger, api=api, cli=self._cli, context=context)
logger.info('Orchestration restore started')
configuration_operations.orchestration_restore(saved_artifact_info=saved_artifact_info,
custom_params=custom_params)
logger.info('Orchestration restore completed')
def get_inventory(self, context):
"""Return device structure with all standard attributes
:param ResourceCommandContext context: ResourceCommandContext object with all Resource Attributes inside
:return: response
:rtype: str
"""
logger = get_logger_with_thread_id(context)
api = get_api(context)
autoload_operations = AutoloadRunner(cli=self._cli, logger=logger, context=context, api=api,
supported_os=self.supported_os)
logger.info('Autoload started')
response = autoload_operations.discover()
logger.info('Autoload completed')
return response
def update_firmware(self, context, remote_host, file_path):
"""Upload and updates firmware on the resource
:param remote_host: path to firmware file location on ftp or tftp server
:param file_path: firmware file name
:return: result
:rtype: str
"""
logger = get_logger_with_thread_id(context)
api = get_api(context)
vrf_management_name = get_attribute_by_name(context=context, attribute_name='VRF Management Name')
logger.info('Start Update Firmware')
firmware_operations = FirmwareRunner(cli=self._cli, logger=logger, context=context, api=api)
response = firmware_operations.load_firmware(path=remote_host, vrf_management_name=vrf_management_name)
logger.info('Finish Update Firmware: {}'.format(response))
def load_firmware(self, context, path, vrf_management_name):
"""Upload and updates firmware on the resource
:param ResourceCommandContext context: ResourceCommandContext object with all Resource Attributes inside
:param path: full path to firmware file, i.e. tftp://10.10.10.1/firmware.tar
:param vrf_management_name: VRF management Name
"""
logger = get_logger_with_thread_id(context)
api = get_api(context)
if not vrf_management_name:
vrf_management_name = get_attribute_by_name(context=context, attribute_name='VRF Management Name')
logger.info('Start Load Firmware')
firmware_operations = FirmwareRunner(cli=self._cli, logger=logger, context=context, api=api)
response = firmware_operations.load_firmware(path=path, vrf_management_name=vrf_management_name)
logger.info('Finish Load Firmware: {}'.format(response))
def send_custom_config_command(self, context, custom_command):
"""Send custom command in configuration mode
:param ResourceCommandContext context: ResourceCommandContext object with all Resource Attributes inside
:return: result
:rtype: str
"""
logger = get_logger_with_thread_id(context)
api = get_api(context)
send_command_operations = CommandRunner(cli=self._cli,
logger=logger,
context=context,
api=api)
result_str = send_command_operations.run_custom_config_command(
custom_command=custom_command)
return result_str
def ApplyConnectivityChanges(self, context, request):
logger = get_logger_with_thread_id(context)
api = get_api(context)
connectivity_operations = ConnectivityRunner(cli=self._cli,
context=context,
api=api,
logger=logger)
logger.info(
'Start applying connectivity changes, request is: {0}'.format(
str(request)))
result = connectivity_operations.apply_connectivity_changes(
request=request)
logger.info(
'Finished applying connectivity changes, response is: {0}'.format(
str(result)))
logger.info('Apply Connectivity changes completed')
return result
def get_inventory(self, context):
"""Return device structure with all standard attributes
:param ResourceCommandContext context: ResourceCommandContext object with all Resource Attributes inside
:return: response
:rtype: str
"""
logger = get_logger_with_thread_id(context)
api = get_api(context)
autoload_operations = AutoloadRunner(cli=self._cli,
logger=logger,
context=context,
api=api,
supported_os=self.supported_os)
logger.info('Autoload started')
response = autoload_operations.discover()
logger.info('Autoload completed')
return response
def orchestration_save(self, context, mode, custom_params):
"""
:param ResourceCommandContext context: ResourceCommandContext object with all Resource Attributes inside
:param mode: mode
:param custom_params: json with custom save parameters
:return str response: response json
"""
if not mode:
mode = 'shallow'
logger = get_logger_with_thread_id(context)
api = get_api(context)
configuration_operations = ConfigurationRunner(logger=logger, api=api, cli=self._cli, context=context)
logger.info('Orchestration save started')
response = configuration_operations.orchestration_save(mode=mode, custom_params=custom_params)
logger.info('Orchestration save completed')
return response
def actual_runner(self, context):
"""
Return runner instance for specific reservation id
:param context:
:return:
:rtype: InstanceLocker
"""
logger = get_logger_with_thread_id(context)
api = get_api(context)
reservation_id = context.reservation.reservation_id
if reservation_id not in self._runners:
runner_locker = InstanceLocker(
BPTestRunner(context, logger, api, self._reservation_info))
self._runners[reservation_id] = runner_locker
else:
runner_locker = self._runners[reservation_id]
runner_locker.instance.context = context
runner_locker.instance.logger = logger
runner_locker.instance.api = api
return runner_locker
def orchestration_restore(self, context, saved_artifact_info,
custom_params):
"""
:param ResourceCommandContext context: ResourceCommandContext object with all Resource Attributes inside
:param saved_artifact_info: OrchestrationSavedArtifactInfo json
:param custom_params: json with custom restore parameters
"""
logger = get_logger_with_thread_id(context)
api = get_api(context)
configuration_operations = ConfigurationRunner(logger=logger,
api=api,
cli=self._cli,
context=context)
logger.info('Orchestration restore started')
configuration_operations.orchestration_restore(
saved_artifact_info=saved_artifact_info,
custom_params=custom_params)
logger.info('Orchestration restore completed')
def load_firmware(self, context, path, vrf_management_name):
"""Upload and updates firmware on the resource
:param ResourceCommandContext context: ResourceCommandContext object with all Resource Attributes inside
:param path: full path to firmware file, i.e. tftp://10.10.10.1/firmware.tar
:param vrf_management_name: VRF management Name
"""
logger = get_logger_with_thread_id(context)
api = get_api(context)
if not vrf_management_name:
vrf_management_name = get_attribute_by_name(
context=context, attribute_name='VRF Management Name')
logger.info('Start Load Firmware')
firmware_operations = FirmwareRunner(cli=self._cli,
logger=logger,
context=context,
api=api)
response = firmware_operations.load_firmware(
path=path, vrf_management_name=vrf_management_name)
logger.info('Finish Load Firmware: {}'.format(response))
def update_firmware(self, context, remote_host, file_path):
"""Upload and updates firmware on the resource
:param remote_host: path to firmware file location on ftp or tftp server
:param file_path: firmware file name
:return: result
:rtype: str
"""
logger = get_logger_with_thread_id(context)
api = get_api(context)
vrf_management_name = get_attribute_by_name(
context=context, attribute_name='VRF Management Name')
logger.info('Start Update Firmware')
firmware_operations = FirmwareRunner(cli=self._cli,
logger=logger,
context=context,
api=api)
response = firmware_operations.load_firmware(
path=remote_host, vrf_management_name=vrf_management_name)
logger.info('Finish Update Firmware: {}'.format(response))