agt.h

Go to the documentation of this file.

/*
 * Copyright (c) 2008 - 2012, Andy Bierman, All Rights Reserved.
 * Copyright (c) 2012 - 2025, YumaWorks, Inc., All Rights Reserved.
 *
 * 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.
 */
#ifndef _H_agt
#define _H_agt
 
/*  FILE: agt.h
*********************************************************************
*                                                                   *
*                        P U R P O S E                              *
*                                                                   *
*********************************************************************/
 
/*********************************************************************
*                                                                   *
*                  C H A N G E   H I S T O R Y                      *
*                                                                   *
*********************************************************************
 
date         init     comment
----------------------------------------------------------------------
04-nov-05    abb      Begun
02-aug-08    abb      Convert from NCX typdef to YANG object design
03-oct-08    abb      Convert to YANG only, remove app, parmset,
                      and parm layers in the NETCONF database
*/
 
#ifndef _H_agt_not
#include "agt_not.h"
#endif
 
#ifndef _H_help
#include "help.h"
#endif
 
#ifndef _H_log
#include "log.h"
#endif
 
#ifndef _H_ncxtypes
#include "ncxtypes.h"
#endif
 
#ifndef _H_status
#include "status.h"
#endif
 
#ifdef __cplusplus
extern "C" {
#endif
 
 
/* define a top-level header here here */
 
 
/* header field defined here, used in rest of library */
 
/********************************************************************
*                                                                   *
*                        C O N S T A N T S                          *
*                                                                   *
*********************************************************************/
 
#define AGT_NUM_CB   (AGT_CB_ROLLBACK+1)
 
#define AGT_MAX_PORTS  4
 
#define AGT_DEF_SUBSYS_TIMEOUT  30
 
#define AGT_DEF_CONF_FILE   \
    (const xmlChar *)"/etc/yumapro/netconfd-pro.conf"
 
#define AGT_DEF_FACTORY_CONFIG_FILE  \
    (const xmlChar *)"factory-startup-cfg.xml"
 
#define AGT_DEF_CONF_DIR    (const xmlChar *)"/etc/yumapro/netconfd-pro.d"
 
#define AGT_DEF_FHS_LOG_FILE \
    (const xmlChar *)"/var/log/netconfd-pro/server.log"
 
#define AGT_DEF_SYSLIB_FILE (const xmlChar *)"libyp_system.so"
 
#define AGT_SYSLIB_NAME     (const xmlChar *)"yp_system"
 
#define AGT_DEF_BACKUP_DIR  (const xmlChar *)"$HOME/.yumapro/backups"
 
#define AGT_DEF_BACKUPS_NAME  (const xmlChar *)"backups"
 
#define AGT_DEF_FHS_BACKUP_DIR \
    (const xmlChar *)"/var/lib/netconfd-pro/backups"
 
#define AGT_SRID_FHS_BACKUP_DIR \
    (const xmlChar *)"/var/lib/netconfd-pro/%s/backups"
 
#define AGT_DEF_DELETE_EMPTY_NP    FALSE
 
#define AGT_DEF_SYSTEM_SORTED      FALSE
 
#define AGT_DEF_LAX_NAMESPACES     TRUE
 
#define AGT_DEF_EVENTLOG_SIZE      1000
 
#define AGT_DEF_MAX_BURST          10
 
#define AGT_DEF_HELLO_TIMEOUT      300
 
#define AGT_DEF_IDLE_TIMEOUT       3600
 
#define AGT_DEF_LINESIZE           72
 
#define AGT_DEF_INDENT             1
 
#define AGT_DEF_MESSAGE_INDENT     (-1)
 
#define AGT_DEF_MAX_SESSIONS       8
 
#define AGT_DEF_MAX_CLI_SESSIONS   0
 
#define AGT_DEF_MAX_USER_SESSIONS   0
 
#define AGT_MAX_USERNAME_LEN   1024
 
#define AGT_MAX_PER_USER_SESSIONS   1024
 
 
#define AGT_DEF_YANGAPI_SERVER_URL (const xmlChar *)"http://localhost"
 
#define AGT_DEF_RESTCONF_SERVER_URL (const xmlChar *)"http://localhost"
 
#define AGT_DEF_SAVE_OWNERS        FALSE
 
#define AGT_DEF_JSON_LEAF_LIST_1LINE  FALSE
 
#define AGT_DEF_SAVE_CONFIG_SYSTEM FALSE
 
#define AGT_DEF_WITH_CONFIG_ID     TRUE
 
#define AGT_DEF_WITH_FSYNC         FALSE
 
#define AGT_DEF_WITH_OCPATTERN     FALSE
 
#define AGT_DEF_NO_NVSTORE         FALSE
 
#define AGT_DEF_WITH_CALLHOME      FALSE
 
#define AGT_DEF_WITH_SCHEMA_MOUNT  TRUE
 
#define AGT_DEF_CALLHOME_RETRY_INT 60
 
#define AGT_DEF_CALLHOME_RETRY_MAX 10
 
#define AGT_DEF_CALLHOME_PORT      NCX_DEF_SSH_CALLHOME
 
#define AGT_DEF_CALLHOME_TLS_PORT  NCX_DEF_TLS_CALLHOME
 
#define AGT_DEF_CALLHOME_RESTCONF_TLS_PORT  NCX_DEF_RESTCONF_TLS_CALLHOME
 
#define AGT_YUMAWORKS_CALLHOME_MODULE   (const xmlChar *)"yumaworks-callhome"
 
#define AGT_YUMAWORKS_CALLHOME_REVISION (const xmlChar *)"2020-10-17"
#define AGT_DEF_FILELOC_FHS        FALSE
 
#define AGT_DEF_NO_AUDIT_LOG       FALSE
 
#define AGT_DEF_CRYPT_HASH_PREFIX (const xmlChar *)"$6$"
 
#define AGT_DEF_MIN_PASSWD_LEN      8
 
#define AGT_DEF_HA_ENABLED          FALSE
 
#define AGT_DEF_HA_SIL_STANDBY      FALSE
 
#define AGT_DEF_HA_PORT             8088
 
#define AGT_DEF_HA_STANDBY_MODE AGT_HA_MODE_HOT_STANDBY
 
#define AGT_DEF_YPCOAP_PORT         5683
 
#define AGT_DEF_YPCOAP_DTLS_PORT    5684
 
#define AGT_DEF_YPCOAP_ADDRESS (const xmlChar *)"0.0.0.0"
 
#define AGT_DEF_RESTCONF_DEFAULT_ENCODING NCX_MSG_ENCODING_JSON
 
#define AGT_DEF_TLS_PORT            6513
 
#define AGT_DEF_DB_LOCK_RETRY      500   // mSec
 
#define AGT_DEF_DB_LOCK_TIMEOUT    20   // Sec
 
#define AGT_DEF_WITH_YUMAWORKS_CONFIG_CHANGE FALSE
 
#define AGT_DEF_WITH_YUMAWORKS_CALLHOME TRUE
 
#define AGT_DEF_WITH_YUMAWORKS_EVENT_STREAM TRUE
 
#define AGT_DEF_WITH_NMDA    FALSE
 
#define AGT_DEF_STARTUP_SKIP_VALIDATION    FALSE
 
#define AGT_DEF_RETURN_STATUS   FALSE
 
#define AGT_DEF_WAIT_DATASTORE_READY  FALSE
 
#define AGT_DEF_YANG_SID_MODE NCX_YANG_SID_MODE_SID_FILE
 
#define AGT_DEF_WITH_YANG_CBOR   FALSE
 
#define AGT_DEF_SILCALL_DELETE_FIRST TRUE
 
#define AGT_DEF_XPATH_DBLSLASH_OK   FALSE
 
#define AGT_DEF_SIL_CC_CALLBACK_ALL    FALSE
 
#define AGT_DEF_DISABLED_PROTOCOLS EMPTY_STRING
 
#define AGT_SELECT_TIMEOUT_SEC      0
 
#define AGT_SELECT_TIMEOUT_USEC     10000
 
#define AGT_USER_VAR        (const xmlChar *)"user"
 
#define AGT_URL_SCHEME_LIST (const xmlChar *)"file"
 
#define AGT_URL_SCHEME_LIST_TFTP (const xmlChar *)"file,tftp"
 
#define AGT_FILE_SCHEME     (const xmlChar *)"file:///"
 
#define AGT_TOASTER_MOD     (const xmlChar *)"toaster"
 
#define AGT_TEST_MOD        (const xmlChar *)"test"
 
#define AGT_SIL_SA          (const xmlChar *)"sil-sa"
 
#define AGT_DB_API          (const xmlChar *)"db-api"
 
#define AGT_YP_HA           (const xmlChar *)"yp-ha"
 
#define AGT_YP_GNMI          (const xmlChar *)"yp-gnmi"
 
#define AGT_YP_GRPC          (const xmlChar *)"yp-grpc"
 
#define AGT_YCONTROL_MOD    (const xmlChar *)"yumaworks-ycontrol"
 
#define AGT_DB_API_MOD      (const xmlChar *)"yumaworks-db-api"
 
#define AGT_SIL_SA_MOD      (const xmlChar *)"yumaworks-sil-sa"
 
#define AGT_PROFILE_MOD     (const xmlChar *)"yumaworks-agt-profile"
 
#define AGT_ACTION_MOD      (const xmlChar *)"yang-attributes"
 
#define AGT_YP_HA_MOD       (const xmlChar *)"yumaworks-yp-ha"
 
#define AGT_TEMPLATES_MOD   (const xmlChar *)"yumaworks-templates"
 
#define AGT_LOCK_MOD   (const xmlChar *)"yumaworks-lock"
 
#define AGT_YP_GNMI_MOD      (const xmlChar *)"yumaworks-yp-gnmi"
 
#define AGT_YP_GRPC_MOD      (const xmlChar *)"yumaworks-yp-grpc"
 
#define AGT_YP_SCHEMA_MOUNT_MOD (const xmlChar *)"yumaworks-schema-mount"
 
#define AGT_YP_SM_YANGLIB_MOD (const xmlChar *)"yumaworks-sm-yanglib"
 
#define AGT_DEF_SERVER_ID   (const xmlChar *)"server1"
 
#define AGT_WITHDEF_MOD     (const xmlChar *)"ietf-netconf-with-defaults"
 
 
#define AGT_TEST_FL_MIN_ELEMS  bit0
 
#define AGT_TEST_FL_MAX_ELEMS  bit1
 
#define AGT_TEST_FL_MANDATORY  bit2
 
#define AGT_TEST_FL_MUST       bit3
 
#define AGT_TEST_FL_UNIQUE     bit4
 
#define AGT_TEST_FL_XPATH_TYPE bit5
 
#define AGT_TEST_FL_CHOICE     bit6
 
#define AGT_TEST_FL_WHEN       bit7
 
#define AGT_TEST_ALL_COMMIT_MASK (bit0|bit1|bit2|bit3|bit4|bit5|bit6)
 
#define AGT_TEST_INSTANCE_MASK (bit0|bit1|bit2|bit4|bit6)
 
#define AGT_CLI_NOSTARTUP   (const xmlChar *)"no-startup"
 
#define AGT_CLI_STARTUP     (const xmlChar *)"startup"
 
#define AGT_CLI_FACTORY_STARTUP   (const xmlChar *)"factory-startup"
 
#define AGT_CLI_STARTUP_FACTORY_FILE  (const xmlChar *)"startup-factory-file"
 
#define AGT_EVAL_REQUEST_LIMIT      500
 
#define AGT_MAX_OWNER_ID            255
 
#define AGT_WATCHER          (const xmlChar *)"ypwatcher"
 
#define AGT_DEF_WAT_INTERVAL        10
 
#define AGT_DEF_SSHD_COMMAND (const xmlChar *)"/usr/sbin/sshd"
 
#define AGT_DEF_SUBSYS_COMMAND \
    (const xmlChar *)"/usr/sbin/netconf-subsystem-pro"
 
#define AGT_DEF_SNMP_SUBAGENT_PRIO  127
 
/* flags for the agt_auditlog_events mask from
 * --audit-log-events CLI parameter.
 * edit-candidate events are generated when an edit
*  to <candidate> is completed.
 */
#define AGT_FL_AUDIT_EDIT_CANDIDATE        bit0
 
#define AGT_FL_AUDIT_EDIT_RUNNING          bit1
 
#define AGT_FL_AUDIT_UPDATE_STARTUP        bit2
 
#define AGT_FL_AUDIT_CLIENT_SESSION        bit3
 
#define AGT_FL_AUDIT_CONTROL_SESSION       bit4
 
#define AGT_FL_AUDIT_NACM_WRITE_ERROR      bit5
 
#define AGT_FL_AUDIT_NACM_EXEC_ERROR       bit6
 
#define AGT_FL_AUDIT_RPC_SUMMARY           bit7
 
#define AGT_FL_AUDIT_EDIT_DATA             bit8
 
#define AGT_FL_AUDIT_RPC_ERROR             bit9
 
#define AGT_FL_AUDIT_RPC_REQUEST           bit10
 
 
 
#define AGT_DEF_AUDIT_EVENTS  AGT_FL_AUDIT_EDIT_RUNNING
 
#define AGT_DEF_CRL_MISSING_OK   false
 
#define AGT_DEF_CRL_MODE  AGT_CRL_MODE_OFF
 
#define AGT_DEF_CVT_SUBTREE_FILTER false
 
#define AGT_DEF_PUSH_MIN_PERIOD 100
 
#define AGT_DEF_PUSH_MIN_DAMPENING 100
 
#define AGT_DEF_PUSH_MAX_PERIODIC 16
 
#define AGT_DEF_PUSH_MAX_OPERATIONAL 4
 
#define AGT_DEF_PUSH_SIMOP_ENABLED true
 
#define AGT_DEF_PUSH_SIMOP_PERIOD 500
 
#define AGT_DEF_PUSH_SIMOP_PATCH_UPDATE true
 
#define AGT_NON_NMDA_YANGLIB_REV (const xmlChar *)"2016-06-21"
 
#define AGT_NMDA_YANGLIB_REV (const xmlChar *)"2019-01-04"
 
#define AGT_SIL_SA_MODULE (const xmlChar *)"yumaworks-sil-sa"
 
#define AGT_DEF_TLS_DEPRECATED_OK false
 
#define AGT_DEF_TLS_DH_ENABLED true
 
#define AGT_DEF_CLIENT_USERNAME (const xmlChar *)"admin"
 
#define AGT_DEF_SAVE_CONFIG_TEMPNAME true
 
#define AGT_SAVE_CONFIG_TEMPNAME_EXT (const xmlChar *)".temp"
 
#define AGT_DEF_RETURN_EMPTY_NPCONTAINERS  TRUE
 
#define AGT_DEF_MAX_DBLSLASH_MATCHES  25
 
 
#define AGT_DEF_MAX_NODES_PER_UPDATE     10000
 
#define AGT_DEF_AUTO_DISCARD_ON_LOCK_TIMEOUT  TRUE
 
 
/********************************************************************
*                                                                   *
*                            T Y P E S                              *
*                                                                   *
*********************************************************************/
 
typedef enum agt_acmode_t_ {
    AGT_ACMOD_NONE,                 
    AGT_ACMOD_ENFORCING,            
    AGT_ACMOD_PERMISSIVE,           
    AGT_ACMOD_DISABLED,             
    AGT_ACMOD_OFF                   
} agt_acmode_t;
 
 
typedef enum agt_cbtyp_t_ {
    AGT_CB_VALIDATE,             
    AGT_CB_APPLY,                
    AGT_CB_COMMIT,               
    AGT_CB_ROLLBACK              
} agt_cbtyp_t;
 
 
typedef enum agt_acm_model_t_ {
    AGT_ACM_MODEL_NONE,         
    AGT_ACM_MODEL_IETF_NACM,    
    AGT_ACM_MODEL_YUMA_NACM,    
    AGT_ACM_MODEL_EXTERNAL      
} agt_acm_model_t;
 
 
typedef enum agt_transaction_model_t_ {
    AGT_TM_NONE,    
    AGT_TM_SHARED,  
    AGT_TM_PRIVATE  
} agt_transaction_model_t;
 
 
typedef enum agt_commit_type_t_ {
    AGT_COMMIT_TYPE_NONE,    
    AGT_COMMIT_TYPE_NORMAL,  
    AGT_COMMIT_TYPE_REPLAY   
} agt_commit_type_t;
 
 
typedef enum agt_exit_mode_t_ {
    AGT_EXIT_MODE_NONE,    
    AGT_EXIT_MODE_OK,      
    AGT_EXIT_MODE_ERROR,   
    AGT_EXIT_MODE_TIMEOUT, 
    AGT_EXIT_MODE_DROPPED  
} agt_exit_mode_t;
 
 
typedef enum agt_tx_type_t_ {
    AGT_TX_TYPE_NONE,    
    AGT_TX_TYPE_GET,     
    AGT_TX_TYPE_EDIT,    
    AGT_TX_TYPE_RPC,     
    AGT_TX_TYPE_HOOK     
} agt_tx_type_t;
 
 
typedef enum agt_ccparm_t_ {
    AGT_CCPARM_NONE,             
    AGT_CCPARM_CONFIRMED,        
    AGT_CCPARM_CONFIRM_TIMEOUT,  
    AGT_CCPARM_PERSIST,          
    AGT_CCPARM_PERSIST_ID        
} agt_ccparm_t;
 
 
typedef enum agt_ha_role_t_ {
    AGT_HA_ROLE_NONE,        
    AGT_HA_ROLE_NOT_SET,     
    AGT_HA_ROLE_STANDBY,     
    AGT_HA_ROLE_ACTIVE       
} agt_ha_role_t;
 
 
typedef enum agt_ch_proto_t_ {
    AGT_CH_PROTO_NONE,           
    AGT_CH_PROTO_NETCONF_SSH,    
    AGT_CH_PROTO_NETCONF_TLS,    
    AGT_CH_PROTO_RESTCONF_TLS    
} agt_ch_proto_t;
 
 
typedef enum agt_crl_mode_t_ {
    AGT_CRL_MODE_NONE,    
    AGT_CRL_MODE_OFF,     
    AGT_CRL_MODE_CLIENT,  
    AGT_CRL_MODE_CA,      
} agt_crl_mode_t;
 
 
typedef enum agt_hook_type_t_ {
    AGT_HOOK_TYPE_NONE,          
    AGT_HOOK_TYPE_SETHOOK,       
    AGT_HOOK_TYPE_TRANSACTION,   
    AGT_HOOK_TYPE_POST_SETHOOK   
} agt_hook_type_t;
 
 
typedef struct agt_replay_subsys_t_ {
    dlq_hdr_t  qhdr;        
    xmlChar   *subsys_id;   
} agt_replay_subsys_t;
 
 
typedef struct agt_maxuser_t_ {
    dlq_hdr_t  qhdr;        
    xmlChar   *username;   
    uint16     max_sessions; 
} agt_maxuser_t;
 
 
 
 
typedef struct agt_profile_t_ {
    ncx_agttarg_t       agt_targ;
 
    ncx_agtstart_t      agt_start;
 
    log_debug_t         agt_log_level;
 
    log_debug_t         agt_syslog_log_level;
 
    log_debug_t         agt_pthread_log_level;
 
    boolean             agt_session_sync_mutex;
 
    boolean             agt_log_acm_reads;
 
    boolean             agt_log_acm_writes;
 
    boolean             agt_validate_all;
 
    boolean             agt_has_startup;
 
    boolean             agt_usestartup;
 
    boolean             agt_factorystartup;
 
    boolean             agt_startup_error;  /* T: stop, F: check fallback */
 
    boolean             agt_running_error;  /* T: stop, F: check fallback */
 
    boolean             agt_logappend;
 
    boolean             agt_xmlorder;
 
    boolean             agt_list_deleteall_ok;
 
    boolean             agt_leaflist_deleteall_ok;
 
    boolean             agt_stream_output;
 
    boolean             agt_delete_empty_npcontainers;
 
    boolean             agt_notif_sequence_id;  
    boolean             agt_yuma_system_notifs;  
    boolean             agt_ietf_system_notifs;  
    boolean             agt_yumaworks_system;  
    boolean             agt_yumaworks_templates;  
    boolean             agt_support_save;
 
    boolean             agt_term_msg;
 
    boolean             agt_alt_names;
 
    boolean             agt_wildcards;
 
    ncx_name_match_t    agt_match_names;
 
    agt_transaction_model_t agt_transaction_model;
 
    const xmlChar      *agt_accesscontrol;
 
    const xmlChar      *agt_conffile;
 
    const xmlChar      *agt_confdir;
 
    const xmlChar      *agt_logfile;
 
    const xmlChar      *agt_startup;
 
    const xmlChar      *agt_startup_factory_file;
 
    const xmlChar      *agt_defaultStyle;
 
    //const xmlChar      *agt_superuser;
 
    const xmlChar      *agt_extern_libspec;
 
    const xmlChar      *agt_backup_dir;
 
    const xmlChar      *agt_server_id;
 
    const xmlChar      *agt_server_root;
 
    uint32              agt_eventlog_size;
 
    uint32              agt_maxburst;
 
    uint32              agt_hello_timeout;
 
    uint32              agt_idle_timeout;
 
    uint32              agt_linesize;
 
    int32               agt_indent;
 
    int32               agt_message_indent;
 
    boolean             agt_usevalidate;
 
    boolean             agt_useurl;
 
    boolean             agt_use_ccommit;
 
    boolean             agt_use_yangapi;
 
    boolean             agt_use_restconf;
 
    boolean             agt_use_cli;
 
    boolean             agt_use_netconf;
 
    boolean             agt_use_local_transport;
 
    boolean             agt_use_notifications;
 
    boolean             agt_system_sorted;
 
    boolean             agt_lax_namespaces;
 
    agt_acm_model_t     agt_acm_model;
 
    ncx_withdefaults_t  agt_defaultStyleEnum;
 
    agt_acmode_t        agt_accesscontrol_enum;
 
    uint16              agt_max_sessions;
 
    uint16              agt_max_cli_sessions;
 
    uint16              agt_max_user_sessions;
 
    uint16              agt_subsys_timeout;
 
    uint16              agt_ports[AGT_MAX_PORTS];
 
    uint16              agt_coap_port;
 
    uint16              agt_coap_dtls_port;
 
    const xmlChar      *agt_coap_address;
 
    const xmlChar      *agt_yangapi_server_url;
 
    const xmlChar      *agt_restconf_server_url;
 
    boolean             agt_use_yuma_proc;
 
    boolean             agt_use_yuma_arp;
 
    boolean             agt_use_yuma_if;
 
    boolean             agt_use_yuma_mysession;
 
    boolean             agt_use_yumaworks_event_filter;
 
    boolean             agt_use_yuma_system;
 
    boolean             agt_use_rollback_on_error;
 
    boolean             agt_use_ycontrol;
 
    boolean             agt_sil_skip_load;
 
    boolean             agt_log_event_drops;
 
    boolean             agt_sil_missing_error;
 
    boolean             agt_sil_skip_keys;
 
    boolean             agt_use_rollback_failed_backup;
 
    boolean             agt_allow_tcp_socket;
 
    boolean             agt_use_tcp_socket;
 
    xmlChar            *agt_subsys_info_file;
 
    boolean             agt_save_owners;
 
    boolean             agt_json_leaf_list_1line;
 
    boolean             agt_save_config_system;
 
    uint8               agt_withdef_enabled;
 
    uint32              agt_watcher_interval;
 
    boolean             agt_audit_log_candidate;
 
    boolean             agt_sil_validate_candidate;
 
    boolean             agt_restconf_strict_headers;
 
    boolean             agt_autodelete_pdu_error;
 
    uint32 agt_sil_getbulk_max;
 
    const xmlChar *agt_crypt_hash_prefix;
 
    uint8 agt_min_passwd_len;
 
    boolean             agt_with_netconf;
 
    boolean             agt_with_restconf;
 
    boolean             agt_with_yang_api;
 
    boolean             agt_with_yp_shell;
 
    boolean             agt_with_yp_coap;
 
    boolean             agt_with_yp_coap_dtls;
 
    boolean             agt_with_netconf_tls;
 
    boolean            agt_tls_common_auth;
 
    boolean            agt_tls_autosan_mode;
 
    log_debug_t         agt_audit_log_console_level;
 
    log_debug_t         agt_audit_log_level;
 
    boolean             agt_audit_log_localtime;
 
    boolean             agt_ha_enabled;
 
    boolean             agt_ha_sil_standby;
 
    uint16              agt_ha_port;
 
    const xmlChar      *agt_ha_server_key;
 
    const xmlChar      *agt_ha_initial_active;
 
    // leaf-list ha-server not stored here; not sent to subsys
 
    boolean             agt_simple_json_names;
 
    boolean             agt_create_empty_npcontainers;
 
    boolean             agt_create_empty_npcontainers_ro;
 
    /* TBD: add this data to subsystems in the near future */
 
    boolean             agt_with_warnings;
 
    boolean             agt_library_mode;
 
    boolean             agt_with_config_id;
 
    boolean             agt_no_nvstore;
 
    boolean             agt_with_yang11_hello;      /* d: false */
 
    boolean             agt_with_callhome;
 
    uint16              agt_callhome_retry_interval;
 
    uint16             agt_callhome_retry_max;
 
    /* the callhome-server parameter is handled by agt_callhome */
 
    const xmlChar     *agt_sshd_path;
 
    const xmlChar     *agt_subsys_path;
 
    const xmlChar     *agt_sshd_config;
 
 
    boolean             agt_with_ocpattern;
 
    boolean             agt_fileloc_fhs;
 
    boolean             agt_no_audit_log;
 
    ncx_msg_encoding_t  agt_restconf_default_encoding;
 
    boolean             agt_startup_fallback;  /* T: restart, F: continue */
 
    boolean             agt_running_fallback;  /* T: restart, F: continue */
 
 
    /* the SNMP agent parameters */
 
    boolean             agt_with_snmp;
 
    ncx_snmp_agt_role_t agt_snmp_agent_role;
 
    uint16              agt_snmp_subagent_priority;
 
    boolean             agt_useurl_tftp;           
    boolean             agt_useurl_ftp;            
    boolean             agt_sil_delete_children_first;
 
    boolean             agt_trim_whitespace;
 
    const xmlChar       *agt_netconf_tls_address;
 
    const xmlChar       *agt_netconf_tls_certificate;
 
    const xmlChar       *agt_netconf_tls_key;
 
    uint16              agt_netconf_tls_port;
 
    const xmlChar       *agt_netconf_tls_trust_store;
 
    boolean              agt_insecure_ok;
 
    const xmlChar        *agt_cert_default_user;
 
    const xmlChar       *agt_errmsg_lang;
 
    boolean              agt_startup_prune_ok;
 
    boolean              agt_startup_create_ok;
 
    boolean              agt_with_canonical;
 
    boolean              agt_with_modtags;
 
    boolean              agt_sil_invoke_false_when_deletes;
 
    boolean              agt_sil_invoke_for_defaults;
 
    boolean             agt_with_gnmi;
 
    boolean             agt_ypserver_mode;
 
    boolean              agt_sil_prio_reverse_for_deletes;
 
    uint32                 agt_audit_log_events;
 
    boolean             agt_sil_root_check_first;
 
    boolean              agt_sil_wait_sa;
 
    boolean              agt_with_maint_mode;
 
    boolean              agt_callhome_reconnect;
 
    boolean              agt_sil_test_get_when;
 
    boolean              agt_yuma_time_filter;
 
    boolean              agt_yumaworks_getbulk;
 
    boolean              agt_yumaworks_ids;
 
    boolean              agt_use_db_lock;
 
    int32                agt_max_strlen;
 
    boolean              agt_with_yumaworks_callhome;
 
    boolean              agt_with_yumaworks_config_change;
 
    boolean              agt_with_yumaworks_event_stream;
 
    agt_crl_mode_t       agt_crl_mode;
 
    boolean              agt_crl_missing_ok;
 
    boolean              agt_with_nmda;
 
    boolean              agt_startup_skip_validation;
 
    boolean              agt_cvt_subtree_filter;
 
    boolean              agt_import_version_bestmatch;
 
    boolean              agt_with_yang_patch_running;
 
    uint16              agt_push_min_period;   // centiseconds
 
    uint16              agt_push_min_dampening;  // centiseconds
 
    uint32              agt_push_max_periodic;  // count
 
    uint32              agt_push_max_operational;  // count
 
    uint32              agt_push_simop_period;
 
    boolean             agt_push_simop_enabled;
 
    boolean             agt_push_simop_patch_update;
 
    uint32             agt_max_nodes_per_update;
 
    boolean             agt_wait_datastore_ready;
 
    boolean             agt_return_status;
 
    boolean             agt_with_grpc;
 
    boolean             agt_with_sm;
 
    const xmlChar      *agt_sm_config;
 
    ncx_msg_encoding_t  agt_sm_config_encoding;
 
 
    boolean             agt_use_yumaworks_sm_yanglib;
 
    boolean             agt_use_yumaworks_cert_usermap;
 
    boolean            agt_remove_schema_aug_leafs;
 
    boolean            agt_tls_debug;
 
    const xmlChar     *agt_tls_cipherlist;
 
    boolean            agt_silcall_delete_first;
 
    boolean            agt_highres_event_time;
 
    boolean agt_with_yang_cbor;
 
    ncx_yang_sid_mode_t agt_yang_sid_mode;
 
    boolean            agt_xpath_dblslash_ok;
 
    boolean            agt_tls_deprecated_ok;
 
    boolean            agt_tls_dh_enabled;
 
    /* YPW-2000
     * Enable use of a temp file while saving config files such
     * as startup-cfg.xml or backup-cfg.xml
     * The file is renamed to the provided filespec after
     * it is written; If no rename because crash then restart will
     * not find real xml file; No CLI to disable
     */
    boolean           agt_save_config_tempname;
 
    uint16            agt_max_lock_hold_time;
 
    boolean           agt_sil_cc_callback_all;
 
    boolean           agt_with_yumaworks_lock;
 
    boolean           agt_with_error_number;
 
    const xmlChar    *agt_user_parm;
 
    boolean           agt_sil_autodelete;
 
    boolean           agt_return_empty_npcontainers;
 
    boolean          agt_save_load_events;
 
    boolean           agt_return_error_with_data;
 
    uint8            agt_max_dblslash_matches;
 
    boolean           agt_with_new_yanglib;
 
    boolean           agt_with_new_notifs;
 
    boolean           agt_with_ietf_caps;
 
    boolean           agt_disable_imported_ok;
 
    boolean           agt_sil_skip_global_edit_validate;
    boolean           agt_sil_skip_global_edit_apply;
 
 
    /****** state variables; TBD: move out of profile ******/
 
    obj_testflags_t     agt_rootflags;
 
    boolean             agt_load_done;
 
    boolean             agt_load_validate_errors;
 
    boolean             agt_load_rootcheck_errors;
 
    boolean             agt_load_top_rootcheck_errors;
 
    boolean             agt_load_apply_errors;
 
    boolean             agt_load_factory_fallback;
 
    boolean             agt_load_def_startup_factory;
 
    dlq_hdr_t           agt_savedevQ;
 
    dlq_hdr_t           agt_commit_testQ;
 
    xmlChar            *agt_startup_txid_file;
 
    xmlChar            *agt_socket_address;
 
    uint16              agt_socket_port;
 
    xmlChar            *agt_conf_dirspec;
    boolean             agt_confdir_skipped;
 
    agt_ha_role_t      agt_ha_role;
 
    boolean            agt_defer_load;
 
    boolean            agt_no_yang_push;
 
    boolean          agt_enable_netconf;
 
    boolean          agt_enable_restconf;
 
    boolean          agt_enable_cli;
 
    boolean          agt_enable_gnmi;
 
    boolean          agt_enable_grpc;
 
    boolean            agt_with_fsync;
 
    /* TBD: --auto-discard-on-lock-timeout=true */
    boolean          agt_auto_discard_on_lock_timeout;
 
} agt_profile_t;
 
 
/******************* External System Callbacks ***********************/
 
typedef void (*agt_system_init_profile_fn_t)
    (agt_profile_t *profile);
 
 
typedef status_t (*agt_system_init1_fn_t)
    (boolean pre_cli);
 
 
typedef status_t (*agt_system_init2_fn_t)
    (boolean pre_load);
 
 
typedef void (*agt_system_cleanup_fn_t) (void);
 
 
typedef status_t (*agt_nvsave_fn_t)
    (ncx_display_mode_t encoding,
     const xmlChar *filespec);
 
 
typedef status_t (*agt_nvload_fn_t)
    (ncx_display_mode_t *encoding,
     xmlChar **filespec);
 
 
typedef struct agt_syslib_cb_t_ {
    dlq_hdr_t             qhdr;
 
    void                 *handle;
 
    xmlChar              *libspec;
 
    agt_system_init_profile_fn_t init_profile_fn;
 
    agt_system_init1_fn_t init1_fn;
 
    agt_system_init2_fn_t init2_fn;
 
    agt_system_cleanup_fn_t cleanup_fn;
 
    status_t              init1_status;
 
    status_t              init2_status;
 
    boolean               cleanup_done;
} agt_syslib_cb_t;
 
 
typedef struct agt_edit_parms_cb_t_ {
 
 
    /**** state data used for the edit transaction ****/
    yang_patch_cb_t *pcb;
 
} agt_edit_parms_cb_t;
 
 
typedef void (*agt_replay_fn_t) (boolean is_start);
 
 
/********************************************************************
*                                                                   *
*                       F U N C T I O N S                           *
*                                                                   *
*********************************************************************/
 
 
extern status_t
    agt_init1 (int argc,
               char *argv[],
               boolean *showver,
               help_mode_t *showhelpmode);
 
 
extern status_t
    agt_init1_ex (int argc,
                  char *argv[],
                  boolean factory_restart,
                  boolean *showver,
                  help_mode_t *showhelpmode);
 
 
extern status_t
    agt_init1_sil_sa (void);
 
 
extern status_t
    agt_init1_ypserver (int argc,
                        char *argv[],
                        boolean factory_restart,
                        boolean *showver,
                        help_mode_t *showhelpmode);
 
 
extern status_t
    agt_init2 (void);
 
 
extern status_t
    agt_init2_ex (boolean factory_restart);
 
 
extern status_t
    agt_init2_sil_sa (void);
 
 
extern void
    agt_cleanup (void);
 
 
extern void
    agt_cleanup_sil_sa (void);
 
 
extern agt_profile_t *
    agt_get_profile (void);
 
 
extern void
    agt_request_shutdown (ncx_shutdowntyp_t mode,
                          int intnum);
 
 
extern boolean
    agt_shutdown_requested (void);
 
 
extern ncx_shutdowntyp_t
    agt_shutdown_mode_requested (void);
 
 
extern int
    agt_shutdown_term_signal (void);
 
 
extern const xmlChar *
    agt_cbtype_name (agt_cbtyp_t cbtyp);
 
 
extern boolean
    agt_advertise_module_needed (const xmlChar *modname);
 
 
extern void agt_request_replay (void);
 
 
extern void agt_request_replay_ex (void *cookie);
 
 
extern void * agt_get_replay_cookie (void);
 
 
extern void
    agt_request_replay_subsys (const xmlChar *subsys_id);
 
 
extern boolean agt_replay_requested (void);
 
 
extern void agt_start_replay (void);
 
 
extern void agt_finish_replay (void);
 
 
extern status_t
    agt_register_local_nv_handler (agt_nvload_fn_t load_fn,
                                   agt_nvsave_fn_t store_fn);
 
 
extern status_t
    agt_check_save_external_config (ncx_display_mode_t encoding,
                                    const xmlChar *filespec);
 
 
extern status_t
    agt_add_allowed_user (const xmlChar *username);
 
 
extern void
    agt_remove_allowed_user (const xmlChar *username);
 
 
extern status_t
    agt_check_allowed_user (const xmlChar *username);
 
 
 
extern status_t
    agt_add_superuser (const xmlChar *username);
 
 
extern void
    agt_remove_superuser (const xmlChar *username);
 
 
extern status_t
    agt_check_superuser (const xmlChar *username);
 
 
extern void
    agt_register_replay_callback (agt_replay_fn_t cbfn);
 
 
extern const xmlChar *
    agt_get_server_id (void);
 
 
extern const xmlChar *
    agt_get_server_root (void);
 
 
extern const xmlChar *
    agt_get_server_key (void);
 
 
extern boolean
    agt_is_sil_sa (void);
 
 
extern dlq_hdr_t *
    agt_get_savedevQ (void);
 
 
extern boolean
    agt_replay_subsys_is_active (const xmlChar *subsys_id);
 
 
extern boolean
    agt_replay_main_is_active (void);
 
 
extern const xmlChar *
    agt_ha_role_str (agt_ha_role_t ha_role);
 
 
extern agt_ha_role_t
    agt_ha_role_enum (const xmlChar *ha_role);
 
 
extern boolean
    agt_use_notifications (void);
 
 
extern status_t
    agt_check_load_config (agt_ha_role_t ha_role);
 
 
extern boolean
    agt_init2_done (void);
 
 
extern boolean
    agt_init2_load_done (void);
 
 
extern boolean
    agt_advertise_yang11_module_needed (ncx_module_t *mod);
 
 
extern void
    agt_set_factory_restart (void);
 
 
extern boolean
    agt_in_factory_restart (void);
 
 
extern status_t
    agt_add_modcache (ncx_modcache_t *mc);
 
 
extern ncx_modcache_t *
    agt_find_modcache (const xmlChar *modname);
 
 
extern status_t
    agt_run_extloop (void);
 
 
extern status_t
    agt_enter_maintenance_mode (boolean read_ok,
                                boolean operation_ok);
 
 
extern status_t
    agt_exit_maintenance_mode (void);
 
 
extern boolean
    agt_in_maintenance_mode (void);
 
 
extern boolean
    agt_maintenance_mode_read_ok (void);
 
 
extern boolean
    agt_maintenance_mode_operation_ok (void);
 
 
extern boolean
    agt_maintenance_mode_session_ok (void);
 
 
extern void
    agt_set_eventlog_size (uint32 eventlog_size);
 
 
extern void
    agt_set_max_burst (uint32 max_burst);
 
 
extern void
    agt_set_max_getbulk (uint32 max_getbulk);
 
 
extern agt_not_msg_t *
    agt_make_term_msg (const xmlChar *msg,
                       status_t *res);
 
 
extern status_t
    agt_init_term_msg_module (void);
 
 
extern boolean
    agt_use_nmda (void);
 
 
extern boolean
    agt_use_new_yanglib (void);
 
 
extern boolean
    agt_waiting_datastore_ready (void);
 
 
extern boolean
    agt_use_yang_cbor (void);
 
 
extern const char *
    agt_get_aflocal_sockname (void);
 
 
extern const xmlChar *
    agt_get_user_parm (void);
 
 
extern status_t
    agt_add_maxuser_parm (const xmlChar *cliparm);
 
 
 
status_t
    agt_get_maxuser_parm (const xmlChar *username,
                          uint16 *retval);
 
 
extern boolean agt_protocol_enabled (const xmlChar *proto);
 
 
extern status_t agt_enable_protocol (const xmlChar *proto);
 
 
extern status_t agt_disable_protocol (const xmlChar *proto);
 
 
extern boolean
    agt_yang_push_is_enabled (void);
 
 
#ifdef __cplusplus
}  /* end extern 'C' */
#endif
 
#endif      /* _H_agt */