CLI Introduction

The YumaPro SDK programs support many configuration parameters. Many of the parameters are shared by multiple programs. They are documented in the next section..

The configuration parameters for each YumaPro program are also documented here, each in their own section.

CLI Parameter YANG Modules

All YumaPro configuration parameters are defined with YANG structures. The name of the program is also the name of the YANG module containing the CLI definitions.

• netconfd-pro.yang

• yangcli-pro.yang

• yangdiff-pro.yang

• yangdump-pro.yang

CLI Parameter Section Structure

Each CLI parameter is defined in its own section in this document.

Example CLI Section

--example-parameter

The --example-parameter parameter ...

[description section]

leaf example-parameter {
    type boolean;
    default false;
}

Syntax	boolean
Default:	false
Min Allowed:	0
Max Allowed:	1
Supported by:	netconfd-pro
Example:	netconfd-pro --example-parameter=true

CLI Parameter Section Heading

The section heading consists of two dash '-' characters, followed by the CLI parameter name.

Example Document Heading:

--example-parameter

CLI Parameter Section Description

The section description is based on the YANG module description for the parameter. It often contains additional details not found in the YANG module, including examples.

CLI Parameter YANG Summary

The YANG summary is a small YANG snippet for a leaf or a leaf-list, that represents the YANG syntax and default value if one is defined.

Note

The YANG snippets shown have the "description" removed and contents moved to regular text.

Example YANG Summary:

leaf example-parameter {
    type boolean;
    default false;
}

CLI Parameter Usage Summary

The usage summary is a small formatted table that summarizes the YANG parameter usage.

Example YANG Summary:

Syntax	boolean
Default:	false
Recommend:	false
Min Allowed:	0
Max Allowed:	1
Introduced:	23.10-6
Supported by:	netconfd-pro
Example:	netconfd-pro --example-parameter=true

Syntax

This row specifies the base YANG type for the parameter. If the type is 'enum' then the enum values will also be listed.

Default

This row specifies the YANG default value for the parameter. The string 'none' is used if there is no YANG default defined.

Note

The YANG default value is usually selected for backward compatibility. This means the default parameter behavior is the same as before the parameter was defined.

Recommend

This row specifies the recommended value for the parameter. The string 'none' is used if there is no recommended value. This value is often the same as default value. This row may not be present in this case.

Min-Allowed

This row specifies the minimum number of instances of the parameter expected.

• Optional Parameter: the value '0' is used

• Mandatory Parameter: the value '1' is used

Max-Allowed

This row specifies the maximum number of instances of the parameter expected.

• Leaf Parameter: the value '1' is used

• Leaf-list Parameter: the value 'unlimited' is used, or a number representing an implementation limit is used

Introduced

This row specifies the YumaPro release (or just release train) when the parameter was first introduced.

• If this row is missing then the parameter was introduced before all current release trains and should be available in all releases.

• All branches with a higher release number also contain the parameter. For example, a parameter added to '22.10-17' is also available in '23.10-5' and '23.10T-5'.

Supported by

This row specifies the program names that support the parameter.

• netconfd-pro

• yangcli-pro

• yangdiff-pro

• yangdump-pro

• sil-sa-app

• db-api-app

• combo-app

Example

This row shows a simple example of the parameter usage.