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 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 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 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 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 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 orchestration_save(self, context, mode, custom_params): """Saves the Shell state and returns a description of the saved artifacts. 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) logger.info("Orchestration save command started") with ErrorHandlingContext(logger): resource_config = create_load_balancing_resource_from_context( shell_name=self.SHELL_NAME, supported_os=self.SUPPORTED_OS, context=context, ) cs_api = get_api(context) mode = mode or "shallow" cli_handler = F5CliHandler( cli=self._cli, resource_config=resource_config, api=cs_api, logger=logger, ) configuration_operations = F5ConfigurationRunner( cli_handler=cli_handler, logger=logger, resource_config=resource_config, api=cs_api, ) response = configuration_operations.orchestration_save( mode=mode, custom_params=custom_params ) logger.info( "Orchestration save command completed with response: {}".format( response ) ) return response
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_load_balancing_resource_from_context( shell_name=self.SHELL_NAME, supported_os=self.SUPPORTED_OS, context=context, ) cs_api = get_api(context) configuration_type = configuration_type or "running" restore_method = restore_method or "override" cli_handler = F5CliHandler( cli=self._cli, resource_config=resource_config, api=cs_api, logger=logger, ) 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 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_load_balancing_resource_from_context( shell_name=self.SHELL_NAME, supported_os=self.SUPPORTED_OS, context=context, ) cs_api = get_api(context) configuration_type = configuration_type or "running" cli_handler = F5CliHandler( cli=self._cli, resource_config=resource_config, api=cs_api, logger=logger, ) 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