yumapro  21.10T-9
YumaPro SDK
agt_cli.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2008 - 2012, Andy Bierman, All Rights Reserved.
3  * Copyright (c) 2012 - 2021, YumaWorks, Inc., All Rights Reserved.
4  *
5  * Unless required by applicable law or agreed to in writing,
6  * software distributed under the License is distributed on an
7  * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
8  * KIND, either express or implied. See the License for the
9  * specific language governing permissions and limitations
10  * under the License.
11  */
12 #ifndef _H_agt_cli
13 #define _H_agt_cli
14 
15 /* FILE: agt_cli.h
16 *********************************************************************
17 * *
18 * P U R P O S E *
19 * *
20 *********************************************************************/
21 
28 /********************************************************************
29 * *
30 * C H A N G E H I S T O R Y *
31 * *
32 *********************************************************************
33 
34 date init comment
35 ----------------------------------------------------------------------
36 27-oct-06 abb Begun
37 01-aug-08 abb Convert from NCX PSD to YANG OBJ
38 
39 */
40 
41 #ifndef _H_agt
42 #include "agt.h"
43 #endif
44 
45 #ifndef _H_help
46 #include "help.h"
47 #endif
48 
49 #ifndef _H_val
50 #include "val.h"
51 #endif
52 
53 #ifndef _H_status
54 #include "status.h"
55 #endif
56 
57 #ifdef __cplusplus
58 extern "C" {
59 #endif
60 
61 /********************************************************************
62 * *
63 * C O N S T A N T S
64 * *
65 *********************************************************************/
66 
67 #define AGT_CLI_MODULE (const xmlChar *)"netconfd-pro"
68 #define AGT_CLI_CONTAINER (const xmlChar *)"netconfd-pro"
69 
70 #define AGT_CLI_RUNNING_ERROR (const xmlChar *)"running-error"
71 #define AGT_CLI_STARTUP_ERROR (const xmlChar *)"startup-error"
72 #define AGT_CLI_STARTUP_STOP (const xmlChar *)"stop"
73 #define AGT_CLI_STARTUP_CONTINUE (const xmlChar *)"continue"
74 #define AGT_CLI_STARTUP_FALLBACK (const xmlChar *)"fallback"
75 
76 #define AGT_CLI_DELETE_EMPTY_NPCONTAINERS \
77  (const xmlChar *)"delete-empty-npcontainers"
78 
79 #define AGT_CLI_SUPERUSER NCX_EL_SUPERUSER
80 
81 #define AGT_CLI_MAX_BURST NCX_EL_MAX_BURST
82 
83 #define AGT_CLI_MAX_SESSIONS (const xmlChar *)"max-sessions"
84 
85 #define AGT_CLI_MAX_CLI_SESSIONS (const xmlChar *)"max-cli-sessions"
86 
87 #define AGT_CLI_SUBSYS_TIMEOUT (const xmlChar *)"subsys-timeout"
88 
89 /********************************************************************
90 * *
91 * F U N C T I O N S *
92 * *
93 *********************************************************************/
94 
125 extern status_t
126  agt_cli_process_input (int argc,
127  char *argv[],
128  agt_profile_t *agt_profile,
129  boolean *showver,
130  help_mode_t *showhelpmode,
131  boolean *no_watcher);
132 
133 
139 extern val_value_t *
140  agt_cli_get_valset (void);
141 
142 
148 extern const xmlChar *
149  agt_cli_get_confspec (void);
150 
151 
157 extern void
158  agt_cli_cleanup (void);
159 
160 
164 #ifdef __cplusplus
165 } /* end extern 'C' */
166 #endif
167 
168 #endif /* _H_agt_cli */
Multiple instances are not supported.
Definition: agt.h:766
const xmlChar * agt_cli_get_confspec(void)
Retrieve the config file used or NULL if none.
Definition: agt_cli.c:3530
Value Node Basic Support.
void agt_cli_cleanup(void)
Cleanup the module static data.
Definition: agt_cli.c:3542
val_value_t * agt_cli_get_valset(void)
Retrieve the command line parameter set from boot time.
Definition: agt_cli.c:3515
one value to match one type
Definition: val.h:870
status_t
global error return code
Definition: status_enum.h:186
Multi-Protocol Network Management Server.
Global error messages for status code enumerations.
YANG help text support for CLI Print help text for various templates.
help_mode_t
modes to match the keywords brief, normal, full
Definition: help.h:84
status_t agt_cli_process_input(int argc, char *argv[], agt_profile_t *agt_profile, boolean *showver, help_mode_t *showhelpmode, boolean *no_watcher)
Process the param line parameters against the hardwired parmset for the netconfd program.
Definition: agt_cli.c:2896