Capabilities Handler

NETCONF protocol capabilities handler. More...

Collaboration diagram for Capabilities Handler:

Functions
void	agt_cap_cleanup (void)
	Clean the NETCONF server capabilities. More...
status_t	agt_cap_set_restconf_caps (const xmlChar *defstyle, uint8 withdef_enabled)
	Initialize the RESTCONF capabilities. More...
status_t	agt_cap_set_caps (ncx_agttarg_t agttarg, ncx_agtstart_t agtstart, const xmlChar *defstyle, uint8 withdef_enabled)
	Initialize the NETCONF server capabilities. More...
status_t	agt_cap_set_modules (void)
	Initialize the NETCONF server capabilities modules list. More...
status_t	agt_cap_add_module (ncx_module_t *mod)
	Add a module at runtime, after the initial set has been set. More...
status_t	agt_cap_remove_module (ncx_module_t *mod)
	Remove a module at runtime, after the initial set has been set MUST call after agt_cap_set_caps. More...
cap_list_t *	agt_cap_get_caps (void)
	Get the NETCONF server capabilities. More...
cap_list_t *	agt_cap_get_restconf_caps (void)
	Get the RESTCONF capabilities. More...
val_value_t *	agt_cap_get_capsval (void)
	Get the NETCONF server capabilities in val_value_t format. More...
val_value_t *	agt_cap_get_restconf_capsval (void)
	Get the RESTCONF capabilities in val_value_t format. More...
boolean	agt_cap_std_set (cap_stdid_t cap)
	Check if the STD capability is set for the server. More...
boolean	agt_restconf_cap_std_set (cap_stdid_t cap)
	Check if the STD RESTCONF capability is set for the agent. More...
status_t	agt_cap_update_config_id (void)
	Update the config-id capability id' value to the new txid for the running config. More...
void	agt_cap_get_netconf_features (boolean *f_write_running, boolean *f_candidate, boolean *f_confirmed_commit, boolean *f_rollback, boolean *f_validate, boolean *f_startup, boolean *f_url, boolean *f_xpath)
	Get the NETCONF 1.1 YANG features that should be enabled for the current server profile. More...
status_t	agt_cap_set_netconf_module (void)
	Initialize the NETCONF module capabilities. More...
status_t	agt_cap_update_module_setid (void)
	Update YANG-LIBRARY capability module setID. More...

Detailed Description

NETCONF protocol capabilities handler.

Implements capability URIs for server hello messages

Function Documentation

agt_cap_add_module()

status_t agt_cap_add_module

(

ncx_module_t *

mod

)

Add a module at runtime, after the initial set has been set.

MUST call after agt_cap_set_caps

Returns

status

Here is the call graph for this function:

Here is the caller graph for this function:

agt_cap_cleanup()

void agt_cap_cleanup

(

void

)

Clean the NETCONF server capabilities.

Called by the server during shutdown.

Here is the call graph for this function:

agt_cap_get_caps()

cap_list_t * agt_cap_get_caps

(

void

)

Get the NETCONF server capabilities.

Returns

pointer to the server caps list

agt_cap_get_capsval()

val_value_t * agt_cap_get_capsval

(

void

)

Get the NETCONF server capabilities in val_value_t format.

Returns

pointer to the server caps list

Here is the caller graph for this function:

agt_cap_get_netconf_features()

void agt_cap_get_netconf_features	(	boolean *	f_write_running,
		boolean *	f_candidate,
		boolean *	f_confirmed_commit,
		boolean *	f_rollback,
		boolean *	f_validate,
		boolean *	f_startup,
		boolean *	f_url,
		boolean *	f_xpath
	)

Get the NETCONF 1.1 YANG features that should be enabled for the current server profile.

Parameters

[out]	f_write_running	writable-running flag
[out]	f_candidate	candidate flag
[out]	f_confirmed_commit	confirmed-commit flag
[out]	f_rollback	rollback-on-error flag
[out]	f_validate	validate flag
[out]	f_startup	startup flag
[out]	f_url	url flag
[out]	f_xpath	XPath flag

Here is the call graph for this function:

agt_cap_get_restconf_caps()

cap_list_t * agt_cap_get_restconf_caps

(

void

)

Get the RESTCONF capabilities.

Returns

pointer to the agent caps list

agt_cap_get_restconf_capsval()

val_value_t * agt_cap_get_restconf_capsval

(

void

)

Get the RESTCONF capabilities in val_value_t format.

Returns

pointer to the agent caps list

agt_cap_remove_module()

status_t agt_cap_remove_module

(

ncx_module_t *

mod

)

Remove a module at runtime, after the initial set has been set MUST call after agt_cap_set_caps.

Returns

status

Here is the call graph for this function:

agt_cap_set_caps()

status_t agt_cap_set_caps	(	ncx_agttarg_t	agttarg,
		ncx_agtstart_t	agtstart,
		const xmlChar *	defstyle,
		uint8	withdef_enabled
	)

Initialize the NETCONF server capabilities.

Parameters

agttarg	the target of edit-config for this server
agtstart	the type of startup configuration for this server
defstyle	default with-defaults style for the entire server
withdef_enabled	bitmask of enabled with-defaults modes

Returns

NO_ERR if all goes well

Here is the call graph for this function:

Here is the caller graph for this function:

agt_cap_set_modules()

status_t agt_cap_set_modules

(

void

)

Initialize the NETCONF server capabilities modules list.

MUST call after agt_cap_set_caps

Returns

status

Here is the call graph for this function:

Here is the caller graph for this function:

agt_cap_set_netconf_module()

status_t agt_cap_set_netconf_module

(

void

)

Initialize the NETCONF module capabilities.

MUST call after agt_cap_set_caps

Returns

status

Here is the caller graph for this function:

agt_cap_set_restconf_caps()

status_t agt_cap_set_restconf_caps	(	const xmlChar *	defstyle,
		uint8	withdef_enabled
	)

Initialize the RESTCONF capabilities.

Parameters

defstyle	default with-defaults style for the entire agent
withdef_enabled	bitmask of enabled with-defaults modes

Returns

NO_ERR if all goes well

Here is the call graph for this function:

agt_cap_std_set()

boolean agt_cap_std_set

(

cap_stdid_t

cap

)

Check if the STD capability is set for the server.

Parameters

cap	ID of capability to check

Returns

TRUE is STD cap set, FALSE otherwise

Here is the call graph for this function:

Here is the caller graph for this function:

agt_cap_update_config_id()

status_t agt_cap_update_config_id

(

void

)

Update the config-id capability id' value to the new txid for the running config.

Returns

status

Here is the call graph for this function:

Here is the caller graph for this function:

agt_cap_update_module_setid()

status_t agt_cap_update_module_setid

(

void

)

Update YANG-LIBRARY capability module setID.

urn:ietf:params:netconf:capability:yang-library:1.0? revision=<date>&module-set-id=<id>

Returns

status

Here is the call graph for this function:

Here is the caller graph for this function:

agt_restconf_cap_std_set()

boolean agt_restconf_cap_std_set

(

cap_stdid_t

cap

)

Check if the STD RESTCONF capability is set for the agent.

Parameters

cap	ID of capability to check

Returns

TRUE is STD cap set, FALSE otherwise

Here is the call graph for this function: