Open Ethernet Networking (OpEN) API Guide and Reference Manual  3.9.0.2
openapi_cli_script.h
Go to the documentation of this file.
1 
9 /*********************************************************************
10 *
11 * Copyright 2016-2018 Broadcom.
12 *
13 * Licensed under the Apache License, Version 2.0 (the "License");
14 * you may not use this file except in compliance with the License.
15 * You may obtain a copy of the License at
16 *
17 * http://www.apache.org/licenses/LICENSE-2.0
18 *
19 * Unless required by applicable law or agreed to in writing, software
20 * distributed under the License is distributed on an "AS IS" BASIS,
21 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
22 * See the License for the specific language governing permissions and
23 * limitations under the License.
24 *
25 **********************************************************************
26 *
27 * @filename openapi_cli_script.h
28 *
29 * @purpose CLI Text Based Configuration
30 *
31 * @component OPEN
32 *
33 * @create 4/26/2014
34 *
35 * @end
36 *
37 **********************************************************************/
38 #ifndef OPENAPI_CLI_SCRIPT_H
39 #define OPENAPI_CLI_SCRIPT_H
40 
41 #include "openapi_common.h"
42 
43 #define OPENAPI_FILE_NAME_LENGTH_MAX 96
44 #define OPENAPI_CLI_MAX_STRING_LENGTH 255
45 
46 /*****************************************************************/
65 open_error_t openapiTxtCfgApply(openapiClientHandle_t *client_handle,
66  open_buffdesc *txtCfgFile, open_buffdesc *outFile);
67 
68 /*****************************************************************/
85 open_error_t openapiRunningCfgGenerate(openapiClientHandle_t *client_handle,
86  open_buffdesc *txtCfgFile);
87 
88 /*****************************************************************/
105 open_error_t openapiSaveConfig(openapiClientHandle_t *client_handle);
106 
107 /*****************************************************************/
127 open_error_t openapiTxtCfgValidate(openapiClientHandle_t *client_handle,
128  open_buffdesc *txtCfgFile, open_buffdesc *outFile);
129 
130 /*****************************************************************/
144 open_error_t openapiFileNameMaxLengthGet(openapiClientHandle_t *client_handle,
145  uint32_t *maxLen);
146 
147 /*****************************************************************/
166 open_error_t openapiTxtCfgNDCApply(openapiClientHandle_t *client_handle,
167  open_buffdesc *txtCfgFile, open_buffdesc *outFile);
168 
169 /*****************************************************************/
187 open_error_t openapiTxtCfgNDCGenerate(openapiClientHandle_t *client_handle,
188  open_buffdesc *txtCfgFile,
189  open_buffdesc *outFile);
190 
191 /*****************************************************************/
210 open_error_t openapiCliShowExecuteToFile(openapiClientHandle_t *client_handle,
211  open_buffdesc *showCliCommand,
212  open_buffdesc *fileName);
213 #endif
214