yumapro  23.10T-6
YumaPro SDK
Loading...
Searching...
No Matches
agt.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
13#define _H_agt
14
15/* FILE: agt.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
34date init comment
35----------------------------------------------------------------------
3604-nov-05 abb Begun
3702-aug-08 abb Convert from NCX typdef to YANG object design
3803-oct-08 abb Convert to YANG only, remove app, parmset,
39 and parm layers in the NETCONF database
40*/
41
42#ifndef _H_agt_not
43#include "agt_not.h"
44#endif
45
46#ifndef _H_help
47#include "help.h"
48#endif
49
50#ifndef _H_log
51#include "log.h"
52#endif
53
54#ifndef _H_ncxtypes
55#include "ncxtypes.h"
56#endif
57
58#ifndef _H_status
59#include "status.h"
60#endif
61
62#ifdef __cplusplus
63extern "C" {
64#endif
65
66
67/* define a top-level header here here */
68
69
157/* header field defined here, used in rest of library */
158
170/********************************************************************
171* *
172* C O N S T A N T S *
173* *
174*********************************************************************/
175
185#define AGT_NUM_CB (AGT_CB_ROLLBACK+1)
186
188#define AGT_MAX_PORTS 4
189
193#define AGT_DEF_SUBSYS_TIMEOUT 30
194
196#define AGT_DEF_CONF_FILE \
197 (const xmlChar *)"/etc/yumapro/netconfd-pro.conf"
198
200#define AGT_DEF_FACTORY_CONFIG_FILE \
201 (const xmlChar *)"factory-startup-cfg.xml"
202
204#define AGT_DEF_CONF_DIR (const xmlChar *)"/etc/yumapro/netconfd-pro.d"
205
207#define AGT_DEF_FHS_LOG_FILE \
208 (const xmlChar *)"/var/log/netconfd-pro/server.log"
209
211#define AGT_DEF_SYSLIB_FILE (const xmlChar *)"libyp_system.so"
212
214#define AGT_SYSLIB_NAME (const xmlChar *)"yp_system"
215
217#define AGT_DEF_BACKUP_DIR (const xmlChar *)"$HOME/.yumapro/backups"
218
220#define AGT_DEF_BACKUPS_NAME (const xmlChar *)"backups"
221
223#define AGT_DEF_FHS_BACKUP_DIR \
224 (const xmlChar *)"/var/lib/netconfd-pro/backups"
225
227#define AGT_SRID_FHS_BACKUP_DIR \
228 (const xmlChar *)"/var/lib/netconfd-pro/%s/backups"
229
233#define AGT_DEF_DELETE_EMPTY_NP FALSE
234
238#define AGT_DEF_SYSTEM_SORTED FALSE
239
241#define AGT_DEF_LAX_NAMESPACES TRUE
242
244#define AGT_DEF_EVENTLOG_SIZE 1000
245
247#define AGT_DEF_MAX_BURST 10
248
250#define AGT_DEF_HELLO_TIMEOUT 300
251
253#define AGT_DEF_IDLE_TIMEOUT 3600
254
256#define AGT_DEF_LINESIZE 72
257
259#define AGT_DEF_INDENT 1
260
262#define AGT_DEF_MESSAGE_INDENT (-1)
263
265#define AGT_DEF_MAX_SESSIONS 8
266
268#define AGT_DEF_MAX_CLI_SESSIONS 0
269
271#define AGT_DEF_MAX_USER_SESSIONS 0
272
276#define AGT_MAX_USERNAME_LEN 1024
277
281#define AGT_MAX_PER_USER_SESSIONS 1024
282
283
285#define AGT_DEF_YANGAPI_SERVER_URL (const xmlChar *)"http://localhost"
286
288#define AGT_DEF_RESTCONF_SERVER_URL (const xmlChar *)"http://localhost"
289
291#define AGT_DEF_SAVE_OWNERS FALSE
292
294#define AGT_DEF_JSON_LEAF_LIST_1LINE FALSE
295
297#define AGT_DEF_SAVE_CONFIG_SYSTEM FALSE
298
300#define AGT_DEF_GETBULK_MAX 10
301
303#define AGT_DEF_WITH_CONFIG_ID TRUE
304
306#define AGT_DEF_WITH_OCPATTERN FALSE
307
309#define AGT_DEF_NO_NVSTORE FALSE
310
312#define AGT_DEF_WITH_CALLHOME FALSE
313
315#define AGT_DEF_WITH_SCHEMA_MOUNT TRUE
316
318#define AGT_DEF_CALLHOME_RETRY_INT 60
319
321#define AGT_DEF_CALLHOME_RETRY_MAX 10
322
324#define AGT_DEF_CALLHOME_PORT NCX_DEF_SSH_CALLHOME
325
327#define AGT_DEF_CALLHOME_TLS_PORT NCX_DEF_TLS_CALLHOME
328
330#define AGT_DEF_CALLHOME_RESTCONF_TLS_PORT NCX_DEF_RESTCONF_TLS_CALLHOME
331
333#define AGT_YUMAWORKS_CALLHOME_MODULE (const xmlChar *)"yumaworks-callhome"
334
336#define AGT_YUMAWORKS_CALLHOME_REVISION (const xmlChar *)"2020-10-17"
337#define AGT_DEF_FILELOC_FHS FALSE
338
340#define AGT_DEF_NO_AUDIT_LOG FALSE
341
346#define AGT_DEF_CRYPT_HASH_PREFIX (const xmlChar *)"$6$"
347
349#define AGT_DEF_MIN_PASSWD_LEN 8
350
352#define AGT_DEF_HA_ENABLED FALSE
353
355#define AGT_DEF_HA_SIL_STANDBY FALSE
356
358#define AGT_DEF_HA_PORT 8088
359
361#define AGT_DEF_HA_STANDBY_MODE AGT_HA_MODE_HOT_STANDBY
362
364#define AGT_DEF_YPCOAP_PORT 5683
365
367#define AGT_DEF_YPCOAP_DTLS_PORT 5684
368
370#define AGT_DEF_YPCOAP_ADDRESS (const xmlChar *)"0.0.0.0"
371
373#define AGT_DEF_RESTCONF_DEFAULT_ENCODING NCX_MSG_ENCODING_JSON
374
376#define AGT_DEF_TLS_PORT 6513
377
379#define AGT_DEF_DB_LOCK_RETRY 500 // mSec
380
382#define AGT_DEF_DB_LOCK_TIMEOUT 20 // Sec
383
385#define AGT_DEF_WITH_YUMAWORKS_CONFIG_CHANGE FALSE
386
388#define AGT_DEF_WITH_YUMAWORKS_CALLHOME TRUE
389
391#define AGT_DEF_WITH_YUMAWORKS_EVENT_STREAM TRUE
392
394#define AGT_DEF_WITH_NMDA FALSE
395
397#define AGT_DEF_STARTUP_SKIP_VALIDATION FALSE
398
400#define AGT_DEF_RETURN_STATUS FALSE
401
405#define AGT_DEF_WAIT_DATASTORE_READY FALSE
406
408#define AGT_DEF_YANG_SID_MODE NCX_YANG_SID_MODE_SID_FILE
409
411#define AGT_DEF_WITH_YANG_CBOR FALSE
412
416#define AGT_DEF_SILCALL_DELETE_FIRST TRUE
417
422#define AGT_DEF_XPATH_DBLSLASH_OK FALSE
423
425#define AGT_DEF_SIL_CC_CALLBACK_ALL FALSE
426
427
429#define AGT_SELECT_TIMEOUT_SEC 0
430
433#define AGT_SELECT_TIMEOUT_USEC 10000
434
436#define AGT_USER_VAR (const xmlChar *)"user"
437
439#define AGT_URL_SCHEME_LIST (const xmlChar *)"file"
440
442#define AGT_URL_SCHEME_LIST_TFTP (const xmlChar *)"file,tftp"
443
445#define AGT_FILE_SCHEME (const xmlChar *)"file:///"
446
448#define AGT_TOASTER_MOD (const xmlChar *)"toaster"
449
451#define AGT_TEST_MOD (const xmlChar *)"test"
452
454#define AGT_SIL_SA (const xmlChar *)"sil-sa"
455
457#define AGT_DB_API (const xmlChar *)"db-api"
458
460#define AGT_YP_HA (const xmlChar *)"yp-ha"
461
463#define AGT_YP_GNMI (const xmlChar *)"yp-gnmi"
464
466#define AGT_YP_GRPC (const xmlChar *)"yp-grpc"
467
469#define AGT_YCONTROL_MOD (const xmlChar *)"yumaworks-ycontrol"
470
472#define AGT_DB_API_MOD (const xmlChar *)"yumaworks-db-api"
473
475#define AGT_SIL_SA_MOD (const xmlChar *)"yumaworks-sil-sa"
476
478#define AGT_PROFILE_MOD (const xmlChar *)"yumaworks-agt-profile"
479
481#define AGT_ACTION_MOD (const xmlChar *)"yang-attributes"
482
484#define AGT_YP_HA_MOD (const xmlChar *)"yumaworks-yp-ha"
485
487#define AGT_TEMPLATES_MOD (const xmlChar *)"yumaworks-templates"
488
490#define AGT_LOCK_MOD (const xmlChar *)"yumaworks-lock"
491
493#define AGT_YP_GNMI_MOD (const xmlChar *)"yumaworks-yp-gnmi"
494
496#define AGT_YP_GRPC_MOD (const xmlChar *)"yumaworks-yp-grpc"
497
499#define AGT_YP_SCHEMA_MOUNT_MOD (const xmlChar *)"yumaworks-schema-mount"
500
502#define AGT_YP_SM_YANGLIB_MOD (const xmlChar *)"yumaworks-sm-yanglib"
503
505#define AGT_DEF_SERVER_ID (const xmlChar *)"server1"
506
508#define AGT_WITHDEF_MOD (const xmlChar *)"ietf-netconf-with-defaults"
509
510
514#define AGT_TEST_FL_MIN_ELEMS bit0
515
517#define AGT_TEST_FL_MAX_ELEMS bit1
518
520#define AGT_TEST_FL_MANDATORY bit2
521
523#define AGT_TEST_FL_MUST bit3
524
526#define AGT_TEST_FL_UNIQUE bit4
527
529#define AGT_TEST_FL_XPATH_TYPE bit5
530
532#define AGT_TEST_FL_CHOICE bit6
533
535#define AGT_TEST_FL_WHEN bit7
536
538#define AGT_TEST_ALL_COMMIT_MASK (bit0|bit1|bit2|bit3|bit4|bit5|bit6)
539
541#define AGT_TEST_INSTANCE_MASK (bit0|bit1|bit2|bit4|bit6)
542
544#define AGT_CLI_NOSTARTUP (const xmlChar *)"no-startup"
545
547#define AGT_CLI_STARTUP (const xmlChar *)"startup"
548
550#define AGT_CLI_FACTORY_STARTUP (const xmlChar *)"factory-startup"
551
553#define AGT_CLI_STARTUP_FACTORY_FILE (const xmlChar *)"startup-factory-file"
554
556#define AGT_EVAL_REQUEST_LIMIT 500
557
561#define AGT_MAX_OWNER_ID 255
562
564#define AGT_WATCHER (const xmlChar *)"ypwatcher"
565
567#define AGT_DEF_WAT_INTERVAL 10
568
570#define AGT_DEF_SSHD_COMMAND (const xmlChar *)"/usr/sbin/sshd"
571
573#define AGT_DEF_SUBSYS_COMMAND \
574 (const xmlChar *)"/usr/sbin/netconf-subsystem-pro"
575
577#define AGT_DEF_SNMP_SUBAGENT_PRIO 127
578
579/* flags for the agt_auditlog_events mask from
580 * --audit-log-events CLI parameter.
581 * edit-candidate events are generated when an edit
582* to <candidate> is completed.
583 */
584#define AGT_FL_AUDIT_EDIT_CANDIDATE bit0
585
589#define AGT_FL_AUDIT_EDIT_RUNNING bit1
590
594#define AGT_FL_AUDIT_UPDATE_STARTUP bit2
595
597#define AGT_FL_AUDIT_CLIENT_SESSION bit3
598
600#define AGT_FL_AUDIT_CONTROL_SESSION bit4
601
603#define AGT_FL_AUDIT_NACM_WRITE_ERROR bit5
604
606#define AGT_FL_AUDIT_NACM_EXEC_ERROR bit6
607
609#define AGT_FL_AUDIT_RPC_SUMMARY bit7
610
612#define AGT_FL_AUDIT_EDIT_DATA bit8
613
615#define AGT_DEF_AUDIT_EVENTS AGT_FL_AUDIT_EDIT_RUNNING
616
618#define AGT_DEF_CRL_MISSING_OK false
619
621#define AGT_DEF_CRL_MODE AGT_CRL_MODE_OFF
622
624#define AGT_DEF_CVT_SUBTREE_FILTER false
625
629#define AGT_DEF_PUSH_MIN_PERIOD 100
630
632#define AGT_DEF_PUSH_MIN_DAMPENING 100
633
635#define AGT_DEF_PUSH_MAX_PERIODIC 16
636
638#define AGT_DEF_PUSH_MAX_OPERATIONAL 4
639
641#define AGT_DEF_PUSH_SIMOP_ENABLED true
642
644#define AGT_DEF_PUSH_SIMOP_PERIOD 500
645
647#define AGT_DEF_PUSH_SIMOP_PATCH_UPDATE true
648
650#define AGT_NON_NMDA_YANGLIB_REV (const xmlChar *)"2016-06-21"
651
653#define AGT_NMDA_YANGLIB_REV (const xmlChar *)"2019-01-04"
654
656#define AGT_SIL_SA_MODULE (const xmlChar *)"yumaworks-sil-sa"
657
661#define AGT_DEF_TLS_DEPRECATED_OK false
662
664#define AGT_DEF_TLS_DH_ENABLED true
665
667#define AGT_DEF_SAVE_CONFIG_TEMPNAME true
668
670#define AGT_SAVE_CONFIG_TEMPNAME_EXT (const xmlChar *)".temp"
671
672/********************************************************************
673* *
674* T Y P E S *
675* *
676*********************************************************************/
677
679typedef enum agt_acmode_t_ {
686
687
695typedef enum agt_cbtyp_t_ {
701
702
704typedef enum agt_acm_model_t_ {
710
711
713typedef enum agt_transaction_model_t_ {
718
719
721typedef enum agt_commit_type_t_ {
726
727
729typedef enum agt_exit_mode_t_ {
736
737
739typedef enum agt_tx_type_t_ {
746
747
749typedef enum agt_ccparm_t_ {
756
757
759typedef enum agt_ha_role_t_ {
765
766
768typedef enum agt_ch_proto_t_ {
774
775
777typedef enum agt_crl_mode_t_ {
783
784
786typedef enum agt_hook_type_t_ {
792
793
797typedef struct agt_replay_subsys_t_ {
798 dlq_hdr_t qhdr;
799 xmlChar *subsys_id;
801
802
806typedef struct agt_maxuser_t_ {
807 dlq_hdr_t qhdr;
808 xmlChar *username;
811
812
813
814
848typedef struct agt_profile_t_ {
853
856
859
862
865
868
871
874
877
880
883
886
888 boolean agt_startup_error; /* T: stop, F: check fallback */
889
891 boolean agt_running_error; /* T: stop, F: check fallback */
892
895
898
901
904
907
910
919
922
925
928
931
934
936 const xmlChar *agt_accesscontrol;
937
939 const xmlChar *agt_conffile;
940
942 const xmlChar *agt_confdir;
943
945 const xmlChar *agt_logfile;
946
948 const xmlChar *agt_startup;
949
952
954 const xmlChar *agt_defaultStyle;
955
960 //const xmlChar *agt_superuser;
961
963 const xmlChar *agt_extern_libspec;
964
966 const xmlChar *agt_backup_dir;
967
971 const xmlChar *agt_server_id;
972
979 const xmlChar *agt_server_root;
980
983
986
989
992
995
998
1001
1004
1006 boolean agt_useurl;
1007
1010
1013
1016
1019
1022
1025
1028
1031
1034
1037
1040
1043
1046
1049
1052
1055
1057 uint16 agt_ports[AGT_MAX_PORTS];
1058
1061
1064
1066 const xmlChar *agt_coap_address;
1067
1070
1073
1076
1079
1082
1085
1088
1091
1097
1100
1108
1111
1114
1117
1120
1123
1126
1133
1136
1139
1147
1158
1164
1171
1177
1182
1187
1196
1202
1205
1213
1216
1219
1222
1225
1228
1231
1234
1237
1240
1243
1246
1248 const xmlChar *agt_ha_server_key;
1249
1252
1253 // leaf-list ha-server not stored here; not sent to subsys
1254
1257
1262
1265
1266 /* TBD: add this data to subsystems in the near future */
1267
1272
1278
1284
1296
1300 boolean agt_with_yang11_hello; /* d: false */
1301
1308
1313
1319
1320 /* the callhome-server parameter is handled by agt_callhome */
1321
1326 const xmlChar *agt_sshd_path;
1327
1332 const xmlChar *agt_subsys_path;
1333
1338 const xmlChar *agt_sshd_config;
1339
1340
1347
1350
1353
1356
1358 boolean agt_startup_fallback; /* T: restart, F: continue */
1359
1361 boolean agt_running_fallback; /* T: restart, F: continue */
1362
1363
1364 /* the SNMP agent parameters */
1365
1368
1371
1376
1383
1386
1389
1392
1394 const xmlChar *agt_netconf_tls_key;
1395
1398
1401
1404
1407
1409 const xmlChar *agt_errmsg_lang;
1410
1413
1418
1421
1424
1427
1430
1435
1438
1441
1447
1453
1456
1459
1466
1469
1472
1475
1478
1481
1484
1487
1490
1493
1496
1499
1502
1505
1508
1511
1513 uint16 agt_push_min_period; // centiseconds
1514
1516 uint16 agt_push_min_dampening; // centiseconds
1517
1519 uint32 agt_push_max_periodic; // count
1520
1523
1526
1529
1532
1535
1538
1541
1546
1554 const xmlChar *agt_sm_config;
1555
1560
1561
1566
1569
1579
1585
1592 const xmlChar *agt_tls_cipherlist;
1593
1596
1601
1604
1607
1610
1613
1618
1619 /* YPW-2000
1620 * Enable use of a temp file while saving config files such
1621 * as startup-cfg.xml or backup-cfg.xml
1622 * The file is renamed to the provided filespec after
1623 * it is written; If no rename because crash then restart will
1624 * not find real xml file; No CLI to disable
1625 */
1626 boolean agt_save_config_tempname;
1627
1632
1638
1641
1649
1651 const xmlChar *agt_user_parm;
1652
1653 /****** state variables; TBD: move out of profile ******/
1654
1657
1660
1663
1666
1669
1672
1675
1678
1680 dlq_hdr_t agt_savedevQ;
1681
1684
1687
1690
1693
1696 boolean agt_confdir_skipped;
1697
1700
1703
1704
1706
1707
1711/******************* External System Callbacks ***********************/
1712
1727 (agt_profile_t *profile);
1728
1729
1743 (boolean pre_cli);
1744
1745
1760 (boolean pre_load);
1761
1762
1768typedef void (*agt_system_cleanup_fn_t) (void);
1769
1770
1782 (ncx_display_mode_t encoding,
1783 const xmlChar *filespec);
1784
1785
1802 (ncx_display_mode_t *encoding,
1803 xmlChar **filespec);
1804
1805
1809typedef struct agt_syslib_cb_t_ {
1811 dlq_hdr_t qhdr;
1812
1814 void *handle;
1815
1817 xmlChar *libspec;
1818
1821
1824
1827
1830
1833
1836
1840
1841
1843typedef struct agt_edit_parms_cb_t_ {
1844
1845
1846 /**** state data used for the edit transaction ****/
1847 yang_patch_cb_t *pcb;
1848
1850
1851
1861typedef void (*agt_replay_fn_t) (boolean is_start);
1862
1863
1867/********************************************************************
1868* *
1869* F U N C T I O N S *
1870* *
1871*********************************************************************/
1872
1873
1897extern status_t
1898 agt_init1 (int argc,
1899 char *argv[],
1900 boolean *showver,
1901 help_mode_t *showhelpmode);
1902
1903
1917extern status_t
1918 agt_init1_ex (int argc,
1919 char *argv[],
1920 boolean factory_restart,
1921 boolean *showver,
1922 help_mode_t *showhelpmode);
1923
1924
1932extern status_t
1933 agt_init1_sil_sa (void);
1934
1935
1950extern status_t
1951 agt_init1_ypserver (int argc,
1952 char *argv[],
1953 boolean factory_restart,
1954 boolean *showver,
1955 help_mode_t *showhelpmode);
1956
1957
1970extern status_t
1971 agt_init2 (void);
1972
1973
1987extern status_t
1988 agt_init2_ex (boolean factory_restart);
1989
1990
1996extern status_t
1997 agt_init2_sil_sa (void);
1998
1999
2006extern void
2007 agt_cleanup (void);
2008
2009
2016extern void
2017 agt_cleanup_sil_sa (void);
2018
2019
2027extern agt_profile_t *
2028 agt_get_profile (void);
2029
2030
2038extern void
2040 int intnum);
2041
2042
2048extern boolean
2050
2051
2057extern ncx_shutdowntyp_t
2059
2060
2067extern int
2069
2070
2077extern const xmlChar *
2079
2080
2090extern boolean
2091 agt_advertise_module_needed (const xmlChar *modname);
2092
2093
2102extern void agt_request_replay (void);
2103
2104
2114extern void agt_request_replay_ex (void *cookie);
2115
2116
2122extern void * agt_get_replay_cookie (void);
2123
2124
2135extern void
2136 agt_request_replay_subsys (const xmlChar *subsys_id);
2137
2138
2144extern boolean agt_replay_requested (void);
2145
2146
2152extern void agt_start_replay (void);
2153
2154
2160extern void agt_finish_replay (void);
2161
2162
2171extern status_t
2173 agt_nvsave_fn_t store_fn);
2174
2175
2186extern status_t
2188 const xmlChar *filespec);
2189
2190
2199extern status_t
2200 agt_add_allowed_user (const xmlChar *username);
2201
2202
2209extern void
2210 agt_remove_allowed_user (const xmlChar *username);
2211
2212
2219extern status_t
2220 agt_check_allowed_user (const xmlChar *username);
2221
2222
2223
2232extern status_t
2233 agt_add_superuser (const xmlChar *username);
2234
2235
2242extern void
2243 agt_remove_superuser (const xmlChar *username);
2244
2245
2252extern status_t
2253 agt_check_superuser (const xmlChar *username);
2254
2255
2261extern void
2263
2264
2270extern const xmlChar *
2271 agt_get_server_id (void);
2272
2273
2280extern const xmlChar *
2281 agt_get_server_root (void);
2282
2283
2289extern const xmlChar *
2290 agt_get_server_key (void);
2291
2292
2298extern boolean
2299 agt_is_sil_sa (void);
2300
2301
2307extern dlq_hdr_t *
2308 agt_get_savedevQ (void);
2309
2310
2317extern boolean
2318 agt_replay_subsys_is_active (const xmlChar *subsys_id);
2319
2320
2327extern boolean
2329
2330
2337extern const xmlChar *
2339
2340
2347extern agt_ha_role_t
2348 agt_ha_role_enum (const xmlChar *ha_role);
2349
2350
2357extern boolean
2358 agt_use_notifications (void);
2359
2360
2368extern status_t
2370
2371
2377extern boolean
2378 agt_init2_done (void);
2379
2380
2392extern boolean
2394
2395
2401extern void
2403
2404
2414extern boolean
2416
2417
2424extern status_t
2426
2427
2434extern ncx_modcache_t *
2435 agt_find_modcache (const xmlChar *modname);
2436
2437
2443extern status_t
2444 agt_run_extloop (void);
2445
2446
2454extern status_t
2455 agt_enter_maintenance_mode (boolean read_ok,
2456 boolean operation_ok);
2457
2458
2464extern status_t
2466
2467
2473extern boolean
2475
2476
2484extern boolean
2486
2487
2495extern boolean
2497
2498
2504extern boolean
2506
2507
2513extern void
2514 agt_set_eventlog_size (uint32 eventlog_size);
2515
2516
2522extern void
2523 agt_set_max_burst (uint32 max_burst);
2524
2525
2531extern void
2532 agt_set_max_getbulk (uint32 max_getbulk);
2533
2534
2542extern agt_not_msg_t *
2543 agt_make_term_msg (const xmlChar *msg,
2544 status_t *res);
2545
2546
2552extern status_t
2554
2555
2561extern boolean
2562 agt_use_nmda (void);
2563
2564
2571extern boolean
2573
2574
2580extern boolean
2581 agt_use_yang_cbor (void);
2582
2583
2589extern const char *
2591
2592
2598extern const xmlChar *
2599 agt_get_user_parm (void);
2600
2601
2608extern status_t
2609 agt_add_maxuser_parm (const xmlChar *cliparm);
2610
2611
2612
2623 agt_get_maxuser_parm (const xmlChar *username,
2624 uint16 *retval);
2625
2626
2630#ifdef __cplusplus
2631} /* end extern 'C' */
2632#endif
2633
2634#endif /* _H_agt */
NETCONF Notifications DM module support.
agt_exit_mode_t
exit reasons for YControl IO loop
Definition: agt.h:729
status_t(* agt_system_init2_fn_t)(boolean pre_load)
system init2 callback
Definition: agt.h:1760
agt_commit_type_t
NETCONF commit types.
Definition: agt.h:721
status_t(* agt_nvload_fn_t)(ncx_display_mode_t *encoding, xmlChar **filespec)
nvload callback
Definition: agt.h:1802
void(* agt_system_cleanup_fn_t)(void)
system cleanup callback
Definition: agt.h:1768
agt_hook_type_t
Hook types enumeration to specify Hook type.
Definition: agt.h:786
void(* agt_replay_fn_t)(boolean is_start)
replay callback (agt_replay_fn_t)
Definition: agt.h:1861
agt_transaction_model_t
not used yet in YANG-API or NETCONF!
Definition: agt.h:713
agt_ccparm_t
confirmed-commit parms
Definition: agt.h:749
status_t(* agt_system_init1_fn_t)(boolean pre_cli)
system init1 callback
Definition: agt.h:1743
agt_ch_proto_t
server callhome protocol
Definition: agt.h:768
status_t(* agt_nvsave_fn_t)(ncx_display_mode_t encoding, const xmlChar *filespec)
brief nvsave callback
Definition: agt.h:1782
agt_acmode_t
matches access-control enumeration in netconfd.yang
Definition: agt.h:679
agt_crl_mode_t
server TLS CRL mode
Definition: agt.h:777
agt_acm_model_t
select the YANG module for the access control model
Definition: agt.h:704
agt_tx_type_t
YControl transaction type.
Definition: agt.h:739
agt_ha_role_t
server HA mode mode
Definition: agt.h:759
#define AGT_MAX_PORTS
maximum number of –port leaf-list values that will be saved
Definition: agt.h:188
agt_cbtyp_t
enumeration of the different server EDIT callback types These are used as array indices so there is n...
Definition: agt.h:695
void(* agt_system_init_profile_fn_t)(agt_profile_t *profile)
system init server profile callback
Definition: agt.h:1727
@ AGT_EXIT_MODE_NONE
this value is used
Definition: agt.h:730
@ AGT_EXIT_MODE_ERROR
exit loop with error
Definition: agt.h:732
@ AGT_EXIT_MODE_TIMEOUT
exit loop with timeout
Definition: agt.h:733
@ AGT_EXIT_MODE_OK
exit loop with OK
Definition: agt.h:731
@ AGT_EXIT_MODE_DROPPED
exit loop with session dropped
Definition: agt.h:734
@ AGT_COMMIT_TYPE_NORMAL
normal client operation
Definition: agt.h:723
@ AGT_COMMIT_TYPE_REPLAY
internal replay commit
Definition: agt.h:724
@ AGT_COMMIT_TYPE_NONE
not set
Definition: agt.h:722
@ AGT_HOOK_TYPE_SETHOOK
Set-Hook.
Definition: agt.h:788
@ AGT_HOOK_TYPE_NONE
not set
Definition: agt.h:787
@ AGT_HOOK_TYPE_TRANSACTION
Transaction Hook.
Definition: agt.h:789
@ AGT_HOOK_TYPE_POST_SETHOOK
Post Set-Hook.
Definition: agt.h:790
@ AGT_TM_PRIVATE
private transactions
Definition: agt.h:716
@ AGT_TM_SHARED
shared transactions (only value supported)
Definition: agt.h:715
@ AGT_TM_NONE
this value is used
Definition: agt.h:714
@ AGT_CCPARM_CONFIRMED
confirmed
Definition: agt.h:751
@ AGT_CCPARM_NONE
not set
Definition: agt.h:750
@ AGT_CCPARM_PERSIST
persist
Definition: agt.h:753
@ AGT_CCPARM_CONFIRM_TIMEOUT
confirm-timeout
Definition: agt.h:752
@ AGT_CCPARM_PERSIST_ID
persist-id
Definition: agt.h:754
@ AGT_CH_PROTO_NONE
not set
Definition: agt.h:769
@ AGT_CH_PROTO_RESTCONF_TLS
restconf-over-ssh callhome
Definition: agt.h:772
@ AGT_CH_PROTO_NETCONF_SSH
netconf-over-ssh callhome
Definition: agt.h:770
@ AGT_CH_PROTO_NETCONF_TLS
netconf-over-tls callhome
Definition: agt.h:771
@ AGT_ACMOD_PERMISSIVE
permissive mode, read + exec allowed
Definition: agt.h:682
@ AGT_ACMOD_OFF
NACM completely off.
Definition: agt.h:684
@ AGT_ACMOD_DISABLED
almost all access control turned off
Definition: agt.h:683
@ AGT_ACMOD_NONE
not set
Definition: agt.h:680
@ AGT_ACMOD_ENFORCING
full enforcement
Definition: agt.h:681
@ AGT_CRL_MODE_CA
CRL check client and CA certs.
Definition: agt.h:781
@ AGT_CRL_MODE_CLIENT
CRL check client cert.
Definition: agt.h:780
@ AGT_CRL_MODE_NONE
not set
Definition: agt.h:778
@ AGT_CRL_MODE_OFF
CRL check off.
Definition: agt.h:779
@ AGT_ACM_MODEL_IETF_NACM
IETF NACM (default)
Definition: agt.h:706
@ AGT_ACM_MODEL_YUMA_NACM
YUMA NACM (obsolete, not supported)
Definition: agt.h:707
@ AGT_ACM_MODEL_NONE
not set
Definition: agt.h:705
@ AGT_ACM_MODEL_EXTERNAL
external ACM via yp_system library
Definition: agt.h:708
@ AGT_TX_TYPE_NONE
not set
Definition: agt.h:740
@ AGT_TX_TYPE_GET
GET2 transaction.
Definition: agt.h:741
@ AGT_TX_TYPE_HOOK
hook callback for edit
Definition: agt.h:744
@ AGT_TX_TYPE_RPC
DB-API RPC transaction.
Definition: agt.h:743
@ AGT_TX_TYPE_EDIT
EDIT1 or EDIT2 transaction.
Definition: agt.h:742
@ AGT_HA_ROLE_STANDBY
HA standby role.
Definition: agt.h:762
@ AGT_HA_ROLE_NONE
not set
Definition: agt.h:760
@ AGT_HA_ROLE_ACTIVE
HA active role.
Definition: agt.h:763
@ AGT_HA_ROLE_NOT_SET
HA role not set.
Definition: agt.h:761
@ AGT_CB_APPLY
P2: write operation apply.
Definition: agt.h:697
@ AGT_CB_VALIDATE
P1: write operation validate.
Definition: agt.h:696
@ AGT_CB_ROLLBACK
P3-neg: write operation rollback.
Definition: agt.h:699
@ AGT_CB_COMMIT
P3-pos: write operation commit.
Definition: agt.h:698
agt_not_msg_t * agt_make_term_msg(const xmlChar *msg, status_t *res)
Create a <term-msg> notification.
Definition: agt.c:6136
void agt_remove_superuser(const xmlChar *username)
Remove a superuser name from the running system Does not change any config file allowed-user paramete...
Definition: agt.c:5374
status_t agt_check_save_external_config(ncx_display_mode_t encoding, const xmlChar *filespec)
Check if an external NV handler needs to be used to save the config.
Definition: agt.c:5164
status_t agt_init1_ypserver(int argc, char *argv[], boolean factory_restart, boolean *showver, help_mode_t *showhelpmode)
Initialize the Server Library: stage 1: CLI and profile Added factory_restart parameter yp-controller...
Definition: agt.c:3810
void agt_cleanup(void)
Cleanup the Server Library.
Definition: agt.c:4702
const xmlChar * agt_get_user_parm(void)
Get the user-parm string (if any)
Definition: agt.c:6287
const xmlChar * agt_get_server_root(void)
Get the server-root string.
Definition: agt.c:5478
status_t agt_add_maxuser_parm(const xmlChar *cliparm)
Add a maxuser parameter value.
Definition: agt.c:6301
void agt_request_replay_subsys(const xmlChar *subsys_id)
Request replay of the running config to the SIL-SA modules on the specified subsystem.
Definition: agt.c:4979
void agt_cleanup_sil_sa(void)
Cleanup the Server Library for SIL-SA usage.
Definition: agt.c:4718
void * agt_get_replay_cookie(void)
Get the current replay cookie.
Definition: agt.c:5039
void agt_set_factory_restart(void)
Set the flag so the server will restart with the factory config.
Definition: agt.c:5824
status_t agt_enter_maintenance_mode(boolean read_ok, boolean operation_ok)
Set the server to mainenance mode to block client activity.
Definition: agt.c:6067
const char * agt_get_aflocal_sockname(void)
Get the AFLOCAL socket name to use for <ncx-connect>
Definition: agt.c:6272
status_t agt_init_term_msg_module(void)
Init the term-msg module and object backptr.
Definition: agt.c:6183
status_t agt_init2(void)
Initialize the Server Library (phase 2 init)
Definition: agt.c:3842
status_t agt_add_allowed_user(const xmlChar *username)
Add a backptr to the string in the val_value_t containing the username that is allowed.
Definition: agt.c:5204
boolean agt_use_nmda(void)
Check if NMDA is enabled.
Definition: agt.c:6217
int agt_shutdown_term_signal(void)
Get the shutdown termination signal if any.
Definition: agt.c:4864
boolean agt_replay_main_is_active(void)
Check if the replay in progress is for the main server or could be for a subsystem.
Definition: agt.c:5568
status_t agt_get_maxuser_parm(const xmlChar *username, uint16 *retval)
Get the maxuser max-sessions value for a specified user.
Definition: agt.c:6398
boolean agt_maintenance_mode_operation_ok(void)
Return true if in maintenance mode operations OK;.
Definition: agt.c:6004
const xmlChar * agt_ha_role_str(agt_ha_role_t ha_role)
Get the string for the specified HA role enumeration.
Definition: agt.c:5586
status_t agt_check_superuser(const xmlChar *username)
Check a username in the superuser Q.
Definition: agt.c:5415
boolean agt_is_sil_sa(void)
Check if server running in SIL-SA mode.
Definition: agt.c:5511
status_t agt_add_modcache(ncx_modcache_t *mc)
Add a module to the modcache queue and hash table.
Definition: agt.c:5866
status_t agt_add_superuser(const xmlChar *username)
Add a backptr to the string in the val_value_t containing the username that is a superuser.
Definition: agt.c:5332
status_t agt_register_local_nv_handler(agt_nvload_fn_t load_fn, agt_nvsave_fn_t store_fn)
Register a set of nvstore and nvload callback functions to handle the non-volatile storage of the con...
Definition: agt.c:5124
const xmlChar * agt_cbtype_name(agt_cbtyp_t cbtyp)
Get the string for the server callback phase.
Definition: agt.c:4883
agt_profile_t * agt_get_profile(void)
Get the server profile struct.
Definition: agt.c:4736
boolean agt_waiting_datastore_ready(void)
Check if client sessions are blocked until the datastore is ready.
Definition: agt.c:6234
void agt_request_replay(void)
Request replay of the running config to SIL modules because SIL hardware has reset somehow.
Definition: agt.c:4937
const xmlChar * agt_get_server_id(void)
Get the server-id string.
Definition: agt.c:5461
boolean agt_maintenance_mode_session_ok(void)
Return true if in maintenance mode new sessions OK;.
Definition: agt.c:6017
status_t agt_init2_ex(boolean factory_restart)
Initialize the Server Library (phase 2 init - extended)
Definition: agt.c:3865
void agt_request_replay_ex(void *cookie)
Request replay of the running config to SIL modules because SIL hardware has reset somehow.
Definition: agt.c:4955
boolean agt_use_yang_cbor(void)
Check if YANG CBOR is enabled.
Definition: agt.c:6255
void agt_request_shutdown(ncx_shutdowntyp_t mode, int intnum)
Request some sort of server shutdown.
Definition: agt.c:4754
status_t agt_init2_sil_sa(void)
Initialize the Server Library for SIL-SA.
Definition: agt.c:4664
void agt_start_replay(void)
Start replay of the running config to SIL modules.
Definition: agt.c:5052
status_t agt_check_allowed_user(const xmlChar *username)
Check a username in the allowed-user Q.
Definition: agt.c:5276
status_t agt_exit_maintenance_mode(void)
Exit the server from mainenance mode to unblock client activity.
Definition: agt.c:6105
status_t agt_init1_sil_sa(void)
Initialize the Server Library: stage 1: CLI and profile.
Definition: agt.c:3767
boolean agt_use_notifications(void)
Check if notifications currently enabled.
Definition: agt.c:5647
status_t agt_run_extloop(void)
Run the agt_ncxserver in external loop mode.
Definition: agt.c:5927
boolean agt_in_factory_restart(void)
Check if a factory restort is in progress.
Definition: agt.c:5846
const xmlChar * agt_get_server_key(void)
Get the ha-server-key string.
Definition: agt.c:5495
boolean agt_maintenance_mode_read_ok(void)
Return true if in maintenance mode reads OK;.
Definition: agt.c:5989
boolean agt_in_maintenance_mode(void)
Return true if in mainenance mode now.
Definition: agt.c:5974
ncx_modcache_t * agt_find_modcache(const xmlChar *modname)
Find a module to the modcache queue and hash table.
Definition: agt.c:5899
status_t agt_init1_ex(int argc, char *argv[], boolean factory_restart, boolean *showver, help_mode_t *showhelpmode)
Initialize the Server Library: stage 1: CLI and profile Added factory_restart parameter.
Definition: agt.c:3740
boolean agt_shutdown_requested(void)
Check if some sort of server shutdown is in progress.
Definition: agt.c:4824
boolean agt_replay_requested(void)
Check if config replay is pending.
Definition: agt.c:5022
status_t agt_check_load_config(agt_ha_role_t ha_role)
Check if the boot-time load-config should be done because it was deferred while waiting for the YP-HA...
Definition: agt.c:5677
void agt_set_max_burst(uint32 max_burst)
Set the max-burst parameter.
Definition: agt.c:6032
ncx_shutdowntyp_t agt_shutdown_mode_requested(void)
Check what shutdown mode was requested.
Definition: agt.c:4847
dlq_hdr_t * agt_get_savedevQ(void)
Get the agt_savedevQ pointer.
Definition: agt.c:5525
boolean agt_advertise_module_needed(const xmlChar *modname)
Check if the module should be advertised or not.
Definition: agt.c:4913
void agt_remove_allowed_user(const xmlChar *username)
Remove an allowed-user name from the running system Does not change any config file allowed-user para...
Definition: agt.c:5237
boolean agt_replay_subsys_is_active(const xmlChar *subsys_id)
Find a subsys replay request struct in the activeQ.
Definition: agt.c:5542
void agt_register_replay_callback(agt_replay_fn_t cbfn)
Register a callback function for a replay config event.
Definition: agt.c:5444
status_t agt_init1(int argc, char *argv[], boolean *showver, help_mode_t *showhelpmode)
Initialize the Server Library: stage 1: CLI and profile.
Definition: agt.c:3703
void agt_set_max_getbulk(uint32 max_getbulk)
Set the max-getbulk parameter.
Definition: agt.c:6047
void agt_set_eventlog_size(uint32 eventlog_size)
Set the eventlog-size parameter.
Definition: agt.c:5959
boolean agt_init2_done(void)
Check if the init2 phase is complete.
Definition: agt.c:5771
void agt_finish_replay(void)
Finish replay of the running config to SIL modules.
Definition: agt.c:5085
boolean agt_advertise_yang11_module_needed(ncx_module_t *mod)
Check whether the NETCONF hello message should conform to the standard and leave out YANG 1....
Definition: agt.c:5797
agt_ha_role_t agt_ha_role_enum(const xmlChar *ha_role)
Get the enum for the specified HA role string.
Definition: agt.c:5616
log_debug_t
The debug level enumerations used in util/log.c.
Definition: log.h:343
status_t
global error return code
Definition: status_enum.h:210
help_mode_t
modes to match the keywords brief, normal, full
Definition: help.h:84
ncx_agttarg_t
enum to identify the agent native target
Definition: ncxtypes.h:517
ncx_yang_sid_mode_t
YANG SID Allocation mode from yang-sid-mode typedef.
Definition: ncxtypes.h:1763
ncx_agtstart_t
enum to identify the agent native startup mode
Definition: ncxtypes.h:528
ncx_msg_encoding_t
enumeration for message encoding formats
Definition: ncxtypes.h:647
ncx_snmp_agt_role_t
enum to identify the SNMP agent native mode
Definition: ncxtypes.h:1593
ncx_name_match_t
Node name match modes.
Definition: ncxtypes.h:695
ncx_display_mode_t
enumeration of val_dump_value display modes Some RESTCONF code uses this field incorrectly for messag...
Definition: ncxtypes.h:617
ncx_withdefaults_t
enum for with-defaults enum values
Definition: ncxtypes.h:1265
ncx_shutdowntyp_t
enumeration of the different program shutdown modes
Definition: ncxtypes.h:536
uint8 obj_testflags_t
object test flags
Definition: obj.h:1177
YANG help text support for CLI Print help text for various templates.
NCX System Logging Manager.
YANG module data structures Many internal representations of YANG module constructs.
Global error messages for status code enumerations.
struct to contain all agt_send_edit parameters
Definition: agt.h:1843
for the list of username / max-session values to support the –max-per-user-sessions CLI parameter
Definition: agt.h:806
xmlChar * username
malloced user name string
Definition: agt.h:808
dlq_hdr_t qhdr
queue header
Definition: agt.h:807
uint16 max_sessions
max session count 0 .
Definition: agt.h:809
one notification message that will be sent to all subscriptions in the stream and kept in the replay ...
Definition: agt_not.h:143
Multiple instances are not supported.
Definition: agt.h:848
const xmlChar * agt_backup_dir
backup dir location
Definition: agt.h:966
boolean agt_with_yp_coap_dtls
enable YP-CoAP DTLS sessions (not supported)
Definition: agt.h:1227
boolean agt_allow_tcp_socket
allow a TCP socket instead of an AF_LOCAL socket for connections
Definition: agt.h:1122
const xmlChar * agt_startup
startup filespec
Definition: agt.h:948
boolean agt_sil_validate_candidate
If true, the server will invoke the VALIDATE phase for SIL and SIL-SA callbacks when each edit is mad...
Definition: agt.h:1176
int32 agt_message_indent
–message-indent parameter
Definition: agt.h:1000
boolean agt_use_ccommit
enable confirmed-comiit
Definition: agt.h:1009
boolean agt_use_tcp_socket
use a TCP socket instead of an AF_LOCAL socket for connections
Definition: agt.h:1125
boolean agt_with_yumaworks_config_change
with-yumaworks-config-change
Definition: agt.h:1486
boolean agt_useurl_ftp
–with-url-ftp
Definition: agt.h:1379
boolean agt_with_yp_shell
enable yp-shell sessions
Definition: agt.h:1221
ncx_name_match_t agt_match_names
match names behavior; needs to be EXACT for YANG
Definition: agt.h:930
boolean agt_tls_deprecated_ok
YPW-1984: TLS Deprecated OK.
Definition: agt.h:1612
boolean agt_sil_test_get_when
enable config=false when-stmt checking for GET1 and GET2 callback functions; if false then the callba...
Definition: agt.h:1465
boolean agt_with_error_number
enable the <error-number) element added to error info some NC clients do not implement the error-info...
Definition: agt.h:1648
boolean agt_use_yuma_if
load yuma-if module
Definition: agt.h:1081
boolean agt_with_yp_coap
enable YP-CoAP sessions (not supported)
Definition: agt.h:1224
boolean agt_autodelete_pdu_error
If 'true' the server will treat edit-config auto-delete because of false when-stmts as an error inste...
Definition: agt.h:1186
uint16 agt_socket_port
listen on this TCP port if TCP socket is enabled
Definition: agt.h:1692
boolean agt_return_status
return exit code or zero
Definition: agt.h:1537
boolean agt_use_yuma_arp
load yuma-arp module
Definition: agt.h:1078
uint32 agt_linesize
line size for logging
Definition: agt.h:994
boolean agt_useurl
–with-url parameter
Definition: agt.h:1006
ncx_yang_sid_mode_t agt_yang_sid_mode
yang-sid-mode parameter
Definition: agt.h:1606
boolean agt_sil_wait_sa
No CLI parameter!! Set to TRUE in agt_profile.c the load-config will wait if agt_ncx_load_any_waiting...
Definition: agt.h:1452
boolean agt_wait_datastore_ready
wait-datastore-ready parameter
Definition: agt.h:1534
boolean agt_sil_skip_load
skip the SIL callbacks for load-config Useful if the authoritative database is really the external sy...
Definition: agt.h:1107
const xmlChar * agt_netconf_tls_certificate
–netconf-tls-cerificate parameter
Definition: agt.h:1391
boolean agt_fileloc_fhs
this flag enables FHS file locations for server data files
Definition: agt.h:1349
uint16 agt_max_sessions
max sessions (total)
Definition: agt.h:1045
const xmlChar * agt_extern_libspec
superuser name (allowed to be NULL) moved to agt.c agt_superuserQ Q of ncx_backptr_t to malloced stri...
Definition: agt.h:963
boolean agt_with_yang11_hello
this field indicates whether the NETCONF hello message should conform to the standard and leave out Y...
Definition: agt.h:1300
boolean agt_load_rootcheck_errors
server load-config root-check had errors flag
Definition: agt.h:1665
uint8 agt_withdef_enabled
bitmask of the with-defaults enumerations that should be enabled in the server
Definition: agt.h:1157
uint16 agt_snmp_subagent_priority
identify the SNMP subagent priority, what priority will be used for OID callbacks registration
Definition: agt.h:1375
boolean agt_save_owners
flag to save owner strings in the database
Definition: agt.h:1135
boolean agt_with_yumaworks_callhome
with-yumaworks-callhome
Definition: agt.h:1483
const xmlChar * agt_yangapi_server_url
YANG-API server URL (obsolete)
Definition: agt.h:1069
boolean agt_restconf_strict_headers
If 'true' the server will only accept requests with normative Accept header entries specified in the ...
Definition: agt.h:1181
const xmlChar * agt_conffile
config file: default: /etc/yumapro/netconfd-pro.conf
Definition: agt.h:939
const xmlChar * agt_user_parm
back-pointer to the user-parm string if any
Definition: agt.h:1651
boolean agt_load_validate_errors
server load-config had errors flag
Definition: agt.h:1662
boolean agt_with_yang_patch_running
with-yang-patch-running parameter
Definition: agt.h:1510
boolean agt_with_config_id
this field indicates if the :config-id capability is enabled or not.
Definition: agt.h:1283
agt_crl_mode_t agt_crl_mode
tls-crl-mode parameter
Definition: agt.h:1492
boolean agt_use_local_transport
use local transport flag
Definition: agt.h:1024
boolean agt_ypserver_mode
this flag indicates the server is rnning as yp-controller and not netconfd-pro
Definition: agt.h:1434
boolean agt_sil_invoke_for_defaults
–sil-invoke-for-defaults parameter
Definition: agt.h:1426
boolean agt_create_empty_npcontainers_ro
special flag for create NP containers if read-only child nodes
Definition: agt.h:1264
boolean agt_use_rollback_on_error
Use rollback-on-error.
Definition: agt.h:1096
boolean agt_xmlorder
use strict XML order flag
Definition: agt.h:897
const xmlChar * agt_errmsg_lang
–errmsg-lang parameter
Definition: agt.h:1409
boolean agt_create_empty_npcontainers
LAST DATA SENT TO SUBSYSTEMS create empty NP containers d: true.
Definition: agt.h:1261
log_debug_t agt_audit_log_level
audit log level
Definition: agt.h:1236
boolean agt_system_sorted
enable system-sorted (obsolete: sorted by val_child algorithms)
Definition: agt.h:1030
ncx_withdefaults_t agt_defaultStyleEnum
default with-defaults enum
Definition: agt.h:1039
uint32 agt_watcher_interval
Specifies the number of seconds the YPWatcher process will sleep before checking if the netconfd-pro ...
Definition: agt.h:1163
boolean agt_library_mode
this field indicates the server is operating in library mode It will look for YANG modules but only l...
Definition: agt.h:1277
xmlChar * agt_subsys_info_file
location of subsys info file YPW-2080: Multi-Instance Mode This filespec will contain the SRID so it ...
Definition: agt.h:1132
obj_testflags_t agt_rootflags
root commit descendant test flags
Definition: agt.h:1656
uint16 agt_max_cli_sessions
max CLI sessions
Definition: agt.h:1048
boolean agt_delete_empty_npcontainers
delete empty config=true NP containers: d: false
Definition: agt.h:909
boolean agt_push_simop_enabled
push-simop-enabled parameter
Definition: agt.h:1528
boolean agt_validate_all
validate all flag
Definition: agt.h:876
boolean agt_with_nmda
with-nmda
Definition: agt.h:1498
boolean agt_load_def_startup_factory
server load-config factory flag
Definition: agt.h:1677
boolean agt_use_yuma_proc
load yuma-proc module
Definition: agt.h:1075
uint16 agt_callhome_retry_max
this field specifies the number of retry attempts the server should attempt to the callhome server be...
Definition: agt.h:1318
boolean agt_sil_root_check_first
–sil-root-check-first to do root check in edit-config before the SIL validate callbacks are invoked t...
Definition: agt.h:1446
boolean agt_simple_json_names
use simple JSON names instead of YANG JSON names
Definition: agt.h:1256
uint16 agt_max_lock_hold_time
YPW-2027 Enforce a max lock hold time if non-zero value.
Definition: agt.h:1631
boolean agt_with_netconf_tls
enable NETCONF over TLS sessions
Definition: agt.h:1230
const xmlChar * agt_netconf_tls_address
–netconf-tls-address parameter
Definition: agt.h:1388
const xmlChar * agt_server_root
assigned server root ID
Definition: agt.h:979
const xmlChar * agt_tls_cipherlist
–tls-cipherlist CLI parameter Use with extreme caution! Advanced libopenssl usage not supported passe...
Definition: agt.h:1592
boolean agt_use_ycontrol
enable YControl protocol
Definition: agt.h:1099
boolean agt_has_startup
has startup flag for –with-startup
Definition: agt.h:879
boolean agt_ha_sil_standby
call SIL code in standby mode
Definition: agt.h:1242
const xmlChar * agt_crypt_hash_prefix
specifies the string that will be pre-pended to the password before calling crypt_r to generate the h...
Definition: agt.h:1201
boolean agt_with_ocpattern
this flag enables/disables the special OpenConfig usage of the YANG pattern-statement.
Definition: agt.h:1346
boolean agt_use_rollback_failed_backup
save running config for a commit, in case the rollback fails
Definition: agt.h:1119
boolean agt_use_yuma_system
load yuma-system module
Definition: agt.h:1090
boolean agt_audit_log_candidate
If true, then transactions to the candidate datastore will be recorded in the audit log.
Definition: agt.h:1170
uint16 agt_push_min_dampening
push-min-dampening parameter
Definition: agt.h:1516
boolean agt_trim_whitespace
–trim-whitespace CLI parameter
Definition: agt.h:1385
uint32 agt_maxburst
–maxburst parameter
Definition: agt.h:985
uint32 agt_push_max_periodic
push-max-periodic parameter
Definition: agt.h:1519
boolean agt_with_callhome
this field indicates that the IETF Callhome feature is enabled if true and WITH_CALLHOME is built int...
Definition: agt.h:1307
boolean agt_yumaworks_ids
use the yumaworks-ids module
Definition: agt.h:1474
boolean agt_stream_output
stream message output: d:true; no CLI support yet
Definition: agt.h:906
const xmlChar * agt_ha_initial_active
active server to use if standby
Definition: agt.h:1251
const xmlChar * agt_cert_default_user
–cert-default-user parameter
Definition: agt.h:1406
boolean agt_ha_enabled
enable YP-HA
Definition: agt.h:1239
agt_ha_role_t agt_ha_role
saved HA role
Definition: agt.h:1699
boolean agt_yuma_time_filter
use the yuma-time-filter module
Definition: agt.h:1468
const xmlChar * agt_sshd_config
set the sshd_config file to use for sshd exectuable for callhome default is $HOME/....
Definition: agt.h:1338
boolean agt_with_sm
this flag indicates that the Schema Mount support should be enabled
Definition: agt.h:1545
boolean agt_use_netconf
enable NETCONF protocol
Definition: agt.h:1021
boolean agt_callhome_reconnect
CLI parameter –callhome-reconnect.
Definition: agt.h:1458
uint16 agt_ha_port
port number is default 8088
Definition: agt.h:1245
boolean agt_with_yumaworks_lock
enable the <lock-all> and <unlock-all> operations
Definition: agt.h:1640
boolean agt_use_notifications
enable notifications
Definition: agt.h:1027
boolean agt_yuma_system_notifs
d: false
Definition: agt.h:912
boolean agt_with_netconf
If 'true' then the corresponding protocol will be enabled.
Definition: agt.h:1212
agt_acm_model_t agt_acm_model
NACM or external ACM model.
Definition: agt.h:1036
ncx_agttarg_t agt_targ
BEGIN DATA SENT TO SUBSYSTEMS; target type (candidate or running)
Definition: agt.h:852
boolean agt_xpath_dblslash_ok
YPW-1981: XPath Dblslash OK.
Definition: agt.h:1609
boolean agt_use_db_lock
db-lock used only if WITH_YCONTROL=1 and CLI set
Definition: agt.h:1477
boolean agt_insecure_ok
–insecure-ok parameter
Definition: agt.h:1403
const xmlChar * agt_subsys_path
set the netconf subsystem for sshd exectuable path for callhome default is /usr/sbin/netconf-subsyste...
Definition: agt.h:1332
boolean agt_support_save
d: true (needs WITH_SUPPORT_SAVE=1)
Definition: agt.h:918
boolean agt_defer_load
saved defer load config flag
Definition: agt.h:1702
boolean agt_running_error
–running-error parameter: stop, continue enums only
Definition: agt.h:891
agt_transaction_model_t agt_transaction_model
TBD private transaction model.
Definition: agt.h:933
uint16 agt_coap_dtls_port
Coap over DTLS port (not implemented)
Definition: agt.h:1063
boolean agt_cvt_subtree_filter
convert-subtree-filterparameter
Definition: agt.h:1504
const xmlChar * agt_netconf_tls_key
–netconf-tls-key parameter
Definition: agt.h:1394
boolean agt_with_yang_api
enable YANG-API sessions (obsolete)
Definition: agt.h:1218
const xmlChar * agt_sm_config
set the Schema Mount configuration file.
Definition: agt.h:1554
boolean agt_startup_fallback
this flag indicates the –startup-error parm is set to fallback
Definition: agt.h:1358
boolean agt_term_msg
d: true for <term-msg> notification
Definition: agt.h:921
const xmlChar * agt_sshd_path
set the sshd exectuable path for callhome default is /usr/sbin/sshd only set by vendor in agt_init1 p...
Definition: agt.h:1326
boolean agt_sil_cc_callback_all
YPW-2042 Apply Commit Completeness Callbacks to All Edit Transactions instead of just the <commit> op...
Definition: agt.h:1637
boolean agt_yumaworks_getbulk
use the yumaworks-getbulk module
Definition: agt.h:1471
boolean agt_yumaworks_system
d: true
Definition: agt.h:914
boolean agt_json_leaf_list_1line
flag to print JSON leaf-list value on 1 line
Definition: agt.h:1138
boolean agt_with_snmp
this flag indicates that the snmp agent should be enabled
Definition: agt.h:1367
boolean agt_logappend
–log-append parameter
Definition: agt.h:894
boolean agt_load_done
server load-config done flag
Definition: agt.h:1659
boolean agt_load_top_rootcheck_errors
server load-config had top root-check errors flag
Definition: agt.h:1668
xmlChar * agt_startup_txid_file
cached location of startup transaction ID file
Definition: agt.h:1686
boolean agt_with_yumaworks_event_stream
with-yumaworks-event-stream
Definition: agt.h:1489
dlq_hdr_t agt_savedevQ
Q of malloced ncx_save_deviations_t.
Definition: agt.h:1680
ncx_snmp_agt_role_t agt_snmp_agent_role
identify the SNMP agent native mode master|subagent
Definition: agt.h:1370
log_debug_t agt_syslog_log_level
requested SYSLOG log-level
Definition: agt.h:861
boolean agt_factorystartup
track –factory-startup flag
Definition: agt.h:885
boolean agt_log_acm_writes
log NACM write requests
Definition: agt.h:873
boolean agt_use_yangapi
enable YANG-API protocol (obsolete: ignored)
Definition: agt.h:1012
const xmlChar * agt_startup_factory_file
factory startup filespec
Definition: agt.h:951
const xmlChar * agt_netconf_tls_trust_store
–netconf-tls-trust-store parameter
Definition: agt.h:1400
boolean agt_leaflist_deleteall_ok
allow delete-all and remove-all operations on a leaf-list
Definition: agt.h:903
uint16 agt_coap_port
the CoAP port number used only if WITH_COAP and agt_use_coap set
Definition: agt.h:1060
const xmlChar * agt_ha_server_key
server-key to keep HA pools separate
Definition: agt.h:1248
boolean agt_use_yumaworks_sm_yanglib
load yumaworks-sm-yanglib module ignred unless agt_with_sm and agt_sm_config both set
Definition: agt.h:1565
boolean agt_with_canonical
–with-canonical parameter
Definition: agt.h:1420
dlq_hdr_t agt_commit_testQ
Q of malloced agt_commit_test_t.
Definition: agt.h:1683
const xmlChar * agt_confdir
config dir: default: /etc/yumapro/netconfd-pro.d
Definition: agt.h:942
boolean agt_with_restconf
enable RESTCONF sessions
Definition: agt.h:1215
boolean agt_silcall_delete_first
YPW-1975: SILCALL delete first.
Definition: agt.h:1595
uint16 agt_subsys_timeout
subsystem timeout in seconds
Definition: agt.h:1054
boolean agt_with_modtags
–with-modtags parameter
Definition: agt.h:1423
boolean agt_highres_event_time
–highres-event-time parameter Affects the <eventTime> leaf in all notifications
Definition: agt.h:1600
boolean agt_ietf_system_notifs
d: true
Definition: agt.h:913
uint32 agt_audit_log_events
–audit-log-events to control audit log content
Definition: agt.h:1440
boolean agt_sil_skip_keys
do not invoke the SIL callback for a key leaf
Definition: agt.h:1116
boolean agt_use_yuma_mysession
load yuma-mysession module
Definition: agt.h:1084
boolean agt_load_apply_errors
server load-config had apply phase errors flag
Definition: agt.h:1671
boolean agt_sil_prio_reverse_for_deletes
–sil-prio-reverse-for-deletes parameter
Definition: agt.h:1437
boolean agt_load_factory_fallback
server load-config allowed to use factory-fallback flag
Definition: agt.h:1674
int32 agt_max_strlen
max-strlen parameter
Definition: agt.h:1480
boolean agt_alt_names
Yuma REST-API urlselect extra parameters.
Definition: agt.h:924
uint8 agt_min_passwd_len
minimum password length when setting crypt-hash variables
Definition: agt.h:1204
boolean agt_with_grpc
this flag indicates that the gRPC support should be enabled
Definition: agt.h:1540
boolean agt_use_yumaworks_event_filter
load yumaworks-event-filter module
Definition: agt.h:1087
boolean agt_useurl_tftp
the libcurl variables
Definition: agt.h:1378
boolean agt_use_cli
enable yp-shell
Definition: agt.h:1018
boolean agt_startup_prune_ok
–startup-prune-ok parameter
Definition: agt.h:1412
boolean agt_save_config_system
flag to skip generation of the startup XML file when a save_config is done by the server.
Definition: agt.h:1146
log_debug_t agt_pthread_log_level
requested PTHREADS log level
Definition: agt.h:864
boolean agt_import_version_bestmatch
import-version-bestmatch parameter
Definition: agt.h:1507
uint32 agt_idle_timeout
–idle-timeout parameter
Definition: agt.h:991
uint32 agt_eventlog_size
eventlog-size set to 0 to disable replay
Definition: agt.h:982
boolean agt_log_event_drops
log event drops
Definition: agt.h:1110
boolean agt_usevalidate
–with-validate parameter
Definition: agt.h:1003
boolean agt_with_gnmi
this flag indicates that the gNMI support should be enabled
Definition: agt.h:1429
boolean agt_remove_schema_aug_leafs
this flag indicates the deprecated schema list leafs added from yumaworks-system should be removed.
Definition: agt.h:1578
boolean agt_with_maint_mode
allow maintenance mode to be used
Definition: agt.h:1455
agt_acmode_t agt_accesscontrol_enum
access control enum
Definition: agt.h:1042
boolean agt_use_yumaworks_cert_usermap
load yumaworks-cert-usermap module
Definition: agt.h:1568
boolean agt_log_acm_reads
log NACM read requests
Definition: agt.h:870
boolean agt_push_simop_patch_update
push-simop-patch-update parameter
Definition: agt.h:1531
const xmlChar * agt_defaultStyle
default-style for with-defaults
Definition: agt.h:954
boolean agt_usestartup
track –no-startup flag
Definition: agt.h:882
boolean agt_with_warnings
this field indicates if agt_record_warning will be allowed to set the error-severity field to warning
Definition: agt.h:1271
boolean agt_startup_skip_validation
startup-skip-validation
Definition: agt.h:1501
boolean agt_startup_error
–startup-error parameter: stop, continue enums only
Definition: agt.h:888
boolean agt_no_audit_log
this flag indicates the –no-audit-log CLI parameter
Definition: agt.h:1352
boolean agt_running_fallback
this flag indicates the –running-error parm is set to fallback
Definition: agt.h:1361
uint16 agt_callhome_retry_interval
this field specifies the number of seconds to wait after a connect attempt to the callhome server has...
Definition: agt.h:1312
uint16 agt_max_user_sessions
max USER sessions
Definition: agt.h:1051
uint16 agt_netconf_tls_port
–netconf-tls-port parameter
Definition: agt.h:1397
const xmlChar * agt_server_id
assigned server ID NcxName (1 .
Definition: agt.h:971
xmlChar * agt_socket_address
strdup of socket-address CLI parameter
Definition: agt.h:1689
int32 agt_indent
–indent parameter
Definition: agt.h:997
boolean agt_sil_delete_children_first
–sil-delete-children-first CLI parameter
Definition: agt.h:1382
log_debug_t agt_audit_log_console_level
log console level
Definition: agt.h:1233
boolean agt_startup_create_ok
no CLI parameter!! set to TRUE! change in yp-system library or agt_profile.c
Definition: agt.h:1417
const xmlChar * agt_restconf_server_url
RESTCONF server URL.
Definition: agt.h:1072
ncx_agtstart_t agt_start
startup type enum (distinct or mirror)
Definition: agt.h:855
uint32 agt_push_simop_period
push-simop-period parameter
Definition: agt.h:1525
const xmlChar * agt_logfile
main logfile
Definition: agt.h:945
uint32 agt_sil_getbulk_max
Specifies the maximum number of getbulk entries to request from a GET2 callback.
Definition: agt.h:1195
uint32 agt_push_max_operational
push-max-operational parameter
Definition: agt.h:1522
boolean agt_lax_namespaces
lax namespace usage: will try to match element name
Definition: agt.h:1033
uint32 agt_hello_timeout
–hello-timeout parameter
Definition: agt.h:988
boolean agt_crl_missing_ok
tls-crl-missing-ok parameter
Definition: agt.h:1495
uint16 agt_push_min_period
push-min-period parameter
Definition: agt.h:1513
boolean agt_wildcards
Allow wildcards in filters.
Definition: agt.h:927
log_debug_t agt_log_level
requested log-level
Definition: agt.h:858
xmlChar * agt_conf_dirspec
malloced string indicating the confdir pathspec in use
Definition: agt.h:1695
boolean agt_list_deleteall_ok
allow delete-all and remove-all operations on a list
Definition: agt.h:900
const xmlChar * agt_coap_address
Coap over DTLS address (not implemented)
Definition: agt.h:1066
boolean agt_tls_debug
–tls-debug CLI parameter this flag indicates that extra TLS debugging should be enabled in the server
Definition: agt.h:1584
boolean agt_with_yang_cbor
with-yang-cbor parameter
Definition: agt.h:1603
boolean agt_tls_dh_enabled
YPW-1994: enable TLS DH parameters needed for TLS 1.3 there is no CLI parameter for this flag; defaul...
Definition: agt.h:1617
ncx_msg_encoding_t agt_restconf_default_encoding
this enum indicates the –restconf-default-encoding CLI parameter
Definition: agt.h:1355
const xmlChar * agt_accesscontrol
access control model
Definition: agt.h:936
boolean agt_sil_missing_error
treat missing SIL libraries as an error, not warning
Definition: agt.h:1113
boolean agt_yumaworks_templates
d: true
Definition: agt.h:915
boolean agt_no_nvstore
this field indicates that the server should not load or save using the normal APIs during transaction...
Definition: agt.h:1295
boolean agt_use_restconf
enable RESTCONF protocol
Definition: agt.h:1015
ncx_msg_encoding_t agt_sm_config_encoding
this flag indicates what parser engine to use to parse the SM Config file.
Definition: agt.h:1559
boolean agt_session_sync_mutex
session sync mutex flag
Definition: agt.h:867
boolean agt_notif_sequence_id
d: false
Definition: agt.h:911
for the list of subsystems requesting or in progress for a config load or replay
Definition: agt.h:797
dlq_hdr_t qhdr
queue header
Definition: agt.h:798
xmlChar * subsys_id
malloced subsystem name string
Definition: agt.h:799
struct to keep track of the dynamic external yp-system hooks library
Definition: agt.h:1809
agt_system_init1_fn_t init1_fn
init1 callback
Definition: agt.h:1823
status_t init1_status
init1 callback result
Definition: agt.h:1832
boolean cleanup_done
cleanup done flag
Definition: agt.h:1838
dlq_hdr_t qhdr
queue header
Definition: agt.h:1811
xmlChar * libspec
yp-system library spec that was loaded (bundle or module)
Definition: agt.h:1817
agt_system_init_profile_fn_t init_profile_fn
init profile callback
Definition: agt.h:1820
void * handle
handle from dlopen
Definition: agt.h:1814
status_t init2_status
init2 callback result
Definition: agt.h:1835
agt_system_cleanup_fn_t cleanup_fn
cleanup callback
Definition: agt.h:1829
agt_system_init2_fn_t init2_fn
init2 callback
Definition: agt.h:1826
server module info cache record for def_reg_add_mod
Definition: ncxtypes.h:1601
representation of one module or submodule during and after parsing
Definition: ncxtypes.h:1125
One YANG Patch Request.
Definition: yang_patch.h:155