ndndpdk-ctrl

ndndpdk-ctrl

Command ndndpdk-ctrl controls the running NDN-DPDK service via GraphQL. Run ndndpdk-ctrl help to show the available subcommands.

Most subcommands print to stdout in ndjson format. You may use jq or gron for further processing.

GraphQL Schema and Queries

The default GraphQL endpoint of the NDN-DPDK service is http://127.0.0.1:3030/. You may change it by passing the --gqlserver flag to both ndndpdk-svc and this command.

GraphQL service schema is published online. You can also discover the schema via introspection. With the NDN-DPDK service running (does not need to be activated), run:

npx -y graphqurl http://127.0.0.1:3030/ --introspect > ndndpdk-svc.graphql

You can view the GraphQL query prepared by this command via the --cmdout flag. For example:

ndndpdk-ctrl --cmdout show-version

Note that the --gqlserver and --cmdout flags must be specified between ndndpdk-ctrl and the subcommand name.

Important Note

The public interface of NDN-DPDK service is the GraphQL API, rather than this command. This command only exposes a subset of API functionality to perform certain common tasks with default settings. It is not intended to expose every feature or every output field that is possible with the API.

If you want additional functionality or more output fields, you should prepare and send GraphQL queries directly. There are many GraphQL tools such as graphqurl and Altair GraphQL Client that may be helpful.