Contents

1   About This Guide

This guide describes how to prepare and deploy configurations for nodes using Parameter Database (PDB).

1.1   Intended Audience

This document is intended for system integrators going on site to configure Ericsson nodes.

1.1.1   Prerequisite Knowledge

Users of this document should have knowledge and experience of the following:

• Familiarity with LDIF and NETCONF configuration files
• Experience with Linux
• Understanding of Ericsson node configuration

1.2   How This Guide is Organized

This document is organized into the following major sections:

1.3   Conventions Used in This Guide

Table 2 provides a list of typographic conventions that may be encountered in this document:

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.4   Related Documents

In addition to the Deploying Node Configurations Using PDB, the following guides are available for this product release:

• PDB Command Line Interface (CLI) Reference (Reference [1])
• PDB System Administration Guide (Reference [2])
• PDB User Guide (Reference [3])

1.5   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   Node Configuration Overview

The Parameter Database (PDB) stores all the necessary configuration information needed to successfully configure nodes within a network environment (for example, IMS nodes such as HSS, CSCF, vEMe, and MTAS).

There are two types of configurations that can be used for a node deployment:

• Reference: Use an existing configuration as the reference for the node deployment. For more information, see Section 4.1.
• Delta: Create a delta configuration based on a reference configuration and modify it to suit your needs. For example, if an Master Parameter Value List (MPVL) configuration does not reflect the required node configuration, then you can customize this configuration for a specific environment by creating a delta configuration. The configuration data delta could enable or disable different modules or change the number of diameter connections. For more information on creating a Delta configuration, see Section 5.1.

2.1   Key Concepts

Understanding the following terms and definitions are useful when working with PDB node configurations:

2.2   Workflow

This section describes a workflow for deployment engineers using PDB to configure nodes on site. The PDB node configuration workflow is as follows:

1. Find the reference configuration: This is done by searching for the reference configuration you need to use to deploy the node configuration. For more information, see Section 4.1.
2. Create a Delta configuration (optional): This is done when you want to modify your selected reference configuration. You would need to create a Delta configuration and modify the configuration to meet your needs. For more information on creating Delta configurations, refer to Section 5.1.
3. Define site specific information: This is performed by mapping and assigning site specific values and managing the site specific variables for an existing node configuration. For more information on defining site specific information, refer to Section 4.3.

   In PDB, a site specific list acts as a container for parameter value variables and can be populated with site specific variables and the associated values.

4. Validate a node configuration: This is done after a node configuration has been modified. The validation process ensures that the configuration conforms to the node configuration's schema definition. For more information on validating node configurations, refer to Section 4.4.
5. Export a node configuration: This involves exporting the node configuration in a ZIP or TAR file making it ready for deployment.

   Node configurations are exported in LDIF or NETCONF format. PDB must resolve all of the site specific variables that have been defined in the configuration data. These variables are resolved manually or through the use of a site specific list.

   • For more information on site specific variables, refer to Section 5.2.7.
   • For more information on defining site specific information, refer to Section 4.3.

   In addition to any site specific variables present in a node configuration, PDB must resolve values for several mandatory Configuration Management (CM) variables that are used to set up the configuration tool itself. For more information on CM variables, refer to Configuration Management Variables in the PDB User Guide (Reference [3]).

   Using PDB, you export a full configuration. Exporting a full configuration includes the entire configuration tree. All parameter groups and parameters associated with the selected configuration, either directly or through inheritance, are included. Full configurations can be used to completely replace any configuration data currently installed on the selected node.

   For more information on exporting a node configuration, refer to Section 4.5.

6. Deploy a node configuration on site: This requires extracting the generated ZIP or TAR file and running the run_configure.sh script to complete the deployment process.

   Note:  

   When deploying a configuration using a NETCONF format, Windows users must run the run_configure.bat script instead of the run_configure.sh script.

   
   

   The deployment of the node configuration is done by running the run_configure.sh script located in the configuration ZIP or TAR file that was generated during the exporting process.

   The configurations in LDIF or NETCONF formats are deployed on the node.

   For more information on deploying a node configuration, refer to Section 4.6.

3   Getting Started

Node configuration activities are performed using the PDB Graphical User Interface (GUI). Connections to the PDB GUI are encrypted. Before accessing the PDB GUI, you must first log in and authenticate yourself. Logging in to PDB requires a valid user account.

To log in to the PDB GUI:

1. In your web browser, connect to the PDB GUI.

   https://<PDB_IP_ADDRESS>:8181/pdb

   The Parameter Database Login window opens. See Figure 1.

2. Enter the valid PDB user name and password.
3. Click Login.

   The PDB GUI is displayed in your browser window. See Figure 2.

Note:  

If you need write access privileges, contact Ericsson support.

3.1   PDB GUI

PDB provides a Graphical User Interface (GUI) to manage the parameter database as shown in Figure 2.

The PDB GUI may display system notifications which are messages drafted by a PDB system administrator to communicate important information to users.

PDB includes a link for IDEAS FEEDBACK on each page. Use to provide ideas on new features or feedback for improvements.

All PDB functionality that is available in the GUI is accessible from the menu options that are always visible on the left side of the window.

Note:  

To deploy node configurations, you will only be working with Configurations and Site Specific workspaces.

The PDB menu provides direct access to the following interfaces:

Help and Support

The PDB GUI includes several links to help and support located in the upper-right corner of the window, under the welcome message.

The following links are available:

PDB Activity Indicator

The PDB GUI includes an activity indicator located at the bottom of the menu options on the left side of the window. The indicator transitions through various colors to reflect the state of PDB requests.

3.1.1   Using Tables

PDB data is presented in tables. Each table uses pagination to divide large data sets. Navigate these tables using the controls () at the bottom of the frame.

The data within each table is sorted in ascending or descending order. The sorting criteria is indicated by the up () or down () arrows in the column headings. You can change the sorting criteria within a table by clicking on the available headings.

4   Defining and Deploying a Node Configuration

PDB allows you to define and deploy a node configuration.

This section describes the steps required to define and deploy a node configuration:

1. Selecting a Reference Configuration
2. Creating a Delta Configuration (Optional)
3. Defining Site Specific Information
4. Validating a Node Configuration
5. Exporting a Node Configuration
6. Deploying a Node Configuration

4.1   Selecting a Reference Configuration

Before defining and deploying a node configuration, you first need to select the reference configuration that you want to use by searching the database.

To select a reference configuration:

• In the Configurations workspace, perform a search by providing a document number (or name) and a node revision and by selecting the MPVL tag. For more information on how to search for a reference configuration, refer to Searching for Node Configurations in the PDB User Guide (Reference [3]).

  The selected configuration is displayed in the Configurations workspace containing the following information:

(1)  This column is normally hidden. Click Show Details to display this information.

4.2   Creating a Delta Configuration (Optional)

This option would be used when the selected Reference configuration must be modified to address specific requirements for the node deployment. The node configuration data can be modified to meet your needs. For more information on creating Delta configurations, see Section 5.1.

4.3   Defining Site Specific Information

Using an existing node configuration, you are ready to define site specific information for the node. Site specific information is contained in site specific lists that are mapped to the variables defined in Section 5.2.

A site specific list is a collection of site specific variables and associated values that can be applied to a node configuration when exporting it in LDIF or NETCONF format.

PDB can automatically add site specific variables from a node configuration to a site specific list. For more information on site specific variables, refer to Section 5.2.7. Once populated with variables, values specific to a target network environment can be added to the site specific list. Each list then becomes an adaptation of a configuration's site-specific information, allowing PDB to resolve site-specific data at export time.

Working with site specific lists involves the following tasks:

• Creating a new Site Specific list
• Adding site-specific variables from a node configuration
• Reporting Site Specific Variable Usage

Once you are done populating site specific variables, you can modify the values for site specific variables. See Section 4.3.4.

Note:  

After modifying the site specific information, it is encouraged to validate the information as described in Section 4.4.

To access the Site Specific Lists workspace:

• Select Site Specific Lists from the menu options on the left. See Figure 3.

4.3.1   Creating a New Site Specific List

New site specific lists can be defined in PDB.

To add a new site specific list:

1. In the Site Specific Lists workspace, click New.

   An empty site specific list is added to the top of the table in edit mode. See Figure 4.

2. Enter the required information. See Site Specific Lists Workspace Elements in the PDB User Guide (Reference [3]).

   Use the following convention when providing a project name: <project>_<site>_<label>.

3. Click Apply.

   The new site specific list is added to the database. New lists are positioned in the table based on the sorting criteria.

4. If required, grant permission for other users to work with the new site specific list by modifying the Access Control List (ACL). For more information on granting ACL permissions, refer to Modifying ACL Permissions in the PDB User Guide (Reference [3]).

4.3.2   Adding Site-Specific Variables from a Node Configuration

You can associate a particular configuration with any site specific list at export time, provided that the list contains all of the site specific variables that are defined in the configuration. Consequently, it is possible for the configurations of two different nodes to use the same site specific list.

PDB can add all site-specific variables defined in a given configuration to a site-specific list, simplifying the list creation process.

When working with delta configurations, PDB has an option to include variables used by deleted parameters in a delta configuration. Adding variables from deleted parameters to a site-specific list allows you to resolve those variables when exporting a configuration in delta-only mode.

Note:  

This procedure can be repeated multiple times to append variables from multiple configurations. With each repeat, only the missing variables are added to the list.

To add site-specific variables from a node configuration:

1. In the Site Specific Lists workspace, select a list to work with.

   The Site Specific Parameters table is displayed. See Figure 5.

   Note:  

   The Site Specific Parameters table shows the variables that are currently included in the list.

   
   

2. Click Add from Configuration.

   The Configurations dialog box opens. See Figure 6.

3. Select a node configuration from the Configuration list.

   Note:  

   This field uses auto-complete functionality. Typing part of the name or revision level displays matching node configurations. Use the down-arrow on your keyboard to display all of the available configurations.

   The revision of the selected configuration is presented in square brackets at the end of the configuration name.

   
   
4. If required, select Include variables used by deleted parameters.

   Note:  

   This option is only available when importing variables from a delta configuration.

   
   
5. If required, select a different configuration format.

   Note:  

   The default configuration format is specified by the PDB node definition and does not need to a change in most cases.

   
   
6. Click Add from Configuration.

   Site-specific variables from the selected node configuration are added to the list.

   Note:  

   Variables imported from a node configuration do not include values. To set site specific values, refer to Section 4.3.4.

   
   

4.3.3   Reporting Site Specific Variable Usage

PDB can report the usage of site specific variables in available node configurations. These reports include detailed information about the Managed Object Instances (MOIs) where variables are being used. These reports provide you with additional information on the type of values assigned to site specific parameters.

To report on the usage of a site specific variable in a node configuration:

1. In the Site Specific Lists workspace, select a list to report on.

   The Site Specific Parameters table is displayed and shows the variables that are currently included in the list. See Figure 5.

2. Click next to the variable that you would like to report on.

   The Usage dialog box opens. See Figure 8.

3. Select a node configuration to search in the Configuration field.

   Note:  

   This field uses auto-complete functionality. Typing part of the name or revision level displays matching node configurations. Use the down-arrow on your keyboard to display all of the available configurations.

   The revision of the selected configuration is presented in square brackets at the end of the configuration name.

   
   
4. Click Find.

   PDB searches the selected configuration for instances of the variable. Once the search is complete, the Parameter table is populated with instances of the site specific variable that are found in the selected configuration.

   Table entries can be selected to populate the schema information for the selected parameter instance.

   Note:  

   Reporting the usage of a specific variable automatically populates the Usage column in the Site Specific Parameters table with a comma-separated list of parameter names that include the variable. The column is populated for all variables that are found in the node configuration.

   
   

4.3.4   Defining Values for Site Specific Variables

The values of existing site specific variables can be modified in PDB.

To modify the value of a site specific variable:

1. In the Site Specific Lists workspace, select a list to work with.

   The Site Specific Parameters table is displayed and shows the variables that are currently included in the list. See Figure 9.

2. Click Edit.

   The Site Specific Parameters table switches to edit mode. See Figure 10.

Figure 10 shows the different elements forming the Site Specific Parameters table in edit mode.

3. Update the values of the site specific parameters as required.

   Note:  

   Site specific variables are not case sensitive.

   
   
4. Click Apply.

   The updated variables are saved to the database.

4.4   Validating a Node Configuration

PDB can validate node configurations to ensure they conform to their respective schema definitions. A validation check is performed automatically as part of the following operations, but should be triggered manually, as needed:

• Importing Configurations
• Migrating Configurations to Another Schema
• Modifying Configuration Data (PDB validates changes to the configuration data on-the-fly)
• Rebasing Delta Configurations

Triggering a manual validation check through the PDB GUI is strongly recommended after any operation that impacts the configuration data and prior to export. All errors and validation warnings must be checked before performing further activities. When more information or clarification is needed, refer to the documentation applicable to the node on which you are working. Warnings are considered as notification of potential issues, but do not block further configuration actions. Errors are any item flagged as high severity.

PDB performs the following checks during schema validation:

Issues discovered during the validation check are output to a plain text file that can be downloaded from the PDB server. The report displays the following messages:

To validate a configuration:

1. In the Configurations workspace, right-click a configuration and select Validate.

   Note:  

   If the configuration is not displayed, perform a search as outlined in the Searching for Node Configurations section of the PDB User Guide (Reference [3]).

   
   

   The Validation dialog box opens. See Figure 11.

2. If required, select an available site specific list to resolve site specific variables in the selected node configuration.

   Note:  

   The Site Specific List field uses auto-complete functionality. Typing part of a name displays matching site-specific lists. Use the down-arrow on your keyboard to display all of the available lists.

   By default, PDB only shows site-specific lists that are associated with this configuration. Select Show All Site-Specific Lists to see all available lists.

   
   
3. Click Validate.

   The node configuration is validated against the associated schema.

   If validation issues are found, the Report Available dialog box opens.

4. Click Download Report to save the Validation report.

Example 1 presents a sample validation report.

CONFIGURATION VALIDATION REPORT
Configuration: /CSCF_11B_R4G_LDIF[PB1]
Schema: CSCF_CM_MIM[A]

WARNING CARDINALITY | PG | SigCompAdvertisedState | Actual cardinality: 0 | Schema constraints: 1-1
WARNING CARDINALITY | PG | SigCompNonTrafficTrace | Actual cardinality: 0 | Schema constraints: 1-1
WARNING CARDINALITY | PG | SigCompProfileContainer | Actual cardinality: 0 | Schema constraints: 1-1
WARNING CARDINALITY | PG | SigCompTrace | Actual cardinality: 0 | Schema constraints: 1-1
WARNING CARDINALITY | PG | SigCompProfile | Actual cardinality: 0 | Schema constraints: 1-1
WARNING       VALUE | P  | tspPmApplication[applicationName=tspPM],tspPmMeasReaderNr=0 |
   Data type: NUMERIC_BIG_DECIMAL | Format: Greater or Equal to: 1 / Less or Equal to: 5000
WARNING       VALUE | P  | tspPmApplication[applicationName=tspPM],tspPmMonitorNr=0 |
    Data type: NUMERIC_BIG_DECIMAL | Format: Greater or Equal to: 1 / Less or Equal to: 500
WARNING       VALUE | P  | DNS-Application[applicationName=DNS],DnsServerEntry=10.80.52.34:53 |
    Data type: STRING | Format: Pattern: ([0-9]{1,3}\.){4}:[0-9]+
INFO         UNUSED | PG | tspPmApplication[applicationName=tspPM],tspPmMonitorGroup
INFO         UNUSED | PG | tspLicenseManagement[applicationName=tspLicenseManagement],
   tspLicenseServerConnection
INFO         UNUSED | PG | NumberNormalisation[applicationName=NumberNormalisation],
   NumNormProfile[NumNormProfile=0],NumNormNsnData
INFO         UNUSED | PG | NumberNormalisation[applicationName=NumberNormalisation],
   NumNormProfile[NumNormProfile=0],NumNormOsnData
INFO         UNUSED | PG | NumberNormalisation[applicationName=NumberNormalisation],
   NumNormProfile[NumNormProfile=0],NumNormDenormalizationSubstitutionRule
...
...
...

4.5   Exporting a Node Configuration

PDB can export the node configuration data in LDIF or NETCONF format and package it in a ZIP or TAR file.

To export a node configuration:

1. In the Configurations workspace, right-click a configuration and select Export.

   Note:  

   If the configuration is not displayed, perform a search as outlined in the Searching for Node Configurations section of the PDB User Guide (Reference [3]).

   
   

   The Export dialog box opens.

The following table describes the elements of the Export dialog box:

2. Enter the required information. See Table 8.
3. Click Export.

   When exporting a node configuration, PDB follows a set of business rules that govern the format and structure of the configuration data. For more information on the PDB export criteria, refer to Export Criteria in the PDB User Guide (Reference [3]).

   The configuration is exported in the selected format. When PDB has finished processing the data, a link to the exported configuration is displayed.

4. Click Download Configuration to save the configuration archive.

Note:  

PDB supports the use of Initial Value Lists (IVLs) that can be associated with configuration schemas. IVLs represent the configuration of a node revision after maiden installation. If the configuration schema of the exported configuration has an IVL associated with it, then PDB will consider those initial values to produce configuration files that will not collide with the configuration data that is assumed to already exist in the real node. For more information on linking an IVL to a schema, refer to Modifying Schema Properties in the PDB User Guide (Reference [3]).

4.6   Deploying a Node Configuration

Node configurations are exported in a compressed TAR or ZIP format. The exported configuration bundle includes the following:

Each archive contains the run_configure script and the node configuration data.

Note:  

When deploying a configuration, Windows users must run the run_configure.bat script, and Linux users must run run_configure.sh.

For TSP based systems with a software level TSP7200 or later, you must use a TLS1.2 capable operating system such as Windows 8.1 or SLES12 Linux. An older OS release can be used, but it must support TLS1.2. Hardening of the LDAP interface now requires secure LDAP in order to communicate with the node.

To configure a node using a configuration bundle exported from PDB in a Linux environment:

1. Deploy the configuration ZIP or TAR file where applicable.
2. Extract the archive within an empty transition directory.
3. If required, set permissions for run_configure.sh so that it can be executed in Linux.

   chmod 777 run_configure.sh

4. Run the script.

   While running, the terminal displays the requests to the node and the responses from the node.

   The following printout shows an example of a successful deployment, and then of an unsuccessful deployment.

   Result:
   
   INFO [2017-11-10 10:45:12,366] c.e.i.p.c.netconf.
   EricNetconfConfigTool: Batch push success!
   
   ---------------------------------------------
   
   INFO [2017-11-10 10:45:12,367] c.e.i.pdb.configtool.netconf.
   EricNetconf: Terminating the SSH session
   Unsuccessful deployment printout:
   ERROR [2017-11-10 10:43:21,222] c.e.i.p.c.netconf.
   EricNetconfConfigTool: Batch push failed.
   ERROR [2017-11-10 10:43:21,248] c.e.i.p.c.netconf.
   EricNetconfConfigTool: there was an error
   configuring the node (opening connection): 6 out of 1287
   failed chunks after 4 attempts.

During the push process, the following log files are generated in the local directory where run_configure is executed:

• out.log

  Contains a record of the transactional information that was printed on screen.

• configtool-<timestamp>.log

  Contains the same transactional information as out.log and also includes Java logger details.

These logs contain all the positive and negative responses to the push requests sent to the node and can be used for troubleshooting. If the configuration was exported in multiple transactions and issues were encountered pushing any of the configuration snippets, a new /failed directory is created in the local directory to hold the configuration snippets that were rejected by the node. Using the contents of this folder and the output logs, you can troubleshoot which parts of the configuration were unusable.

When processing a split configuration, the run_configure scripts use a brute force approach to pushing configuration snippets to the node. On the first pass, all configuration snippets are sent to the node. Any failures in the pass are set aside. During additional passes, any snippets that failed during the previous round are reattempted. This process continues until no snippets were successfully pushed.

The following example shows one possible command sequence for executing the configuration script in Linux.

mkdir -p /tmp/pdbconfigtool
cd /tmp/pdbconfigtool
(deploy configuration bundle here)
unzip config-MPVL_CSCF_13A_FIXED-20130117_153648.zip
chmod 777 run_configure.sh
./run_configure.sh

5   Customizing a Node Configuration

Before creating a node configuration, it is important to understand the following configuration types:

Any configuration can be used as the parent of a delta configuration, including another delta configuration.

5.1   Creating a Delta Configuration

To create a delta configuration:

1. Select Configurations from the menu options on the left. See Figure 12.

2. In the Configurations workspace, right-click a parent configuration for the new delta and select Create Delta.

   Note:  

   If the configuration is not displayed, perform a search as outlined in the Searching for Node Configurations section of the PDB User Guide (Reference [3]).

   
   

   The Delta dialog box opens. See Figure 13.

The following table describes the elements of the Delta dialog box:

3. Enter the required information. See Table 9.
4. Click Create.

   The delta configuration is created.

5. If required, grant permission for other users to work with the new configuration by modifying the ACL. For more information on granting ACL permissions, refer to Modifying ACL Permissions in the PDB User Guide (Reference [3]).

5.2   Modifying Node Configuration Data

With the Delta configuration created, you can now start modifying the node configuration.

Node configurations contain a collection of parameters and parameter groups that are used to configure the software on a node. These parameters and parameter groups (collectively called configuration data) are structured in accordance with a configuration schema that defines all of the legitimate classes and attributes for a specific node revision. For more information on configuration schemas, refer to Working with Schemas in the PDB User Guide (Reference [3])

You can modify the following:

• Parameter Groups
• Parameters
• Site Specific Variables

5.2.1   Working With Parameter Groups

Within the constraints of the schema, you can perform the following tasks in the Configurations workspace:

• Adding a Parameter Group
• Copying and Pasting a Parameter Group
• Commenting a Parameter Group
• Deleting a Parameter Group

To view a configuration in PDB:

• In the Configurations workspace, select a configuration to browse and click Open.

  Note:  

  If the configuration is not displayed, perform a search as outlined in the Searching for Node Configurations section of the PDB User Guide (Reference [3]).

  
  

  Elements of the selected configuration are displayed in the configuration browser.

  To facilitate working with large configurations, the configuration browser includes a search functionality that allows you to filter the displayed list of configuration elements. For more information on the search functionality, refer to Searching Node Configurations in the PDB User Guide (Reference [3]).

5.2.2   Adding Parameter Groups

The configuration browser can be used to add new parameter groups to the local configuration.

To add a new parameter group:

1. In the configuration browser, right-click a parent for the new parameter group and select Add Parameter Group.

   If needed, you can perform a search as described in the Searching Node Configurations section of the PDB User Guide (Reference [3]).

   The Add Parameter Group dialog box opens. See Figure 14.

The following table describes the elements of the Add Parameter Group dialog box:

2. Enter the required information. See Table 10.
3. Click Apply.

   The parameter group is added to the local configuration.

   By default, PDB automatically performs a validation check when adding parameter groups and displays the results, if applicable. The check verifies that the new addition is conformed with the schema definition for this configuration. For a description of the validation check, refer to Section 4.4.

5.2.3   Copying and Pasting a Parameter Group

The configuration browser can be used to copy a parameter group and paste it within the same configuration.

Copying a parameter group captures all configuration elements within the selected group, including subgroups and parameters.

To copy and paste a parameter group:

1. In the configuration browser, right-click a parameter group and select Copy.

   If needed, you can perform a search as described in the Searching Node Configurations section of the PDB User Guide (Reference [3]).

   Note:  

   Root elements and singletons cannot be copied.

   
   

   The parameter group is copied.

2. Navigate the configuration and select a location to paste the parameter group.

   If needed, you can perform a search as described in the Searching Node Configurations section of the PDB User Guide (Reference [3]).

   Note:  

   The configuration schema must allow the copied parameter group to be inserted at the selected location.

   
   
3. Right-click the selected location and select Paste.

   The Copy/Paste Parameter Group dialog box opens. See Figure 15.

The following table describes the elements of the Copy/Paste Parameter Group dialog box:

4. Enter the required information. See Table 11.
5. Click Apply.

   The copied parameter group is pasted under the selected location.

   By default, PDB automatically performs a validation check when pasting parameter groups and displays the results, if applicable. The check verifies that the new addition is in line with the schema definition for this configuration. For a description of the validation check, refer to Section 4.4.

5.2.4   Commenting a Parameter Group

The configuration browser can be used to add, modify, or remove descriptive comments for parameter groups in the local configuration.

To comment on a parameter group:

1. In the configuration browser, right-click a parameter group to comment and select Edit.

   If needed, you can perform a search as described in the Searching Node Configurations section of the PDB User Guide (Reference [3]).

   The Edit dialog box opens. See Figure 16.

2. Add, modify, or remove your comment in the Comment field.
3. Click Apply.

   The parameter group is updated.

5.2.5   Deleting a Parameter Group

Authorized users can remove parameter groups from a configuration.

Deleting inherited elements does not remove them from the parent configuration. When an inherited element is removed from a delta configuration, it is replaced with a deleted data reference that is accessible at the corresponding location in the Delta Only view. This data reference can be restored to bring back the inherited data.

To delete a parameter group from the local configuration:

1. In the configuration browser, right-click a parameter group to remove and select Delete.

   If needed, you can perform a search as described in the Searching Node Configurations section of the PDB User Guide (Reference [3]).

   A confirmation dialog box opens.

   Caution!

   Deleting a parameter group also removes all child parameter groups and any associated parameters.

2. Click OK.

   The selected parameter group is removed from the local configuration.

5.2.6   Working with Parameters

Within the constraints of the schema, you can perform the following tasks in the Configurations workspace:

• Adding Parameters
• Adding Parameter Structs
• Modifying Parameters or Parameter Structs
• Deleting Parameters or Parameter Structs

5.2.6.1   Adding Parameters

The configuration browser can be used to add new parameters to the local configuration. Parameters can be added using the Add Parameter dialog box, described here, or directly in the configuration browser using in-line editing. For more information on using in-line editing to add new parameters, refer to Section 5.2.6.2.

To add a new parameter using the Add Parameter dialog box:

1. In the configuration browser, right-click a parameter group that will contain the new parameter and select Add Parameter.

   If needed, you can perform a search as described in the Searching Node Configurations section of the PDB User Guide (Reference [3]).

   The Add Parameter dialog box opens. See Figure 17.

The following table describes the different elements forming the Create Parameter Instance dialog box:

2. Enter the required information. See Table 12.
3. Click Apply.

   The parameter is added to the local configuration.

   By default, PDB automatically performs a validation check when adding parameters and displays the results, if applicable. The check verifies that the new addition is conformed with the schema definition for this configuration. For a description of the validation check, refer to Section 4.4.

   If this parameter has been populated with a parameter value variable, the validation check will verify that the variable is defined in the Global Variables list. PDB warns if the variable is not defined in the global list, but does not prevent the use of custom variables.

5.2.6.2   Adding Parameters Using In-Line Editing

The PDB configuration browser allows you to add parameters directly to a configuration using in-line editing. This process makes it easier to work with multiple parameters at the same time, allowing you to make additions in a single step.

Note:  

In-line editing, can only add unused parameters to a node configuration.

To add parameters using in-line editing:

1. In the configuration browser, select the following options:
   • Enable TREE view (default) by selecting TREE from the format list.
   • Enable the display of unused configuration elements by selecting the Show Unused check box.

   For more information on these configuration browser options, refer to The Configuration Browser section of the PDB User Guide (Reference [3]).

2. Navigate to a parameter group containing the unused parameters that you want to add.

   If needed, you can perform a search as described in the Searching Node Configurations section of the PDB User Guide (Reference [3]).

   The list of parameters is displayed in the right frame. See Figure 18.

   Note:  

   Unused parameters that are not instantiated in the current configuration are colored purple and are commented with Not present. Existing parameters can be modified while adding new elements. For more information on modifying parameters using in-line editing, refer to Section 5.2.6.5.

   
   

3. Click Edit In-Line at the top of the parameters table or right-click a parameter and select Edit In-Line.

   The parameters table opens in edit mode. See Figure 19.

4. For each unused parameter, enter the required information and select the Create check box.

   If an usused parameter has a default value, the default will be set as the initial value.

   For more information on the parameter fields, refer to Section 5.2.6.1.

   Note:  

   Unused parameters can only be added to a parameter group that is part of the node configuration. If the selected parameter group is also unused, the corresponding primary key will be automatically selected for addition.

   
   
5. Click Apply.

   The new parameters are added to the node configuration.

5.2.6.3   Adding Parameter Structs

Where permitted by the configuration schema, parameter structs can be added to the local configuration. The configuration browser treats parameter structs in the same way as parameter groups. In TREE view, a parameter struct is added in the left frame, along with parameter groups, and the associated struct members are modified in the right frame.

To add a new parameter struct:

1. In the configuration browser, right-click a parameter group that will contain the new parameter struct and select Add Parameter Struct.

   If needed, you can perform a search as described in the Searching Node Configurations section of the PDB User Guide (Reference [3]).

   The Add Parameter Struct dialog box opens. See Figure 20.

The following table describes the different elements forming the Add Parameter Struct dialog box:

2. Enter the required information. See Table 13.
3. Click Apply.

   The parameter struct is added to the local configuration.

   By default, PDB automatically performs a validation check when adding parameter structs and displays the results, if applicable. The check verifies that the new addition is in line with the schema definition for this configuration. For a description of the validation check, refer to Section 4.4.

5.2.6.4   Modifying Parameters or Parameter Structs

The properties of an existing parameter or parameter struct can be modified. In addition to these changes, PDB also allows you to edit Primary Key parameters that are local to the configuration.

Note:  

Modifying a Primary Key changes the DN of the associated parameter group.

Any Primary Key parameters that are inherited from the parent configuration cannot be modified in a delta configuration.

Parameters and struct members can be modified through the Edit dialog box, described here, or directly in the configuration browser using in-line editing. For more information on using in-line editing to modify parameters or struct members, refer to Section 5.2.6.5.

To update a parameter or parameter struct using the Edit dialog box:

1. In the configuration browser, right-click a configuration element to modify and select Edit.

   If needed, you can perform a search as described in the Searching Node Configurations section of the PDB User Guide (Reference [3]).

   The Edit dialog box opens. See Figure 21.

2. Update the Value or Comment fields, as required.
3. Click Apply.

   The configuration element is updated. If required you can move directly to an adjacent parameter or parameter struct instance using the navigation buttons.

   By default, PDB automatically performs a validation check when modifying a parameter and displays the results, if applicable. The check verifies that your change is conformed with the schema definition for this configuration. For a description of the validation check, refer to Section 4.4.

   If this edit has populated a parameter with a parameter value variable, the validation check will verify that the variable is included on the Global Variables list. PDB warns if the variable is not defined in the global list, but does not prevent the use of custom variables.

   Note:  

   PDB tracks modifications to parameters and parameter structs across configuration revisions. Value changes along with any associated CRs are captured in the Parameter Value History.

   To view the history of a parameter or parameter struct, select it in the configuration browser and click History.

   
   

5.2.6.5   Modifying Parameters and Struct Members Using In-Line Editing

The PDB configuration browser allows you to modify parameters or struct members using in-line editing. This process makes it easier to work with multiple values at the same time, allowing you to several changes in a single step.

To modify parameters or struct members using in-line editing:

1. In the configuration browser, enable TREE view (default) by selecting TREE from the format list.

   For more information on configuration browser options, refer to The Configuration Browser section of the PDB User Guide (Reference [3]).

2. Select a parameter group or parameter struct containing the configuration elements that you want to modify.

   If needed, you can perform a search as described in the Searching Node Configurations section of the PDB User Guide (Reference [3]).

   A list of parameters or struct members is displayed in the right frame. See Figure 22.

   Note:  

   Unused parameters that are not instantiated in the parent configuration are colored purple and are commented with Not present. These parameters can be added to the delta configuration while modifying other elements. For more information on adding unused parameters using in-line editing, refer to Section 5.2.6.2.

   
   

3. Click Edit In-Line at the top of the table or right-click a configuration element and select Edit In-Line.

   The parameters table opens in edit mode. See Figure 23.

4. For each parameter or struct member, enter the required information.

   For more information on the parameter fields, refer to Section 5.2.6.4.

5. Click Apply.

   The updated configuration elements are added to the node configuration.

5.2.6.6   Deleting Parameters or Parameter Structs

Authorized users can remove parameters or parameter structs from a configuration.

Note:  

Individual struct members and primary key parameters cannot be deleted in this way.

To remove a primary key parameter, you must delete the associated parameter group. For more information on deleting parameter groups, refer to Section 5.2.5.

To remove a struct member, the entire parameter struct must be deleted.

Deleting inherited elements does not remove them from the parent configuration. When an inherited element is removed from a delta configuration, it is replaced with a deleted data reference that is accessible at the corresponding location in the Delta Only view. This data reference can be restored to bring back the inherited data.

If a configuration has inherited several instances of a given parameter type, all instances can be blocked at the same time using Block All.

To delete a parameter or parameter struct from the local configuration:

1. In the configuration browser, right-click a parameter or parameter struct to remove and select Delete.

   If needed, you can perform a search as described in the Searching Node Configurations section of the PDB User Guide (Reference [3]).

   A confirmation dialog box opens.

2. Click OK.

   The selected parameter or parameter struct is removed from the local configuration.

5.2.7   Working with Site Specific Variables

Node configurations can include a number of site-specific parameters that define parts of the target network environment, such as IP addresses, port numbers, domain names, and login credentials, that cannot be known in advance. To facilitate working with site-specific information, PDB allows you to populate these values with parameter value variables.

Site-specific variables act as a place holder for legitimate values. When exporting a node configuration in LDIF or NETCONF format, these variables must be resolved manually or through the use of a site-specific list.

• For more information on exporting node configurations, refer to Section 4.5.
• For more information on site-specific lists, refer to Section 4.3.

Using variables to populate the site-specific parameters inside a node configuration allows it to function independently of site-specific information.

PDB identifies a parameter value variable as a string defined between double curly brackets {{ and }} that uses the following supported characters:

• alpha-numeric (a,A, to z,Z and 0-9)
• underscore ( _ )
• dash ( - )

For example, the string {{server_abc_ip_address}} is considered to be a site-specific variable called server_abc_ip_address.

PDB does not support nested site-specific variables, such as {{somename@{{domain}}}}.

PDB includes a global list of parameter value variables. This list allows authorized users to define a set of variables that are recommended for use in PDB. Global variables can be added to a node configuration using auto-complete functionality.

Variables are defined for site-specific parameters in the same way as regular values. For more information, refer to the previous sections.

Reference List