openapi_cli_script.h

Go to the documentation of this file.

/*********************************************************************
*
* Copyright 2016-2023 Broadcom.
*
*  Licensed under the Apache License, Version 2.0 (the "License");
*  you may not use this file except in compliance with the License.
*  You may obtain a copy of the License at
*
*      http://www.apache.org/licenses/LICENSE-2.0
*
*  Unless required by applicable law or agreed to in writing, software
*  distributed under the License is distributed on an "AS IS" BASIS,
*  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
*  See the License for the specific language governing permissions and
*  limitations under the License.
*
**********************************************************************
*
* @filename  openapi_cli_script.h
*
* @purpose   CLI Text Based Configuration
*
* @component OPEN
*
* @create    4/26/2014
*
* @end
*
**********************************************************************/
#ifndef OPENAPI_CLI_SCRIPT_H
#define OPENAPI_CLI_SCRIPT_H

#include "openapi_common.h"

#define OPENAPI_FILE_NAME_LENGTH_MAX   96
#define OPENAPI_CLI_MAX_STRING_LENGTH  255

/*****************************************************************/
open_error_t openapiTxtCfgApply(openapiClientHandle_t *client_handle,
                                open_buffdesc *txtCfgFile, open_buffdesc *outFile);

/*****************************************************************/
open_error_t openapiRunningCfgGenerate(openapiClientHandle_t *client_handle,
                                       open_buffdesc *txtCfgFile);

/*****************************************************************/
open_error_t openapiSaveConfig(openapiClientHandle_t *client_handle);

/*****************************************************************/
open_error_t openapiTxtCfgValidate(openapiClientHandle_t *client_handle,
                                   open_buffdesc *txtCfgFile, open_buffdesc *outFile);

/*****************************************************************/
open_error_t openapiFileNameMaxLengthGet(openapiClientHandle_t *client_handle,
                                         uint32_t *maxLen);

/*****************************************************************/
open_error_t openapiTxtCfgNDCApply(openapiClientHandle_t *client_handle,
                                open_buffdesc *txtCfgFile, open_buffdesc *outFile);

/*****************************************************************/
open_error_t openapiTxtCfgNDCGenerate(openapiClientHandle_t *client_handle,
                                      open_buffdesc *txtCfgFile, 
                                      open_buffdesc *outFile);

/*****************************************************************/
open_error_t openapiCliShowExecuteToFile(openapiClientHandle_t *client_handle,
                                         open_buffdesc         *showCliCommand,
                                         open_buffdesc         *fileName);

/*****************************************************************/
open_error_t openapiTxtCfgCompress(openapiClientHandle_t *client_handle,
                                   open_buffdesc *pInUncompCfgFile,
                                   open_buffdesc *pOutCmpCfgFile);

/*****************************************************************/
open_error_t openapiTxtCfgUnCompress(openapiClientHandle_t *client_handle,
                                     open_buffdesc *pInCompCfgFile,
                                     open_buffdesc *pOutUncompCfgFile);
#endif