def update_firmware(self, context, remote_host, file_path): """Upload and updates firmware on the resource :param ResourceCommandContext context: ResourceCommandContext object with all Resource Attributes inside :param remote_host: full path to firmware file, i.e. tftp://10.10.10.1/firmware.tar :param file_path: file name """ logger = get_logger_with_thread_id(context) api = get_api(context) resource_config = create_networking_resource_from_context( shell_name=self.SHELL_NAME, supported_os=self.SUPPORTED_OS, context=context) cli_handler = CliHandler(self._cli, resource_config, logger, api) logger.info('Start Load Firmware') firmware_operations = FirmwareRunner(cli_handler=cli_handler, logger=logger) response = firmware_operations.load_firmware( path=remote_host, vrf_management_name=resource_config.vrf_management_name) logger.info('Finish Load Firmware: {}'.format(response))
def load_firmware(self, context, path, features_to_install="", vrf_management_name=None): """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 features_to_install: :param vrf_management_name: VRF management Name """ logger = get_logger_with_thread_id(context) api = get_api(context) resource_config = create_networking_resource_from_context( shell_name=self.SHELL_NAME, supported_os=self.SUPPORTED_OS, context=context) if not vrf_management_name: vrf_management_name = resource_config.vrf_management_name cli_handler = CliHandler(self._cli, resource_config, logger, api) logger.info('Start Load Firmware') firmware_operations = FirmwareRunner( cli_handler=cli_handler, logger=logger, features_to_install=features_to_install) response = firmware_operations.load_firmware( path=path, vrf_management_name=vrf_management_name) logger.info('Finish Load Firmware: {}'.format(response)) return response
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) resource_config = create_networking_resource_from_context( shell_name=self.SHELL_NAME, supported_os=self.SUPPORTED_OS, context=context) cli_handler = CliHandler(self._cli, resource_config, logger, api) configuration_operations = ConfigurationRunner( cli_handler=cli_handler, logger=logger, resource_config=resource_config, api=api) 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 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) logger.info('Apply connectivity changes command started with request: {}'.format(request)) with ErrorHandlingContext(logger): api = get_api(context) resource_config = create_networking_resource_from_context(shell_name=self.SHELL_NAME, supported_os=self.SUPPORTED_OS, context=context) cli_handler = CumulusCliHandler(cli=self._cli, resource_config=resource_config, logger=logger, api=api) connectivity_operations = CumulusLinuxConnectivityRunner(cli_handler=cli_handler, logger=logger) result = connectivity_operations.apply_connectivity_changes(request=request) logger.info('Apply connectivity changes command completed with response: {}'.format(result)) return result
def orchestration_restore(self, context, cancellation_context, saved_artifact_info, custom_params): """Restores a saved artifact previously saved by this Shell driver using the orchestration_save function :param ResourceCommandContext context: The context object for the command with resource and reservation info :param CancellationContext cancellation_context: Object to signal a request for cancellation. Must be enabled in drivermetadata.xml as well :param str saved_artifact_info: A JSON string representing the state to restore including saved artifacts and info :param str custom_params: Set of custom parameters for the restore operation :return: None """ logger = get_logger_with_thread_id(context) logger.info("Orchestration restore command started") with ErrorHandlingContext(logger): api = get_api(context) resource_config = create_networking_resource_from_context(shell_name=self.SHELL_NAME, supported_os=self.SUPPORTED_OS, context=context) cli_handler = CumulusCliHandler(cli=self._cli, resource_config=resource_config, logger=logger, api=api) configuration_operations = CumulusLinuxConfigurationRunner(cli_handler=cli_handler, resource_config=resource_config, api=api, logger=logger) configuration_operations.orchestration_restore(saved_artifact_info=saved_artifact_info, custom_params=custom_params) logger.info('Orchestration restore command completed')
def shutdown(self, context, cancellation_context): """Sends a graceful shutdown to the device :param ResourceCommandContext context: The context object for the command with resource and reservation info :param CancellationContext cancellation_context: Object to signal a request for cancellation. Must be enabled in drivermetadata.xml as well """ logger = get_logger_with_thread_id(context) logger.info('Shutdown command started') with ErrorHandlingContext(logger): api = get_api(context) resource_config = create_networking_resource_from_context(shell_name=self.SHELL_NAME, supported_os=self.SUPPORTED_OS, context=context) cli_handler = CumulusCliHandler(cli=self._cli, resource_config=resource_config, logger=logger, api=api) state_operations = CumulusLinuxStateRunner(logger=logger, api=api, resource_config=resource_config,cli_handler=cli_handler) result = state_operations.shutdown() logger.info('Shutdown command ended with result: {}'.format(result)) 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: startup or running :param folder_path: destination path where file will be saved :param vrf_management_name: VRF management Name :return str saved configuration file name: """ logger = get_logger_with_thread_id(context) api = get_api(context) resource_config = create_networking_resource_from_context( self.SHELL_NAME, self.SUPPORTED_OS, context) cli_handler = CliHandler(self._cli, resource_config, logger, api) configuration_type = configuration_type or 'running' vrf_management_name = vrf_management_name or resource_config.vrf_management_name configuration_operations = ConfigurationRunner(logger, resource_config, api, cli_handler) 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 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) logger.info('Health Check command started') with ErrorHandlingContext(logger): api = get_api(context) resource_config = create_networking_resource_from_context( shell_name=self.SHELL_NAME, supported_os=self.SUPPORTED_OS, context=context) cli_handler = CgsCliHandler(cli=self._cli, resource_config=resource_config, logger=logger, api=api) state_operations = CgsStateRunner(logger=logger, api=api, resource_config=resource_config, cli_handler=cli_handler) result = state_operations.health_check() logger.info( 'Health Check command ended with result: {}'.format(result)) return result
def save(self, context, folder_path, configuration_type, vrf_management_name): """Save a configuration file to the provided destination :param ResourceCommandContext context: The context object for the command with resource and reservation info :param str folder_path: The path to the folder in which the configuration file will be saved :param str configuration_type: startup or running config :return The configuration file name :rtype: str """ logger = get_logger_with_thread_id(context) api = get_api(context) resource_config = create_networking_resource_from_context( shell_name=self.SHELL_NAME, supported_os=self.SUPPORTED_OS, context=context) cli_handler = CliHandler(self._cli, resource_config, logger, api) configuration_type = configuration_type or 'running' configuration_operations = ConfigurationRunner(logger, resource_config, api, cli_handler) logger.info('Save started') response = configuration_operations.save(folder_path, configuration_type) logger.info('Save completed') return response
def run_custom_command(self, context, cancellation_context, custom_command): """Executes a custom command on the device :param ResourceCommandContext context: The context object for the command with resource and reservation info :param CancellationContext cancellation_context: Object to signal a request for cancellation. Must be enabled in drivermetadata.xml as well :param str custom_command: The command to run. Note that commands that require a response are not supported. :return: the command result text :rtype: str """ logger = get_logger_with_thread_id(context) logger.info('Run Custom command started') with ErrorHandlingContext(logger): api = get_api(context) resource_config = create_networking_resource_from_context( shell_name=self.SHELL_NAME, supported_os=self.SUPPORTED_OS, context=context) cli_handler = CgsCliHandler(cli=self._cli, resource_config=resource_config, logger=logger, api=api) send_command_operations = RunCommandRunner(logger=logger, cli_handler=cli_handler) response = send_command_operations.run_custom_command( custom_command=parse_custom_commands(custom_command)) logger.info( 'Run Custom command ended with response: {}'.format(response)) return response
def restore(self, context, path, configuration_type, restore_method, vrf_management_name): """Restores a configuration file :param ResourceCommandContext context: The context object for the command with resource and reservation info :param str path: The path to the configuration file, including the configuration file name :param str restore_method: Determines whether the restore should append or override the current configuration :param str configuration_type: Specify whether the file should update the startup or running config """ logger = get_logger_with_thread_id(context) api = get_api(context) resource_config = create_networking_resource_from_context( shell_name=self.SHELL_NAME, supported_os=self.SUPPORTED_OS, context=context) cli_handler = CliHandler(self._cli, resource_config, logger, api) configuration_type = configuration_type or 'running' restore_method = restore_method or 'override' configuration_operations = ConfigurationRunner(logger, resource_config, api, cli_handler) logger.info('Restore started') configuration_operations.restore(path, configuration_type, restore_method) logger.info('Restore completed')
def load_firmware(self, context, cancellation_context, path, vrf_management_name): """Upload and updates firmware on the resource :param ResourceCommandContext context: The context object for the command with resource and reservation info :param str path: path to tftp server where firmware file is stored :param str vrf_management_name: Optional. Virtual routing and Forwarding management name """ logger = get_logger_with_thread_id(context) logger.info('Load firmware command started') with ErrorHandlingContext(logger): api = get_api(context) resource_config = create_networking_resource_from_context( shell_name=self.SHELL_NAME, supported_os=self.SUPPORTED_OS, context=context) vrf_management_name = vrf_management_name or resource_config.vrf_management_name cli_handler = CgsCliHandler(cli=self._cli, resource_config=resource_config, logger=logger, api=api) firmware_operations = CgsFirmwareRunner(cli_handler=cli_handler, logger=logger) response = firmware_operations.load_firmware( path=path, vrf_management_name=vrf_management_name) logger.info('Load firmware command ended with response: {}'.format( 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) resource_config = create_networking_resource_from_context(shell_name=self.SHELL_NAME, supported_os=self.SUPPORTED_OS, context=context) cli_handler = CliHandler(self._cli, resource_config, logger, api) configuration_operations = ConfigurationRunner(cli_handler=cli_handler, logger=logger, resource_config=resource_config, api=api) logger.info('Orchestration save started') response = configuration_operations.orchestration_save(mode=mode, custom_params=custom_params) logger.info('Orchestration save completed') return response
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) resource_config = create_networking_resource_from_context( shell_name=self.SHELL_NAME, supported_os=self.SUPPORTED_OS, context=context) cli_handler = CliHandler(self._cli, resource_config, logger, api) snmp_handler = SNMPHandler(resource_config, logger, api, cli_handler) autoload_operations = AutoloadRunner(logger=logger, resource_config=resource_config, snmp_handler=snmp_handler) logger.info('Autoload started') response = autoload_operations.discover() logger.info('Autoload completed') return response
def orchestration_save(self, context, mode, custom_params): """Saves the Shell state and returns a description of the saved artifacts and information This command is intended for API use only by sandbox orchestration scripts to implement a save and restore workflow :param ResourceCommandContext context: the context object containing resource and reservation info :param str mode: Snapshot save mode, can be one of two values 'shallow' (default) or 'deep' :param str custom_params: Set of custom parameters for the save operation :return: SavedResults serialized as JSON :rtype: OrchestrationSaveResult """ logger = get_logger_with_thread_id(context) api = get_api(context) resource_config = create_networking_resource_from_context( shell_name=self.SHELL_NAME, supported_os=self.SUPPORTED_OS, context=context) cli_handler = CliHandler(self._cli, resource_config, logger, api) configuration_operations = ConfigurationRunner(logger, resource_config, api, cli_handler) logger.info('Orchestration save started') response = configuration_operations.orchestration_save( mode, custom_params) logger.info('Orchestration save completed') return response
def orchestration_restore(self, context, saved_artifact_info, custom_params): """Restores a saved artifact previously saved by this Shell driver using the orchestration_save function :param ResourceCommandContext context: The context object for the command with resource and reservation info :param str saved_artifact_info: A JSON string representing the state to restore including saved artifacts and info :param str custom_params: Set of custom parameters for the restore operation """ logger = get_logger_with_thread_id(context) api = get_api(context) resource_config = create_networking_resource_from_context( shell_name=self.SHELL_NAME, supported_os=self.SUPPORTED_OS, context=context) cli_handler = CliHandler(self._cli, resource_config, logger, api) configuration_operations = ConfigurationRunner(logger, resource_config, api, cli_handler) logger.info('Orchestration restore started') configuration_operations.orchestration_restore(saved_artifact_info, 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) resource_config = create_networking_resource_from_context(shell_name=self.SHELL_NAME, supported_os=self.SUPPORTED_OS, context=context) if "true" in resource_config.enable_snmp.lower() and "3" in resource_config.snmp_version: raise Exception("Enabling of snmp v3 is not supported") cli_handler = CliHandler(self._cli, resource_config, logger, api) snmp_handler = SNMPHandler(resource_config, logger, api, cli_handler) autoload_operations = AutoloadRunner(logger=logger, resource_config=resource_config, snmp_handler=snmp_handler) logger.info('Autoload started') response = autoload_operations.discover() logger.info('Autoload completed') return response
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 = get_logger_with_thread_id(context) api = get_api(context) resource_config = create_networking_resource_from_context(shell_name=self.SHELL_NAME, supported_os=self.SUPPORTED_OS, context=context) if not configuration_type: configuration_type = 'running' if not vrf_management_name: vrf_management_name = resource_config.vrf_management_name configuration_operations = ConfigurationRunner(cli=self._cli, logger=logger, resource_config=resource_config, 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_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) resource_config = create_networking_resource_from_context(shell_name=self.SHELL_NAME, supported_os=self.SUPPORTED_OS, context=context) cli_handler = CliHandler(self._cli, resource_config, logger, api) configuration_operations = ConfigurationRunner(cli_handler=cli_handler, logger=logger, resource_config=resource_config, api=api) 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 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 = get_logger_with_thread_id(context) api = get_api(context) resource_config = create_networking_resource_from_context(shell_name=self.SHELL_NAME, supported_os=self.SUPPORTED_OS, context=context) 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 configuration_operations = ConfigurationRunner(cli=self._cli, logger=logger, resource_config=resource_config, api=api) 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) resource_config = create_networking_resource_from_context( shell_name=self.SHELL_NAME, supported_os=self.SUPPORTED_OS, context=context) cli_handler = CliHandler(self._cli, resource_config, logger, api) connectivity_operations = ConnectivityRunner(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
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 = get_logger_with_thread_id(context) api = get_api(context) resource_config = create_networking_resource_from_context(shell_name=self.SHELL_NAME, supported_os=self.SUPPORTED_OS, context=context) if not configuration_type: configuration_type = 'running' if not vrf_management_name: vrf_management_name = resource_config.vrf_management_name cli_handler = CliHandler(self._cli, resource_config, logger, api) configuration_operations = ConfigurationRunner(cli_handler=cli_handler, logger=logger, resource_config=resource_config, 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) resource_config = create_networking_resource_from_context( shell_name=self.SHELL_NAME, supported_os=self.SUPPORTED_OS, context=context) cli_handler = CliHandler(self._cli, resource_config, logger, api) configuration_operations = ConfigurationRunner( cli_handler=cli_handler, logger=logger, resource_config=resource_config, api=api) logger.info('Orchestration save started') response = configuration_operations.orchestration_save( mode=mode, custom_params=custom_params) logger.info('Orchestration save completed') return response
def initialize(self, context): """ Initialize the driver session """ resource_config = create_networking_resource_from_context( shell_name=self.SHELL_NAME, supported_os=self.SUPPORTED_OS, context=context) session_pool_size = int(resource_config.sessions_concurrency_limit) self._cli = get_cli(session_pool_size) return 'Finished initializing'
def shutdown(self, context): logger = get_logger_with_thread_id(context) api = get_api(context) resource_config = create_networking_resource_from_context(shell_name=self.SHELL_NAME, supported_os=self.SUPPORTED_OS, context=context) cli_handler = JuniperCliHandler(self._cli, resource_config, logger, api) state_operations = StateRunner(logger, api, resource_config, cli_handler) return state_operations.shutdown()
def initialize(self, context): """Initialize method :param InitCommandContext context: the context the command runs on """ resource_config = create_networking_resource_from_context( self.SHELL_NAME, self.SUPPORTED_OS, context) session_pool_size = int(resource_config.sessions_concurrency_limit) self._cli = get_cli(session_pool_size) return 'Finished initializing'
def _setUp(self, attrs=None): self.resource_config = create_networking_resource_from_context( self.SHELL_NAME, ['TiMOS'], self.create_context(attrs)) self._cli = get_cli( int(self.resource_config.sessions_concurrency_limit)) self.logger = MagicMock() self.api = MagicMock( DecryptPassword=lambda password: MagicMock(Value=password)) self.cli_handler = AlcatelCliHandler(self._cli, self.resource_config, self.logger, self.api)
def initialize(self, context): """Initialize method :type context: cloudshell.shell.core.context.driver_context.InitCommandContext """ resource_config = create_networking_resource_from_context(shell_name=self.SHELL_NAME, supported_os=self.SUPPORTED_OS, context=context) session_pool_size = int(resource_config.sessions_concurrency_limit) self._cli = get_cli(session_pool_size) return 'Finished initializing'
def initialize(self, context): """Initialize method :type context: cloudshell.shell.core.context.driver_context.InitCommandContext """ resource_config = create_networking_resource_from_context(shell_name=self.SHELL_NAME, supported_os=self.SUPPORTED_OS, context=context) session_pool_size = int(resource_config.sessions_concurrency_limit) self._cli = get_cli(session_pool_size) return 'Finished initializing'
def initialize(self, context): """ Initialize the driver session, this function is called everytime a new instance of the driver is created This is a good place to load and cache the driver configuration, initiate sessions etc. :param InitCommandContext context: the context the command runs on """ resource_config = create_networking_resource_from_context(shell_name=self.SHELL_NAME, supported_os=self.SUPPORTED_OS, context=context) session_pool_size = int(resource_config.sessions_concurrency_limit) self._cli = get_cli(session_pool_size) return 'Finished initializing'
def restore(self, context, cancellation_context, path, configuration_type, restore_method, vrf_management_name): """Restores a configuration file :param ResourceCommandContext context: The context object for the command with resource and reservation info :param CancellationContext cancellation_context: Object to signal a request for cancellation. Must be enabled in drivermetadata.xml as well :param str path: The path to the configuration file, including the configuration file name. :param str restore_method: Determines whether the restore should append or override the current configuration. :param str configuration_type: Specify whether the file should update the startup or running config. :param str vrf_management_name: Optional. Virtual routing and Forwarding management name """ logger = get_logger_with_thread_id(context) logger.info('Restore command started') with ErrorHandlingContext(logger): api = get_api(context) resource_config = create_networking_resource_from_context(shell_name=self.SHELL_NAME, supported_os=self.SUPPORTED_OS, context=context) cli_handler = CumulusCliHandler(cli=self._cli, resource_config=resource_config, logger=logger, api=api) if configuration_type.lower() == "startup": raise Exception("Shell doesn't support 'Startup' configuration type") if restore_method.lower() == "append": raise Exception("Shell doesn't support 'Append' restore method") configuration_type = "running" restore_method = "override" if not vrf_management_name: vrf_management_name = resource_config.vrf_management_name configuration_operations = CumulusLinuxConfigurationRunner(cli_handler=cli_handler, resource_config=resource_config, api=api, logger=logger) configuration_operations.restore(path=path, restore_method=restore_method, configuration_type=configuration_type, vrf_management_name=vrf_management_name) logger.info("Restore command completed")
def initialize(self, context): """Initialize method :type context: cloudshell.shell.core.context.driver_context.InitCommandContext """ resource_config = create_networking_resource_from_context(shell_name=self.SHELL_NAME, supported_os=self.SUPPORTED_OS, context=context) session_pool_size = int(resource_config.sessions_concurrency_limit) self._cli = get_cli(session_pool_size) ConfigCommandMode.ENTER_COMMAND = "conf sync" ConfigCommandMode.ENTER_ACTION_COMMANDS = ["switch-profile configure-fex"] ConfigCommandMode.EXIT_COMMAND = "end" return 'Finished initializing'
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) resource_config = create_networking_resource_from_context(shell_name=self.SHELL_NAME, supported_os=self.SUPPORTED_OS, context=context) state_operations = StateRunner(cli=self._cli, logger=logger, api=api, resource_config=resource_config) return state_operations.health_check()
def save(self, context, cancellation_context, folder_path, configuration_type, vrf_management_name): """Creates a configuration file and saves it to the provided destination :param ResourceCommandContext context: The context object for the command with resource and reservation info :param CancellationContext cancellation_context: Object to signal a request for cancellation. Must be enabled in drivermetadata.xml as well :param str configuration_type: Specify whether the file should update the startup or running config. Value can one :param str folder_path: The path to the folder in which the configuration file will be saved. :param str vrf_management_name: Optional. Virtual routing and Forwarding management name :return The configuration file name. :rtype: str """ logger = get_logger_with_thread_id(context) logger.info('Save command started') with ErrorHandlingContext(logger): api = get_api(context) resource_config = create_networking_resource_from_context(shell_name=self.SHELL_NAME, supported_os=self.SUPPORTED_OS, context=context) cli_handler = CumulusCliHandler(cli=self._cli, resource_config=resource_config, logger=logger, api=api) if configuration_type.lower() == "startup": raise Exception("Shell doesn't support 'Startup' configuration type") configuration_type = 'running' if not vrf_management_name: vrf_management_name = resource_config.vrf_management_name configuration_operations = CumulusLinuxConfigurationRunner(cli_handler=cli_handler, resource_config=resource_config, api=api, logger=logger) response = configuration_operations.save(folder_path=folder_path, configuration_type=configuration_type, vrf_management_name=vrf_management_name) logger.info('Save command completed') return response
def run_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) resource_config = create_networking_resource_from_context(shell_name=self.SHELL_NAME, supported_os=self.SUPPORTED_OS, context=context) send_command_operations = CommandRunner(cli=self._cli, logger=logger, resource_config=resource_config, 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) resource_config = create_networking_resource_from_context(shell_name=self.SHELL_NAME, supported_os=self.SUPPORTED_OS, context=context) cli_handler = CliHandler(self._cli, resource_config, logger, api) state_operations = StateRunner(logger=logger, api=api, resource_config=resource_config, cli_handler=cli_handler) return state_operations.health_check()
def shutdown(self, context): """ Shutdown device :param ResourceCommandContext context: ResourceCommandContext object with all Resource Attributes inside :return: """ logger = get_logger_with_thread_id(context) api = get_api(context) resource_config = create_networking_resource_from_context(shell_name=self.SHELL_NAME, supported_os=self.SUPPORTED_OS, context=context) cli_handler = CliHandler(self._cli, resource_config, logger, api) state_operations = StateRunner(logger=logger, api=api, resource_config=resource_config, cli_handler=cli_handler) return state_operations.shutdown()
def run_custom_command(self, context, custom_command): """Send custom command :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) resource_config = create_networking_resource_from_context(shell_name=self.SHELL_NAME, supported_os=self.SUPPORTED_OS, context=context) cli_handler = CliHandler(self._cli, resource_config, logger, api) send_command_operations = CommandRunner(logger=logger, cli_handler=cli_handler) response = send_command_operations.run_custom_command(custom_command=parse_custom_commands(custom_command)) return response
def update_firmware(self, context, remote_host, file_path): """Upload and updates firmware on the resource :param ResourceCommandContext context: ResourceCommandContext object with all Resource Attributes inside :param remote_host: full path to firmware file, i.e. tftp://10.10.10.1/firmware.tar :param file_path: file name """ logger = get_logger_with_thread_id(context) api = get_api(context) resource_config = create_networking_resource_from_context(shell_name=self.SHELL_NAME, supported_os=self.SUPPORTED_OS, context=context) cli_handler = CliHandler(self._cli, resource_config, logger, api) logger.info('Start Load Firmware') firmware_operations = FirmwareRunner(cli_handler=cli_handler, logger=logger) response = firmware_operations.load_firmware(path=remote_host, vrf_management_name=resource_config.vrf_management_name) logger.info('Finish Load Firmware: {}'.format(response))
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) resource_config = create_networking_resource_from_context(shell_name=self.SHELL_NAME, supported_os=self.SUPPORTED_OS, context=context) cli_handler = CliHandler(self._cli, resource_config, logger, api) connectivity_operations = ConnectivityRunner(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
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 = get_logger_with_thread_id(context) api = get_api(context) resource_config = create_networking_resource_from_context(shell_name=self.SHELL_NAME, supported_os=self.SUPPORTED_OS, context=context) 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 = CliHandler(self._cli, resource_config, logger, api) configuration_operations = ConfigurationRunner(cli_handler=cli_handler, logger=logger, resource_config=resource_config, api=api) 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')