File: README.md

package info (click to toggle)
sysrepo 4.5.1-1
  • links: PTS
  • area: main
  • in suites: experimental
  • size: 6,824 kB
  • sloc: ansic: 86,774; sh: 145; makefile: 29
file content (60 lines) | stat: -rw-r--r-- 1,859 bytes parent folder | download | duplicates (4)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60

## Examples
To try most important API functions in some basic use-case there are example applications that can be used either on
their own or with the **examples.yang** module. To use this module you first need to install it using
`sysrepoctl -i examples.yang`. Then the following specific examples should work.

### Configuration Data

```
application_changes_example examples
```
This will listen for configuration changes in *<running>* of the *examples* module. It will also block the terminal,
so use another one to continue.
___

```
sr_set_item_example /examples:cont/l value
```
This will set */examples:cont/l* to *value*. You should see information about this in the first terminal.

### Operational State Data

```
oper_data_pull_example examples /examples:stats
```
This will subscribe for providing *<operational>* data */examples:stats* in the *examples* module. Use another terminal
to request the data.
___
```
sr_get_items_example /examples:*//. operational
```
This will request all *<operational>* data of the *examples* module.

### RPCs

```
rpc_subscribe_example /examples:oper
```
This will subscribe for handling RPC */examples:oper* and only for this RPC it also generates some output. Use another
terminal to send the RPC.
___
```
rpc_send_example /examples:oper
```
This will send the RPC */examples:oper*. You should see it being received in the first terminal and also
the returned output.

### Notifications

```
notif_subscribe_example examples
```
This will subscribe for all notifications from the *examples* module received. Another argument can be specified
to filter them. Use another terminal to send the notification.
___
```
notif_send_example /examples:notif val 25.22
```
This will send the notification */examples:notif* with input value *val* set to *25.22*. You should see it being
received in the first terminal.