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_firewall_resource_from_context( shell_name=self.SHELL_NAME, supported_os=self.SUPPORTED_OS, context=context) configuration_operations = ConfigurationRunner( cli=self._cli, 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 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_firewall_resource_from_context( shell_name=self.SHELL_NAME, supported_os=self.SUPPORTED_OS, context=context) configuration_operations = ConfigurationRunner( cli=self._cli, 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 orchestration_restore(self, context, saved_artifact_info, custom_params): """Restores a saved artifact previously saved by this Shell. :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) logger.info("Orchestration restore command started") with ErrorHandlingContext(logger): resource_config = create_firewall_resource_from_context( self.SHELL_NAME, self.SUPPORTED_OS, context ) cs_api = get_api(context) cli_handler = F5CliHandler(self._cli, resource_config, logger, cs_api) configuration_operations = F5ConfigurationRunner( cli_handler=cli_handler, logger=logger, resource_config=resource_config, api=cs_api, ) configuration_operations.orchestration_restore( saved_artifact_info=saved_artifact_info, custom_params=custom_params ) logger.info("Orchestration restore command completed")
def save(self, context, folder_path, configuration_type): """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 :return str saved configuration file name: """ logger = get_logger_with_thread_id(context) api = get_api(context) resource_config = create_firewall_resource_from_context( shell_name=self.SHELL_NAME, supported_os=self.SUPPORTED_OS, context=context) if not configuration_type: configuration_type = 'running' 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) logger.info('Save completed') return response
def shutdown(self, context): """Sends a graceful shutdown to the device. :param ResourceCommandContext context: The context object for the command with resource and reservation info """ logger = get_logger_with_thread_id(context) logger.info("Shutdown command started") with ErrorHandlingContext(logger): resource_config = create_firewall_resource_from_context( self.SHELL_NAME, self.SUPPORTED_OS, context ) cs_api = get_api(context) cli_handler = F5CliHandler(self._cli, resource_config, logger, cs_api) state_operations = StateRunner( logger=logger, api=cs_api, resource_config=resource_config, cli_handler=cli_handler, ) response = state_operations.shutdown() logger.info("Shutdown command completed with response: {}".format(response)) return response
def restore(self, context, path, configuration_type, restore_method): """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_firewall_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' 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) logger.info('Restore completed')
def run_custom_command(self, 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 str custom_command: The command to run :return: the command result text :rtype: str """ logger = get_logger_with_thread_id(context) logger.info("Run custom command started") with ErrorHandlingContext(logger): resource_config = create_firewall_resource_from_context( self.SHELL_NAME, self.SUPPORTED_OS, context ) cs_api = get_api(context) cli_handler = F5CliHandler(self._cli, resource_config, logger, cs_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 load_firmware(self, context, path): """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 """ logger = get_logger_with_thread_id(context) logger.info("Load firmware command started") with ErrorHandlingContext(logger): resource_config = create_firewall_resource_from_context( self.SHELL_NAME, self.SUPPORTED_OS, context ) cs_api = get_api(context) cli_handler = F5CliHandler(self._cli, resource_config, logger, cs_api) logger.info("Start Loading Firmware...") firmware_operations = F5FirmwareRunner( cli_handler=cli_handler, logger=logger ) response = firmware_operations.load_firmware(path=path) logger.info( "Load firmware command completed with response: {}".format(response) ) return response
def save(self, context, folder_path, configuration_type): """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_firewall_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' 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 health_check(self, context): """Checks if the device is up and connectable :param ResourceCommandContext context: ResourceCommandContext object with all Resource Attributes inside :return: Success or fail message :rtype: str """ logger = get_logger_with_thread_id(context) api = get_api(context) logger.info("CONTEXT: {}".format(context)) logger.info("SHELL_NAME: {}".format(self.SHELL_NAME)) logger.info("SUPPORTED_OS: {}".format(self.SUPPORTED_OS)) resource_config = create_firewall_resource_from_context( shell_name=self.SHELL_NAME, supported_os=self.SUPPORTED_OS, context=context) logger.info("RESOURCE_CONFIG: {}".format(resource_config.__dict__)) cli_handler = CliHandler(self._cli, resource_config, logger, api) state_operations = StateRunner(logger, api, resource_config, cli_handler) return state_operations.health_check()
def restore(self, context, path, configuration_type, restore_method): """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_firewall_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' 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 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_firewall_resource_from_context( self.SHELL_NAME, self.SUPPORTED_OS, 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_firewall_resource_from_context( self.SHELL_NAME, self.SUPPORTED_OS, 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): """Discovers the resource structure and attributes. :param AutoLoadCommandContext context: the context the command runs on :return Attribute and sub-resource information for the Shell resource :rtype: AutoLoadDetails """ logger = get_logger_with_thread_id(context) logger.info("Autoload command started") with ErrorHandlingContext(logger): resource_config = create_firewall_resource_from_context( self.SHELL_NAME, self.SUPPORTED_OS, context ) cs_api = get_api(context) cli_handler = F5CliHandler(self._cli, resource_config, logger, cs_api) snmp_handler = F5SnmpHandler(resource_config, logger, cs_api, cli_handler) autoload_operations = F5FirewallAutoloadRunner( logger=logger, resource_config=resource_config, snmp_handler=snmp_handler, ) autoload_details = autoload_operations.discover() logger.info("Autoload command completed") return autoload_details
def health_check(self, context): """Checks if the device is up and connectable. :param ResourceCommandContext context: ResourceCommandContext object with all Resource Attributes inside :return: Success or fail message :rtype: str """ logger = get_logger_with_thread_id(context) logger.info("Health check command started") with ErrorHandlingContext(logger): resource_config = create_firewall_resource_from_context( self.SHELL_NAME, self.SUPPORTED_OS, context ) cs_api = get_api(context) cli_handler = F5CliHandler(self._cli, resource_config, logger, cs_api) state_operations = StateRunner( logger=logger, api=cs_api, resource_config=resource_config, cli_handler=cli_handler, ) response = state_operations.health_check() logger.info("Health check command ended with response: {}".format(response)) return response
def initialize(self, context): """Initialize the driver session. :param InitCommandContext context: the context the command runs on :rtype: str """ resource_config = create_firewall_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 initialize(self, context): """Initialize method :type context: cloudshell.shell.core.context.driver_context.InitCommandContext """ resource_config = create_firewall_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. """ resource_config = create_firewall_resource_from_context( shell_name=self.SHELL_NAME, supported_os=self.SUPPORTED_OS, context=context) # session_pool_size = int(resource_config.sessions_concurrency_limit or 1) session_pool_size = int(resource_config.sessions_concurrency_limit) self._cli = get_cli(session_pool_size) return 'Finished initializing'
def shutdown(self, context): """Sends a graceful shutdown to the device :param ResourceCommandContext context: The context object for the command with resource and reservation info """ logger = get_logger_with_thread_id(context) api = get_api(context) resource_config = create_firewall_resource_from_context( self.SHELL_NAME, self.SUPPORTED_OS, context) cli_handler = CliHandler(self._cli, resource_config, logger, api) state_operations = StateRunner(logger, api, resource_config, cli_handler) return state_operations.shutdown()
def _setUp(self, attrs=None): if attrs is None: attrs = {} self.resource_config = create_firewall_resource_from_context( self.SHELL_NAME, ['ACOS'], self.create_context(attrs)) self._set_snmp_v3_protocols(self.resource_config, 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 = CliHandler(self._cli, self.resource_config, self.logger, self.api)
def load_firmware(self, context, path): """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 """ logger = get_logger_with_thread_id(context) api = get_api(context) resource_config = create_firewall_resource_from_context( self.SHELL_NAME, self.SUPPORTED_OS, context) cli_handler = CliHandler(self._cli, resource_config, logger, api) logger.info('Start Load Firmware') firmware_operations = FirmwareRunner(logger, cli_handler) response = firmware_operations.load_firmware(path) logger.info('Finish Load Firmware: {}'.format(response))
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_firewall_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.shutdown()
def restore(self, context, path, configuration_type, restore_method): """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) logger.info("Restore command started") with ErrorHandlingContext(logger): resource_config = create_firewall_resource_from_context( self.SHELL_NAME, self.SUPPORTED_OS, context ) cs_api = get_api(context) configuration_type = configuration_type or "running" restore_method = restore_method or "override" cli_handler = F5CliHandler(self._cli, resource_config, logger, cs_api) configuration_operations = F5ConfigurationRunner( cli_handler=cli_handler, logger=logger, resource_config=resource_config, api=cs_api, ) logger.info("Restoring started...") configuration_operations.restore( path=path, restore_method=restore_method, configuration_type=configuration_type, ) logger.info("Restore command completed")
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_firewall_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, folder_path, configuration_type): """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) logger.info("Save command started") with ErrorHandlingContext(logger): resource_config = create_firewall_resource_from_context( self.SHELL_NAME, self.SUPPORTED_OS, context ) cs_api = get_api(context) configuration_type = configuration_type or "running" cli_handler = F5CliHandler(self._cli, resource_config, logger, cs_api) configuration_operations = F5ConfigurationRunner( cli_handler=cli_handler, logger=logger, resource_config=resource_config, api=cs_api, ) logger.info("Saving started... ") response = configuration_operations.save( folder_path=folder_path, configuration_type=configuration_type ) logger.info("Save command completed") return response
def load_firmware(self, context, path): """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) resource_config = create_firewall_resource_from_context( shell_name=self.SHELL_NAME, supported_os=self.SUPPORTED_OS, context=context) logger.info('Start Load Firmware') firmware_operations = FirmwareRunner(cli=self._cli, logger=logger, resource_config=resource_config, api=api) response = firmware_operations.load_firmware(path=path) logger.info('Finish Load Firmware: {}'.format(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_firewall_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 = RunCommandRunner(logger=logger, cli_handler=cli_handler) result_str = send_command_operations.run_custom_config_command( parse_custom_commands(command=custom_command)) return result_str
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_firewall_resource_from_context( shell_name=self.SHELL_NAME, supported_os=self.SUPPORTED_OS, context=context) autoload_operations = AutoloadRunner(cli=self._cli, logger=logger, resource_config=resource_config, api=api) logger.info('Autoload started') response = autoload_operations.discover() logger.info('Autoload completed') return response
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_firewall_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) response = send_command_operations.run_custom_command( custom_command=custom_command) return response