![]() |
Kea
2.3.9
|
Netconf agent. More...
#include <netconf.h>
Public Member Functions | |
virtual | ~NetconfAgent () |
Destructor (call clear). More... | |
void | clear () |
Clear. More... | |
void | init (NetconfCfgMgrPtr cfg_mgr) |
Initialization. More... | |
void | initSysrepo () |
Initialize sysrepo sessions. More... | |
Static Public Member Functions | |
static sysrepo::ErrorCode | change (sysrepo::Session sess, const CfgServersMapPair &service_pair) |
Event::Change callback. More... | |
static sysrepo::ErrorCode | done (sysrepo::Session sess, const CfgServersMapPair &service_pair) |
Event::Done callback. More... | |
static void | logChanges (sysrepo::Session sess, std::string_view const &model) |
Log changes. More... | |
Protected Member Functions | |
void | announceShutdown () const |
Set the shutdown flag of the process to true so that it can exit at the earliest convenient time. More... | |
bool | checkModule (const std::string &module_name) const |
Check essential module availability. More... | |
void | checkModules (CfgServersMapPtr const &servers={}) const |
Check module availability. More... | |
void | getModules () |
Retrieve names and revisions of installed modules through the sysrepo API. More... | |
void | keaConfig (const CfgServersMapPair &service_pair) |
Get and display Kea server configuration. More... | |
bool | shouldShutdown () const |
Check the shutdown flag of the process. More... | |
void | subscribeToDataChanges (const CfgServersMapPair &service_pair) |
Subscribe changes for a module in YANG datastore. More... | |
void | subscribeToNotifications (const CfgServersMapPair &service_pair) |
Subscribe to notifications for a given YANG module. More... | |
void | yangConfig (const CfgServersMapPair &service_pair) |
Retrieve Kea server configuration from the YANG startup datastore and applies it to servers. More... | |
Protected Attributes | |
std::map< const std::string, const std::string > | modules_ |
Available modules and revisions in Sysrepo. More... | |
std::optional< sysrepo::Session > | running_sess_ |
Sysrepo running datastore session. More... | |
std::optional< sysrepo::Session > | startup_sess_ |
Sysrepo startup datastore session. More... | |
std::map< const std::string, sysrepo::Subscription > | subscriptions_ |
Subscription map. More... | |
Netconf agent.
Service performed by the Netconf agent:
|
virtual |
Destructor (call clear).
Definition at line 145 of file netconf.cc.
|
protected |
Set the shutdown flag of the process to true so that it can exit at the earliest convenient time.
Definition at line 729 of file netconf.cc.
|
static |
Event::Change callback.
Validate YANG datastore changes using Kea configuration test.
sess | The sysrepo running datastore session. |
service_pair | The service name and configuration pair. |
Definition at line 505 of file netconf.cc.
References isc::config::answerToText(), isc::config::CONTROL_RESULT_SUCCESS, isc::netconf::controlSocketFactory(), isc::yang::TranslatorConfig::getConfig(), LOG_DEBUG, LOG_ERROR, LOG_INFO, isc::netconf::NETCONF_DBG_TRACE_DETAIL_DATA, isc::netconf::netconf_logger, isc::netconf::NETCONF_VALIDATE_CONFIG, isc::netconf::NETCONF_VALIDATE_CONFIG_COMPLETED, isc::netconf::NETCONF_VALIDATE_CONFIG_FAILED, isc::netconf::NETCONF_VALIDATE_CONFIG_REJECTED, isc::netconf::NETCONF_VALIDATE_CONFIG_STARTED, isc::config::parseAnswer(), and isc::data::prettyPrint().
|
protected |
Check essential module availability.
Emit a fatal error if an essential one (i.e. required in a further phase) is missing or does not have the expected revision.
module_name | The module name. |
Definition at line 281 of file netconf.cc.
References LOG_ERROR, isc::netconf::netconf_logger, and isc::netconf::NETCONF_MODULE_MISSING_ERR.
|
protected |
Check module availability.
Emit a warning if a module is missing or does not have the expected revision.
servers | the configured servers to check against YANG_REVISIONS. Is empty by default for when the caller only wants to check installed modules. |
Unexpected | if a module from YANG_REVISIONS is not installed or has the wrong revision. |
Definition at line 306 of file netconf.cc.
References isc_throw.
void isc::netconf::NetconfAgent::clear | ( | ) |
|
static |
Event::Done callback.
Get notified that a Kea configuration has been written to the YANG datastore.
sess | The sysrepo running datastore session. |
service_pair | The service name and configuration pair. |
Definition at line 589 of file netconf.cc.
References isc::config::answerToText(), isc::config::CONTROL_RESULT_SUCCESS, isc::netconf::controlSocketFactory(), isc::yang::TranslatorConfig::getConfig(), LOG_DEBUG, LOG_ERROR, LOG_INFO, isc::netconf::NETCONF_DBG_TRACE_DETAIL_DATA, isc::netconf::netconf_logger, isc::netconf::NETCONF_UPDATE_CONFIG, isc::netconf::NETCONF_UPDATE_CONFIG_COMPLETED, isc::netconf::NETCONF_UPDATE_CONFIG_FAILED, isc::netconf::NETCONF_UPDATE_CONFIG_STARTED, isc::config::parseAnswer(), and isc::data::prettyPrint().
|
protected |
Retrieve names and revisions of installed modules through the sysrepo API.
Unexpected | if module information cannot be retrieved from sysrepo |
Definition at line 260 of file netconf.cc.
References isc_throw, and isc::Exception::what().
void isc::netconf::NetconfAgent::init | ( | NetconfCfgMgrPtr | cfg_mgr | ) |
Initialization.
Check available modules / revisions. Get and display Kea server configurations. Load Kea server configurations from YANG datastore. Subscribe configuration changes in YANG datastore.
cfg_mgr | The configuration manager (can be null). |
Definition at line 150 of file netconf.cc.
References isc_throw.
Referenced by isc::netconf::NetconfProcess::run().
void isc::netconf::NetconfAgent::initSysrepo | ( | ) |
Initialize sysrepo sessions.
Must be called before init. Collect the list of available modules with their revisions.
Definition at line 245 of file netconf.cc.
References isc_throw, and isc::Exception::what().
|
protected |
Get and display Kea server configuration.
Retrieves current configuration via control socket (unix or http) from a running Kea server. If boot-update is set to false, this operation is a no-op.
service_pair | The service name and configuration pair. |
Definition at line 185 of file netconf.cc.
References isc::config::answerToText(), isc::config::CONTROL_RESULT_SUCCESS, isc::netconf::controlSocketFactory(), LOG_DEBUG, LOG_ERROR, LOG_INFO, isc::netconf::NETCONF_DBG_TRACE_DETAIL_DATA, isc::netconf::NETCONF_GET_CONFIG, isc::netconf::NETCONF_GET_CONFIG_FAILED, isc::netconf::NETCONF_GET_CONFIG_STARTED, isc::netconf::netconf_logger, isc::config::parseAnswer(), and isc::data::prettyPrint().
|
static |
Log changes.
Iterate on changes logging them. Sysrepo changes are an operation (created, modified, deleted or moved) with old and new values (cf sr_change_oper_e sysrepo documentation).
sess | The sysrepo running datastore session. |
model | The model name. |
Definition at line 682 of file netconf.cc.
References LOG_DEBUG, isc::netconf::NETCONF_CONFIG_CHANGED_DETAIL, isc::netconf::NETCONF_DBG_TRACE_DETAIL_DATA, and isc::netconf::netconf_logger.
|
protected |
Check the shutdown flag of the process.
Definition at line 738 of file netconf.cc.
|
protected |
Subscribe changes for a module in YANG datastore.
service_pair | The service name and configuration pair. |
Definition at line 423 of file netconf.cc.
References LOG_ERROR, LOG_INFO, isc::netconf::netconf_logger, isc::netconf::NETCONF_SUBSCRIBE_CONFIG, and isc::netconf::NETCONF_SUBSCRIBE_CONFIG_FAILED.
|
protected |
Subscribe to notifications for a given YANG module.
service_pair | the service name and configuration pair |
Definition at line 467 of file netconf.cc.
References LOG_INFO, LOG_WARN, isc::netconf::netconf_logger, isc::netconf::NETCONF_NOT_SUBSCRIBED_TO_NOTIFICATIONS, and isc::netconf::NETCONF_SUBSCRIBE_NOTIFICATIONS.
|
protected |
Retrieve Kea server configuration from the YANG startup datastore and applies it to servers.
This method retrieves the configuation from sysrepo first, then established control socket connection to Kea servers (currently dhcp4 and/or dhcp6) and then attempts to send configuration using config-set.
If boot-update is set to false, this operation is a no-op.
service_pair | The service name and configuration pair. |
Definition at line 338 of file netconf.cc.
References isc::config::answerToText(), isc::config::CONTROL_RESULT_SUCCESS, isc::netconf::controlSocketFactory(), isc::yang::TranslatorConfig::getConfig(), LOG_DEBUG, LOG_ERROR, LOG_INFO, isc::netconf::NETCONF_BOOT_UPDATE_COMPLETED, isc::netconf::NETCONF_DBG_TRACE_DETAIL_DATA, isc::netconf::netconf_logger, isc::netconf::NETCONF_SET_CONFIG, isc::netconf::NETCONF_SET_CONFIG_FAILED, isc::netconf::NETCONF_SET_CONFIG_STARTED, isc::config::parseAnswer(), and isc::data::prettyPrint().
|
protected |
|
protected |
|
protected |
|
protected |