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 = LoggingSessionContext.get_logger_with_thread_id(context)
api = CloudShellSessionContext(context).get_api()
resource_config = NetworkingResourceConfig.from_context(shell_name=self.SHELL_NAME,
supported_os=self.SUPPORTED_OS,
context=context, api=api)
cli_handler = self._cli.get_cli_handler(resource_config, logger)
configuration_flow = ConfigurationFlow(cli_handler=cli_handler,
logger=logger,
resource_config=resource_config)
logger.info('Orchestration restore started')
restore_params = OrchestrationSaveRestore(logger, resource_config.name).parse_orchestration_save_result(
saved_artifact_info)
configuration_flow.restore(**restore_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 = LoggingSessionContext.get_logger_with_thread_id(context)
api = CloudShellSessionContext(context).get_api()
resource_config = NetworkingResourceConfig.from_context(shell_name=self.SHELL_NAME,
supported_os=self.SUPPORTED_OS,
context=context, api=api)
cli_handler = self._cli.get_cli_handler(resource_config, logger)
snmp_handler = SNMPHandler(resource_config, logger, cli_handler)
autoload_operations = AutoloadFlow(logger=logger,
snmp_handler=snmp_handler)
logger.info('Autoload started')
resource_model = NetworkingResourceModel(resource_config.name,
resource_config.shell_name,
resource_config.family_name)
response = autoload_operations.discover(resource_config.supported_os, resource_model)
logger.info('Autoload completed')
return 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 = LoggingSessionContext.get_logger_with_thread_id(context)
api = CloudShellSessionContext(context).get_api()
resource_config = NetworkingResourceConfig.from_context(shell_name=self.SHELL_NAME,
supported_os=self.SUPPORTED_OS,
context=context, api=api)
if not vrf_management_name:
vrf_management_name = resource_config.vrf_management_name
cli_handler = self._cli.get_cli_handler(resource_config, logger)
logger.info('Start Load Firmware')
firmware_operations = FirmwareFlow(cli_handler=cli_handler,
logger=logger)
response = firmware_operations.load_firmware(path=path,
vrf_management_name=vrf_management_name)
logger.info('Finish Load Firmware: {}'.format(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
"""
logger = LoggingSessionContext.get_logger_with_thread_id(context)
api = CloudShellSessionContext(context).get_api()
resource_config = NetworkingResourceConfig.from_context(shell_name=self.SHELL_NAME,
supported_os=self.SUPPORTED_OS,
context=context, api=api)
if not configuration_type:
configuration_type = 'running'
if not restore_method:
restore_method = 'override'
if not vrf_management_name:
vrf_management_name = resource_config.vrf_management_name
cli_handler = self._cli.get_cli_handler(resource_config, logger)
configuration_flow = ConfigurationFlow(cli_handler=cli_handler,
logger=logger,
resource_config=resource_config)
logger.info('Restore started')
configuration_flow.restore(path=path, restore_method=restore_method,
configuration_type=configuration_type,
vrf_management_name=vrf_management_name)
logger.info('Restore completed')
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 = LoggingSessionContext.get_logger_with_thread_id(context)
api = CloudShellSessionContext(context).get_api()
resource_config = NetworkingResourceConfig.from_context(shell_name=self.SHELL_NAME,
supported_os=self.SUPPORTED_OS,
context=context, api=api)
cli_handler = self._cli.get_cli_handler(resource_config, logger)
configuration_flow = ConfigurationFlow(cli_handler=cli_handler,
logger=logger,
resource_config=resource_config)
logger.info('Orchestration save started')
response = configuration_flow.orchestration_save(mode=mode,
custom_params=custom_params)
response_json = OrchestrationSaveRestore(logger, resource_config.name).prepare_orchestration_save_result(
response)
logger.info('Orchestration save completed')
return response_json
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:
"""
logger = LoggingSessionContext.get_logger_with_thread_id(context)
api = CloudShellSessionContext(context).get_api()
resource_config = NetworkingResourceConfig.from_context(shell_name=self.SHELL_NAME,
supported_os=self.SUPPORTED_OS,
context=context, api=api)
if not configuration_type:
configuration_type = 'running'
if not vrf_management_name:
vrf_management_name = resource_config.vrf_management_name
cli_handler = self._cli.get_cli_handler(resource_config, logger)
configuration_flow = ConfigurationFlow(cli_handler=cli_handler,
logger=logger,
resource_config=resource_config)
logger.info('Save started')
response = configuration_flow.save(folder_path=folder_path,
configuration_type=configuration_type,
vrf_management_name=vrf_management_name)
logger.info('Save completed')
return response
def run_custom_command(self, context: ResourceCommandContext,
custom_command: str) -> str:
"""Send custom command.
:param custom_command: Command user wants to send to the device.
:param context: an object with all Resource Attributes inside
:return: result
"""
logger = LoggingSessionContext.get_logger_with_thread_id(context)
api = CloudShellSessionContext(context).get_api()
resource_config = NetworkingResourceConfig.from_context(
shell_name=self.SHELL_NAME,
supported_os=self.SUPPORTED_OS,
context=context,
api=api,
)
cli_handler = self._cli.get_cli_handler(resource_config, logger)
send_command_operations = CommandFlow(logger=logger,
cli_configurator=cli_handler)
response = send_command_operations.run_custom_command(
custom_command=custom_command)
return response
def shutdown(self, context: ResourceCommandContext):
"""Shutdown device.
:param context: an object with all Resource Attributes inside
:return:
"""
logger = LoggingSessionContext.get_logger_with_thread_id(context)
api = CloudShellSessionContext(context).get_api()
resource_config = NetworkingResourceConfig.from_context(
shell_name=self.SHELL_NAME,
supported_os=self.SUPPORTED_OS,
context=context,
api=api,
)
cli_handler = self._cli.get_cli_handler(resource_config, logger)
state_operations = StateFlow(
logger=logger,
api=api,
resource_config=resource_config,
cli_configurator=cli_handler,
)
return state_operations.shutdown()
def ApplyConnectivityChanges(self, context: ResourceCommandContext,
request: str) -> str:
"""
Create vlan and add or remove it to/from network interface.
:param context: an object with all Resource Attributes inside
:param str request: request json
:return:
"""
logger = LoggingSessionContext.get_logger_with_thread_id(context)
api = CloudShellSessionContext(context).get_api()
resource_config = NetworkingResourceConfig.from_context(
shell_name=self.SHELL_NAME,
supported_os=self.SUPPORTED_OS,
context=context,
api=api,
)
cli_handler = self._cli.get_cli_handler(resource_config, logger)
connectivity_operations = ConnectivityFlow(
logger=logger,
cli_handler=cli_handler,
support_vlan_range_str=False,
support_multi_vlan_str=False,
)
logger.info("Start applying connectivity changes.")
result = connectivity_operations.apply_connectivity_changes(
request=request)
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 = LoggingSessionContext.get_logger_with_thread_id(context)
api = CloudShellSessionContext(context).get_api()
resource_config = NetworkingResourceConfig.from_context(shell_name=self.SHELL_NAME,
supported_os=self.SUPPORTED_OS,
context=context, api=api)
cli_handler = self._cli.get_cli_handler(resource_config, logger)
state_operations = StateFlow(logger=logger,
api=api,
resource_config=resource_config,
cli_configurator=cli_handler)
return state_operations.health_check()
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 = LoggingSessionContext.get_logger_with_thread_id(context)
api = CloudShellSessionContext(context).get_api()
resource_config = NetworkingResourceConfig.from_context(shell_name=self.SHELL_NAME,
supported_os=self.SUPPORTED_OS,
context=context, api=api)
cli_handler = self._cli.get_cli_handler(resource_config, logger)
connectivity_operations = ConnectivityFlow(logger=logger, cli_handler=cli_handler)
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
