Call Home Support

CallHome allows the server to initiate the TCP connection to the client that is used for the NETCONF session. More...

Collaboration diagram for Call Home Support:

Data Structures
struct	agt_callhome_cb_t
	control block for each client for a callhome connection More...

Functions
status_t	agt_callhome_init (void)
	Initialize the Callhome module. More...
status_t	agt_callhome_init_postcli (void)
	Initialize the Callhome module POST CLI parms. More...
status_t	agt_callhome_init2 (void)
	Initialize the Callhome module (Init phase II) More...
void	agt_callhome_cleanup (void)
	Cleanup the Callhome module. More...
boolean	agt_callhome_connecting (const xmlChar *addr)
	Check if the source address is connecting in a callhome session. More...
status_t	agt_callhome_add_server_cli (const xmlChar *valstr, agt_ch_proto_t ch_proto)
	Add a CallHome server entry from the –callhome-server CLI parm. More...
status_t	agt_callhome_add_server (const xmlChar *ch_name, const xmlChar *ch_addr, uint16 ch_port, agt_ch_proto_t ch_proto, boolean start_now)
	Add a CallHome server entry from a YANG module at run-time. More...
status_t	agt_callhome_remove_server (const xmlChar *ch_name)
	Remove a CallHome server entry added from a YANG module at run-time. More...
status_t	agt_callhome_remove_all_servers (void)
	Remove all CallHome server entries added from a YANG module at run-time. More...
void	agt_callhome_check_reconnect (ses_cb_t *scb)
	Check if the session is a callhome session that needs reconnect. More...
status_t	agt_ncchd_connect (agt_callhome_cb_t *cb)
	Start the SSHd server for a Call Home connection. More...
status_t	y_yumaworks_callhome_init (const xmlChar *modname, const xmlChar *revision)
	initialize the yumaworks-callhome server instrumentation library More...
status_t	y_yumaworks_callhome_init2 (void)
	SIL init phase 2: non-config data structures. More...
void	y_yumaworks_callhome_cleanup (void)
	cleanup the server instrumentation library More...

Detailed Description

CallHome allows the server to initiate the TCP connection to the client that is used for the NETCONF session.

Both NETCONF over SSH and NETCONF over TLS call-home sessions are supported. RESTCONF CallHome is not supported.

Function Documentation

agt_callhome_add_server()

status_t agt_callhome_add_server	(	const xmlChar *	ch_name,
		const xmlChar *	ch_addr,
		uint16	ch_port,
		agt_ch_proto_t	ch_proto,
		boolean	start_now
	)

Add a CallHome server entry from a YANG module at run-time.

The netconfd-pro server will attempt a connection right away if start_now == TRUE

Parameters

ch_name	CallHome server name
ch_addr	CallHome server IP address
ch_port	CallHome Port number (0 == use default for ch_proto)
ch_proto	callhome protocol to use
start_now	TRUE to start a connection attempt now FALSE to just add the server to the config (NOT SAVED YET)

Returns

status

Here is the call graph for this function:

agt_callhome_add_server_cli()

status_t agt_callhome_add_server_cli	(	const xmlChar *	valstr,
		agt_ch_proto_t	ch_proto
	)

Add a CallHome server entry from the –callhome-server CLI parm.

This is an internal API used to add the bootstrap CallHome servers at init2 time.

DO NOT USE AT RUN-TIME

Parameters

valstr	CLI value string to parse and use
ch_proto	callhome protocol to use

Returns

status

Here is the call graph for this function:

agt_callhome_check_reconnect()

void agt_callhome_check_reconnect

(

ses_cb_t *

scb

)

Check if the session is a callhome session that needs reconnect.

If so then start a 1 second timer to do the reconnect; Does not start the callhome session immediately; Called durintg agt_ses_free_session2

Parameters

[in]

scb

session control block from killed session to check

Here is the call graph for this function:

Here is the caller graph for this function:

agt_callhome_cleanup()

void agt_callhome_cleanup

(

void

)

Cleanup the Callhome module.

Called by server during shutdown.

Here is the call graph for this function:

agt_callhome_connecting()

boolean agt_callhome_connecting

(

const xmlChar *

addr

)

Check if the source address is connecting in a callhome session.

Parameters

addr	IP address string

Returns

true if a callhome session to that address is connecting

Here is the call graph for this function:

Here is the caller graph for this function:

agt_callhome_init()

status_t agt_callhome_init

(

void

)

Initialize the Callhome module.

Returns

status

Here is the call graph for this function:

agt_callhome_init2()

status_t agt_callhome_init2

(

void

)

Initialize the Callhome module (Init phase II)

Returns

status

Here is the call graph for this function:

agt_callhome_init_postcli()

status_t agt_callhome_init_postcli

(

void

)

Initialize the Callhome module POST CLI parms.

Returns

status

Here is the call graph for this function:

agt_callhome_remove_all_servers()

status_t agt_callhome_remove_all_servers

(

void

)

Remove all CallHome server entries added from a YANG module at run-time.

Returns

status

Here is the call graph for this function:

agt_callhome_remove_server()

status_t agt_callhome_remove_server

(

const xmlChar *

ch_name

)

Remove a CallHome server entry added from a YANG module at run-time.

The netconfd-proserver will attempt a connection right away

Parameters

ch_name

CallHome server name

Here is the call graph for this function:

agt_ncchd_connect()

status_t agt_ncchd_connect

(

agt_callhome_cb_t *

cb

)

Start the SSHd server for a Call Home connection.

Start the openssh server in inet mode so it will just listen for the 1 session expected to start on the connection.

Parameters

cb	callhome control block to use

Returns

status

Here is the call graph for this function:

y_yumaworks_callhome_cleanup()

void y_yumaworks_callhome_cleanup

(

void

)

cleanup the server instrumentation library

Called by the server during shutdown.

Here is the call graph for this function:

Here is the caller graph for this function:

y_yumaworks_callhome_init()

status_t y_yumaworks_callhome_init	(	const xmlChar *	modname,
		const xmlChar *	revision
	)

initialize the yumaworks-callhome server instrumentation library

Parameters

modname	requested module name
revision	requested version (NULL for any)

Returns

error status

Here is the call graph for this function:

Here is the caller graph for this function:

y_yumaworks_callhome_init2()

status_t y_yumaworks_callhome_init2

(

void

)

SIL init phase 2: non-config data structures.

Called after running config is loaded

Returns

error status

Here is the caller graph for this function: