Contents
1 AboutThis Guide
This document describes the functionality offered by each of the PDB Command Line Interface (CLI) commands.
1.1 Intended Audience
This guide is intended for end-users who interact with PDB using the CLI.
Personnel working on Ericsson products or systems must have the training and competence required to perform their work correctly.
1.1.1 Prerequisite Knowledge
Users of this document should have knowledge and experience of the following:
1.2 Conventions Used in This Guide
Table 1 provides a list of typographic conventions that may be encountered in this document:
|
Convention |
Description |
Example |
|---|---|---|
|
Code Examples |
Code examples |
stat char* months[] |
|
Command Variables |
You need to supply the values within the <> |
<home_directory> |
|
Document and File Names |
References to document titles or sections in a document and file names |
For more information, refer to the System Administrator Guide. Check the local runlog files (xxx.runlog and xxa.runlog) in the /var/log/xxx directory. |
|
GUI Objects |
GUI objects, such as menus, fields, and buttons, dialog boxes, and options |
On the File menu, click Exit. |
|
Key Combinations |
Key combinations |
Press Ctrl+X to delete the selected value.(1) |
|
Output Information |
Text displayed by the system |
System awaiting input |
|
Parameter/Configuration Values |
Parameter values (numbers, true/false, yes/no, and so on) |
To use this feature, the parameter must be set to true |
|
System Elements |
Command and parameter names, program names, path names, URLs, and directory names |
The files are located in E:\Test The files are located in /etc/opt/ericsson/bin. (2) |
|
User Input |
In this document when you are required to input content, the input content is displayed using this bold mono-spaced font. The content must be added exactly as shown. |
cd $HOME |
|
Line Break |
The arrow symbol (⇒) can be used when an inappropriate line break has been made. An inappropriate line break occurs when the code lines are too long to fit on the page, and there is no appropriate place for a line break. |
cd /opt/msmw-cds-⇒ cxp-<version> |
(1) The plus sign (+) indicates that you must
press the keys simultaneously.
(2) The use of the forward slash (/) is for Linux and UNIX
systems; Windows systems use the backslash (\).
(3) The use of the ⇒ symbol
(character entity ⇒) at the end of a line has a meaning to the
human reader, but if copied and pasted from a CPI document to a command
line interpreter the symbol must be cut from the code.
1.3 Prerequisites
The PDB CLI client is installed and properly configured.
For installation procedures, refer to the Parameter Database (PDB) Installation Instructions (Reference [1]).
For configuration procedures, refer to the PDB System Administration Guide (Reference [2]).
1.4 Comments About the Documentation
Ericsson encourages you to provide feedback, comments, or suggestions so that we can improve the documentation to better meet your needs. With your comments, provide the following:
- Document title
- Document number and revision
- Page number
Please send your comments to your local Ericsson Support.
2 Overview
The PDB CLI is a collection of command line tools that allows you to make use of the PDB functionality without having to log into a PDB server.
The CLI client is available on Linux and Microsoft® Windows® platforms. For detailed instructions on how to install the PDB CLI, refer to the Parameter Database (PDB) Installation Instructions (Reference [1]).
The CLI client acts as a front end for the CLI commands. You can retrieve the CLI version with the following option:
pdbcli --version
The following commands are available for use:
|
Command |
Description |
|
Compares a configuration file (extracted from a node) against a reference configuration in PDB.
| |
|
Compares two local configuration files.
| |
|
Lists configurations stored in PDB.
| |
|
Sets the status of a configuration revision.
| |
|
Applies one or more tags to a configuration revision stored in PDB.
| |
|
Removes one or more tags from a configuration revision stored in PDB.
| |
|
Converts a configuration between the supported formats.
| |
|
Generates a template file containing all the parameter variables required by a given configuration.
| |
|
Exports a configuration from the PDB server.
| |
|
Imports a new node configuration to the PDB database.
| |
|
Imports a new revision of an existing node configuration to the PDB database.
| |
|
Imports a new revision of an existing configuration schema to the PDB database.
| |
|
Creates a new revision of a node defined in PDB.
| |
|
Links a configuration revision to a node revision.
| |
|
Links a schema revision to a node revision.
| |
|
Compares two sets of schema files and provides a comparison report in Comma-Separated Values (CSV) format.
| |
|
Lists configuration schemas stored in PDB.
| |
|
Associates an IVL with a configuration schema stored in PDB. | |
|
Sets the status of a schema revision.
| |
|
Removes an IVL association from a configuration schema stored in PDB. | |
|
Exports a Site-Specific List (SSL) from the PDB server to an output file.
| |
|
Lists SSLs stored in PDB.
| |
|
Lists the variables in a specified SSL.
| |
|
Sets a new value for an existing SSL variable or creates a new SSL variable with the specified value.
| |
|
Deletes a SSL variable.
| |
|
Validates local configuration files and generates a validation report. Validation considers standard file syntax, format rules, and the limits set by the selected MIM files, including schematron rules.
| |
|
Validates MIM files and other support files like index and model. The validation considers both standard XML syntax and format rules that are part of the official MIM format definitions.
| |
|
Validates configuration files written in PVL format. The validation considers standard XML syntax, format rules established by the official definition of the PVL format, and the limits set by the selected MIM files.
|
Refer to the following sections for command and usage information.
2.1 CLI Help
All CLI commands have a help option that prints usage information.
To request help for a specific command, enter the following at the command line:
pdbcli [<command>] -h, --help
3 compare-configuration-file
compare-configuration-file compares a configuration file extracted from a node against a reference configuration defined in PDB. The command outputs a comparison report in CSV format. If the configurations are identical, this report is empty and the exit status will be 0.
- Note:
- This command requires connectivity with a PDB server and a valid PDB user account. For more information on configuring connectivity, refer to the PDB System Administration Guide (Reference [2]).
PDB includes a UNIX script called compare_live_node that automatically extracts a live node configuration and compares it against a reference configuration defined in PDB. For more information on compare_live_node, refer to Section 3.4.
3.1 Usage Syntax
pdbcli compare-configuration-file -n <configuration_name> [-r <revision>] -f <format> -c <input_configuration> [-v <variables_file>] [-R <validation_report_file>] -S <comparison_report_file> -u <user_name> [-p <password>]
3.2 Options
|
Option |
Description |
Notes |
|---|---|---|
|
-c, --configuration- |
Specifies the path and filename of a configuration file to use for the comparison. |
Mandatory. Paths can be relative or absolute. This command supports the comparison of multiple LDIF files. Multiple files are specified using additional -c options. |
|
-f, --format <arg> |
Specifies the format of the node configuration file. Possible formats include:
|
Mandatory. |
|
-n, --configuration- |
Specifies the name of a reference configuration in PDB. |
Mandatory. |
|
-p, --password <arg> |
The PDB user password. |
Optional. If omitted, the PDB CLI prompts for the password interactively. Passwords input at the prompt are masked. |
|
-r, --revision <arg> |
Specifies a revision of the reference configuration. The command defaults to the latest revision if this option is not used. |
Optional. |
|
-R, --validation- |
Before PDB compares against an external configuration it first performs a validation check on that configuration. compare-configuration-file can store the results of the validation in a plain-text file. Specifies a path and filename for the validation report. |
Optional. Paths can be relative or absolute. |
|
-S, --report-file <arg> |
Specifies a path and filename for the comparison report. |
Mandatory. Paths can be relative or absolute. The comparison report is generated in CSV format. |
|
-u, --username <arg> |
Specifies a valid PDB user name that is used to authenticate the CLI user in PDB. |
Mandatory. User accounts must be provisioned in the PDB authentication realm. User accounts must have the necessary permissions to access the selected objects. For more information on PDB access rights, refer to Access Control Lists in the PDB User Guide (Reference [3]). |
|
-v, --variables-file <arg> |
Specifies the path and filename of a variables list that can be used to resolve any parameter value variables in the reference configuration before comparing. |
Optional. Paths can be relative or absolute. The variables list is a user-defined CSV file that adheres to the following format, one variable per line: <name>,<value>,<description>,<usage> Use the create-variables-file CLI command to generate a file that you can populate with values. |
3.3 Examples
- Note:
- You must use double quotes <" "> to surround entries that have spaces.
Sample Command Usage on a Linux Platform
pdbcli compare-configuration-file -n CSCF_11B_R4G -f ldif -c Configurations/ldif/CSCF_11A_R4B.ldif -v ss_list.lst -S Comparisons/ldif_cscf11a_r4b.csv -u PDB_User -p pass
This command compares the latest revision of the CSCF_11B_R4G configuration to the CSCF_11A_R4B.ldif file using the ss_list.lst variables file and output the results to Comparisons/ldif_cscf11a_r4b.csv.
3.4 Automated Live Node Configuration Comparison
- Note:
- Automated live node configuration comparison is not offered through the PDB CLI.
PDB includes a UNIX script that can be used to automate the comparison of live node configurations in LDIF or NETCONF format. compare_live_node connects to a live node and automatically extracts the configuration data. Using the same logic as the compare-configuration-file CLI command, the script initiates a comparison of the live node configuration against a reference configuration defined in PDB and outputs a comparison report in CSV format. If the configurations are identical, this report is empty and the exit status will be 0.
compare_live_node requires connectivity with the designated live node as well as the PDB server. Live node connectivity is configured using a site-specific variables file that includes the destination IP address, port number, and login credentials. Use the create-variables-file CLI command to generate a file that you can populate with the necessary values.
Extracted node configurations are stored locally as follows:
- LDIF files are saved to the <pdbtools>/cli directory with the following naming convention:
config_from_node_<timestamp>.ldif
- NETCONF files are saved to the <pdbtools>/configtool directory with the following naming convention:
config_from_node_<timestamp>.xml
compare_live_node uses external scripts to extract live node configurations.
LDAP nodes are processed using a set of Parameter Comparison Application (PCA) extractor scripts that must be installed separately. For more information on installing the PCA extractors, refer to the Parameter Database (PDB) Installation Instructions (Reference [1]).
NETCONF nodes are processed using the PDB configtool and no further installation is necessary.
3.4.1 Usage Syntax
compare_live_node -n <configuration_name> [-r <revision>]
-v <variables_file> -a <node_application>
{[-f ldif -s <script_application>]|[-f netconf -t <type>]}
-R <report_file> -u <user> -p <password>
3.4.2 Options
|
Option |
Description |
Notes |
|---|---|---|
|
-a <node_application> |
Specifies the node application name as defined in PDB and the site-specific variables file. |
Mandatory. PDB prefixes LDAP and NETCONF variables with the associated application name. This name is necessary for the script to parse incoming variables. |
|
-f <format> |
Specifies the configuration format of the live node. Possible values include:
|
Mandatory. |
|
-n <configuration_name> |
Specifies the name of a reference configuration in PDB. |
Mandatory. |
|
-p <password> |
The PDB user password. |
Optional. If omitted, the PDB CLI prompts for the password interactively. Passwords input at the prompt are masked. |
|
-r <revision> |
Specifies a revision of the reference configuration. The command defaults to the latest revision if this option is not used. |
Optional. |
|
-R <report_file> |
Specifies a path and filename for the comparison report. |
Mandatory. Paths can be relative or absolute. The comparison report is generated in CSV format. |
|
-s <script_application> |
Specifies a script application to use for extracting the live configuration from an LDAP node. Possible values include:
|
Mandatory for the LDIF configuration format. The extractor scripts must be installed separately. For more information on installing the PCA extractors, refer to the Parameter Database (PDB) Installation Instructions (Reference [1]). |
|
-t <type> |
Specifies the platform type of the live node. Possible values include:
|
Mandatory for the NETCONF configuration format. |
|
-u <user> |
Specifies a valid PDB user name that is used to authenticate the CLI user in PDB. |
Mandatory. User accounts must be provisioned in the PDB authentication realm. User accounts must have the necessary permissions to access the selected objects. For more information on PDB access rights, refer to Access Control Lists in the PDB User Guide (Reference [3]). |
|
-v <variables_file> |
Specifies the path and filename of a variables list. compare_live_node uses the site-specific information contained in this file to resolve the destination IP address, port number, and login credentials for the live node as well as any site-specific variables used in the reference configuration before comparing. |
Mandatory. Paths can be relative or absolute. The variables list is a user-defined CSV file that adheres to the following format, one variable per line: <name>,<value>,<description>,<usage> Use the create-variables-file CLI command to generate a file that you can populate with values. |
3.4.3 Examples
- Note:
- You must use double quotes <" "> to surround entries that have spaces.
Sample Usage on a Linux Platform
./compare_live_node -n CSCF_11B_R4G_LDIF -v ldif.properties -a CSCF -f ldif -s cscf -R cscf_comparison.csv -u PDB_User -p pass
Compares the latest revision of the CSCF_11B_R4G configuration to the CSCF live node defined in ldif.properties and will output the results to ./cscf_comparison.csv.
./compare_live_node -n SBG_R1A -r PA3 -v netconf.properties -a SBG -f netconf -t is -R sbg_comparison.csv -u PDB_User -p pass
Compares the PA3 revision of the SBG_R1A configuration to the SBG live node defined in netconf.properties and will output the results to ./sbg_comparison.csv.
4 compare-local-configuration-files
compare-local-configuration-files compares two local configuration files to identify the differences between them. The command outputs a comparison report in CSV format. If the configurations are identical, this report is empty and the exit status will be 0.
When performing a comparison, this command distinguishes between an Original (Left) Configuration and a Target (Right) Configuration. The Original Configuration serves as a starting point for the comparison and is displayed on the left side of the comparison report. Data from the Original Configuration is compared against a Target Configuration that is displayed on the right side of the comparison report.
compare-local-configuration-files allows you to customize the comparison report with options specified in an input file (yaml format). Customization options include:
- Specifying Site Specific Lists
- Falling Back to Default Values
- Ignoring Letter Case
- Ignoring ReadOnly Attributes
- Filtering by Category
- Filtering by Managed Object Class (MOC)
- Setting the Comparison Direction
A template file that specifies the default comparison options (comparison-options.yaml) is provided with the PDB CLI. For more information on working with a comparison options file, refer to Section 4.4.
4.1 Usage Syntax
pdbcli compare-local-configuration-files -s <schema_files> -l <left_configuration_file> -L <left_configuration_format> -r <right_configuration_file> -R <right_configuration_format> [-T <solution_type> -M <moi_format> -o comparison-options-file] [-S <comparison_report_file>] [-V <validation_report_file>]
4.2 Options
|
Option |
Description |
Notes |
|---|---|---|
|
-l, |
Specifies a single configuration file or a directory containing configuration files to serve as the Original configuration on the left side of the comparison report. |
Mandatory. Paths can be relative or absolute. This option accepts only decompressed configuration files or a directory of decompressed files that constitute a single configuration. If selected, the directory is searched recursively for configuration files that may be present in subdirectories. Multiple files can be specified using additional -l options. |
|
-L, |
Specifies the format of the left configuration file. Possible formats include:
|
Mandatory. |
|
-M, --moi-format <arg> |
Specifies the MOI format of the PVL configuration files. Possible formats include:
|
Mandatory for PVL input files only. This selection applies to both the left and the right configuration. For more information on the PVL MOI format, refer to the Parameter List Template Description, EAB/FTI-08:0686 Uen. |
|
-o, |
Specifies a comparison options file (yaml format) to customize the comparison report. For more information on working with a comparison options file, refer to Section 4.4. |
Optional. Paths can be relative or absolute. |
|
-r, |
Specifies a single configuration file or a directory containing configuration files to serve as the Target configuration on the right side of the comparison report. |
Mandatory. Paths can be relative or absolute. This option accepts only decompressed configuration files or a directory of decompressed files that constitute a single configuration. If selected, the directory is searched recursively for configuration files that may be present in subdirectories. Multiple files can be specified using additional -r options. |
|
-R, |
Specifies the format of the right configuration file. Possible formats include:
|
Mandatory. |
|
-s, --schema-files <arg> |
Specifies a single MIM file or a directory containing MIM files to use as a schema for the selected configurations. |
Mandatory. Paths can be relative or absolute. This option accepts only descompressed MIM files or a directory of decompressed files that constitute a single schema. If selected, the directory is searched recursively for schema files that may be present in subdirectories. Multiple files can be specified using additional -s options. |
|
-S, --comparison- |
Specifies a path and filename for the comparison report. The output defaults to stdout if this option is not set. |
Optional Paths can be relative or absolute. The comparison report is generated in CSV format. |
|
-T, --solution-type <arg> |
Specifies which PVL parameter value set to compare. Possible solution types include:
|
Mandatory for PVL input files only. |
|
-V, --validation- |
Before comparing external configuration files, a validation check is performed on the configuration data. compare-local-configuration-files can store the results of the validation in a plain-text file. Specifies a path and filename for the validation report. |
Optional. Paths can be relative or absolute. |
4.3 Examples
- Note:
- You must use double quotes <" "> to surround entries that have spaces.
Sample Command Usage on a Linux Platform
pdbcli compare-local-configuration-files -s ../schemas/tsp_format.xml -l ../configs/pvl1.xml -L pvl -r ../configs/pvl2.xml -R pvl -T FIXED -M tsp -S ../reports/compare.csv
This command compares the FIXED parameter value set of two PVL configuration files using tsp_format.xml as the schema. The comparison report will be output to ../reports/compare.csv.
4.4 Working with a Comparison Options File
compare-local-configuration-files accepts an input file that allows you to customize the comparison report. A template file that specifies the default comparison options (comparison-options.yaml) is provided with the PDB CLI. Example 1 shows the contents of comparison-options.yaml.
Example 1 comparison-options.yaml
# This file is to be used in conjunction with the following command: compare-local-configuration-files
# The following options are specific to each configuration under comparison
#
# site_specific_list:
#
# Site specific lists are a collection of key/value pairs used to support variable definition in
# configuration files. They are used to resolve any site-specific variables in the configuration.
# Enter the filename, absolute or relative path to the .CSV file. Leave empty if not used.
#
# fallback_to_default_values:
#
# If a configuration element exist in one configuration but is absent on the other, this
# option attempts a match by falling back to the default value for the absent element, if available.
# Available options are: false, true. Default is 'false'.
left_configuration:
site_specific_list:
fallback_to_default_values: false
right_configuration:
site_specific_list:
fallback_to_default_values: false
# The following configuration applies to both left and right configuration
common_options:
# Consider the letter case when performing the comparison.
# Available options are: false, true. Default is 'false'.
case_insensitive: false
# Consider read-only parameters when performing the comparison.
# Available options are: false, true. Default is 'false'.
ignore_read_only: false
# Narrow down the comparison results by filtering based on parameter category.
# Available categories are: [Internal, Operator Configurable, Site Specific, Solution Integration].
# Note that 'include' acts as a white-list and 'exclude' as a black-list.
# The value is an array. Leave it as '[]' if not used.
filter_by_category:
include: []
exclude: []
# Narrow down the comparison results by filtering based on MOC (managed object class) name.
# Note that 'include' acts as a white-list and 'exclude' as a black-list.
# The value is an array. Example: [SwInventory, SwM, Fm, Pm, ExtNetSelPoolTableEntryClass]
# Leave it as '[]' if not used.
filter_by_moc_name:
include: []
exclude: []
# Specify in which direction the comparison is performed. Available options are:
# . both_sides - This is the default behavior. PDB examines differences in both configurations
# . left_to_right - PDB examines only what exist on the LEFT and is different on the RIGHT
# . right_to_left - PDB examines only what exist on the RIGHT and is different on the LEFT
comparison_direction: both_sidesTable 6 describes the comparison options in comparison-options.yaml.
|
Option |
Description |
Notes |
|---|---|---|
|
site_specific_list |
Specifies the path and filename of a variables list that can be used to resolve any parameter value variables in the Original (Left) or Target (Right) configurations before comparing. |
Optional. Paths can be relative or absolute. The variables list is a user-defined CSV file that adheres to the following format, one variable per line: <name>,<value>,<description>,<usage> Use the create-variables-file CLI command to generate a file that you can populate with values. |
|
fallback_to_default_ |
true/false When a configuration element is defined in one configuration but is absent from the other, this option attempts a match by falling back to the default value for the absent element, if available. |
Optional. Default: false. |
|
case_insensitive |
true/false Ignore the letter case of parameter values. |
Optional. Default: false. |
|
ignore_read_only |
true/false Ignore differences in ReadOnly parameters. |
Optional. Default: false. |
|
filter_by_category |
Filters the comparison results to include or exclude specific categories of parameters and parameter groups. Available categories include:
|
Optional. Specified as an array of comma-separated values. Leave it as '[]' if not used. |
|
filter_by_moc_name |
Filters the comparison results to include or exclude specific Managed Object Classes. |
Optional. Specified as an array of comma-separated values. Leave it as '[]' if not used. |
|
comparison_direction |
Configures how the comparison is performed.
|
Optional. Default: both_sides. |
To customize the comparison options:
- Locate the comparison-options.yaml template file in the <pdbtools>/cli directory.
- Make a copy of comparison-options.yaml for editing.
- Update the copy of comparison-options.yaml as needed. See Table 6.
- Save your changes and quit the editor.
- Use the updated copy of comparison-options.yaml when executing compare-local-configuration-files.
A customized comparison report is generated.
5 configuration-list
configuration-list connects to the PDB server and retrieves a list of node configurations that match the optional filters. If required, the list of configurations can be exported to a plain-text file for future use.
- Note:
- This command requires connectivity with a PDB server and a valid PDB user account. For more information on configuring connectivity, refer to the PDB System Administration Guide (Reference [2]).
The text file that is output by this command has the following format, one configuration per line:
/<root configuration>[/<delta configuration>[/...]], <revision>
By default, the configuration-list command will list all of the configurations that are visible to the selected user on the PDB server. This list can be filtered with the following options:
| Name | Only configurations with names that match the selected substring will be included. | |
| Owner | Only configurations with owners that match the selected substring will be included. | |
| Revision | Only configurations with revisions that match the selected substring will be included. | |
5.1 Usage Syntax
pdbcli configuration-list [-n <config_name>] [-r <config_revision>] [-O <config_owner>] [-o <output_file>] -u <user_name> [-p <password>]
5.2 Options
|
Option |
Description |
Notes |
|---|---|---|
|
-n, --config-name <arg> |
Specifies a substring to filter the list of configurations from PDB by name. |
Optional. Partial matches are supported. If any part of the configuration name matches this substring, it will be included. |
|
-o, --output <arg> |
Specifies the path and filename for a new plain-text output file containing the list of configurations. |
Optional. Paths can be relative or absolute. By default, the command outputs the matching configurations on screen. |
|
-O, --config-owner <arg> |
Specifies a substring to filter the list of configurations from PDB by owner. |
Optional. Partial matches are supported. If any part of the configuration owner matches this substring, it will be included. |
|
-p, --password <arg> |
The PDB user password. |
Optional. If omitted, the PDB CLI prompts for the password interactively. Passwords input at the prompt are masked. |
|
-r, --config-revision <arg> |
Specifies a substring to filter the list of configurations from PDB by revision level. This option can be set to “latest” to return only the latest revisions of the available configurations. |
Optional. Partial matches are supported. If any part of the configuration revision matches this substring, it will be included. |
|
-u, --username <arg> |
Specifies a valid PDB user name that is used to authenticate the CLI user in PDB. |
Mandatory. User accounts must be provisioned in the PDB authentication realm. To access node configurations with this command, the selected user account must have the necessary permissions to view the configurations. For more information on PDB access rights, refer to Access Control Lists in the PDB User Guide (Reference [3]). |
5.3 Examples
- Note:
- You must use double quotes <" "> to surround entries that have spaces.
Sample Command Usage on a Linux Platform
pdbcli configuration-list -n CSCF_13A -o "CSCF Configs.txt" -r latest -u PDB_User -p pass
This command lists latest revision of node configurations in PDB that have a name containing "CSCF_13A". The configuration list will be output to CSCF Configs.txt in the current directory.
6 configuration-revision-set-status
configuration-revision-set-status can be used as an alternative to the PDB GUI to set the document state of a configuration revision. Document states must proceed through the following sequence:
PREL > FROZ
- Note:
- Only PDB System Administrators can set a configuration to a previous state.
- Note:
- This command requires connectivity with a PDB server and a valid PDB user account. For more information on configuring connectivity, refer to the PDB System Administration Guide (Reference [2]).
6.1 Usage Syntax
pdbcli configuration-revision-set-status -n <name> [-r <revision>] -s <status> -u <user_name> [-p <password>]
6.2 Options
|
Option |
Description |
Notes |
|---|---|---|
|
-n, --name <arg> |
Specifies the name of a configuration in PDB. |
Mandatory. |
|
-p, --password <arg> |
The PDB user password. |
Optional. If omitted, the PDB CLI prompts for the password interactively. Passwords input at the prompt are masked. |
|
-r, --revision <arg> |
Specifies a revision of the selected configuration. The command defaults to the latest revision if this option is not used. |
Optional. |
|
-s, --status <arg> |
Specifies a document state for the selected configuration revision. Valid states are:
|
Mandatory. |
|
-u, --username<arg> |
Specifies a valid PDB user name that is used to authenticate the CLI user in PDB. |
Mandatory. User accounts must be provisioned in the PDB authentication realm. User accounts must have the necessary permissions to access the selected objects. For more information on PDB access rights, refer to Access Control Lists in the PDB User Guide (Reference [3]). |
6.3 Examples
- Note:
- You must use double quotes <" "> to surround entries that have spaces.
Sample Command Usage on a Linux Platform
pdbcli configuration-revision-set-status -n "HSS 14B Lab1" -r PA3 -s FROZ -u PDB_User -p pass
This command advances the document state of the HSS 15B Lab1 configuration , revision PB6, from PREL to FROZ.
7 configuration-revision-set-tag
configuration-revision-set-tag can be used as an alternative to the PDB GUI to apply one or more tags to a configuration revision stored in PDB. The command labels the selected configuration revision with one or more descriptive tags. These tags are used to categorize and add prominence to the configuration in PDB.
- Note:
- This command requires connectivity with a PDB server and a valid PDB user account. For more information on configuring connectivity, refer to the PDB System Administration Guide (Reference [2]).
7.1 Usage Syntax
pdbcli configuration-revision-set-tag -n <configuration_name>
[-r <configuration_revision>] -t {all|<tags,..>}
-u <user_name> [-p <password>]7.2 Options
|
Option |
Description |
Notes |
|---|---|---|
|
-n, --configuration- |
Specifies the name of a configuration in PDB. |
Mandatory. |
|
-r, --configuration- |
Specifies a revision of the selected configuration to work with. The command defaults to the latest revision if this option is not used. |
Optional. |
|
-t, --tag <arg> |
Specifies a comma-separated list of tags to add to the selected configuration revision. The following options are available:
|
Mandatory. Tags are not case-sensitive. |
|
-p, --password <arg> |
The PDB user password. |
Optional. If omitted, the PDB CLI prompts for the password interactively. Passwords input at the prompt are masked. |
|
-u, --username<arg> |
Specifies a valid PDB user name that is used to authenticate the CLI user in PDB. |
Mandatory. User accounts must be provisioned in the PDB authentication realm. User accounts must have the necessary permissions to access the selected objects. For more information on PDB access rights, refer to Access Control Lists in the PDB User Guide (Reference [3]). |
7.3 Examples
- Note:
- You must use double quotes <" "> to surround entries that have spaces.
Sample Command Usage on a Linux Platform
pdbcli configuration-revision-set-tag -n "CSCFv 15A" -r PA5 -t ivl,mpvl -u PDB_User -p pass
This command tags the PA5 revision of the CSCFv 15A node configuration with the IVL and MPVL tags.
8 configuration-revision-unset-tag
configuration-revision-unset-tag can be used as an alternative to the PDB GUI to remove one or more tags from a configuration revision stored in PDB.
- Note:
- This command requires connectivity with a PDB server and a valid PDB user account. For more information on configuring connectivity, refer to the PDB System Administration Guide (Reference [2]).
8.1 Usage Syntax
pdbcli configuration-revision-set-tag -n <configuration_name>
[-r <configuration_revision>] -t {all|<tags,..>}
-u <user_name> [-p <password>]8.2 Options
|
Option |
Description |
Notes |
|---|---|---|
|
-n, --configuration- |
Specifies the name of a configuration in PDB. |
Mandatory. |
|
-p, --password <arg> |
The PDB user password. |
Optional. If omitted, the PDB CLI prompts for the password interactively. Passwords input at the prompt are masked. |
|
-r, --configuration- |
Specifies a revision of the selected configuration to work with. The command defaults to the latest revision if this option is not used. |
Optional. |
|
-t, --tag <arg> |
Specifies a comma-separated list of tags to remove from the selected configuration revision. The following options are available:
|
Mandatory. Tags are not case-sensitive. |
|
-u, --username<arg> |
Specifies a valid PDB user name that is used to authenticate the CLI user in PDB. |
Mandatory. User accounts must be provisioned in the PDB authentication realm. User accounts must have the necessary permissions to access the selected objects. For more information on PDB access rights, refer to Access Control Lists in the PDB User Guide (Reference [3]). |
8.3 Examples
- Note:
- You must use double quotes <" "> to surround entries that have spaces.
Sample Command Usage on a Linux Platform
pdbcli configuration-revision-unset-tag -n "CSCFv 15A" -r PA5 -t ivl,mpvl -u PDB_User -p pass
This command removes the IVL and MPVL tags from the PA5 revision of the CSCFv 15A node configuration.
9 convert-configuration
convert-configuration is a standalone configuration converter that can be used to convert configuration files between the supported formats. The command produces a configuration bundle that contains the converted configuration files. With the exception of configurations converted to the PVL format, all configuration bundles produced by convert-configuration contain the necessary logic to push the converted configuration to a target node.
To perform a conversion, convert-configuration takes one or more files representing a configuration (such as LDIF files) as input. In addition to the required base configuration, the command accepts an optional set of delta configurations that are applied sequentially (in order of appearance) on top of the base configuration. The delta configuration files must share the same schema as the base configuration.
The following table outlines the supported configuration formats.
|
Supported Input Formats |
Supported Output Formats |
|---|---|
|
CSV |
CSV |
|
EAS | |
|
NETCONF |
|
|
PVL |
NETCONF |
|
PVL |
When converting a configuration to the LDIF format, the converter supports the use of Initial Value Lists (IVLs). IVLs represent the configuration of an LDAP node after maiden installation. When using an IVL, the converter considers the initial values to produce LDIF files that will not collide with the configuration data that is assumed to already exist in the real node.
9.1 Usage Syntax
pdbcli convert-configuration -m <mims> -c <configuration_file>
-f <input_format> [-s <solution_type> -M <moi_format> [-d]]
[-C <delta_file>] [-i <initial_value_file> -I <initial_value_format>]
-F <output_format> -o <output_file> [-t <archive_type>]
[-R <report_file>] [-v <variables_file> -a <application_name>]9.2 Options
|
Option |
Description |
Notes |
|---|---|---|
|
-a, --application <arg> |
Species the node application that is associated with this configuration. |
Mandatory only when using a variables file. |
|
-c, --configuration- |
Specifies the path and filename of a configuration file to convert. |
Mandatory. Paths can be relative or absolute. Multiple inputs are specified using additional -c options. |
|
-C, --delta-file <arg> |
Specifies the path and filename of a delta configuration file in PVL format to apply on top of the base configuration. |
Optional Multiple inputs are specified using additional -C options. Delta configurations must be in PVL format. These configurations must share the same schema as the base configuration. You must specify a solution type for the delta files. If the base configuration is PVL, any delta configurations must share the same solution type. |
|
-d, --use-delta |
This option instructs the configuration converter to process values from the delta column in addition to the specified solution type. |
Optional. Valid for PVL input files only. |
|
-f, --input-format <arg> |
Specifies the format of the node configuration input file. Possible formats include:
|
Mandatory. |
|
-F, --output-format <arg> |
Specifies the format of the node configuration output file. Possible formats include:
|
Mandatory. |
|
-i, --initial-values- |
Specifies the path and filename of a configuration file to use as an IVL for a LDIF conversion. |
Optional. Paths can be relative or absolute. |
|
-I, --initial-values- |
Specifies the format of the IVL configuration. |
Optional. |
|
-m, --mim-files <arg> |
Specifies MIM files, directories, or ZIP archives that will be used as a schema for the converted configuration. |
Mandatory. Paths can be relative or absolute. This option supports multiple MIM files, directories, or ZIP archives as input. Multiple inputs are specified using additional -m options. |
|
-M, --moi-format <arg> |
Specifies which MOI format to apply to the conversion of a PVL configuration. Possible formats include:
|
Mandatory for PVL input files only. For more information on the PVL MOI format, refer to the Parameter List Template Description, EAB/FTI-08:0686 Uen. |
|
-o, --output <arg> |
Specifies a path and filename for the converted configuration archive. |
Mandatory. Paths can be relative or absolute. |
|
-R, --report-file <arg> |
Specifies a path and filename for the error report file. The output defaults to stdout if this option is not set. |
Optional. Paths can be relative or absolute. |
|
-s, --solution-type <arg> |
Specifies which PVL parameter value set to convert. Possible solution types include:
|
Mandatory for PVL input files only. |
|
-t, --archive-type <arg> |
Specifies the output format for the converted configuration archive. Possible formats include:
|
Optional. The configuration converter defaults to the ZIP format. |
|
-v, --variables-file <arg> |
Specifies the path and filename of a variables list that can be used to resolve any parameter value variables in the reference configuration before comparing. |
Optional. Paths can be relative or absolute. The variables list is a user-defined CSV file that adheres to the following format, one variable per line: <name>,<value>,<description>,<usage> Use the create-variables-file CLI command to generate a file that you can populate with values. |
9.3 Examples
- Note:
- You must use double quotes <" "> to surround entries that have spaces.
Sample Command Usage on a Linux Platform
pdbcli convert-configuration -m Mims/CSCF_11A.zip -c Configurations/pvl/CSCF_11A_R4B_1.xml -c Configurations/pvl/CSCF_11A_R4B_2.xml -i Configurations/ivl/CSCF_11A_R4B.ldif -I ldif -f pvl -F ldif -s CONVERGED -M tsp -o config.zip -v ss_list.lst -a CSCF
This command converts the converged column of the CSCF_11A_R4B PVL configuration file to the LDIF format using initial values provided by the CSCF_11A_R4B.ldif configuration. The ss_list.lst variables file will be used to resolve any site-specific variables.
pdbcli convert-configuration -m CSCF_13B_Schema.zip -c cscf_mpvl_pdb.xml -C delta-pvl2.xml -f pvl -F ldif -s FIXED -M tsp -o config.zip -v ssl.csv -a CSCF
This command converts the fixed column of the cscf_mpvl_pdb.xml PVL configuration file to the LDIF format. The contents of delta-pvl2.xml delta configuration will be applied on top of the base configuration and the ssl.csv variables file will be used to resolve any site-specific variables.
10 create-variables-file
create-variables-file generates a template file containing all of the parameter variables required by a selected node configuration. The command retrieves the list of parameter variables for a selected configuration from PDB server and saves them as a CSV file.
- Note:
- This command requires connectivity with a PDB server and a valid PDB user account. For more information on configuring connectivity, refer to the PDB System Administration Guide (Reference [2]).
The variables file that is output by this command has the following format, one variable per line:
<name>,<value>,<description>,<usage>
- Note:
- The description and usage fields are used by PDB to provide additional information and should not be modified.
Values must be added to the file before it can be used in conjunction with other CLI commands, including:
10.1 Usage Syntax
pdbcli create-variables-file -n <configuration_name> [-r <revision>] -f <format> -o <output_file> -u <user_name> [-p <password>]
10.2 Options
|
Option |
Description |
Notes |
|---|---|---|
|
-f, --format <arg> |
Specifies the configuration format. Possible formats include:
|
Mandatory. PDB uses the selected format to add the correct Configuration Management (CM) variables to the site-specific list. For more information on CM variables, refer to Configuration Management Variables in the PDB User Guide (Reference [2]). |
|
-n, --configuration- |
Specifies the name of a configuration in PDB to use as a source for site-specific variables. |
Mandatory. |
|
-o, --output <arg> |
Specifies a path and filename for the new variables file. |
Mandatory. Paths can be relative or absolute. |
|
-p, --password <arg> |
The PDB user password. |
Optional. If omitted, the PDB CLI prompts for the password interactively. Passwords input at the prompt are masked. |
|
-r, --revision <arg> |
Specifies a revision of the selected configuration. |
Optional. If this option has not been set, the create-variables-file command will automatically export the highest revision of the selected configuration. |
|
-u, --username<arg> |
Specifies a valid PDB user name that is used to authenticate the CLI user in PDB. |
Mandatory. User accounts must be provisioned in the PDB authentication realm. User accounts must have the necessary permissions to access the selected objects. For more information on PDB access rights, refer to Access Control Lists in the PDB User Guide (Reference [3]). |
10.3 Examples
- Note:
- You must use double quotes <" "> to surround entries that have spaces.
Sample Command Usage on a Linux Platform
pdbcli create-variables-file -n CSCF_11A_R4B -o CSCF_11A_R4B_ss.lst -u PDB_User -p pass
This command retrieves site-specific variables from the latest revision of the CSCF_11A_R4B node configuration and stores them in the CSCF_11A_R4B_ss.lst file.
11 export-configuration
export-configuration can be used as an alternative to the PDB GUI to export node configurations. The command pulls a selected configuration from the PDB database and packages it in a ZIP or TAR archive that contains the necessary logic to configure the target node.
- Note:
- This command requires connectivity with a PDB server and a valid PDB user account. For more information on configuring connectivity, refer to the PDB System Administration Guide (Reference [2]).
11.1 Usage Syntax
pdbcli export-configuration -n <configuration_name> [-r <revision>] [-d ] -f <format> [-s <solution-type>] [-v <variables_file> | -V <ssl from PDB server>] -o <output_file> [-t <archive_type>] -u <user_name> [-p <password>]
11.2 Options
|
Option |
Description |
Notes |
|---|---|---|
|
-d, --use-delta |
Activates the Delta Only option. Select this option to restrict the exported configuration data to information that is local to the delta configuration. |
Optional. This option is only applicable to delta configurations. |
|
-f, --format <arg> |
Specifies a format for the exported configuration. Possible formats include:
|
Mandatory. Configurations exported in the PVL format only include data from the ims_fixed column. |
|
-n, --configuration- |
Specifies the name of a configuration to export from PDB. |
Mandatory. |
|
-o, --output <arg> |
Specifies a destination archive for the exported configuration. |
Mandatory |
|
-p, --password <arg> |
The PDB user password. |
Optional. If omitted, the PDB CLI prompts for the password interactively. Passwords input at the prompt are masked. |
|
-r, --revision <arg> |
Specifies a revision of the selected configuration to export. |
Optional. If this option has not been set, the export-configuration command will automatically export the highest revision of the selected configuration. |
|
-s, --solution-type <arg> |
Specifies which parameter value set to export. Possible solution types include:
The command defaults to FIXED if this option is not specified. |
Optional. |
|
-t, --archive-type <arg> |
Specifies the output format for the exported configuration archive. Possible formats include:
|
Optional. The configuration exporter defaults to the ZIP format. tar_ait produces an Automatic Installation Tool (AIT) compliant TAR file that contains additional information intended for use by AIT. This format is only available when exporting a CBA-based node configuration in NETCONF format. |
|
-u, --username <arg> |
Specifies a valid PDB user name that is used to authenticate the CLI user in PDB. |
Mandatory. User accounts must be provisioned in the PDB authentication realm. User accounts must have the necessary permissions to access the selected objects. For more information on PDB access rights, refer to Access Control Lists in the PDB User Guide (Reference [3]). |
|
-v, --variables-file <arg> |
Specifies the path and filename of a variables list that is used to resolve any parameter value variables in the exported configuration. |
Optional. Using this option makes -V, --ssl-name unavailable. Paths can be relative or absolute. The variables list is a user-defined CSV file that adheres to the following format, one variable per line: <name>,<value>,<description>,<usage> Use the create-variables-file CLI command to generate a file that you can populate with values. |
|
-V, --ssl-name <arg> |
Specifies the name of a site-specific list on the PDB server that is used to resolve any parameter value variables in the exported configuration. |
Optional. Using this option makes -v, --variables-file unavailable. The specified PDB user must have access to the selected site-specific list. This option can be specified multiple times. |
11.3 Examples
- Note:
- You must use double quotes <" "> to surround entries that have spaces.
Sample Command Usage on a Linux Platform
pdbcli export-configuration -n "HSS 5.0" -f ldif -v ss_list.lst -o Configurations/ldif_hss50.zip -u PDB_User -p pass
This command exports the latest revision of the HSS 5.0 configuration in ldif format to Configurations/ldif_hss50.zip.
pdbcli export-configuration -n "Delta HSS 5.0" -f ldif -V HSS_Lab1 -o Configurations/do_hss50.zip -d -u PDB_User -p pass
This command exports the latest revision of the Delta HSS 5.0 configuration in ldif format to Configurations/do_hss50.zip. This operation has been set to Delta Only, meaning that only configuration data locally defined in the delta configuration will be exported.
pdbcli export-configuration -n "MGW 1.3.5" -r PC3 -f netconf -t tar -v ss_list.lst -o Configurations/mgw135.tar -u PDB_User
This command exports revision PC3 of the MGW 1.3.5 configuration in netconf format to Configurations/mgw135.tar and prompts for the user password.
12 import-configuration
import-configuration can be used as an alternative to the PDB GUI to import a new node configuration. The command takes configuration data from one or more files, directories, or archives and imports them to the PDB database as a new configuration.
- Note:
- This command requires connectivity with a PDB server and a valid PDB user account. For more information on configuring connectivity, refer to the PDB System Administration Guide (Reference [2]).
12.1 Usage Syntax
pdbcli import-configuration -n <configuration_name> -c <input_configuration> [-d] [-F] [-D <document_number>] -f <format> [-s <solution_type>] [-r <configuration_revision>] [-C <revision_comment>] [-e <configuration_description>] -N <schema_name> [-S <schema_revision>][-R <report_file>] -u <user_name> [-p <password>]
12.2 Options
|
Option |
Description |
Notes |
|---|---|---|
|
-c, --configuration- |
Specifies the configuration files, directories, or archives that constitute the node configuration. |
Mandatory. Paths can be relative or absolute. This option supports multiple configuration files, directories, or archives as input. Multiple inputs are specified using additional -c options. |
|
-C, --comment<arg> |
Specifies a comment for the new revision. |
Optional. |
|
-d, --use-delta |
This option instructs import-configuration to process values from the delta column in addition to the specified solution type in a PVL configuration file. |
Optional. This option is only applicable to delta configurations using the PVL configuration format. |
|
-D, --document-number <arg> |
Specifies a document number for the new configuration. PDB will assign an internal number if this option is not specified. |
Optional. |
|
-e,--configuration-description <arg> |
Specifies a configuration description. |
Optional. |
|
-f, --format <arg> |
Specifies the format for of the incoming configuration data. Possible formats include:
|
Mandatory. |
|
-F, --freeze |
Sets the document state of the new configuration to FROZ. |
Optional. |
|
-n, --configuration- |
Specifies the name of the new configuration in PDB. |
Mandatory. |
|
-p, --password <arg> |
The PDB user password. |
Optional. If omitted, the PDB CLI prompts for the password interactively. Passwords input at the prompt are masked. |
|
-r, --revision <arg> |
Specifies a revision level for the imported configuration data. |
Optional. If this option has not been set, import-configuration defaults to "PA1". |
|
-R, --report-file <arg> |
Specifies a path and filename for the validation report. The output defaults to stdout if this option is not set. |
Optional. Paths can be relative or absolute. |
|
-s, --solution-type <arg> |
Specifies which PVL parameter value set to import. Possible solution types include:
|
Mandatory only when importing PVL configuration files. The INITIALVALUE syntax is deprecated and has been replaced by INITIAL_VALUE. |
|
-S, --schema-revision <arg> |
If required, this option specifies which a schema revision to use with the imported configuration data. |
Optional. If this option has not been set, import-configuration defaults to the latest revision. |
|
-u, --username <arg> |
Specifies a valid PDB user name that is used to authenticate the CLI user in PDB. |
Mandatory. User accounts must be provisioned in the PDB authentication realm. User accounts must have the necessary permissions to access the selected objects. For more information on PDB access rights, refer to Access Control Lists in the PDB User Guide (Reference [3]). |
12.3 Examples
- Note:
- You must use double quotes <" "> to surround entries that have spaces.
Sample Command Usage on a Linux Platform
pdbcli import-configuration -n HSS_11A_R9B_LDIF -c Configurations/ldif_hss11a_r9b_pb2.zip -f ldif -u PDB_User -p pass
This command imports the a new configuration named HSS_11A_R9B_LDIF in LDIF format from the Configurations/ldif_hss11A_r9b_pb2.zip configuration archive.
pdbcli import-configuration -n MPVL_MTAS_11B_FIXED -c Configurations/mtas11b.pvl -f pvl -s fixed -S PA4 -u PDB_User
This command imports a new configuration named MPVL_MTAS_11B_FIXED in PVL format from the Configurations/mtas11b.pvl configuration file. PDB will use values from the FIXED solution type and revision PA4 of the associated schema. The PDB user will be prompted for their password.
13 import-configuration-revision
import-configuration-revision can be used as an alternative to the PDB GUI to import a new revision of an existing configuration. The command takes configuration data from one or more files, directories, or archives and imports them to the PDB database as a new revision of an existing configuration. The previous revision must be frozen before a new revision can be added.
- Note:
- This command requires connectivity with a PDB server and a valid PDB user account. For more information on configuring connectivity, refer to the PDB System Administration Guide (Reference [2]).
13.1 Usage Syntax
pdbcli import-configuration-revision -n <configuration_name> -c <input_configuration> [-C <revision_comment>]-f <format> [-s <solution_type>] [-d] [-S <schema_revision>] [-r <new_revision>] [-F] [-R <report_file>] -u <user_name> [-p <password>]
13.2 Options
|
Option |
Description |
Notes |
|---|---|---|
|
-c, --configuration- |
Specifies the configuration files, directories, or archives that constitute the node configuration. |
Mandatory. Paths can be relative or absolute. This option supports multiple configuration files, directories, or archives as input. Multiple inputs are specified using additional -c options. |
|
-C, --comment<arg> |
Specifies a comment for the new revision. |
Optional. |
|
-d, --use-delta |
This option instructs import-configuration-revision to process values from the delta column in addition to the specified solution type in a PVL configuration file. |
Optional. This option is only applicable to delta configurations using the PVL configuration format. |
|
-f, --format <arg> |
Specifies the format for of the incoming configuration data. Possible formats include:
|
Mandatory. |
|
-F, --freeze |
Sets the document state of the new configuration revision to FROZ. |
Optional. |
|
-n, --configuration- |
Specifies the name of a frozen configuration in PDB to update as a new revision. |
Mandatory. |
|
-p, --password <arg> |
The PDB user password. |
Optional. If omitted, the PDB CLI prompts for the password interactively. Passwords input at the prompt are masked. |
|
-r, --revision <arg> |
Specifies a revision level for the imported configuration data. |
Optional. If this option has not been set, the import-configuration-revision command defaults to the next legal revision of the selected configuration. |
|
-R, --report-file <arg> |
Specifies a path and filename for the validation report. The output defaults to stdout if this option is not set. |
Optional. Paths can be relative or absolute. |
|
-s, --solution-type <arg> |
Specifies which PVL parameter value set to import. Possible solution types include:
|
Mandatory only when importing PVL configuration files. The INITIALVALUE syntax is deprecated and has been replaced by INITIAL_VALUE. |
|
-S, --schema-revision <arg> |
If necessary, this option can be used to specify a new schema revision to use with the imported configuration data. |
Optional. |
|
-u, --username <arg> |
Specifies a valid PDB user name that is used to authenticate the CLI user in PDB. |
Mandatory. User accounts must be provisioned in the PDB authentication realm. User accounts must have the necessary permissions to access the selected objects. For more information on PDB access rights, refer to Access Control Lists in the PDB User Guide (Reference [3]). |
13.3 Examples
- Note:
- You must use double quotes <" "> to surround entries that have spaces.
Sample Command Usage on a Linux Platform
pdbcli import-configuration-revision -n HSS_11A_R9B_LDIF -c Configurations/ldif_hss11a_r9b_pb2.zip -f ldif -u PDB_User -p pass
This command imports the next legal revision (PB2) of the HSS_11A_R9B_LDIF configuration from the Configurations/ldif_hss11A_r9b_pb2.zip configuration archive.
pdbcli import-configuration-revision -n MPVL_MTAS_11B_FIXED -c Configurations/mtas11b.pvl -f pvl -s fixed -r PA4 -u PDB_User
This command imports a new PA4 revision of the MPVL_MTAS_11B_FIXED configuration from the Configurations/mtas11b.pvl configuration file. PDB will use values from the FIXED solution type and prompts for the user password.
14 import-schema-revision
import-schema-revision can be used as an alternative to the PDB GUI to import a new revision of an existing schema. The command retrieves data from one or more MIM files, directories, or archives and imports them to the PDB database as a new revision of an existing schema.
- Note:
- This command requires connectivity with a PDB server and a valid PDB user account. For more information on configuring connectivity, refer to the PDB System Administration Guide (Reference [2]).
14.1 Usage Syntax
pdbcli import-schema-revision -n <schema_name> -m <mims> [-r <new_revision>] [-C <revision_comment>] [-F] [-R <report_file>] -u <user_name> [-p <password>]
14.2 Options
|
Option |
Description |
Notes |
|---|---|---|
|
-C, --comment<arg> |
Specifies a comment for the new revision. |
Optional. |
|
-F, --freeze |
Sets the document state of the new schema revision to FROZ. |
Optional. |
|
-m, --mim-files <arg> |
Specifies the files, directories, or archives that constitute the configuration schema. |
Mandatory. Paths can be relative or absolute. This option supports multiple schema files, directories, or archives as input. Multiple inputs are specified using additional -m options. |
|
-n, --schema-name <arg> |
Specifies the name of a schema in PDB to update as a new revision. |
Mandatory. |
|
-p, --password <arg> |
The PDB user password. |
Optional. If omitted, the PDB CLI prompts for the password interactively. Passwords input at the prompt are masked. |
|
-r, --revision <arg> |
Specifies a revision level for the imported schema data. |
Optional. If this option has not been set, the import-schema-revision command defaults to the next legal revision of the selected schema. |
|
-R, --report-file <arg> |
Specifies a path and filename for the validation report. The output defaults to stdout if this option is not set. |
Optional. Paths can be relative or absolute. |
|
-u, --username <arg> |
Specifies a valid PDB user name that is used to authenticate the CLI user in PDB. |
Mandatory. User accounts must be provisioned in the PDB authentication realm. User accounts must have the necessary permissions to access the selected objects. For more information on PDB access rights, refer to Access Control Lists in the PDB User Guide (Reference [3]). |
14.3 Examples
- Note:
- You must use double quotes <" "> to surround entries that have spaces.
Sample Command Usage on a Linux Platform
pdbcli import-schema-revision -n HSS_CM_MIM -m Schemas/hss_mim.zip -u PDB_User -p pass
This command imports the next legal revision (PB1) of the HSS_CM_MIM schema from the Schemas/hss_mim.zip archive.
pdbcli import-schema-revision -n MTAS_CM_MIM -m Schemas/mtas11b/-r PA2 -u PDB_User
This command imports a new PA2 revision of the MTAS_CM_MIM schema from the Schemas/mtas11b/ directory and prompts for the user password.
15 node-create-revision
node-create-revision can be used as an alternative to the PDB GUI to create a new revision of a node defined in PDB. The command creates a new revision of the specified node with an optional description. If the node revision has already been defined, specifying a new description will overwrite the existing one.
- Note:
- This command requires connectivity with a PDB server and a valid PDB user account. For more information on configuring connectivity, refer to the PDB System Administration Guide (Reference [2]).
15.1 Usage Syntax
pdbcli node-create-revision -n <node_name> -r <node-revision> [-d <description>] -u <user_name> [-p <password>]
15.2 Options
|
Option |
Description |
Notes |
|---|---|---|
|
-d, --description <arg> |
Specifies a description for the node revision. |
Optional. If the node revision has already been defined, specifying a new description will overwrite the existing one. |
|
-n, --node-name <arg> |
Specifies the name of a node in PDB. |
Mandatory. |
|
-p, --password <arg> |
The PDB user password. |
Optional. If omitted, the PDB CLI prompts for the password interactively. Passwords input at the prompt are masked. |
|
-r, --node-revision <arg> |
Specifies a revision of the selected node to create. |
Mandatory. |
|
-u, --username<arg> |
Specifies a valid PDB user name that is used to authenticate the CLI user in PDB. |
Mandatory. User accounts must be provisioned in the PDB authentication realm. User accounts must have the necessary permissions to access the selected objects. For more information on PDB access rights, refer to Access Control Lists in the PDB User Guide (Reference [3]). |
15.3 Examples
- Note:
- You must use double quotes <" "> to surround entries that have spaces.
Sample Command Usage on a Linux Platform
pdbcli node-create-revision -n "CSCF 13B" -r R11B02 -d WP265A -u PDB_User -p pass
This command creates a new R11B02 revision for the CSCF 13B node described as "WP265A".
16 node-revision-link-configuration-revision
node-revision-link-configuration-revision can be used as an alternative to the PDB GUI to link a configuration revision to a node revision. The selected configuration must be based on a schema that is associated with the specified node.
- Note:
- This command requires connectivity with a PDB server and a valid PDB user account. For more information on configuring connectivity, refer to the PDB System Administration Guide (Reference [2]).
16.1 Usage Syntax
pdbcli node-revision-link-configuration-revision -n <node_name> -r <node-revision> -c <configuration_name> -cr <configuration_revision> -u <user_name> [-p <password>]
16.2 Options
|
Option |
Description |
Notes |
|---|---|---|
|
-c, --configuration- |
Specifies the name of a configuration in PDB. |
Mandatory. |
|
-cr, --configuration- |
Specifies a revision of the selected configuration. |
Mandatory. |
|
-n, --node-name <arg> |
Specifies the name of a node in PDB. |
Mandatory. |
|
-p, --password <arg> |
The PDB user password. |
Optional. If omitted, the PDB CLI prompts for the password interactively. Passwords input at the prompt are masked. |
|
-r, --node-revision <arg> |
Specifies a revision of the selected node. |
Mandatory. |
|
-u, --username<arg> |
Specifies a valid PDB user name that is used to authenticate the CLI user in PDB. |
Mandatory. User accounts must be provisioned in the PDB authentication realm. User accounts must have the necessary permissions to access the selected objects. For more information on PDB access rights, refer to Access Control Lists in the PDB User Guide (Reference [3]). |
16.3 Examples
- Note:
- You must use double quotes <" "> to surround entries that have spaces.
Sample Command Usage on a Linux Platform
pdbcli node-revision-link-configuration-revision -n "HSS 14B" -r R4B -c "MPVL HSS 14B FIXED" -r PA2 -u PDB_User -p pass
This command links the PA2 revision of the MPVL HSS 14B FIXED configuration to the R4B revision of the HSS 14B node.
17 node-revision-link-schema-revision
node-revision-link-schema-revision can be used as an alternative to the PDB GUI to link a schema revision to a node revision.
- Note:
- This command requires connectivity with a PDB server and a valid PDB user account. For more information on configuring connectivity, refer to the PDB System Administration Guide (Reference [2]).
17.1 Usage Syntax
pdbcli node-revision-link-schema-revision -n <node_name> -r <node-revision> -s <schema_name> -sr <schema_revision> -u <user_name> [-p <password>]
17.2 Options
|
Option |
Description |
Notes |
|---|---|---|
|
-n, --node-name <arg> |
Specifies the name of a node in PDB. |
Mandatory. |
|
-p, --password <arg> |
The PDB user password. |
Optional. If omitted, the PDB CLI prompts for the password interactively. Passwords input at the prompt are masked. |
|
-r, --node-revision <arg> |
Specifies a revision of the selected node. |
Mandatory. |
|
-s, --schema-name <arg> |
Specifies the name of a configuration schema in PDB. |
Mandatory. |
|
-sr, --schema-revision <arg> |
Specifies a revision of the selected configuration schema. |
Mandatory. |
|
-u, --username<arg> |
Specifies a valid PDB user name that is used to authenticate the CLI user in PDB. |
Mandatory. User accounts must be provisioned in the PDB authentication realm. User accounts must have the necessary permissions to access the selected objects. For more information on PDB access rights, refer to Access Control Lists in the PDB User Guide (Reference [3]). |
17.3 Examples
- Note:
- You must use double quotes <" "> to surround entries that have spaces.
Sample Command Usage on a Linux Platform
pdbcli node-revision-link-schema-revision -n "HSS 14B" -r R4B -s "HSS 14B" -sr PA2 -u PDB_User -p pass
This command links the PA2 revision of the HSS 14B configuration schema to the R4B revision of the HSS 14B node.
18 schema-compare
schema-compare is a comparison tool that can be used as an alternative to the PDB GUI to examine the differences between two sets of schema files. The command outputs a comparison report in CSV format. If the schema files are identical, this report is empty and the exit status will be 0.
The selected schema files are validated before each comparison to ensure proper syntax and element relationships.
18.1 Usage Syntax
pdbcli schema-compare -base <base_mim_files> -target <target_mim_files>
[-c {card,cat,cons,desc,fdesc,def,m,case,pk,ro,stat}]
[-R <import_report_file>] -S <comparison_report_file>18.2 Options
|
Option |
Description |
Notes |
|---|---|---|
|
-base -base,--base-mim-files <arg> |
Specifies the path to a directory, schema file, or archive file (ZIP/TAR) of the base schema that will serve as the starting point for the comparison. |
Mandatory. Paths can be relative or absolute. This option can be specified multiple times to capture all of the necessary schema file. |
|
-c,--criteria <arg> |
Specifies the schema properties to include in the comparison report. Possible properties include:
If this option is not specified, the command defaults to ALL. |
Optional. For more information on the properties of a comparison report, refer to Comparing Two Schemas in the PDB User Guide (Reference [3]) |
|
-R,--import-report- |
Specifies a path and filename for a validation error report file. The output defaults to stdout if this option is not set. |
Optional. Paths can be relative or absolute. |
|
-S,--comparison-report-file <arg> |
Specifies a path and filename for the comparison report. |
Mandatory. Paths can be relative or absolute. The comparison report is generated in CSV format. |
|
-target ,--target-mim-files <arg> |
Specifies the path to a directory, schema file, or archive file (ZIP/TAR) of the target schema for the comparison. |
Mandatory. Paths can be relative or absolute. This option can be specified multiple times to capture all of the necessary schema files. |
18.3 Examples
- Note:
- You must use double quotes <" "> to surround entries that have spaces. For sample usage, see the following example.
Sample Command Usage on a Linux Platform
pdbcli schema-compare -base "tsp schemas/CSCF/13B.zip" -target "tsp schemas/CSCF/13B_1.zip" -R error.txt -S comp/13B/comp.csv
This command compares the schema files contained in 13B.zip to the schema files contained within 13B_1.zip. Any schema validation errors will be output to errors.txt. The schema comparison report will be output to comp/13B/comp.csv.
19 schema-list
schema-list connects to the PDB server and retrieves a list of configuration schemas that match the optional filters. If required, the list can be exported to a plain-text file with one schema per line.
- Note:
- This command requires connectivity with a PDB server and a valid PDB user account. For more information on configuring connectivity, refer to the PDB System Administration Guide (Reference [2]).
By default, the schema-list command will list all of the configuration schemas that are visible to the selected user on the PDB server. This list can be filtered with the following options:
| Name | Only schemas with names that match the selected substring are included. | |
| Owner | Only schemas with owners that match the selected substring are included. | |
| Revision | Only schemas with revisions that match the selected substring are included. This option default to the latest revision. | |
19.1 Usage Syntax
pdbcli schema-list [-n <schema_name>] [-r <schema_revision>] [-o <output_file>] [-O <schema_owner>] -u <user_name> [-p <password>]
19.2 Options
|
Option |
Description |
Notes |
|---|---|---|
|
-n, --schema-name <arg> |
Specifies a substring to filter the list of schemas from PDB by name. |
Optional. Partial matches are supported. If any part of the schema name matches this substring, it is included. |
|
-o, --output <arg> |
Specifies the path and filename for a new plain-text output file containing the list of schemas. |
Optional. Paths can be relative or absolute. By default, the command outputs the matching schemas on screen. |
|
-O, --schema-owner <arg> |
Specifies a substring to filter the list of schemas from PDB by owner. |
Optional. Partial matches are supported. If any part of the schema owner matches this substring, it is included. |
|
-p, --password <arg> |
The PDB user password. |
Optional. If omitted, the PDB CLI prompts for the password interactively. Passwords input at the prompt are masked. |
|
-r, --schema-revision <arg> |
Specifies a substring to filter the list of schemas from PDB by revision. The command defaults to the latest revision if this option is not used. |
Optional. Partial matches are supported. If any part of the schema name matches this substring, it is included. Use all to display every schema revision that matches the other criteria. |
|
-u, --username <arg> |
Specifies a valid PDB user name that is used to authenticate the CLI user in PDB. |
Mandatory. User accounts must be provisioned in the PDB authentication realm. To access schemas with this command, the selected user account must have the necessary permissions to view the schemas in PDB. For more information on PDB access rights, refer to Access Control Lists in the PDB User Guide (Reference [3]). |
19.3 Examples
- Note:
- You must use double quotes <" "> to surround entries that have spaces.
Sample Command Usage on a Linux Platform
pdbcli schema-list -n CSCF -o "CSCF schemas.txt" -u PDB_User -p pass
This command connects to PDB with the PDB_User account and lists the latest revision of schemas visible to that user in PDB with names containing "CSCF". The schema list is output to CSCF schemas.txt in the current directory.
20 schema-revision-set-ivl
schema-revision-set-ivl can be used as an alternative the PDB GUI to associate an Initial Value List (IVL) with a configuration schema stored in PDB. If the selected configuration schema already has an IVL, this command overwrites it.
Node configurations stored in PDB must be tagged as IVL before they can be associated with a schema. For more information on tagging configurations as IVL, refer to configuration-revision-set-tag or Modifying Configuration Properties in the PDB User Guide (Reference [3])
- Note:
- This command requires connectivity with a PDB server and a valid PDB user account. For more information on configuring connectivity, refer to the PDB System Administration Guide (Reference [2]).
20.1 Usage Syntax
pdbcli schema-revision-set-ivl -s <schema_name> [-r <schema_revision>] -c <configuration_name> [-cr <configuration_revision>] -u <user_name> [-p <password>]
20.2 Options
|
Option |
Description |
Notes |
|---|---|---|
|
-c, --configuration- |
Specifies the name of a configuration in PDB. |
Mandatory. |
|
-cr, --configuration- |
Specifies a revision of the selected configuration. The command defaults to the latest revision if this option is not used. |
Optional. |
|
-p, --password <arg> |
The PDB user password. |
Optional. If omitted, the PDB CLI prompts for the password interactively. Passwords input at the prompt are masked. |
|
-r, --schema-revision <arg> |
Specifies a revision of the selected configuration schema. The command defaults to the latest revision if this option is not used. |
Optional. |
|
-s, --schema-name <arg> |
Specifies the name of a configuration schema in PDB. |
Mandatory. |
|
-u, --username<arg> |
Specifies a valid PDB user name that is used to authenticate the CLI user in PDB. |
Mandatory. User accounts must be provisioned in the PDB authentication realm. User accounts must have the necessary permissions to access the selected objects. For more information on PDB access rights, refer to Access Control Lists in the PDB User Guide (Reference [3]). |
20.3 Examples
- Note:
- You must use double quotes <" "> to surround entries that have spaces.
Sample Command Usage on a Linux Platform
pdbcli schema-revision-set-ivl -s "HSS 15A" -c HSS_Lab_1 -cr B -u PDB_User -p pass
This command sets revision B of the HSS_Lab_1 configuration as IVL for the latest revision of the HSS 15A configuration schema.
21 schema-revision-set-status
schema-revision-set-status can be used as an alternative to the PDB GUI to set the document state of a schema revision. Document states must proceed through the following sequence:
PREL > FROZ
- Note:
- Only PDB System Administrators can set a schema to a previous state. System Administrators cannot unfreeze a schema revision that is the basis for any frozen configurations.
- Note:
- This command requires connectivity with a PDB server and a valid PDB user account. For more information on configuring connectivity, refer to the PDB System Administration Guide (Reference [2]).
21.1 Usage Syntax
pdbcli schema-revision-set-status -n <name> [-r <revision>] -s <status> -u <user_name> [-p <password>]
21.2 Options
|
Option |
Description |
Notes |
|---|---|---|
|
-n, --name <arg> |
Specifies the name of a configuration schema in PDB. |
Mandatory. |
|
-p, --password <arg> |
The PDB user password. |
Optional. If omitted, the PDB CLI prompts for the password interactively. Passwords input at the prompt are masked. |
|
-r, --revision <arg> |
Specifies a revision of the selected configuration schema. The command defaults to the latest revision if this option is not used. |
Optional. |
|
-s, --status <arg> |
Specifies a document state for the selected schema revision. Valid states are:
|
Mandatory. |
|
-u, --username<arg> |
Specifies a valid PDB user name that is used to authenticate the CLI user in PDB. |
Mandatory. User accounts must be provisioned in the PDB authentication realm. User accounts must have the necessary permissions to access the selected objects. For more information on PDB access rights, refer to Access Control Lists in the PDB User Guide (Reference [3]). |
21.3 Examples
- Note:
- You must use double quotes <" "> to surround entries that have spaces.
Sample Command Usage on a Linux Platform
pdbcli schema-revision-set-status -n "HSS 14B" -r PA3 -s FROZ -u PDB_User -p pass
This command advances the document state of the HSS 14B configuration schema, revision PA3, from PREL to FROZ.
22 schema-revision-unset-ivl
schema-revision-set-ivl can be used as an alternative the PDB GUI to remove an IVL association from a configuration schema stored in PDB.
- Note:
- This command requires connectivity with a PDB server and a valid PDB user account. For more information on configuring connectivity, refer to the PDB System Administration Guide (Reference [2]).
22.1 Usage Syntax
pdbcli schema-revision-unset-ivl -s <schema_name> [-r <schema_revision>] -u <user_name> [-p <password>]
22.2 Options
|
Option |
Description |
Notes |
|---|---|---|
|
-p, --password <arg> |
The PDB user password. |
Optional. If omitted, the PDB CLI prompts for the password interactively. Passwords input at the prompt are masked. |
|
-r, --schema-revision <arg> |
Specifies a revision of the selected configuration schema. The command defaults to the latest revision if this option is not used. |
Optional. |
|
-s, --schema-name <arg> |
Specifies the name of a configuration schema in PDB. |
Mandatory. |
|
-u, --username<arg> |
Specifies a valid PDB user name that is used to authenticate the CLI user in PDB. |
Mandatory. User accounts must be provisioned in the PDB authentication realm. User accounts must have the necessary permissions to access the selected objects. For more information on PDB access rights, refer to Access Control Lists in the PDB User Guide (Reference [3]). |
22.3 Examples
- Note:
- You must use double quotes <" "> to surround entries that have spaces.
Sample Command Usage on a Linux Platform
pdbcli schema-revision-unset-ivl -s "HSS 15A" -u PDB_User -p pass
This command removes the IVL associated with the latest revision of the HSS 15A configuration schema.
23 ssl-export
ssl-export can be used as an alternative to the PDB GUI to export site-specific lists. The command pulls a selected SSL from the PDB database and exports it as a list of parameter value variables in CSV or Testing and Test Control Notation (TTCN) format.
- Note:
- This command requires connectivity with a PDB server and a valid PDB user account. For more information on configuring connectivity, refer to the PDB System Administration Guide (Reference [2]).
CSV Format
When exporting an SSL in CSV format, ssl-export creates a variables file with a " .csv" file extension to store the exported data. These files have the following structure, one variable per line:
<name>,<value>,<description>,<usage>
Example 2 shows a CSV variables file with sample data.
Example 2 Sample CSV Variables File
name,value,description,usage CSCF_DN_NODE_NAME,nsp100,, CSCF_DOMAIN_ALIAS-01,tco.ics.se,, CSCF_DOMAIN_BCF,BCF.tco.ics.se,, CSCF_DOMAIN_CX,CSCFCX.tco.ics.se,, CSCF_DOMAIN_DESTREALM,tco.ics.se,, CSCF_DOMAIN_DIGESTREALM,tco.ics.se,,
CSV variables files can be used with other CLI commands to supply values for parameter value variables. These commands include:
TTCN Format
The TTCN format is used to provide SSL data to Titansim test bundles. When exporting an SSL in TTCN format, ssl-export creates a variables file with a " .cfg" file extension to store the exported data. These files have the following format, one variable per line:
<name> := "<value>"
Example 3 shows a TTCN variables file with sample data.
Example 3 Sample TTCN Variables File
[DEFINE] CSCF_DN_NODE_NAME := "nsp100" CSCF_DOMAIN_ALIAS-01 := "tco.ics.se" CSCF_DOMAIN_BCF := "BCF.tco.ics.se" CSCF_DOMAIN_CX := "CSCFCX.tco.ics.se" CSCF_DOMAIN_DESTREALM := "tco.ics.se" CSCF_DOMAIN_DIGESTREALM := "tco.ics.se"
23.1 Usage Syntax
pdbcli ssl-export [-f <format>] -n <ssl_name> -o <output_file> -u <user_name> [-p <password>]
23.2 Options
|
Option |
Description |
Notes |
|---|---|---|
|
-f, --format <arg> |
Specifies an output format for the exported SSL. Possible formats include:
The format defaults to CSV if this option is not set. |
Optional. |
|
-n, --ssl-name <arg> |
Specifies the name of a site-specific list to export from PDB. |
Mandatory. |
|
-o, --output <arg> |
Specifies a path and filename for the new variables file. |
Mandatory. Paths can be relative or absolute. |
|
-p, --password <arg> |
The PDB user password. |
Optional. If omitted, the PDB CLI prompts for the password interactively. Passwords input at the prompt are masked. |
|
-u, --username<arg> |
Specifies a valid PDB user name that is used to authenticate the CLI user in PDB. |
Mandatory. User accounts must be provisioned in the PDB authentication realm. User accounts must have the necessary permissions to access the selected objects. For more information on PDB access rights, refer to Access Control Lists in the PDB User Guide (Reference [3]). |
23.3 Examples
- Note:
- You must use double quotes <" "> to surround entries that have spaces.
Sample Command Usage on a Linux Platform
pdbcli ssl-export -n SSL_lab1 -o /tmp/pdb/lab1_ss -u PDB_User -p pass
This command exports the SSL_lab1 site-specific list from PDB to /tmp/pdb/lab1_ss.csv in CSV format.
24 ssl-list
ssl-list connects to the PDB server and retrieves a list of site-specific lists that match the optional filters. If required, the list can be exported to a plain-text file with one list per line.
- Note:
- This command requires connectivity with a PDB server and a valid PDB user account. For more information on configuring connectivity, refer to the PDB System Administration Guide (Reference [2]).
By default, the ssl-list command will list all of the SSLs that are visible to the selected user on the PDB server. This list can be filtered with the following options:
| Name | Only SSLs with names that match the selected substring are included. | |
| Owner | Only SSLs with owners that match the selected substring are included. | |
24.1 Usage Syntax
pdbcli ssl-list [-n <ssl_name>] [-o <output_file>] -u <user_name> [-p <password>] [-O <ssl_owner>]
24.2 Options
|
Option |
Description |
Notes |
|---|---|---|
|
-n, --ssl-name <arg> |
Specifies a substring to filter the list of SSLs from PDB by name. |
Optional. Partial matches are supported. If any part of the SSL name matches this substring, it will be included. |
|
-o, --output <arg> |
Specifies the path and filename for a new plain-text output file containing the list of SSLs. |
Optional. Paths can be relative or absolute. By default, the command outputs the matching SSLs on screen. |
|
-O, --ssl-owner <arg> |
Specifies a substring to filter the list of SSLs from PDB by owner. |
Optional. Partial matches are supported. If any part of the SSL owner matches this substring, it will be included. |
|
-p, --password <arg> |
The PDB user password. |
Optional. If omitted, the PDB CLI prompts for the password interactively. Passwords input at the prompt are masked. |
|
-u, --username <arg> |
Specifies a valid PDB user name that is used to authenticate the CLI user in PDB. |
Mandatory. User accounts must be provisioned in the PDB authentication realm. To access SSLs with this command, the selected user account must have the necessary permissions to view the SSLs. For more information on PDB access rights, refer to Access Control Lists in the PDB User Guide (Reference [3]). |
24.3 Examples
- Note:
- You must use double quotes <" "> to surround entries that have spaces.
Sample Command Usage on a Linux Platform
pdbcli ssl-list -n Lab1 -o "Lab1 SSL.txt" -u PDB_User -p pass
This command connects to PDB with the PDB_User account and lists SSLs visible to that user in PDB with names containing "Lab1". The SSL list is output to Lab1 SSL.txt in the current directory.
25 ssl-list-variable
ssl-list-variable connects to the PDB server and fetches variables from the specified site-specific list. Variables retrieved by the command are printed on screen.
- Note:
- This command requires connectivity with a PDB server and a valid PDB user account. For more information on configuring connectivity, refer to the PDB System Administration Guide (Reference [2]).
By default, the ssl-list-variable command lists all of the variables in the specified SSL. This list can be filtered with the following option:
| Name | Only variables names that match the selected substring are included. | |
25.1 Usage Syntax
pdbcli ssl-variable-list -s <ssl_name> [-n <variable_name>] -u <user_name> [-p <password>]
25.2 Options
|
Option |
Description |
Notes |
|---|---|---|
|
-n, --name <arg> |
Specifies a substring to filter the list of SSL variables retrieved from PDB by name. |
Optional. Partial matches are supported. If any part of the variable name matches this substring, it will be included. |
|
-p, --password <arg> |
The PDB user password. |
Optional. If omitted, the PDB CLI prompts for the password interactively. Passwords input at the prompt are masked. |
|
-s, --ssl <arg> |
Specifies the name of a site-specific list in PDB. |
Mandatory. |
|
-u, --username <arg> |
Specifies a valid PDB user name that is used to authenticate the CLI user in PDB. |
Mandatory. User accounts must be provisioned in the PDB authentication realm. To access SSLs with this command, the selected user account must have the necessary permissions to view the SSLs. For more information on PDB access rights, refer to Access Control Lists in the PDB User Guide (Reference [3]). |
25.3 Examples
- Note:
- You must use double quotes <" "> to surround entries that have spaces.
Sample Command Usage on a Linux Platform
pdbcli ssl-list -s "CSCF 12C" -n CSCF -u PDB_User -p pass
This command prints all variables in the CSCF 12C site-specific list that have a name containing "CSCF".
26 ssl-set-variable
ssl-set-variable can be used as an alternative to the PDB GUI to set a new value to an existing SSL variable or create a new variable with the specified value.
- Note:
- This command requires connectivity with a PDB server and a valid PDB user account. For more information on configuring connectivity, refer to the PDB System Administration Guide (Reference [2]).
26.1 Usage Syntax
pdbcli ssl-set-variable -s <ssl_name> -n <variable_name> -v <variable_value> -u <user_name> [-p <password>]
26.2 Options
|
Option |
Description |
Notes |
|---|---|---|
|
-n, --name <arg> |
Specifies a variable name. |
Mandatory. If this variable does not exist in the specified SSL, it is created and populated with the selected value. If this variable already exists in the specified SSL, it is updated with the selected value. |
|
-p, --password <arg> |
The PDB user password. |
Optional. If omitted, the PDB CLI prompts for the password interactively. Passwords input at the prompt are masked. |
|
-s, --ssl <arg> |
Specifies the name of a site-specific list in PDB. |
Mandatory. |
|
-u, --username <arg> |
Specifies a valid PDB user name that is used to authenticate the CLI user in PDB. |
Mandatory. User accounts must be provisioned in the PDB authentication realm. To access SSLs with this command, the selected user account must have the necessary permissions to view the SSLs. For more information on PDB access rights, refer to Access Control Lists in the PDB User Guide (Reference [3]). |
|
-v, --value <arg> |
Specifies a value for the selected variable. |
Mandatory. |
26.3 Examples
- Note:
- You must use double quotes <" "> to surround entries that have spaces.
Sample Command Usage on a Linux Platform
pdbcli ssl-set-variable -s "CSCF 12C" -n CSCF_IP_DNS -v 11.82.165.241 -u PDB_User -p pass
This command creates or updates the CSCF_IP_DNS variable in the CSCF 12C site-specific list with the value 11.82.165.241.
27 ssl-unset-variable
ssl-unset-variable can be used as an alternative to the PDB GUI to delete a variable from the specified site-specific list.
- Note:
- This command requires connectivity with a PDB server and a valid PDB user account. For more information on configuring connectivity, refer to the PDB System Administration Guide (Reference [2]).
27.1 Usage Syntax
pdbcli ssl-unset-variable -s <ssl_name> -n <variable_name> -u <user_name> [-p <password>]
27.2 Options
|
Option |
Description |
Notes |
|---|---|---|
|
-n, --name <arg> |
Specifies a variable name to delete. |
Mandatory. |
|
-p, --password <arg> |
The PDB user password. |
Optional. If omitted, the PDB CLI prompts for the password interactively. Passwords input at the prompt are masked. |
|
-s, --ssl <arg> |
Specifies the name of a site-specific list in PDB. |
Mandatory. |
|
-u, --username <arg> |
Specifies a valid PDB user name that is used to authenticate the CLI user in PDB. |
Mandatory. User accounts must be provisioned in the PDB authentication realm. To access SSLs with this command, the selected user account must have the necessary permissions to view the SSLs. For more information on PDB access rights, refer to Access Control Lists in the PDB User Guide (Reference [3]). |
27.3 Examples
- Note:
- You must use double quotes <" "> to surround entries that have spaces.
Sample Command Usage on a Linux Platform
pdbcli ssl-unset-variable -s "CSCF 12C" -n CSCF_IP_DNS -u PDB_User -p pass
This command removes the CSCF_IP_DNS variable from the CSCF 12C site-specific list.
28 validate-local-configuration-files
validate-local-configuration-files is a standalone validation command that can be used to validate a local configuration files and generate a validation report. Validation considers standard file syntax, format rules, and the limits set by the selected MIM files, including schematron rules. CLI validation applies the same logic to verify input files as configuration validation in the PDB GUI, and generates the same type of report when problems are found.
For more information on validating node configurations through the GUI including a description of the validation report, refer to the PDB System Administration Guide (Reference [2]).
28.1 Usage Syntax
pdbcli validate-local-configuration-files -s <schema_files> -c <configuration_files> -f <configuration_format> [-M <moi_format>] [-V <validation_report_file>]
28.2 Options
|
Option |
Description |
Notes |
|---|---|---|
|
-c, --configuration-files <arg> |
Specifies the path and filename of a configuration file to validate. |
Mandatory. Paths can be relative or absolute. Multiple inputs are specified using additional -c options. |
|
-f,--configuration-format <arg> |
Specifies the configuration format. Possible formats include:
|
Mandatory. |
|
-M, --moi-format <arg> |
Specifies the MOI format of the PVL configuration. Possible formats include:
|
Mandatory for PVL configurations only. For more information on the PVL format, refer to the Parameter List Template Description, EAB/FTI-08:0686 Uen. |
|
-s,--schema-files <arg> |
Specifies a MIM file, directory, or ZIP archive that constitutes the configuration schema. |
Mandatory. Paths can be relative or absolute. When specifying a directory, subdirectories on the same path are automatically included. Multiple MIM files, directories, or ZIP archives are specified using additional -m options. |
|
-T, --solution-type <arg> |
Only applicable when validating PVL configuration files. Specifies which PVL parameter value set to validate. Possible solution types include:
|
Optional. If a solution type is not specified, all solutions types will be validated, including initial values. The INITIALVALUE syntax is deprecated and has been replaced by INITIAL_VALUE. |
|
-V,--validation-report-file <arg> |
Specifies a destination file for the validation report. The output defaults to stdout if this option is not set. |
Optional. |
28.3 Examples
- Note:
- You must use double quotes <" "> to surround entries that have spaces.
Sample Command Usage on a Linux Platform
pdbcli validate-local-configuration-files -c Configurations/pvl/CSCF_11A_R4B.xml -f pvl -M tsp -s Mims/CSCF_11A.zip -V Reports/CSCF_11A_R4B -T CONVERGED
This command validates the CONVERGED column of the CSCF_11A_R4B.xml PVL configuration against the schema files contained within CSCF_11A.zip and outputs the validation report to Reports/CSCF_11A_R4B.
29 validate-mim
validate-mim is a standalone MIM validation command that can be used to check the syntax of schema files against one of the supported MIM formats. CLI MIM validation applies the same logic used by PDB when importing a schema without adding files to the PDB server.
In addition, this command validates any schematron rules and allows you to export those rules to a designated XML file.
Multiple schema files, directories, ZIP archives, or any combination of the three can be used as input for the tool. A validation report is generated when problems are found. This report groups errors and warnings by the affected files.
29.1 Usage Syntax
pdbcli validate-mim [-t <mim_type>] [-m <mim_file>] [-d <mim_dir>] [-z <mim_zip>] [-R <report_file>] [-s <schematron>]
29.2 Options
|
Option |
Description |
Notes |
|---|---|---|
|
-d , --mim-dir <arg> |
This option is deprecated and has been replaced by -m, --mim-file. Specifies the path of a directory containing input files to validate. Subdirectories on the same path are automatically included. |
Optional. Paths can be relative or absolute. This option can be specified multiple times. |
|
-m, --mim-file <arg> |
Specifies a MIM file, directory, or ZIP archive that constitutes the configuration schema. |
Optional. Paths can be relative or absolute. When specifying a directory, subdirectories on the same path are automatically included. Multiple MIM files, directories, or ZIP archives are specified using additional -m options. |
|
-R, --report-file <arg> |
Specifies a destination file for the validation report. The output defaults to stdout if this option is not set. |
Optional. |
|
-s, --schematron <arg> |
Exports schematron rules from the selected schema to the specified XML file. |
Optional. Schematron rules can only be exported in XML format. |
|
-t, --mim-type <arg> |
Specifies a supported MIM format that is used to validate the selected input files. The possible values are:
|
Optional. validate-mim will automatically detect the MIM type if this option has not been set. For more information on TSP MIM files, refer to CM Management Information Models for TSP based nodes in IMS, 17/1550-HSC 113 06 Uen E in CDM. For more information on IS MIM files, refer to Management Information Modeling in IS, 25/155 19-AZE 101 01/1 Uen E in CDM. |
|
-z, --mim-zip <arg> |
This option is deprecated and has been replaced by -m, --mim-file. Specifies the path and filename of a ZIP archive containing input files to validate. |
Optional. Paths can be relative or absolute. This option can be specified multiple times. |
- Note:
- validate-mim requires at least one input (-m, -d, or -z) to function.
29.3 Examples
- Note:
- You must use double quotes <" "> to surround entries that have spaces.
Sample Command Usage on a Linux Platform
pdbcli validate-mim -t IMS_CM_MIM_1_0 -m mims
This command validates the contents of the mims subfolder against the TSP 1.0 format.
pdbcli validate-mim -t IMS_CM_MIM_0_1 -m mimss/tsp_mims.zip
This command validates the contents of the tsp_mims.zip archive against the TSP 0.1 format.
pdbcli validate-mim -t IS_CM_MIM -m mims/new -m mims/unsorted -m mims/is.zip
This command validates files contained in the mims/new and mims/unsorted folders along with the contents of the is.zip archive against the IS format.
30 validate-mpvl
validate-mpvl is a standalone MPVL validation command that can be used to validate a configuration file written in PVL format. The validation considers standard XML syntax, format rules established by the official definition of the PVL format, and the limits set by the selected MIM files, including schematron rules. CLI MPVL validation applies the same logic to verify input files as configuration validation in the PDB GUI, and generates the same type of report when problems are found.
For more information on validating node configurations through the GUI including a description of the validation report, refer to the PDB System Administration Guide (Reference [2]).
30.1 Usage Syntax
pdbcli validate-mpvl -m <mims> -c <input_configuration> [-s <solution_type>] [-d] -M <moi_format> [-R <report_file>] [-v <variables_file>]
30.2 Options
|
Option |
Description |
Notes |
|---|---|---|
|
-c, --configuration-files <arg> |
Specifies the path and filename of a MPVL configuration file to validate. |
Mandatory. Paths can be relative or absolute. Multiple inputs are specified using additional -c options. |
|
-d, --use-delta |
This option instructs the MPVL validator to process values from the delta column in addition to the specified solution type. |
Optional. |
|
-m, --mim-files <arg> |
Specifies a MIM file, directory, or ZIP archive that constitutes the configuration schema. |
Mandatory. Paths can be relative or absolute. When specifying a directory, subdirectories on the same path are automatically included. Multiple MIM files, directories, or ZIP archives are specified using additional -m options. |
|
-M, --moi-format <arg> |
Specifies the MOI format of the MPVL configuration. Possible formats include:
|
Mandatory. For more information on the PVL format, refer to the Parameter List Template Description, EAB/FTI-08:0686 Uen. |
|
-R, --report-file <arg> |
Specifies a path and filename for the validation report file. The output defaults to stdout if this option is not set. |
Optional. Paths can be relative or absolute. |
|
-s, --solution-type <arg> |
Specifies which PVL parameter value set to validate. Possible solution types include:
|
Optional. If a solution type is not specified, all solutions types will be validated, including initial values. The INITIALVALUE syntax is deprecated and has been replaced by INITIAL_VALUE. |
|
-v <variables_file> |
Specifies the path and filename of a variables list that is used to resolve any parameter value variables in the MPVL configuration. |
Optional. Paths can be relative or absolute. The variables list is a user-defined CSV file that adheres to the following format, one variable per line: <name>,<value>,<description>,<usage> Use the create-variables-file CLI command to generate a file that you can populate with values. |
30.3 Examples
- Note:
- You must use double quotes <" "> to surround entries that have spaces.
Sample Command Usage on a Linux Platform
pdbcli validate-mpvl -c Configurations/pvl/CSCF_11A_R4B.xml -M tsp -m Mims/CSCF_11A.zip -R Reports/CSCF_11A_R4B -s CONVERGED
This command validates the CONVERGED column of the CSCF_11A_R4B.xml PVL configuration against the schema files contained within CSCF_11A.zip and output the validation report to Reports/CSCF_11A_R4B.
Reference List
| [1] Parameter Database (PDB) Installation Instructions, 1/1531-CXP 902 0212 Uen |
| [2] PDB System Administration Guide, 2/1543-CXP 902 0212 Uen |
| [3] PDB User Guide, 2/1553-CXP 902 0212 |