 |
sysrepo
1.4.70
YANG datastore
|
Go to the documentation of this file.
30 #include <sys/types.h>
33 #include <libyang/libyang.h>
754 sr_val_t **values,
size_t *value_cnt);
1023 uint32_t timeout_ms,
int wait);
1104 uint32_t *nc_id, time_t *timestamp);
1322 sr_event_t event, uint32_t request_id,
void *private_data);
1424 const struct lyd_node **node,
const char **prev_value,
const char **prev_list,
bool *prev_dflt);
1463 sr_event_t event, uint32_t request_id,
sr_val_t **output,
size_t *output_cnt,
void *private_data);
1482 sr_event_t event, uint32_t request_id,
struct lyd_node *output,
void *private_data);
1542 uint32_t timeout_ms,
sr_val_t **output,
size_t *output_cnt);
1597 const sr_val_t *values,
const size_t values_cnt, time_t timestamp,
void *private_data);
1611 const struct lyd_node *notif, time_t timestamp,
void *private_data);
1727 const char *request_xpath, uint32_t request_id,
struct lyd_node **parent,
void *private_data);
1763 #define SRP_INIT_CB "sr_plugin_init_cb"
1768 #define SRP_CLEANUP_CB "sr_plugin_cleanup_cb"
1799 #define SRP_LOG_ERR(format, ...) srp_log(SR_LL_ERR, format, __VA_ARGS__)
1807 #define SRP_LOG_WRN(format, ...) srp_log(SR_LL_WRN, format, __VA_ARGS__)
1815 #define SRP_LOG_INF(format, ...) srp_log(SR_LL_INF, format, __VA_ARGS__)
1823 #define SRP_LOG_DBG(format, ...) srp_log(SR_LL_DBG, format, __VA_ARGS__)
1830 #define SRP_LOG_ERRMSG(msg) srp_log(SR_LL_ERR, msg)
1837 #define SRP_LOG_WRNMSG(msg) srp_log(SR_LL_WRN, msg)
1844 #define SRP_LOG_INFMSG(msg) srp_log(SR_LL_INF, msg)
1851 #define SRP_LOG_DBGMSG(msg) srp_log(SR_LL_DBG, msg)
int sr_get_module_access(sr_conn_ctx_t *conn, const char *module_name, char **owner, char **group, mode_t *perm)
Learn about module filesystem permissions.
@ SR_SUBSCR_CTX_REUSE
This option enables the application to re-use an already existing subscription context previously ret...
int sr_cancel_update_module(sr_conn_ctx_t *conn, const char *module_name)
Cancel scheduled update of a module.
int sr_set_module_access(sr_conn_ctx_t *conn, const char *module_name, const char *owner, const char *group, mode_t perm)
Change module filesystem permissions.
int sr_lock(sr_session_ctx_t *session, const char *module_name)
Locks the data of the specified module or the whole datastore.
enum sr_get_oper_flag_e sr_get_oper_flag_t
Flags used to override default data get behaviour on SR_DS_OPERATIONAL by sr_get_data call.
const char * sr_strerror(int err_code)
Returns the error message corresponding to the error code.
@ SR_SUBSCR_PASSIVE
The subscriber is not the "owner" of the subscribed data tree, just a passive watcher for changes....
int sr_update_module(sr_conn_ctx_t *conn, const char *schema_path, const char *search_dirs)
Update an installed schema (module) to a new revision. Deferred until there are no connections!
int(* sr_rpc_cb)(sr_session_ctx_t *session, const char *xpath, const sr_val_t *input, const size_t input_cnt, sr_event_t event, uint32_t request_id, sr_val_t **output, size_t *output_cnt, void *private_data)
Callback to be called for the delivery of an RPC/action. Data are represented as sr_val_t structures.
int(* sr_diff_check_cb)(sr_session_ctx_t *session, const struct lyd_node *diff)
Callback to be called before applying a diff. Set it using sr_set_diff_check_callback.
@ SR_SUBSCR_DEFAULT
Default behavior of the subscription. In case of sr_module_change_subscribe call it means that:
sr_datastore_e
Datastores that sysrepo supports. To change which datastore a session operates on,...
sr_move_position_e
Options for specifying move direction of sr_move_item call.
void sr_set_diff_check_callback(sr_conn_ctx_t *conn, sr_diff_check_cb callback)
Set callback for checking every diff before it is applied on the datastore. The diff is final (only C...
void sr_free_val(sr_val_t *value)
Free sr_val_t structure and all memory allocated within it.
void(* sr_event_notif_cb)(sr_session_ctx_t *session, const sr_ev_notif_type_t notif_type, const char *xpath, const sr_val_t *values, const size_t values_cnt, time_t timestamp, void *private_data)
Callback to be called for the delivery of a notification. Data are represented as sr_val_t structures...
void(* sr_log_cb)(sr_log_level_t level, const char *message)
Sets callback that will be called when a log entry would be populated.
int sr_event_notif_subscribe(sr_session_ctx_t *session, const char *module_name, const char *xpath, time_t start_time, time_t stop_time, sr_event_notif_cb callback, void *private_data, sr_subscr_options_t opts, sr_subscription_ctx_t **subscription)
Subscribe for the delivery of a notification(s). Data are represented as sr_val_t structures.
struct sr_error_info_s sr_error_info_t
Detailed sysrepo session error information.
int sr_get_subtree(sr_session_ctx_t *session, const char *path, uint32_t timeout_ms, struct lyd_node **subtree)
Retrieve a single subtree whose root node is selected by the provided path. Data are represented as l...
enum sr_datastore_e sr_datastore_t
Datastores that sysrepo supports. To change which datastore a session operates on,...
uint32_t sr_conn_options_t
Options overriding default connection handling by sr_connect call, it is supposed to be bitwise OR-ed...
@ SR_SUBSCR_UPDATE
The subscriber will be called before any other subscribers for the particular module with an addition...
sr_log_level_t sr_log_get_stderr(void)
Learn current standard error output log level.
@ SR_SUBSCR_OPER_MERGE
Instead of removing any previous existing matching data before getting them from an operational subsc...
enum sr_type_e sr_type_t
Possible types of a data element stored in the sysrepo datastore.
void sr_session_set_nc_id(sr_session_ctx_t *session, uint32_t nc_sid)
Set a NETCONF session ID for a sysrepo session. Any application callbacks handling operations initiat...
sr_conn_flag_e
Flags used to override default connection handling by sr_connect call.
int sr_session_set_user(sr_session_ctx_t *session, const char *user)
Set the effective user of a session to a different one that the process owner.
int(* sr_oper_get_items_cb)(sr_session_ctx_t *session, const char *module_name, const char *path, const char *request_xpath, uint32_t request_id, struct lyd_node **parent, void *private_data)
Callback to be called when operational data at the selected xpath are requested. Data are represented...
int sr_remove_module(sr_conn_ctx_t *conn, const char *module_name)
Remove an installed module from sysrepo. Deferred until there are no connections!
uint32_t sr_subscr_options_t
Options overriding default behavior of subscriptions, it is supposed to be a bitwise OR-ed value of a...
int sr_disconnect(sr_conn_ctx_t *conn)
Disconnect from the sysrepo datastore.
sr_ev_notif_type_e
Type of the notification passed to the sr_event_notif_cb and sr_event_notif_tree_cb callbacks.
@ SR_CONN_ERR_ON_SCHED_FAIL
void(* srp_cleanup_cb_t)(sr_session_ctx_t *session, void *private_data)
Sysrepo plugin cleanup callback.
void sr_log_syslog(const char *app_name, sr_log_level_t log_level)
Enables / disables / changes log level (verbosity) of logging to system log.
sr_subscr_flag_e
Flags used to override default handling of subscriptions.
enum sr_move_position_e sr_move_position_t
Options for specifying move direction of sr_move_item call.
void sr_log_set_cb(sr_log_cb log_callback)
Sets callback that will be called when a log entry would be populated. Callback will be called for ev...
@ SR_CONN_NO_SCHED_CHANGES
sr_type_e
Possible types of a data element stored in the sysrepo datastore.
int sr_rpc_send(sr_session_ctx_t *session, const char *path, const sr_val_t *input, const size_t input_cnt, uint32_t timeout_ms, sr_val_t **output, size_t *output_cnt)
Send an RPC/action and wait for the result. Data are represented as sr_val_t structures.
int sr_apply_changes(sr_session_ctx_t *session, uint32_t timeout_ms, int wait)
Apply changes made in the current session. In case the changes could not be applied successfully for ...
int sr_get_items(sr_session_ctx_t *session, const char *xpath, uint32_t timeout_ms, const sr_get_oper_options_t opts, sr_val_t **values, size_t *value_cnt)
Retrieve an array of data elements selected by the provided XPath. Data are represented as sr_val_t s...
sr_datastore_t sr_session_get_ds(sr_session_ctx_t *session)
Learn the datastore a session operates on.
sr_log_level_t
Log levels used to determine if message of certain severity should be printed.
int sr_move_item(sr_session_ctx_t *session, const char *path, const sr_move_position_t position, const char *list_keys, const char *leaflist_value, const char *origin, const sr_edit_options_t opts)
Prepare to move/create the instance of an user-ordered list or leaf-list to the specified position....
int sr_get_module_info(sr_conn_ctx_t *conn, struct lyd_node **sysrepo_data)
Get internal sysrepo data tree, which holds information about installed modules. These data are from ...
int sr_session_notif_buffer(sr_session_ctx_t *session)
Use notification buffering for the session.
enum sr_subscr_flag_e sr_subscr_flag_t
Flags used to override default handling of subscriptions.
struct sr_subscription_ctx_s sr_subscription_ctx_t
Sysrepo subscription context returned from sr_*_subscribe calls, it is supposed to be released by the...
uint32_t sr_session_get_nc_id(sr_session_ctx_t *session)
Learn NETCONF session ID from a sysrepo session. Either reads back the value set by sr_session_set_nc...
enum sr_change_oper_e sr_change_oper_t
Type of the operation made on an item, used by changeset retrieval in sr_get_change_next.
int sr_set_error(sr_session_ctx_t *session, const char *path, const char *format,...)
Set detailed error information into provided session. Used to notify the client library about errors ...
@ SR_CONTAINER_PRESENCE_T
@ SR_SUBSCR_DONE_ONLY
The subscriber does not support verification of the changes and wants to be notified only after the c...
int sr_get_error(sr_session_ctx_t *session, const sr_error_info_t **error_info)
Retrieve information about the error that has occurred during the last operation executed within prov...
int sr_event_notif_send(sr_session_ctx_t *session, const char *path, const sr_val_t *values, const size_t values_cnt)
Send a notification. Data are represented as sr_val_t structures. In case there are particularly many...
sr_error_info_msg_t * err
@ SR_SUBSCR_ENABLED
The subscriber wants to be notified about the current configuration at the moment of subscribing....
int sr_connect(const sr_conn_options_t opts, sr_conn_ctx_t **conn)
Connects to the sysrepo datastore. If possible (no other connections exist), also apply any scheduled...
int sr_copy_config(sr_session_ctx_t *session, const char *module_name, sr_datastore_t src_datastore, uint32_t timeout_ms, int wait)
Replaces a conventional datastore with the contents of another conventional datastore....
sr_error_e
Sysrepo error codes.
void sr_log_stderr(sr_log_level_t log_level)
Enables / disables / changes log level (verbosity) of logging to standard error output.
int sr_get_item(sr_session_ctx_t *session, const char *path, uint32_t timeout_ms, sr_val_t **value)
Retrieve a single data element selected by the provided path. Data are represented as sr_val_t struct...
int(* srp_init_cb_t)(sr_session_ctx_t *session, void **private_data)
Sysrepo plugin initialization callback.
struct sr_session_ctx_s sr_session_ctx_t
Sysrepo session on a connection.
int sr_rpc_subscribe(sr_session_ctx_t *session, const char *xpath, sr_rpc_cb callback, void *private_data, uint32_t priority, sr_subscr_options_t opts, sr_subscription_ctx_t **subscription)
Subscribe for the delivery of an RPC/action. Data are represented as sr_val_t structures.
int(* sr_module_change_cb)(sr_session_ctx_t *session, const char *module_name, const char *xpath, sr_event_t event, uint32_t request_id, void *private_data)
Callback to be called on the event of changing datastore content of the specified module.
enum sr_edit_flag_e sr_edit_flag_t
Flags used to override default behavior of data manipulation calls.
int sr_delete_item(sr_session_ctx_t *session, const char *path, const sr_edit_options_t opts)
Prepare to selete the nodes matching the specified xpath. These changes are applied only after callin...
enum sr_conn_flag_e sr_conn_flag_t
Flags used to override default connection handling by sr_connect call.
int sr_install_module_data(sr_conn_ctx_t *conn, const char *module_name, const char *data, const char *data_path, LYD_FORMAT format)
Set newly installed module startup and running data. It is necessary in case empty data are not valid...
sr_conn_ctx_t * sr_session_get_connection(sr_session_ctx_t *session)
Get the connection the session was created on.
A single, detailed error message. Used in sr_error_info_s.
Data of an element (if applicable), properly set according to the type.
int sr_oper_get_items_subscribe(sr_session_ctx_t *session, const char *module_name, const char *path, sr_oper_get_items_cb callback, void *private_data, sr_subscr_options_t opts, sr_subscription_ctx_t **subscription)
Register for providing operational data at the given xpath.
int sr_edit_batch(sr_session_ctx_t *session, const struct lyd_node *edit, const char *default_operation)
Provide a prepared edit data tree to be applied. These changes are applied only after calling sr_appl...
int sr_rpc_send_tree(sr_session_ctx_t *session, struct lyd_node *input, uint32_t timeout_ms, struct lyd_node **output)
Send an RPC/action and wait for the result. Data are represented as libyang subtrees.
sr_change_oper_e
Type of the operation made on an item, used by changeset retrieval in sr_get_change_next.
struct sr_change_iter_s sr_change_iter_t
Iterator used for retrieval of a changeset using sr_get_changes_iter call.
int sr_get_changes_iter(sr_session_ctx_t *session, const char *xpath, sr_change_iter_t **iter)
Create an iterator for retrieving the changes (list of newly added / removed / modified nodes) in mod...
enum sr_ev_notif_type_e sr_ev_notif_type_t
Type of the notification passed to the sr_event_notif_cb and sr_event_notif_tree_cb callbacks.
int sr_discard_changes(sr_session_ctx_t *session)
Discard prepared changes made in the current session.
struct sr_val_s sr_val_t
Structure that contains value of an data element stored in the sysrepo datastore.
const struct ly_ctx * sr_get_context(sr_conn_ctx_t *conn)
Get the libyang context used by a connection. Can be used in an application for working with data and...
@ SR_SUBSCR_NO_THREAD
There will be no thread created for handling this subscription meaning no event will be processed!...
sr_event_e
Type of the event that has occurred (passed to application callbacks).
void sr_free_values(sr_val_t *values, size_t count)
Free array of sr_val_t structures (and all memory allocated within of each array element).
int sr_disable_module_feature(sr_conn_ctx_t *conn, const char *module_name, const char *feature_name)
Disable a module feature. Deferred until there are no connections!
int sr_set_module_replay_support(sr_conn_ctx_t *conn, const char *module_name, int replay_support)
Change module replay support.
struct sr_error_info_msg_s sr_error_info_msg_t
A single, detailed error message. Used in sr_error_info_s.
int sr_enable_module_feature(sr_conn_ctx_t *conn, const char *module_name, const char *feature_name)
Enable a module feature. Deferred until there are no connections!
int sr_unlock(sr_session_ctx_t *session, const char *module_name)
Unlocks the data of the specified module or the whole datastore.
sr_edit_flag_e
Flags used to override default behavior of data manipulation calls.
int sr_get_change_next(sr_session_ctx_t *session, sr_change_iter_t *iter, sr_change_oper_t *operation, sr_val_t **old_value, sr_val_t **new_value)
Return the next change from the provided iterator created by sr_get_changes_iter call....
@ SR_SUBSCR_UNLOCKED
The subscriber wants to modify other subscriptions in its callback. Normally, this would cause deadlo...
int sr_session_stop(sr_session_ctx_t *session)
Stop current session and releases resources tied to the session.
int sr_get_change_tree_next(sr_session_ctx_t *session, sr_change_iter_t *iter, sr_change_oper_t *operation, const struct lyd_node **node, const char **prev_value, const char **prev_list, bool *prev_dflt)
Returns the next change from the provided iterator created by sr_get_changes_iter call....
int sr_get_lock(sr_conn_ctx_t *conn, sr_datastore_t datastore, const char *module_name, int *is_locked, uint32_t *id, uint32_t *nc_id, time_t *timestamp)
Check whether the data of the specified module or the whole datastore are locked.
uint32_t sr_get_oper_options_t
Options overriding default get handling by sr_get_data call, it is supposed to be bitwise OR-ed value...
int sr_session_switch_ds(sr_session_ctx_t *session, sr_datastore_t ds)
Change datastore which the session operates on. All subsequent calls will be issued on the chosen dat...
int sr_connection_count(uint32_t *conn_count)
Learn the current global number of (some possibly dead) connections.
int sr_session_start(sr_conn_ctx_t *conn, const sr_datastore_t datastore, sr_session_ctx_t **session)
Start a new session.
enum sr_error_e sr_error_t
Sysrepo error codes.
int sr_set_item_str(sr_session_ctx_t *session, const char *path, const char *value, const char *origin, const sr_edit_options_t opts)
Prepare to set (create) the value of a leaf, leaf-list, list, or presence container....
int sr_validate(sr_session_ctx_t *session, const char *module_name, uint32_t timeout_ms)
Perform the validation a datastore and any changes made in the current session, but do not apply nor ...
int sr_rpc_subscribe_tree(sr_session_ctx_t *session, const char *xpath, sr_rpc_tree_cb callback, void *private_data, uint32_t priority, sr_subscr_options_t opts, sr_subscription_ctx_t **subscription)
Subscribe for the delivery of an RPC/action. Data are represented as libyang subtrees.
Detailed sysrepo session error information.
sr_get_oper_flag_e
Flags used to override default data get behaviour on SR_DS_OPERATIONAL by sr_get_data call.
int sr_set_item(sr_session_ctx_t *session, const char *path, const sr_val_t *value, const sr_edit_options_t opts)
Prepare to set (create) the value of a leaf, leaf-list, list, or presence container....
int sr_dup_changes_iter(sr_session_ctx_t *session, const char *xpath, sr_change_iter_t **iter)
Create an iterator for retrieving the changes (list of newly added / removed / modified nodes) in mod...
@ SR_EV_NOTIF_REPLAY_COMPLETE
int(* sr_rpc_tree_cb)(sr_session_ctx_t *session, const char *op_path, const struct lyd_node *input, sr_event_t event, uint32_t request_id, struct lyd_node *output, void *private_data)
Callback to be called for the delivery of an RPC/action. Data are represented as libyang subtrees.
uint32_t sr_edit_options_t
Options overriding default behavior of data manipulation calls, it is supposed to be bitwise OR-ed va...
void srp_log(sr_log_level_t ll, const char *format,...)
const char * sr_get_repo_path(void)
Get the common path prefix for all sysrepo files.
uint32_t sr_session_get_id(sr_session_ctx_t *session)
Return the assigned session ID of the sysrepo session.
int sr_event_notif_subscribe_tree(sr_session_ctx_t *session, const char *module_name, const char *xpath, time_t start_time, time_t stop_time, sr_event_notif_tree_cb callback, void *private_data, sr_subscr_options_t opts, sr_subscription_ctx_t **subscription)
Subscribes for the delivery of a notification(s). Data are represented as libyang subtrees.
union sr_data_u sr_data_t
Data of an element (if applicable), properly set according to the type.
int sr_event_notif_send_tree(sr_session_ctx_t *session, struct lyd_node *notif)
Send a notification. Data are represented as libyang subtrees. In case there are particularly many no...
int sr_replace_config(sr_session_ctx_t *session, const char *module_name, struct lyd_node *src_config, uint32_t timeout_ms, int wait)
Replace a datastore with the contents of a data tree. If the module is specified, limit the operation...
const char * sr_session_get_user(sr_session_ctx_t *session)
Get the effective user of a session.
void(* sr_event_notif_tree_cb)(sr_session_ctx_t *session, const sr_ev_notif_type_t notif_type, const struct lyd_node *notif, time_t timestamp, void *private_data)
Callback to be called for the delivery of a notification. Data are represented as libyang subtrees.
struct sr_conn_ctx_s sr_conn_ctx_t
Sysrepo connection.
enum sr_event_e sr_event_t
Type of the event that has occurred (passed to application callbacks).
int sr_get_event_pipe(sr_subscription_ctx_t *subscription, int *event_pipe)
Get the event pipe of a subscription. Do not call unless SR_SUBSCR_NO_THREAD flag was used when subsc...
int sr_has_changes(sr_session_ctx_t *session)
Learn whether there are any prepared non-applied changes in the session.
int sr_unsubscribe(sr_subscription_ctx_t *subscription)
Unsubscribes from a subscription acquired by any of sr_*_subscribe calls and releases all subscriptio...
int sr_process_events(sr_subscription_ctx_t *subscription, sr_session_ctx_t *session, time_t *stop_time_in)
Process any pending new events on a subscription. Should not be called unless SR_SUBSCR_NO_THREAD fla...
sr_log_level_t sr_log_get_syslog(void)
Learn current system log log level.
@ SR_ERR_VALIDATION_FAILED
int sr_install_module(sr_conn_ctx_t *conn, const char *schema_path, const char *search_dirs, const char **features, int feat_count)
Install a new schema (module) into sysrepo. Deferred until there are no connections!
void sr_free_change_iter(sr_change_iter_t *iter)
Frees sr_change_iter_t iterator and all memory allocated within it.
int sr_module_change_subscribe(sr_session_ctx_t *session, const char *module_name, const char *xpath, sr_module_change_cb callback, void *private_data, uint32_t priority, sr_subscr_options_t opts, sr_subscription_ctx_t **subscription)
Subscribe for changes made in the specified module. If there are changes made in several modules,...
@ SR_ERR_OPERATION_FAILED
Structure that contains value of an data element stored in the sysrepo datastore.
int sr_get_data(sr_session_ctx_t *session, const char *xpath, uint32_t max_depth, uint32_t timeout_ms, const sr_get_oper_options_t opts, struct lyd_node **data)
Retrieve a tree whose root nodes match the provided XPath. Data are represented as libyang subtrees.