3  CLI Reference

The ypgnmi-app program uses command line interface (CLI) parameters to control program behavior.

The following sections document all the CLI parameters relevant to this program, in alphabetical order.

3.1  --bind-address

The --bind-address parameter specifies the gNMI server binding. This is the address that the gNMI client will use top contact the gNMI server. By default the address is the local host and default port is 10161.

 

--bind-address parameter

 

Syntax

inet:ip-address : inet:port-number

Default:

:10161

Min Allowed:

0

Max Allowed:

1

Supported by:

ypgnmi-app

Example:

ypgnmi-app --bind-address=permissive

 

3.2  --ca

The --ca parameter specifies the gNMI server CA certificate file. The path to the CA certificate should be absolute.

 

--ca parameter

 

Syntax

filespec

Default:

none

Min Allowed:

1

Max Allowed:

1

Supported by:

ypgnmi-app

Example:

ypgnmi-app --ca=/tmp/ca.crt

 

 

 

 

3.3  --cert

The --cert parameter specifies the gNMI server certificate file. The path to the certificate should be absolute.

 

--cert parameter

 

Syntax

filespec

Default:

none

Min Allowed:

1

Max Allowed:

1

Supported by:

ypgnmi-app

Example:

ypgnmi-app --cert=/tmp/cert.crt

 

3.4  --fileloc-fhs

The --fileloc-fhs parameter specifies whether the ypgnmi-app should use Filesystem Hierarchy Standard (FHS) directory locations to create, store and use data and files. May need to run as root. If false then the server will use $HOME/.yumapro and other file locations to store application data and to access the netconfd-pro files.

 

--fileloc-fhs parameter

 

Syntax

boolean

Default:

false

Min Allowed:

0

Max Allowed:

1

Supported by:

ypgnmi-app

Example:

ypgnmi-app --fileloc-fhs=true

 

3.5  --key

The --key parameter specifies the gNMI server private key file. The path to the key should be absolute.

 

--key parameter

 

Syntax

filespec

Default:

none

Min Allowed:

1

Max Allowed:

1

Supported by:

ypgnmi-app

Example:

ypgnmi-app --key=/tmp/cert.crt

 

3.6  --log

The --log parameter specifies the file path of the application log. Filespec for the log file to use instead of STDOUT. Leave out to use STDOUT for log messages.

 

--log parameter

 

Syntax

filespec

Default:

none

Min Allowed:

0

Max Allowed:

1

Supported by:

ypgnmi-app

Example:

ypgnmi-app --log=/var/log/app-log.log

 

 

3.7  --log-console

The --log-console parameter directs that log output will be be sent to STDOUT, after being sent to the log file and/or local syslog daemon. (This assumes that --log parameter is present).

 

--log-console parameter

 

Syntax

boolean

Default:

none

Min Allowed:

0

Max Allowed:

1

Supported by:

ypgnmi-app

Example:

ypgnmi-app --log-console=true

 

3.8  --log-level

The --log-level parameter controls the verbosity level of messages printed to the log file or STDOUT, if no log file is specified.

The log levels are incremental, meaning that each higher level includes everything from the previous level, plus additional messages.

There are 4 settings that can be used:

 

--log-level parameter

 

Syntax

enumeration:
 error
 warn
ing
 info
 debug

Default:

info

Min Allowed:

0

Max Allowed:

1

Supported by:

ypgnmi-app

Example:

ypgnmi-app --log=/var/log/app-log.log \

     --log-level=debug

 

3.9  --server

The --server parameter specifies the netconfd-pro server IP address. The default is '127.0.0.1' if no value is specified.

 

--server parameter

 

Syntax

inet:ip-address

Default:

127.0.0.1

Min Allowed:

0

Max Allowed:

1

Supported by:

ypgnmi-app

Example:

ypgnmi-app --server=10.10.0.11

 

3.10  --server-id

The --server-id parameter specifies the server identifier to use when registering with the netconfd-pro server.  The default is 'server1' if no value is specified.

 

--server-id parameter

 

Syntax

string

Default:

server1

Min Allowed:

0

Max Allowed:

1

Supported by:

ypgnmi-app

Example:

ypgnmi-app --server-id=id-12

 

3.11  --service-id

The --service-id parameter specifies the service identifier to use when registering with the netconfd-pro server. The default is 'yp-gnmi' if no value is specified.

 

--service-id parameter

 

Syntax

string

Default:

yp-gnmi

Min Allowed:

0

Max Allowed:

1

Supported by:

ypgnmi-app

Example:

ypgnmi-app --service-id=service1

 

3.12  --subsys-id

The --subsys-id parameter specifies the subsystem identifier to use when registering with the netconfd-pro server. The default is 'yp-gnmi' if no value is specified.

 

--subsys-id parameter

 

Syntax

string

Default:

yp-gnmi

Min Allowed:

0

Max Allowed:

1

Supported by:

ypgnmi-app

Example:

ypgnmi-app --subsys-id=subsys1