Yuma System Modules

Supports yuma-system and yumaworks-system modules. More...

Collaboration diagram for Yuma System Modules:

Macros
#define	AGT_SYS_MODULE   (const xmlChar *)"yuma-system"
	older yuma-system module
#define	AGT_YWSYS_MODULE   (const xmlChar *)"yumaworks-system"
	newerr yumaworks-system module mostly replaces yuma-system

Functions
status_t	agt_sys_init (void)
	INIT 1: Initialize the server notification module data structures. More...
status_t	agt_sys_init2 (void)
	INIT 2: Initialize the monitoring data structures This must be done after the <running> config is loaded. More...
void	agt_sys_cleanup (void)
	Cleanup the module data structures. More...
void	agt_sys_send_sysSessionStart (const ses_cb_t *scb)
	Queue the Session Start notification. More...
void	agt_sys_send_sysSessionEnd (const ses_cb_t *scb, ses_term_reason_t termreason, ses_id_t killedby)
	Queue the Session End notification. More...
void	agt_sys_send_sysConfigChange (const ses_cb_t *scb, dlq_hdr_t *auditrecQ)
	Queue the Config Change notification. More...
void	agt_sys_send_sysCapabilityChange (ses_cb_t *changed_by, boolean is_add, const xmlChar *capstr)
	Send a Capability Change notification. More...
void	agt_sys_send_sysConfirmedCommit (const ses_cb_t *scb, ncx_confirm_event_t event, uint32 timeout)
	Queue the Confirmed Commit notification. More...
uint32	agt_sys_get_capability_changes (void)
	Get the capability-changes counter. More...
val_value_t *	agt_sys_get_system_node (void)
	Get the /yuma-system:system container. More...
status_t	agt_sys_fill_ha_status (val_value_t *ha_status_val)
	Fill the HA status container. More...

Detailed Description

Supports yuma-system and yumaworks-system modules.

• System notifications are supported and the IETF or Yuma modules can be selected.
• Usually only the IETF notifications are used.
• Notification APIs can be used even if Yuma modules are turned off
• with-yuma-system=true CLI needed to enable yuma-system.yang
• with-yumaworks-system=true CLI needed to enable yumaworks-system.yang
• system-notifications=yuma CLI needed to enable yuma-system notifications

Function Documentation

agt_sys_cleanup()

void agt_sys_cleanup

(

void

)

Cleanup the module data structures.

Called by the server during shutdown.

Here is the call graph for this function:

agt_sys_fill_ha_status()

status_t agt_sys_fill_ha_status

(

val_value_t *

ha_status_val

)

Fill the HA status container.

<verbatim> +–ro ha-status +–ro ha-built? boolean +–ro ha-role-state? HaRoleState +–ro ha-enabled? boolean +–ro ha-sil-standby? boolean +–ro ha-server* string +–ro ha-server-key? string +–ro ha-initial-active? string +–ro socket-type? enumeration +–ro socket-port? inet:port-number +–ro server-id? yt:NcxName +–ro config-id? uint64 +–ro config-stamp? yang:date-and-time </verbatim>

Parameters

ha_status_val

value node to fill in that uses HaStatusParms grouping

status

Here is the call graph for this function:

agt_sys_get_capability_changes()

uint32 agt_sys_get_capability_changes

(

void

)

Get the capability-changes counter.

Returns

current sysCapabilityChanges counter value

agt_sys_get_system_node()

val_value_t * agt_sys_get_system_node

(

void

)

Get the /yuma-system:system container.

Only available if –with-yuma-system=true

Returns

pointer to container

Here is the call graph for this function:

agt_sys_init()

status_t agt_sys_init

(

void

)

INIT 1: Initialize the server notification module data structures.

Returns

status

Here is the call graph for this function:

Here is the caller graph for this function:

agt_sys_init2()

status_t agt_sys_init2

(

void

)

INIT 2: Initialize the monitoring data structures This must be done after the <running> config is loaded.

Returns

status

Here is the call graph for this function:

agt_sys_send_sysCapabilityChange()

void agt_sys_send_sysCapabilityChange	(	ses_cb_t *	changed_by,
		boolean	is_add,
		const xmlChar *	capstr
	)

Send a Capability Change notification.

Send a <sysCapabilityChange> event for a module being added

• Send <netconf-capability-change> if –system-notifications=ietf.
• Send <sysCapability> if –system-notifications=yuma.
• Notification generated and added to notificationQ

Parameters

changed_by	session control block that made the change to add this module NULL if the server made the change
is_add	TRUE if the capability is being added FALSE if the capability is being deleted
capstr	capability string that was added or deleted

Here is the call graph for this function:

Here is the caller graph for this function:

agt_sys_send_sysConfigChange()

void agt_sys_send_sysConfigChange	(	const ses_cb_t *	scb,
		dlq_hdr_t *	auditrecQ
	)

Queue the Config Change notification.

• Send <netconf-config-change> if –system-notifications=ietf.
• Send <sysConfigChange> if –system-notifications=yuma.
• Notification generated and added to notificationQ

Parameters

scb	session control block to use for payload values
auditrecQ	Q of rpc_audit_rec_t structs to use for the notification payload contents

Here is the call graph for this function:

Here is the caller graph for this function:

agt_sys_send_sysConfirmedCommit()

void agt_sys_send_sysConfirmedCommit	(	const ses_cb_t *	scb,
		ncx_confirm_event_t	event,
		uint32	timeout
	)

Queue the Confirmed Commit notification.

• Send <netconf-confirmed-commit> if –system-notifications=ietf.
• Send <sysConfirmedCommit> if –system-notifications=yuma.
• Notification generated and added to notificationQ

Parameters

scb	session control block to use for payload values
event	enum for the confirmEvent leaf
timeout	number of seconds configured for CC time out

Here is the call graph for this function:

Here is the caller graph for this function:

agt_sys_send_sysSessionEnd()

void agt_sys_send_sysSessionEnd	(	const ses_cb_t *	scb,
		ses_term_reason_t	termreason,
		ses_id_t	killedby
	)

Queue the Session End notification.

• Send <netconf-session-end> if –system-notifications=ietf.
• Send <sysSessionEnd> if –system-notifications=yuma.
• Notification generated and added to notificationQ

Parameters

scb	session control block to use for payload values
termreason	enum for the terminationReason leaf
killedby	session-id for killedBy leaf if termreason "killed" ignored otherwise

Here is the call graph for this function:

Here is the caller graph for this function:

agt_sys_send_sysSessionStart()

void agt_sys_send_sysSessionStart

(

const ses_cb_t *

scb

)

Queue the Session Start notification.

• Send <netconf-session-start> if –system-notifications=ietf.
• Send <sysSessionStart> if –system-notifications=yuma.
• Notification generated and added to notificationQ

Parameters

scb	session control block to use for payload values

Here is the call graph for this function:

Here is the caller graph for this function: