yumapro  23.10T-10
YumaPro SDK
Loading...
Searching...
No Matches
agt_cap.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_cap
13#define _H_agt_cap
14
15/* FILE: agt_cap.h
16*********************************************************************
17* *
18* P U R P O S E *
19* *
20*********************************************************************/
21
27/*********************************************************************
28* *
29* C H A N G E H I S T O R Y *
30* *
31*********************************************************************
32
33date init comment
34----------------------------------------------------------------------
3503-feb-06 abb Begun; split out from base/cap.h
36
37*/
38
39#ifndef _H_agt
40#include "agt.h"
41#endif
42
43#ifndef _H_cap
44#include "cap.h"
45#endif
46
47#ifndef _H_ncxconst
48#include "ncxconst.h"
49#endif
50
51#ifndef _H_status
52#include "status.h"
53#endif
54
55#ifndef _H_val
56#include "val.h"
57#endif
58
59#ifdef __cplusplus
60extern "C" {
61#endif
62
63/********************************************************************
64* *
65* F U N C T I O N S *
66* *
67*********************************************************************/
68
69
70/* header only */
71
95extern void
96 agt_cap_cleanup (void);
97
98
106extern status_t
107 agt_cap_set_restconf_caps (const xmlChar *defstyle,
108 uint8 withdef_enabled);
109
110
120extern status_t
122 ncx_agtstart_t agtstart,
123 const xmlChar *defstyle,
124 uint8 withdef_enabled);
125
126
134extern status_t
135 agt_cap_set_modules (void);
136
137
145extern status_t
147
148
155extern status_t
157
158
164extern cap_list_t *
165 agt_cap_get_caps (void);
166
172extern cap_list_t *
174
175
181extern val_value_t *
182 agt_cap_get_capsval (void);
183
184
190extern val_value_t *
192
193
200extern boolean
202
203
210extern boolean
212
213
220extern status_t
222
223
237extern void
238 agt_cap_get_netconf_features (boolean *f_write_running,
239 boolean *f_candidate,
240 boolean *f_confirmed_commit,
241 boolean *f_rollback,
242 boolean *f_validate,
243 boolean *f_startup,
244 boolean *f_url,
245 boolean *f_xpath);
246
247
255extern status_t
257
258
267extern status_t
269
270
274#ifdef __cplusplus
275} /* end extern 'C' */
276#endif
277
278#endif /* _H_agt_cap */
Multi-Protocol Network Management Server.
NETCONF protocol capabilities.
status_t agt_cap_add_module(ncx_module_t *mod)
Add a module at runtime, after the initial set has been set.
Definition: agt_cap.c:860
cap_list_t * agt_cap_get_restconf_caps(void)
Get the RESTCONF capabilities.
Definition: agt_cap.c:949
status_t agt_cap_update_config_id(void)
Update the config-id capability id' value to the new txid for the running config.
Definition: agt_cap.c:1040
val_value_t * agt_cap_get_restconf_capsval(void)
Get the RESTCONF capabilities in val_value_t format.
Definition: agt_cap.c:983
status_t agt_cap_set_caps(ncx_agttarg_t agttarg, ncx_agtstart_t agtstart, const xmlChar *defstyle, uint8 withdef_enabled)
Initialize the NETCONF server capabilities.
Definition: agt_cap.c:482
status_t agt_cap_set_restconf_caps(const xmlChar *defstyle, uint8 withdef_enabled)
Initialize the RESTCONF capabilities.
Definition: agt_cap.c:315
cap_list_t * agt_cap_get_caps(void)
Get the NETCONF server capabilities.
Definition: agt_cap.c:931
status_t agt_cap_set_modules(void)
Initialize the NETCONF server capabilities modules list.
Definition: agt_cap.c:792
status_t agt_cap_remove_module(ncx_module_t *mod)
Remove a module at runtime, after the initial set has been set MUST call after agt_cap_set_caps.
Definition: agt_cap.c:896
status_t agt_cap_update_module_setid(void)
Update YANG-LIBRARY capability module setID.
Definition: agt_cap.c:1176
void agt_cap_cleanup(void)
Clean the NETCONF server capabilities.
Definition: agt_cap.c:276
val_value_t * agt_cap_get_capsval(void)
Get the NETCONF server capabilities in val_value_t format.
Definition: agt_cap.c:966
void agt_cap_get_netconf_features(boolean *f_write_running, boolean *f_candidate, boolean *f_confirmed_commit, boolean *f_rollback, boolean *f_validate, boolean *f_startup, boolean *f_url, boolean *f_xpath)
Get the NETCONF 1.1 YANG features that should be enabled for the current server profile.
Definition: agt_cap.c:1071
boolean agt_cap_std_set(cap_stdid_t cap)
Check if the STD capability is set for the server.
Definition: agt_cap.c:1001
boolean agt_restconf_cap_std_set(cap_stdid_t cap)
Check if the STD RESTCONF capability is set for the agent.
Definition: agt_cap.c:1020
status_t agt_cap_set_netconf_module(void)
Initialize the NETCONF module capabilities.
Definition: agt_cap.c:1151
cap_stdid_t
enumerated list of standard capability IDs
Definition: cap.h:228
status_t
global error return code
Definition: status_enum.h:210
ncx_agttarg_t
enum to identify the agent native target
Definition: ncxtypes.h:517
ncx_agtstart_t
enum to identify the agent native startup mode
Definition: ncxtypes.h:528
Contains NCX constants.
Global error messages for status code enumerations.
one capabilities list
Definition: cap.h:304
representation of one module or submodule during and after parsing
Definition: ncxtypes.h:1134
one value to match one type
Definition: val.h:912
Value Node Basic Support.