ypgnmi-app Usage

The following sections describe the steps to run and test ypgnmi-app application.

Running Ypgnmi-app

Run the server with the setting --with-gnmi=true flag as follows:

mydir> netconfd-pro --log-level=debug4 --with-gnmi=true

Start the ypgnmi-app application. Note that you have to provide your certificates to start the application:

mydir> ypgnmi-app -cert ~/certs/server.crt -ca ~/certs/ca.crt -key ~/certs/server.key -log-level=debug

Note

Use -fileloc-fhs flag if you started the netconfd-pro server in privileged mode

After this step, the gNMI server starts to listen for any gNMI client requests and will process the requests to the netconfd-pro server and will transfer all the replies back.

Running gNMI Client Applications

The gRPC Network Management/Operations Interface Tools (gNXI Tools) provides basic applications to connect to the server and can be used to test the system. Install the gNXI Tools using the 'go get' and 'go install' tools.

mydir> go get github.com/google/gnxi/gnmi_get
mydir> go install github.com/google/gnxi/gnmi_get
mydir> go get github.com/google/gnxi/gnmi_capabilities
mydir> go install github.com/google/gnxi/gnmi_capabilities
mydir> go get github.com/google/gnxi/gnmi_set
mydir> go install github.com/google/gnxi/gnmi_set

Running CAPABILITY Request

The gNMI CAPABILITY request allows you to query a gNMI-enabled device for its capabilities. Capabilities can include information about the device like the gNMI version it supports, the data models it uses, and additional vendor-specific information.

Pre-requisites

Make sure you have a running ypgnmi-app and netconfd-pro to interact with. gNMI client software installed on your machine (you can use open-source clients like (gnmi_capabilities) or develop your client).

Procedure

Connected ypgnmi-app to the netconfd-pro server

Run the Capability Request: Use the gNMI client's capability command to request capabilities from the server.

mydir> gnmi_capabilities \
  --target_addr 127.0.0.1:10161  \
  --target_name restconf \
  --ca ~/certs/ca.crt \
  --key ~/certs/client.key \
  --cert ~/certs/client.crt

Alternatively, if you're using a custom client, make sure to invoke the Capability method provided by the gNMI gRPC service.

Sample Output

The gNMI server will respond with a list of its capabilities. This could include information such as supported data models, gNMI versions, and any additional vendor-specific capabilities.

Here is a simplified example of what the output might look like:

gNMI version: 0.7.0
supported models:
- name: openconfig-interfaces
   version: "1.0.0"
- name: openconfig-system
   version: "1.0.0"

Troubleshooting

Connection Errors: If you can't establish a connection, double-check your server address and port. Also, ensure that the server is running and accessible from your client machine.

Unsupported Capabilities: If the server does not list a capability you expected, it's possible that the particular version of the gNMI server you're interacting with does not support that capability.

Further Reading

For more details about gNMI and the Capability request, you can consult the (official gNMI specification).

Running GET Request

The gNMI GET request allows you to query the state information from a gNMI-enabled device. You can use this request to fetch data, whether it's operational data, configuration data, or any other data that the device exposes through gNMI.

Pre-requisites

Make sure you have a running ypgnmi-app and netconfd-pro to interact with. gNMI client software installed on your machine. You can use open-source clients like (gnmi_get), or you might have your custom client.

Procedure

Connected ypgnmi-app to the netconfd-pro server

Run the Get Request: Use the gNMI client's get command to request capabilities from the server.

mydir> gnmi_get \
  --target_addr 127.0.0.1:10161 \
  --target_name restconf \
  --ca ~/certs/ca.crt \
  --key ~/certs/client.key \
  --cert ~/certs/client.crt \
  --xpath "/uint16.1"

If you're using a custom client, you will need to call the Get RPC method of the gNMI service.

XPath parameter values are just sample paths of the nodes. Use real paths that represent real nodes in YANG modules that are loaded into the netconfd-pro server.

Set the '--xpath' parameter to a real node to retrieve.

Sample Output

After you issue the GET request, the server will respond with the data associated with the path you queried. This can include configuration values, operational statistics, or other data depending on what you requested.

Here's a simplified example output:

== GetResponse:
notification: <
   timestamp: 1697157269962932559
   update: <
      path: <
         elem: <
            name: "uint16.1"
         >
      >
      val: <
         json_ietf_val: "42"
      >
   >
>

Troubleshooting

Path Errors: If you get an error regarding the path, double-check your syntax. Make sure the path you specified is correct and supported by the server.

Data Unavailable: If the server responds that the data is unavailable, it's possible that the path you're querying does not exist or is not supported.

Further Reading

For more details about gNMI and the Capability request, you can consult the (official gNMI specification).

Running SET Request

The gNMI SET request is used to modify the configuration or state of a gNMI-enabled network device. With a SET request, you can update, replace, or delete specific data elements on the device.

Pre-requisites

Make sure you have a running ypgnmi-app and netconfd-pro to interact with. gNMI client software installed on your machine. You can use open-source clients like (gnmi_set), or you might have your custom client.

Procedure

Connected ypgnmi-app to the netconfd-pro server

Run the Set Request: Use the gNMI client's set command to request capabilities from the server.

mydir> gnmi_set \
  --target_addr localhost:10161 \
  --target_name restconf \
  --ca ~/certs/ca.crt \
  --key ~/certs/client.key \
  --cert ~/certs/client.crt \
  --delete /system/openflow/agent/config/max-backoff \
  --delete /system/openflow/agent/config/max-backoff2 \
  --replace /system/clock:@/mydir/clock-config.json \
  --update /system/clock/config/timezone-name:@/mydir/clock-config2.json

XPath parameter values are just sample paths of the nodes. Use your real paths that represent your real nodes in YANG modules that you loaded into the netconfd-pro server. Set the --delete, --update, --replace parameter paths with real nodes that you want to edit.

The clock-config.json input file to replace container “clock” might look as follows.

{
  "clock": {
    "timezone-name": "Europe/Stockholm"
  }
}

The clock-config2.json input file to update a lead “timezone-name” might look as follows:

{
    "timezone-name": "ETZ"
}

In addition, you may use the following gNMI client for sending SET requests.

Refer to OpenConfig gNMI for more details.

To run gNMI requests using the following client, for example, SET and Subscribe request:

mydir> gnmi_cli \
  --address localhost:10161 \
  --server_name restconf \
  --ca_crt ~/certs/ca.crt \
  --client_crt ~/certs/client.crt \
  --client_key ~/certs/client.key \
  --set --delete="/person"

In a custom client, you'd make a call to the Set RPC method provided by the gNMI service.

Sample Output

After running the SET request, you should get a response from the server indicating whether the operation was successful.

Here's a simplified example output:

response: <
   path: <
      elem: < name: "interfaces" >
      elem: <name: "interface" key: <key: "name" value: "eth0" > >
      elem: <name: "config" >
      elem: <name: "enabled" > >
   op: UPDATE
>

Troubleshooting

Path Errors: Double-check your path and syntax if you get a path-related error.

Operation Failure: If the SET operation fails, the error message should give you clues about what went wrong. This could be due to permission issues, unsupported data paths, or incorrect values.

Further Reading

For an in-depth look at the SET request in gNMI, check out the (official gNMI specification).

Closing ypgnmi-app

The ypgnmi-app can be shut down by typing Ctrl-C in the window that started the application.

If the netconfd-pro server is not running when ypgnmi-app is started the application will terminate with an error message stating that the netconfd-pro server is not running.

If the netconfd-pro server is shut down then ypgnmi-app will also shutdown.

ypgnmi-app Usage

Running Ypgnmi-app

Running gNMI Client Applications

Running CAPABILITY Request

Running GET Request

Running SET Request

Running SUBSCRIBE Request

ONCE Subscription Mode

POLL Subscription Mode

STREAM Subscription Mode

Sampled STREAM Subscription

On Change STREAM Subscription

Closing ypgnmi-app