Contents

1   Introduction

This document describes the Ericsson Command-Line Interface (ECLI). It is based on industry de facto standard patterns.

The ECLI is a terminal-based command-line interface that allows the user to monitor and manage the Managed Element (ME). The ECLI enables the user to interact with the Management Information Base (MIB) through common, generic-purpose commands.

1.1   Related Information

For information on the Managed Object Model (MOM), Managed Object Classes (MOCs), Managed Objects (MOs), and related concepts mentioned in this document, refer to Managed Object Model User Guide.

1.2   Key Features of ECLI

The key features of the ECLI are described in Table 1.

Note:  

The examples in this document are based on models that are subject of change. For node name, NODE06ST is used as an example.

1.3   Prerequisites

This section describes the prerequisites, which must be fulfilled before using the ECLI.

1.3.1   Conditions

The following conditions must apply:

• A client supporting the Operation and Maintenance (O&M) network protocol implemented by the ME, for example a Secure Shell (SSH) version 2 client, is available. Terminal type VT100 is supported. For information on terminal types, see Section 4.1 Terminal Types.
• The user has IP access to the O&M address of the ME.
• The user has a valid O&M user account.
• Suitable firewall settings enable access to the ECLI port.

1.4   ECLI Version

The CLI version can be displayed by command version, see Section 3.12 Display CLI Version.

The CLI version is described using three sequence numbers, <major>.<minor>.<revision>, where:

• <major> is incremented when a significant and non-backward compatible change is made, for example, when a command is deleted, or when the syntax or behavior of a command is changed.
• <minor> is incremented when a significant but backward compatible change is made, for example, when a new command is added or when new options are added to an existing command.
• <revision> is incremented when a minor change not affecting the behavior is made, for example, when a fault that made a documented function unusable is corrected.

The version number informs CLI users, including scripts and programs, about what behavior to expect from the CLI commands. Usability enhancing features, like auto-completion and help, are not considered in the version number.

Commands labeled as optional in this document are not considered in the version number.

This document describes CLI version 1.5.0.

1.4.1   Changes between CLI Versions 1.4.0 and 1.5.0

CLI 1.5.0 adds support for the following:

• Fetch real time counter values by using new filter options -g and -m for Performance Management (PM) groups and measured objects respectively and -f option to format the output.
• Re-initializing an object from any cursor location.

CLI 1.5.0 removes constraint validation during navigation and errors can be checked only by issuing a validate or commit command.

1.4.2   Changes between CLI Versions 1.3.0 and 1.4.0

CLI 1.4.0 adds support for the following:

• Show command and its variants, upon failing to retrieve information from a certain MO instance, or group of MO instances with MO SPI error, continues to display information from the following MO instances, if any.
• Comments in CLI input using comment delimiter.
• Unidirectional association with external objects.

1.4.3   Changes between CLI Versions 1.2.1 and 1.3.0

CLI 1.3.0 adds support for the following:

• Retrieving model information using the new parameters --moc, --property, and --tree to command help.
• Regular expressions in search conditions.
• Performing operations on multiple MO instances using the new pipe commands action, modify, and no.

CLI 1.3.0 improves Tab completion support for typed MO reference values.

CLI 1.3.0 removes auto-completion on the comma (,), equal sign (=), and space (Space) keys.

1.4.4   Changes between CLI Versions 1.2.0 and 1.2.1

CLI 1.2.1 changes the name of command reset to reinit.

1.4.5   Changes between CLI Versions 1.1.1 and 1.2.0

CLI 1.2.0 adds support for the following:

• Command reset to set an attribute or an MO instance back to its default state.
• Command back to navigate back to a previously visited CLI position.
• Recursive searching with search conditions in command show and show-table.
• Searching for an MO instance to navigate to in command dn.
• More escape sequences in string values.
• Passphrase strings.
• Addressing individual values in sequences of simple types using indexes.
• Tab completion of multiple attribute assignments on the same command line, and of MO reference values.

1.4.6   Changes between CLI Versions 1.1.0 and 1.1.1

CLI 1.1.1 adds option -s|--sort to command show, show-config, show-mib, and show-table. With this option, MO instances are sorted according to their instance names.

1.4.7   Changes between CLI Versions 1.0.0 and 1.1.0

CLI 1.1.1 adds support for the following:

• Floating point numbers.
• MO key attributes of integer and enumeration types. This does not affect the CLI syntax, but new error messages specific to these types can be returned when attempting to create an MO instance.
• Properties canCreate and canDelete on MO relations. This does not affect the CLI syntax, but new error messages specific to these properties can be returned when attempting to create or delete an MO instance.

2   CLI Concepts

This section describes the CLI concepts.

2.1   CLI Modes

The CLI provides the following modes:

• Exec mode – Displays the status of the ME. In this mode, the user enters commands to monitor the ME, display its configuration, and execute actions.
• Config mode – Used to change the ME configuration. In this mode, the user starts a configuration transaction to the MIB, enter commands to change the ME configuration, and commit the changes.

Attention!

Risk of data loss or data corruption.

Unless stated otherwise, only execute actions in Exec mode to minimize the risk to misconfigure the system.

As shown in Figure 1, when the user initiates a CLI session, the user always enter Exec mode, which is the default mode.

Depending on the CLI mode, different CLI functions and set of CLI commands are supported with different parameters.

2.2   CLI Session

This section describes a CLI session. A CLI session can be started over SSH and TLS.

2.2.1   Start a CLI Session over SSH

How to start a CLI session depends both on the O&M network protocol implemented by the ME and on the client. This section describes two common cases:

• With a standard SSH client towards an ME that provides a dedicated CLI SSH port on the O&M address.
• With a standard SSH client towards an ME that provides an SSH port that is shared with between services.

2.2.1.1   Log On to CLI Session over SSH

To start a CLI session:

1. Use a terminal and start the SSH session.

   Example of logon with OpenSSH client:

   ssh <user>@<target_host> -p 22

   The options are as follows:

   • <user> – Username.
   • <target_host> – The OAM virtual IP address of the ME.
   • -p (port number) – TCP port 22 is default.

   Root user access is denied.

2. Wait for the session to start.

2.2.1.2   Log On to CLI Session over SSH (Deprecated)

To start a CLI session:

1. Use a terminal and start the SSH session.

   Example of logon with OpenSSH client:

   ssh <user>@<target_host> -p 22 -t -s cli

   The options are as follows:

   • <user> – Username.
   • <target_host> – The OAM virtual IP address of the ME.
   • -p (port number) – TCP port 22 is default.
   • -t (force pseudo-tty allocation).
   • -s (subsystem) – Use cli.

   Root user access is denied.

2. Wait for the session to start.

2.2.1.3   Successful Logon

When logon is successful, a startup message can be displayed (if it is configured), the session starts in Exec mode, and the prompt is displayed.

2.2.1.4   Unsuccessful Logon

Logon can fail because of the reasons specified in Table 2.

2.2.2   Start a CLI Session over TLS

2.2.2.1   Log On to CLI Session over TLS

1. Start a TLS connection.

   Example of logon with OpenSSL s_client:

   openssl s_client -connect <host>:<port> -quiet -tls1 -bugs -cert <nodecert> -key <nodekey> -CAfile <cacert>

   The options are as follows:

   • <host> – O&M IP address or hostname of the ME.
   • <port> – Transmission Control Protocol (TCP) port 6522 is default.
   • <nodecert> – Certificate file to use, PEM format is assumed.
   • <nodekey> – The private key to use. If not specified, the certificate file is used.
   • <cacert> – PEM format file of CAS.

Note:  

The client certificate contains the user identity in field subjectAltName.

2.2.2.2   Successful Logon

When logon is successful, a startup message can be displayed, the session starts in Exec mode, and the prompt is displayed.

2.2.2.3   Unsuccessful Logon

TLS client-specific error messages are displayed. For more information, refer to respective client documents (example: OpenSSL s_client).

2.2.3   Parallel Sessions

The maximal number of parallel sessions is 256.

2.2.4   Session Inactivity Timer

When the predefined time has passed without activity in the CLI, the system automatically aborts the ongoing transaction and closes the session without any warning. Activity in a CLI session means any operation resulting in data exchange between the terminal and the server.

The default inactivity timer value is 120 seconds.

2.2.5   CLI Session End

CLI session is closed either as a result of command exit or when the session inactivity timer expires.

2.3   CLI Transaction

Configuration changes are applied in a transaction in such a way that all or none of the operations are executed.

If an action executed in Exec mode changes the configuration, the change is committed automatically when the action is executed. In Config mode, all configuration changes, whether from configuration commands or from actions, are committed with command commit [-s|--stay].

2.3.1   Start

The CLI session starts in Exec mode and can be changed to Config mode by command configure.

If the CLI mode is changed to Config mode, this initiates a new configuration transaction to the MIB.

2.3.2   Commit

Command commit [-s|--stay] validates the transaction and, on success, commits the configuration changes. The CLI position is unchanged, unless the MO in the CLI position no longer exists; in this case the CLI position moves to the closest instantiated parent MO location.

Command commit without any argument performs a commit and the CLI mode changes to Exec mode.

(config-ManagedElement=NODE06ST)>userLabel="Stockholm, Building 25"
(config-ManagedElement=NODE06ST)>commit
(ManagedElement=NODE06ST)>

Command commit -s or commit --stay performs a commit, the CLI remains in Config mode and starts a new transaction instead of returning to Exec mode.

(config-ManagedElement=NODE06ST)>userLabel="Stockholm, Building 25"
(config-ManagedElement=NODE06ST)>commit -s
(config-ManagedElement=NODE06ST)>

If the command is completed without errors, nothing is displayed by the system.

From the CLI perspective, a successful commit command consists of following three steps:

1. Validates the data in the transaction against model restrictions, such as multiplicity and cardinality.
2. Requests validation of the transaction from the middleware.
3. Requests transaction commit from the middleware.

If any of the three steps fail, an error message is displayed and the command does not proceed to the next step.

Validation errors related to multiplicity and cardinality from all the MOs are thrown when validate or commit command is executed, as shown in Example 3.

Note:  

It is recommended to use command validate before commit to verify that the entered changes are valid.

(config-ManagedElement=NODE06ST)>TestRootMoc=1
(config-TestRootMoc=1)>..,TestRootMoc=2
(config-TestRootMoc=2)>commit
ERROR: Unable to commit incomplete object (ManagedElement=NODE06ST,TestRootMoc=1)
Minimum multiplicity of 1 is violated for attribute (mandatoryBoolMultivalueAttr)
Minimum multiplicity of 2 is violated for attribute (stringMultivalueAttr)
Current cardinality of 0 for class-instance of  TestRootChildMoc is < 1 (lower-limit) for
ManagedElement=NODE06ST,TestRootMoc=1
ERROR: Unable to commit incomplete object (ManagedElement=NODE06ST,TestRootMoc=2)
Minimum multiplicity of 1 is violated for attribute (mandatoryBoolMultivalueAttr)
Minimum multiplicity of 2 is violated for attribute (stringMultivalueAttr)
Current cardinality of 0 for class-instance of  TestRootChildMoc is < 1 (lower-limit) for
ManagedElement=NODE06ST,TestRootMoc=2
(config-TestRootMoc=2)>

2.3.2.1   Model Validation Phase Error Messages

When command commit fails during the model validation, model restrictions have been violated by the data in the current transaction. The error messages are described in Table 3.

When the model validation is unsuccessful, the transaction is still valid and its state is the same as before command commit was executed.

2.3.2.2   Middleware Validation Phase Error Messages

Command commit can fail during the middleware validation phase. The error messages are described in Table 4.

2.3.2.3   Commit Phase Error Message

When command commit fails during the commit phase, an error message is displayed, which is described in Table 5.

The following warning is displayed to notify that the prompt is changed because of cursor points to an uninstantiated MO:

Invalid location. Cursor points to uninstantiated MO

This can occur if command commit fails and the MO that the cursor points to was created in the transaction that was lost.

2.3.3   Abort

Command abort [-s|--stay] discards the changes in the transaction and terminates the transaction.

Command abort without any argument performs an abort and, on success, returns to Exec mode.

(config-ManagedElement=NODE06ST)>userLabel="Stockholm, Building 25"
(config-ManagedElement=NODE06ST)>abort
(ManagedElement=NODE06ST)>

Command abort -s or abort --stay performs an abort and starts a new transaction. The CLI position is unchanged, unless the MO in the CLI position no longer exists; in this case the CLI position moves to the closest instantiated parent MO location.

(config-ManagedElement=NODE06ST)>userLabel="Stockholm, Building 25"
(config-ManagedElement=NODE06ST)>abort -s
(config-ManagedElement=NODE06ST)>

If the abort fails, this results in an error message and the CLI mode is unchanged.

2.3.4   End

Command end returns from Config mode to Exec mode when there are no changes in the configuration transaction. The CLI position is unchanged, unless the MO in the CLI position no longer exists; in this case the CLI position moves to the closest instantiated parent MO location.

Use command abort or commit to return to the Exec mode after entering configuration changes.

(config-ManagedElement=NODE06ST)>end
(ManagedElement=NODE06ST)>

If transactional changes have been made, the command returns error message Configuration changes have been made in the current transaction, use 'abort' or 'commit' to leave config mode.

2.3.5   Time-Out

At transaction inactivity time-out, the following events are triggered:

• Transaction abort resulting in deletion of transaction content and MO locks.
• State of the transaction is changed from active to timed out.
• Start of transaction cleanup timer triggering transaction ID and state deletion after a system-defined period, which is 3600 seconds by default.

The first operations entered in a timed out, but not deleted, transaction is replied with the following transaction time-out error message:

ERROR: Transaction broken, possibly because of a timeout. Uncommitted changes have been lost

If the session inactivity timer occurs before transaction time-out, the session is closed and the transaction is immediately aborted.

2.3.6   Exit

Command exit exits the CLI session. This command is valid only in the Exec mode.

2.4   CLI Position

The CLI position is a Distinguished Name (DN) of an MO instance identifying a position in the MO tree. The CLI position can be changed by navigation commands, such as directory change commands in a directory tree of a file system.

2.4.1   Distinguished Name

The DN identifies an MO instance with comma-separated sequence of <class_name>=<key_value> name value pairs.

ManagedElement=NODE06ST,SystemFunctions=1,SysM=1,Snmp=1

2.4.2   Local Distinguished Name

The Local Distinguished Name (LDN) is a DN starting at LDN root and provides address of MO instance through its sequence of parent MOs. The LDN root is ManagedElement=<managed_element_id>.

The MOs are organized in a hierarchical structure. Each MO instance is uniquely identified in the node by its LDN. The highest MO in a node, the root MO, is ManagedElement and represents the whole node.

When an MO is located further down in the MO tree, the LDN must contain the MO classes identifying all parents of that MO, in a sequence going from the root MO down to the MO in question.

ManagedElement=NODE06ST
ManagedElement=NODE06ST,SystemFunctions=1,
ManagedElement=NODE06ST,SystemFunctions=1,SysM=1
ManagedElement=NODE06ST,SystemFunctions=1,SysM=1,Snmp=1

In this example, ManagedElement=NODE06ST has child SystemFunctions=1, which has child SysM=1, which has child Snmp=1 representing Snmp. The LDN of the lowest MO (Snmp=1) contains the address of all successive parents of that MO all the way up to ManagedElement=NODE06ST.

2.4.3   Relative Distinguished Name

The Relative Distinguished Name (RDN) is the address of an MO instance in relation to its parent MO. It is a <name_value> pair DN.

For example, SysM=1 is the RDN for LDN ManagedElement=NODE06ST,SystemFunctions=1,SysM=1.

2.4.4   CLI Path

An CLI path, denoted <path>, can consist of either an LDN or an RDN.

2.4.5   Valid Positions in Tree

Considering the LDN ManagedElement=NODE06ST,SystemFunctions=1,SysM=1, the valid positions in the tree are described in Table 6.

2.4.6   Interpretation of CLI Commands

CLI commands are interpreted in the context of the CLI position. That is, attribute names, action names, and RDNs are prepended by the DN indicating the CLI position. For example, the following operations show the same attribute from different CLI positions:

(config)>show ManagedElement=NODE06ST,SystemFunctions=1,SysM=1,userLabel

(config-ManagedElement=NODE06ST)>show SystemFunctions=1,SysM=1,userLabel

(config-SystemFunctions=1)>show SysM=1,userLabel

(config-SysM=1)>show userLabel

2.5   CLI Prompt

The CLI prompt provides information on the status and context of the CLI session as follows:

• In Exec mode, the default prompt is >. The prompt is changed in Exec mode, based on the RDN value during navigation, to (RDN)>.
• In Config mode, the default prompt is (config)>. The prompt is changed in Config mode, based on the RDN value during creation or navigation, to (config-RDN)>.

After session start, command prompt changes the prompt configuration in any of the CLI modes for the lifetime of the session to contain any elements shown in Table 7.

If the CLI prompt is longer than the terminal width, it continues on the next line.

2.6   Context-Sensitive Help

The CLI provides online and context-sensitive help. It enables the user to access information and learn about the commands, the MIB, and the MOM without relying on the documentation library.

By pressing the ? key, the user can request context-sensitive help on the CLI operations and MOM elements (MOCs, attributes, and actions) that are available for the following:

• CLI mode
• CLI position
• CLI command

After the help text, a new prompt without the ? character is displayed. If no help text is available, only a new prompt is displayed.

Note:  

The CLI supports only US-ASCII characters. If any other character is to be displayed in help text, it is displayed as a question mark (?) in the CLI terminal.

Verbose Help is provided if the context uniquely identifies a single MOM element, else only Brief Help on all available elements is listed, as a summary.

Verbose Help is provided when pressing the ? key on a single element (CLI command or MOM element).

No help is provided when pressing the ? key on partial command (if context does not find any hit for MOM elements).

CLI help is not available for the position in key values of the CLI path. For example, no CLI help is provided in the following cases:

• On an attribute in command show-config <path>, <attribute_name> if the attribute is defined as read-only or restricted.
• On a MOC in command show-config [<path>], <class_name> if the class is defined as system-created and has no MO instance created.
• On a MOC in command show [<path>], <class_name> if the class is defined as not system-created and has no MO instance created.

Note:  

Command help can also be used to retrieve help on both CLI commands and the model. For more information, see Section 3.14 Help Command.

2.6.1   Brief Help

A description of the Brief Help content and format is provided in Table 8.

The class, attribute, and action descriptions are displayed in a truncated form (first sentence only). Truncation is not indicated in the printout. The text-formatting characters (tab, new line) are deleted from the description printouts.

For example, (config-ManagedElement=NODE06ST)>?, brings Brief Help information about the ManagedElement MOC attributes and the child MOCs, as shown in Example 9 and Example 10.

(config-ManagedElement=NODE06ST)>?
dateTimeOffset        Difference between the value of the localDateTime attribute and UTC
                      (Coordinated Universal Time).
dnPrefix              It provides naming context allowing the managed objects to be partitioned
                      into logical domains.
localDateTime         This is the local date and time for the Managed Element.
managedElementId      Contains the identity of a release of the product type being managed.
managedElementType    The type of product being managed.
networkManagedElementId Replaces the value component of the RDN in the COM Northbound Interface.
productIdentity       Contains product information for the Managed Element and its Managed
                      Function(s).
release               The release of the type of product specified by the attribute
                      managedElementType.
siteLocation          A freetext attribute describing the geographic location of a Managed
                      Element.
timeZone              This is the timeZone that the Managed Element resides in.
userLabel             A freetext string for additional information to assist Managed Element
                      identification.
+SystemFunctions      This model has a structural purpose to group the management of the system
                      functions of the Managed Element
+Transport            This is a container for common transport functions used within the Managed
                      Element.
[...]

(config-MOex1=1)>addNumbers ?
--num1                   Number one
--num2                   Number two

The following indicators are used to indicate what syntax is used to interact with the data type:

• () action or command that can be executed
• + MO instance or struct that can be navigated to

(config-ManagedElement=NODE06ST)>?
actionA() first line of help text
myMultiValueAttr[] first line of help text
+B first line of help text

2.6.2   Verbose Help

A description on the Verbose Help content and format is provided in Table 9.

(1)  The [singleton] class specifier is present if exactly one instance of this class can exist as a child MO of its actual parent. The [optional] class specifier is present if zero is the minimal number of instances of this class as a child MO of its actual parent.

(2)  The [exclusive] specifier can only be present for struct members, and means that struct property isExclusive is set. See Section 3.3.1 Display Single-Valued Attribute.

The descriptions of class, attribute, and action are displayed in a complete form without truncating the text. The text formatting characters (tab, new line) are kept.

>show ManagedElement=NODE06ST,SystemFunctions ?
SystemFunctions	MO Type [singleton] [optional]
This model has a structural purpose to group the management of the system functions
of the Managed Element.

(config)>ManagedElement=NODE06ST,userLabel ?
userLabel	  String [optional]
A freetext string for additional information to assist Managed Element identification.

(config-ManagedElement=NODE06ST)>siteLocation ?
siteLocation   String [optional]
A freetext attribute describing the geographic location of a Managed Element.

If help is triggered directly after (without space) the CLI operation or action name, Verbose Help is provided on the operation, as shown in Example 15.

(config-ManagedElement=NODE06ST)>show?
show	  Command
Display information

If help is triggered separated by space from the command or action name, Verbose Help is provided on the operation parameter, as shown in Example 16 through Example 20.

(config)>show ?
--moc                          Option to select a specific Child MOC under the current DN
--recursive                    Display all information
--sort                         Sort the MO instances in numerical/alphabetical order
--verbose                      Display verbose information
-m                             Option to select a specific Child MOC under the current DN
-r                             Display all information
-s                             Sort the MO instances in numerical/alphabetical order
-v                             Display verbose information
+ManagedElement                The top-level class in the Common Information Model
                               is Managed Element root Managed Object Class.

(config-MOex2=1)>concatString_defValues --str1 ?
--str1                         String [optional/default=com]
String one

(config)>show-mib ?
--sort                         Sort the MO instances in numerical/alphabetical order
--verbose                      Display full path of MO instance information
-s                             Sort the MO instances in numerical/alphabetical order
-v                             Display full path of MO instance information
+ManagedElement                The top-level class in the Common Information Model
                               is Managed Element root Managed Object Class.

(config)>show -v ?
--recursive                    Display all information
--sort                         Sort the MO instances in numerical/alphabetical order
-r                             Display all information
-s                             Sort the MO instances in numerical/alphabetical order
+ManagedElement                The top-level class in the Common Information Model
                               is Managed Element root Managed Object Class.

(config)>show-table ?
--moc                          Option to select a specific Child MOC under the current DN
--recursive                    Display all information
-m                             Option to select a specific Child MOC under the current DN
-r                             Display all information
+ManagedElement                The top-level class in the Common Information Model
                               is Managed Element root Managed Object Class.

(config)>show | filter  ?
--after                        Print number of lines of trailing context after matching lines
--before                       Print number of lines of leading context before matching lines
--ignore                       Ignore case distinctions in both the pattern and the input
--invert                       Invert the sense of matching, to select non-matching lines
-A                             Print number of lines of trailing context after matching lines
-B                             Print number of lines of leading context before matching lines
-i                             Ignore case distinctions in both the pattern and the input
-v                             Invert the sense of matching, to select non-matching lines
<pattern>                      The text used for pattern matching

2.7   Auto-Completion

By pressing the Tab key at any position of the CLI command, completion can be requested on all possible continuations of the CLI command and MOM-defined elements the user is authorized to.

Depending on the entered command, the response can be as shown in Table 10.

Auto-completion is provided only for valid CLI commands the user is authorized to, in a context-sensitive way, for example, as follows:

• Completion is provided for DNs as parameter of command show if the MO exists and the user has read privilege to the MO.
• Completion is provided for attribute names as parameter of command show if the attribute has a value assigned and the user has read privilege to the attribute.
• Completion is provided for an attribute name in an attribute value change operation if the attribute is not defined as readOnly or restricted, and if the user has write privileges to the attribute.
• Read-only and restricted attributes are not auto-completed as parameters of command show-config.
• Completion is provided for parameters of an action if the parameter exists.

2.7.1   Keys Activating Auto-Completion

The keys in Table 11 activate auto-completion in the listed contexts if the entered partial name uniquely identifies the name of the command or its parameter.

2.7.2   Examples of Completion Possibility Lists

This section provides examples of completion possibility lists.

(config)>show<Tab>
show-config
show-dn
show-mib
show-table
<cr>
<space>

(config-MOex3=1)>add<Tab>
addNumbers
addNumbers_defValues
addNumbersNameClash
addsoc

(config-MOex4=1)>addNumbers --n<Tab>
--num1
--num2

(config)>show <Tab>
--moc
--recursive
--sort
--verbose
-m
-r
-s
-v
ManagedElement=NODE06ST
<cr>

(config-ManagedElement=NODE06ST)>show | filter <Tab>
--after
--before
--ignore
--invert
-A
-B
-I
-v
<pattern>

2.7.3   Examples of Auto-Completion

Examples of auto-completion are shown in Table 12.

2.7.4   Auto-Completion of MO Reference Type

Completion of MO reference values are supported when the value starts with a quote. The behavior is different depending on the type of the MO reference. A generic reference is allowed to have any MOC instance as a value, whereas a typed reference value is restricted to instances of a specific MOC.

2.7.4.1   Generic MO References

For generic references, Tab completion suggests both absolute MO paths starting from the root MOC, and relative paths starting from the current CLI position.

Assume a model with MO D under C, MO C under B, MO B under the root ManagedElement=NODE06ST, and MoReferenceAttribute under C. This creates the following example output:

(config-ManagedElement=NODE06ST,B=1,C=1)>moReferenceAttribute="<Tab>
"ManagedElement=NODE06ST
"D
"..

Assume a model with MO C1 and C2 under B, MO B under the root ManagedElement=NODE06ST, and MoReferenceAttribute under C1. This creates the following example output:

(config-ManagedElement=NODE06ST,B=1)>C1=1,moReferenceAttribute="<Tab>
"ManagedElement=NODE06ST
"C1
"C2
"..

2.7.4.2   Typed MO References

For typed references, Tab completion suggests LDNs of existing instances of the MOC type of the reference attribute. If no such instances exist, Tab completion falls back to the same behavior as for generic references.

Assume a reference attribute named targetRef of MOC type Target. Target can be found in two different locations, in ManagedElement,ParentOne,Target and ManagedElement,ParentTwo,Target. See Example 27 through Example 29.

(config-SomeMO=1)>targetRef="<Tab>
(config-SomeMO=1)>targetRef="ManagedElement=NODE06ST,ParentOne=1,Target=1"

(config-SomeMO=1)>targetRef="<Tab>
"ManagedElement=NODE06ST,ParentOne=1,Target=1"
"ManagedElement=NODE06ST,ParentOne=1,Target=2"
(config-SomeMO=1)>targetRef="ManagedElement=NODE06ST,ParentOne=1,Target=

(config-SomeMO=1)>targetRef="<Tab>
"ManagedElement=NODE06ST,ParentOne=1,Target=1"
"ManagedElement=NODE06ST,ParentTwo=1,Target=2"
(config-SomeMO=1)>targetRef="ManagedElement=NODE06ST,Parent

The CLI falls back to the behavior of generic MO references in the following situations:

• There are no instances of the MOC type of the reference attribute.
• A partial MO path has been entered, and no instances matching this path exist.
• The search algorithm finds more than 100 instances of the MOC type. The search then aborts to avoid too long response time, and a partial MO path matching less than 100 instances must be entered for suggestions to be provided.
• A relative MO path has been entered.

2.7.4.3   External MO References

For MO references with an external Unidirectional Association, Tab completion suggests the <value> tag, in addition to the suggestions for internal associations, if there are any.

Assume a reference attribute named targetRef with external Unidirectional Association and internal association of MOC type target. This creates the following example output:

(config-SomeMo=1)>targetRef="<TAB>
"ManagedElement=1,TargetMoc=1"
<value>
(config-CrazyThing=1)>targetRef="ManagedElement=1,TargetMoc=1"

2.8   Case Correction

When input contains only lower case, a unique match of auto-completion automatically triggers case correction (for example, logicalfs to LogicalFs) of one CLI command element at a time for the following types:

• MOC name
• Attribute name, struct name, and struct member attribute name
• Enumeration value, that is, enumeration member or literal name
• Action name
• CLI operation and parameter name
• Action parameter name

Case correction is not supported in following cases:

• For string attribute values.
• If input contains at least one upper case.

2.9   Escaping of Special Characters

The CLI support the US-ASCII character set. In both input and output strings, escape sequences are used to represent non-printable characters, non-US-ASCII characters, and characters with a special meaning in the CLI, as shown in Table 13.

Note:  

A slight difference exists between the escape sequences used in attributes, struct members, and action parameters, and those used in MO instance names.

(1)  This character does not need to be escaped in quoted input strings.

(config-ManagedElement=NODE06ST)>userLabel=hello\nworld
(config-ManagedElement=NODE06ST)>show userLabel
userLabel="hello\nworld"

(config-aSimpleStruct)>str1=hello\!world
(config-aSimpleStruct)>show str1
str1="hello!world"

If a non-supported escape sequence is entered, the CLI displays an error message.

(config-ManagedElement=NODE06ST)>userLabel=temp\76value
ERROR: Invalid value 'temp\76value' for attribute 
'userLabel'.
This is not a valid escape sequence

Entered escape sequences are internally converted into the characters they represent before being stored. When a string value is printed by the CLI, characters are escaped when needed. For example, a quotation character within a string is printed as \".

The exception is DNs, where an escape sequence is only converted into the character it represents when the character is allowed according to 3GPP TS 32.300. Otherwise escaping is translated to the \NN format (as mandated by 32.300).

2.10   CLI Comments

It is possible to include comments in CLI input. The comment delimiter # and the rest of the input line on which it appears is considered as comment and is discarded before the line is executed. An input line that only consists of a comment is ignored, as if it had been a blank line.

CLI command completion and context sensitive help cannot be used after the # character. Pressing the Tab key has no effect, and pressing the ? key will add the character to the comment.

If a # character is escaped as described in Section 2.9 Escaping of Special Characters, or if it appears inside a quoted string, it is treated as a normal string character.

2.11   Visibility Levels

The behavior of CLI command output depends on the following visibility levels returned for MOM elements:

• visible – Specifies that the user has full access to all MOM elements.
• accessible – Specifies that the user can only display or access MOM elements by providing the full name of a MOM element.
• not-visible – Specifies that the user cannot display or access MOM elements.

The behavior of the visibility for MOM elements in the CLI is shown in Table 14.

The default visibility level for all MOM elements is visible. That is, obsolete, preliminary, and deprecated elements are set to visible in visibility configuration file for backward compatibility.

Note:  

The examples are executed with deprecated element set to accessible. The obsolete and preliminary elements are set to not-visible.

In the examples, consider the visibility level for the following MOC instances:

• YCurrentThing MOC is visible
• YDeprecatedThing MOC is accessible
• YObsoleteThing MOC is not visible

2.11.1   Auto-Completion

Auto-completion for accessible element YDeprecatedThing is not supported, as the current location is visible element YCurrentThing, as shown in Example 33.

(config-YCurrentThing=1)>YDepre<Tab>

Auto-completion for accessible element YSampleDeprecatedThing is supported, as the current location is accessible element YDeprecatedThing, as shown in Example 34.

(config-YDeprecatedThing=1)>YSample<Tab>
YSampleDeprecatedThing=1

2.11.2   Display Information

When command show is executed from the visible current location, only visible elements, such as YCurrentThing, are displayed. as shown in Example 35.

(config-YCurrentThing=1)>show
YCurrentThing=1
   userLabel=”UserLabel”

When command show -v|--verbose is executed from the visible current location, all visible elements, such as YCurrentThing, and accessible elements, such as YDeprecatedThing, are displayed. When the life cycle status of an element is anything else than the current one, the status is included as a tag in verbose mode, as shown in Example 36.

(config-YCurrentThing=1)>show -v
YCurrentThing=1
  rwattr1=[] <empty>
  userLabel="UserLabelValue"
  yCurrentThingId="1"
  YDeprecatedThing=1 <deprecated>

When command show-config is executed from the visible current location, all visible elements, such as YCurrentThing, and accessible elements, such as YDeprecatedThing, are displayed, as shown in Example 37.

(config-YThing=1)>show-config
YThing=1
  restrictedattr=4
  rwattr1="RW-One"
  rwattr2=2
  rwattr3=3
  YCurrentThing=1
     userLabel="UserLabelValue"
     YDeprecatedThing=1
        depAttr1=UNLOCKED
        depAttr2=16
        deprecatedStruct
           bool1=true
           int1=132
           str1="StringValue1"
           str2="StringValue2"
           up
        depStructWithKeyAttribute="StringValue1"
           bool1=true
           int1=132
           str2="StringValue2"
           up
        YSampleDeprecatedThing=1
           rwattr2=2
           up
        up
     up
  up

2.11.3   Context-Sensitive Help

For accessible elements, context-sensitive help information is displayed when the user specifies a full element name, but not when only a partial element name is specified.

When the life cycle status of an element is anything else than the current one, the status is included as a tag in the context-sensitive help information, as shown in Example 38.

(config-YCurrentThing=1)>YDeprecatedThing?
YDeprecatedThing MO Type [optional] [deprecated]
aMOC

For not-visible elements, no context-sensitive help is supported.

2.12   Automatic Correction of ManagedElement ID

The ManagedElement ID typically reflects the node name, that is, different nodes in a network can have different names.

To facilitate creation of generic CLI scripts and other tools to be used for several nodes, the CLI accepts any 3GPP® compliant ManagedElement ID as part of a DN. The CLI can automatically correct this to the actual/correct ID.

This applies for all commands and command parameters containing a DN.

2.13   Limitations

The CLI has the following limitations:

• CLI session properties (prompt, width, length, script mode) changed in an CLI session are not stored persistently and are lost after session end.
• The maximum line length supported by the CLI is 2048 characters.

3   CLI Commands

An overview of the CLI commands is provided in Table 15.

3.1   Summary of CLI Commands

A summary of the CLI commands is provided in Table 16.

(1)  The syntax '['<existing_sequence_element>']' means here that <existing_sequence_element> is mandatory in the command.

(2)  The syntax '['@<index>']' means here that @<index> is mandatory in the command.

(3)  The syntax '['@<position>']' means here that @<position> is mandatory in the command.

3.2   Success and Error Indications

The conditions for successful command completion are checked in multiple steps as follows:

• The user must have the proper authorization.
• The command must comply to CLI syntax rules.
• The command must comply to the constraints defined in the model.
• The command must comply to semantic rules, that is, the system state must be valid after the command completion.
• The system must be in a state to be able to process the command.

If the CLI command completes with success, no printout is provided. If the operation fails, an error message is displayed in the following format:

ERROR: <generic_error_message>[<specific_error_message>]

The error messages are as follows:

• Generic error message – Error text using the same message format or template for error indication for all the MOCs and attributes of the same properties in the same error situation. Examples of generic error messages are shown in Table 17.
• Specific error messages – Context-specific details are provided by the model.

As an exception, command validate returns a printout on success, and actions can return printout if the action return value is not void.

3.2.1   Error Codes

The error codes shown in CLI error messages are described in Table 18.

3.3   Display Information

This section describes how to display the following information:

• Single-valued attribute, see Section 3.3.1 Display Single-Valued Attribute
• Configurational information, see Section 3.3.2 Display Configurational Information
• Struct, see Section 3.3.3 Display Struct
• Struct member, see Section 3.3.4 Display Struct Member
• Sequence of simple type, see Section 3.3.5 Display Sequence of Simple Type
• Sequence of struct, see Section 3.3.6 Display Sequence of Struct
• Sequence element of sequence of struct, see Section 3.3.7 Display Sequence Element of Sequence of Struct
• MO instance information, see Section 3.3.8.2 Display MO Instance Information
• MO information in tabular format, see Section 3.3.9.3 Display MO Information in Tabular Format
• PM measurements, see Section 3.3.9.5 Display PM Measurements

3.3.1   Display Single-Valued Attribute

Command show [-r|--recursive] [-v|--verbose] [<path>,]<attribute_name> displays a single-valued attribute.

A summary on the printout syntax and the displayed information with various attribute types is shown in Table 19.

(1)  The description is valid both for attributes and struct members.

(2)  The <key> printout is present if the struct member is key.

(3)  The <passphrase> printout is present if the attribute is a passphrase string.

(4)  The <read only> printout is present if the attribute is read-only.

(5)  The <read only> printout is also present if the attribute is read-only.

(6)  That is, optional or nillable attributes that have no value assigned.

The display formats of supported attribute value data types are shown in Table 20.

>show ManagedElement=NODE06ST,userLabel
userLabel="BTS#21 in Zone C"

>show ManagedElement=NODE06ST,myEmptyAttribute
myEmptyAttribute

>show -r ManagementElement=NODE06ST,MOCex1=1,MOex5=1,anAttrwWithIntDerivedType
anAttrWithIntDerivedType=16

>show ManagementElement=NODE06ST,MOCex2=1,userLabel
userLabel="NODE"

3.3.2   Display Configurational Information

Command show-config [-v|--verbose] [-s|--sort] [<path>] displays the output in configuration format. It also automatically enables parameter -r|--recursive.

Command show-config with the verbose option displays attributes that are not set and attributes set to their default values.

The difference between show-config and show-config with the verbose option when copying the output into an CLI, is as follows:

• With parameter -v|--verbose, the command overwrites, that is, deletes non-set (in the input) optional values and sets non-set default values back to default.

  It is recommended to use show-config with -v|--verbose when copying the output into an CLI.

• Without parameter -v|--verbose, the command appends, that is, only includes values that are set.

With parameter s|--sort, MO instances are sorted according to their instance names.

(config-MOex6=1)>show-config
MOex6=1
administrativeState=UNLOCKED
aManagedObject="ManagedElement=NODE06ST,MOCex3=1,MOex1=1"
anAttrWithIntDerivedType=16
anAttrWithStringDerivedType="xx6BBBBBBBBBBBxx"
aSimpleStruct
   bool1=true
   int1=132
   str1="StringValue1"
   str2="StringValue2"
   up
aStructWithDefValues
   up
aStructWithKeyAttribute="StringValue1"
   bool1=true
   int1=132
   str2="StringValue2"
   up
up

(config-MOex7=1)>show-config -v
MOex7=1
administrativeState=UNLOCKED
aManagedObject="NODE06ST,MOCex4=1,MOex=1"
anAttrWithIntDerivedType=16
anAttrWithStringDerivedType="xx6BBBBBBBBBBBxx"
   no anAttrWithStringDerivedType_noDefault
   no anEcimEmpty
   no anyManagedObject
   no DateTimeTestValue
   no DateTimeWithoutOffsetTestValue
   defaultValue=0
   no DifferenceFromUTCTestValue
   no ipDNSAddressTestValue
   no noDontAutocompleteOnNo
   no ProblemCauseTestValue
   no rebelObject
   no RuleDataTypeTestValue
   no TimeoutTestValue
   no UnsignedRangeDataTestValue
   no anExclusiveStruct
   no anOptionalStruct
   no aPassphraseStruct
aSimpleStruct
   bool1=true
   int1=132
   int2=42
   str1="StringValue1"
   str2="StringValue2"
   up
aStructWithDefValues
   bool1=false
   int1=1
   str1="HoggaBogga"
   up
   no aStructWithHiddenAttribute
aStructWithKeyAttribute="StringValue1"
   bool1=true
   no int0
   int1=132
   int2=42
   str1="StringValue1"
   str2="StringValue2"
   up
no aStructWithMoRefs
no ecimStructArray
no MultiValueStructWithKeyAttr
up

(Snmp=1)>show-config
Snmp=1
engineId="1234567890"
   agentAddress
      host="0.0.0.0"
      port=161
      up

Command show-config with parameter -v|--verbose displays configuration with explicit position for sequence of keyless structs.

(Snmp=1)>show-config -v
Snmp=1
   administrativeState=UNLOCKED
   enableSourceCheckForV1V2C=false
   engineId="1234567890"
   no nodeCredential
   port=161
   portDtls=10161
   no trustCategory
   agentAddress[@1]
      host="0.0.0.0"
      port=161
      up
   no agentAddressDtls
   up

3.3.3   Display Struct

Command show [-v|--verbose] [<path>,] <attribute_name> displays attributes defined as struct.

Printout format:

<attribute_name>
   <struct_member_name>=<value>
   <struct_member_name>=<value>
   <struct_member_name>=[]
[...]
   <struct_member_name>=<value>

Note:  

The nillable attributes are displayed as ordinary attributes. See Table 19.

(config-MOex8=1)>show aSimpleStruct
aSimpleStruct
   bool1=true
   int1=132
   str1="StringValue1"
   str2="StringValue2"

(config-MOex9=1)>show --verbose aSimpleStruct
aSimpleStruct
   bool1=true
   int1=132
   int2=42 <default>
   str1="StringValue1"
   str2="StringValue2"

(config-MOex10=1)>show -r aSimpleStruct
aSimpleStruct
   bool1=true
   int1=132
   str1="StringValue1"
   str2="StringValue2"

3.3.4   Display Struct Member

This section provides information about displaying structure member.

3.3.4.1   Display Single-Valued Structure Member

Command show [-v|--verbose] [<path>,] <attribute_name>,<struct_member_name> displays single-valued struct members.

The printout is according to the data type of the struct member.

(config-MOex11=1)>show aSimpleStruct,str1
str1="string"

(config-MOex11=1)>show -v aSimpleStruct,int2
int2=42 <default>

3.3.4.2   Display Sequence Structure Member

Command show [-v|--verbose] [<path>,] <attribute_name>,<struct_member_name> displays structure members defined as sequence (also known as multi-valued struct members).

(config-structWithMultivalueMembers)>show intMultivalueMember
intMultivalueMember
   42
   43
   44

(config-structWithMultivalueMembers)>show -v intMultivalueMember
intMultivalueMember <default>
   42
   43
   44

3.3.4.3   Display Sequence Element of Sequence Structure Member

Command show [-v|--verbose] [<path>,]<attribute_name>,<struct_member_name>'['@<index>']' displays a sequence element of a sequence structure member.

(config-structWithMultivalueMembers)>show intMultivalueMember[@2]
intMultivalueMember
   43

3.3.5   Display Sequence of Simple Type

Command show [-r|--recursive] [-v|--verbose] [<path>,]<sequence_attribute_name> displays attributes defined as sequence (also known as multi-valued attributes).

Printout format if the sequence contains elements of the same type:

<sequence_attribute_name>
   <sequence_element_value>
   <sequence_element_value>
[...]
   <sequence_element_value>

(config-MultivalueThing=1)>show PlainMultivalueAttrs=1,stringMultivalueAttr
stringMultivalueAttr
   "STRING"
   "SWEDEN"

(config-MultivalueThing=1)>show -r PlainMultivalueAttrs=1,stringMultivalueAttr
stringMultivalueAttr
   "STRING"
   "SWEDEN"

(config-PlainMultivalueAttrs=1)>show -v intMultivalueAttr
intMultivalueAttr <default>
   42
   43
   44

3.3.5.1   Display Sequence Element of Sequence of Simple Type

Command show [-v|--verbose] [<path>,]<sequence_attribute_name>'['@<index>']' displays a selected sequence element from a sequence of simple type using positional index. The positional index starts from 1.

(config-PlainMultivalueAttr=1)>show intMultivalueAttr
intMultivalueAttr
   42
   43
   44
(config-PlainMultivalueAttr=1)>show intMultivalueAttr[@1]
intMultivalueAttr
   42

3.3.6   Display Sequence of Struct

Command show [-r|--recursive] [-v|--verbose] [<path>,] <attribute_name> displays attributes defined as a sequence of struct.

Printout format:

<attribute_name>
   <struct_member_name>=<value>
   <struct_member_name>=<value>
   <struct_member_name>=[]
[...]
   <struct_member_name>=<value>
<attribute_name>
   <struct_member_name>=<value>
   <struct_member_name>=<value>
   <struct_member_name>=[]

>show ManagedElement=NODE06ST,SystemFunctions=1,SysM=1,Snmp=1,agentAddress
agentAddress
   host="1.1.1.1"
   port=111
agentAddress
   host="2.2.2.2"
   port=222

>show -v ManagedElement=NODE06ST,SystemFunctions=1,SysM=1,Snmp=1,agentAddress
agentAddress[@1]
   host="1.1.1.1"
   port=111
agentAddress[@2]
   host="2.2.2.2"
   port=222

3.3.7   Display Sequence Element of Sequence of Struct

Command show [-r|--recursive] [-v|--verbose] [<path>,] <attribute_name>,<key_struct_member_name>=<key_struct_member_value> displays selected sequence elements if they contain a struct with a key member.

Printout format:

<key_struct_member_name>=<key_struct_member_value>
   <struct_member_name>=<struct_member_value>
   <struct_member_name>=<struct_member_value>
[...]
   <struct_member_name>=<struct_member_value>

In Example 61, attribute multiValueStructWithIntId is defined as a sequence of struct and the struct has the following members:

• id – Defined as int64, that is, the key member of the struct
• name – Defined as a string with default value "countryName"
• capital – Defined as a string
• population – Defined as int64 with default value 0

(config-PlainMultivalueAttrs=1)>show -v multiValueStructWithIntId
multiValueStructWithIntId=2
   capital="kol"
   id=2 <key>
   name="countryName" <default>
   population=0 <default>
multiValueStructWithIntId=3
   capital="xyz"
   id=3 <key>
   name="countryName" <default>
   population=0 <default>
multiValueStructWithIntId=1
   capital="delhi"
   id=1 <key>
   name="countryName" <default>
   population=0 <default>
(config-MultivalueThing=1)>show -v PlainMultivalueAttrs=1,⇒
multiValueStructWithIntId=1
multiValueStructWithIntId=1
   capital="delhi"
   id=1 <key>
   name="countryName" <default>
   population=0 <default>

>show ManagedElement=NODE06ST,SystemFunctions=1,SysM=1,Snmp=1,agentAddress,host
ERROR: Multi-value struct attribute 'agentAddress' is missing a key value or an index

(config-PlainMultivalueAttrs=1)>show -r multiValueStructWithIntId
multiValueStructWithIntId=1
   capital="Sweden"
   population=20000000
multiValueStructWithIntId=2
   capital="Norway"

3.3.8   Display MO Information

This section describe how to display MO information.

3.3.8.1   Display MO Instances

This section describes how to display MO instances.

3.3.8.1.1   MO Instance Sorting

By default, MO instances are displayed in an ME-dependent order, for example, in creation order.

The MO instances can also be displayed in a sorted order, by adding parameter -s|--sort. The instances are sorted in the following order:

1. All instances with numeric names are displayed in increasing numeric order.
2. All other instances are displayed in alphabetical order.

Note:  

Sorting MO instances increases the command execution time. Only MO instances are sorted, not elements of sequence attributes.

3.3.8.1.2   Display Single MO

Command show [-s|--sort] [-v|--verbose] [<path] displays a single MO.

Printout format:

<moc_name>=<key_value>
   <attribute>
   <attribute>
[...]
   <struct>
   <struct>
[...]
  <child_moc_name>=<key_value>
  <child_moc_name>=<key_value>
[...]

The list of actions for a class is deleted from the show output.

>show ManagedElement=NODE06ST,SystemFunctions=1,SysM=1,Snmp=1
Snmp=1
   engineId="1234567890"
   operationalState=ENABLED
   agentAddress
      host="0.0.0.0"
      port=161

3.3.8.1.3   Display Single MO and Its Child MOs

Command show [-s|--sort] [-r|--recursive] [-v|--verbose] [<path>] displays a single MO and its child MOs.

The displayed information is according to the single MO printout for the root MO and also for the child MOs. That is, all child MOs with all their properties, excluding the actions, are displayed in a recursive way.

>show -r ManagedElement=NODE06ST,SystemFunctions=1,SysM=1,Snmp=1
Snmp=1
   administrativeState=LOCKED
   engineId="1234567890"
   operationalState=DISABLED
   agentAddress
      host="0.0.0.0"
      port=161

3.3.8.1.4   Display Single MO and Its Child MOs in Configuration Printout Format

Command show-config [-s|--sort] [-v|--verbose] [<path>] displays a single MO and its child MOs in configuration format.

The displayed information is according to the recursive MO printout, with the addition of navigation command up in specific positions. The displayed information forms a valid CLI command sequence that can be input for the CLI. The information allows configuration data export and import by copy/paste.

>show-config ManagedElement=NODE06ST,SystemFunctions=1,SysM=1,Snmp=1
Snmp=1
  administrativeState=LOCKED
   engineId="1234567890"
   agentAddress
      host="0.0.0.0"
      port=161
      up
   up

3.3.8.1.5   Summary of Displayed MO Properties

A summary of the elements displayed by different display options shown in Table 21.

(1)  Only if the MO subtree has configurable elements.

(2)  This is present in the show attribute printout.

(3)  That is, optional or nillable attributes with no values assigned.

The command is atomic and does not include non-committed changes in other transactions.

>show -v ManagedElement=NODE06ST,SystemFunctions=1,Fm=1
Fm=1
   heartbeatInterval=300
   lastChanged="2014-02-06T14:12:26Z" <read-only>
   lastSequenceNo=4
   sumCritical=1
   sumMajor=1
   sumMinor=0
   sumWarning=2
   totalActive=4

3.3.8.2   Display MO Instance Information

Command show-mib [-v|--verbose] [-s|--sort] [<path>] displays the list of instance information without their contents. The MO instance names are displayed recursively.

With parameter s|--sort, MO instances are sorted according to their instance names.

(config-SecM=1)>show-mib
SecM=1
   UserManagement=1
      LocalAuthorizationMethod=1
         CustomRole=CustomSystemOperator
         CustomRule=Custom_FaultManagement_1
         Role=NodeApplicationAdministrator
            Rule=NodeApplicationAdministrator

Command show–mib with parameter -v|--verbose displays the complete path of the DN.

(config-ManagedElement=NODE06ST)>show-mib -v MOCex5=1
ManagedElement=NODE06ST,MOCex5=1
ManagedElement=NODE06ST,MOCex5=1,MOex1=1
ManagedElement=NODE06ST,MOCex5=1,MOex2=1
ManagedElement=NODE06ST,MOCex5=1,MOex3=1
ManagedElement=NODE06ST,MOCex5=1,MOex4=1
ManagedElement=NODE06ST,MOCex5=1,MOex5=1
ManagedElement=NODE06ST,MOCex5=1,MOex6=1,MOex7=1
ManagedElement=NODE06ST,MOCex5=1,MOex8=1

3.3.9   Filter MO Information

The MO information can be reduced with the filter options added to commands show and show-table. The filtered information is displayed in tree structure and in tabular format.

3.3.9.1   Parameters to Filter MO Information

The mandatory parameter -m|--moc signifies the name of a child class (MOC) under the current context where the user is located.

If there is more than one class with same name, the name must be qualified by prepending the class name with the parent class name and a comma. For example, assume that there is a class Xyz under SystemFunctions and another class with the same name under ManagedElement. These classes can then be addressed by SystemFunctions,Xyz and ManagedElement,Xyz, respectively.

Optional parameters:

• -p|--property signifies the attributes that the user wants to display under the MOC, specified in option -m|--moc. The attribute list is specified by [-p <attribute_name>], where attributes are separated by a comma. The list can include zero to many attributes, where zero means that no attribute is printed.
• For command show-table, which shows MO information in tabular format, the column width can optionally be specified for attributes by using the syntax -p <attribute_name:column_width>.
• To filter and display MO information based on a condition, use option -c|--condition.

  If the attribute used in the condition is of the type string, the value specified for that attribute must be quoted, else error message Condition String not quoted is displayed.

  Syntax for condition:

  [Condition]=[<attribute><operator><value>]

  Valid operators:

  • == or = for left-hand side is equal to the right-hand side
  • >= for left-hand side is greater than or equal to the right-hand side
  • <= for left-hand side is less than or equal to the right-hand side
  • > for left-hand side is greater than the right-hand side
  • < for left-hand side is smaller than the right-hand side
  • <> for left-hand side is greater or less than (not equal) the right-hand side
  • =~ for left-hand side matching the regular expression on the right-hand side.

  To specify multiple conditions, separate them by the logical operator OR (||) or AND (&&). To negate the expression, let it be preceded by a NOT. To group expressions, use parentheses.

  Multiple condition syntax:

  [Condition]=((condition)&&(condition))⇒ =((condition)||(condition))=NOT((condition)

Values are entered in the same format as when setting values. Strings must be quoted if they contain spaces or special characters. A special value is "[]", which is the empty value.

When matching a regular expression, the left-hand side attribute value is converted to a string, as if the value would be printed. This includes structs, with the special detail that struct members are converted to a sequence of space-separated <member>=<value> statements. Password types cannot be matched with a regular expression.

When the left-hand side attribute is a sequence attribute, a condition matches if at least one value in the sequence matches.

3.3.9.2   Search for Information in MO Tree Structure

Command show [-s|--sort] [<path>] -m|--moc <moc_name> [-p|--property <attribute_name> [,<attribute_name>]...] [-r|--recursive] [-v|--verbose] [-c|--condition <condition>] searches for information in an MO tree structure.

For information about the filtering parameters -m|--moc, -p|--property, and -c|--condition, see Table 16.

Parameter -r|--recursive can be used to search recursively in the whole MO tree. When the parameter is used, the DN for each matching MO instance is displayed. Omitting the parameter implies searching of one level and the RDN for each matching MO instance is displayed.

With parameter -s|--sort, MO instances are sorted according to their instance names.

>show SysM=1 -m Schema -r
ManagedElement=NODE06ST,SystemFunctions=1,SysM=1,Schema=ECIM_CommonLibrary
   baseModelIdentifier="ECIM_CommonLibrary"
   baseModelVersion="1.2"
   identifier="ECIM_CommonLibrary"
   version="1.2"
ManagedElement=NODE06ST,SystemFunctions=1,SysM=1,Schema=ComTop
   baseModelIdentifier="ECIM_Top"
   baseModelVersion="2.1.0"
   identifier="ComTop"
   version="10.10.0"
ManagedElement=NODE06ST,SystemFunctions=1,SysM=1,Schema=ComSecM
   baseModelIdentifier="ECIM_Security_Management"
   baseModelVersion="2.0"
   identifier="ComSecM"
   version="11.0.1"
ManagedElement=NODE06ST,SystemFunctions=1,SysM=1,Schema=ComLocalAuthorization
   baseModelIdentifier="ECIM_Local_Authorization"
   baseModelVersion="2.0.0"
   identifier="ComLocalAuthorization"
   version="0.11.1"
ManagedElement=NODE06ST,SystemFunctions=1,SysM=1,Schema=ComLdapAuthentication
   baseModelIdentifier="ECIM_LDAP_Authentication"
   baseModelVersion="2.0"
   identifier="ComLdapAuthentication"
   version="11.0.0"
ManagedElement=NODE06ST,SystemFunctions=1,SysM=1,Schema=ComSysM
   baseModelIdentifier="ECIM_SysM"
   baseModelVersion="3.1.0"
   identifier="ComSysM"
   version="3.1.0"

Display Specific Attributes, or No Attributes, for Found MO Instances

Command show with parameter -p|--property displays specified attributes under all the MO instances of the specified MOC.

>show SysM=1 -m Schema -r -p
ManagedElement=NODE06ST,SystemFunctions=1,SysM=1,Schema=ECIM_CommonLibrary
ManagedElement=NODE06ST,SystemFunctions=1,SysM=1,Schema=ComTop
ManagedElement=NODE06ST,SystemFunctions=1,SysM=1,Schema=ComSecM
ManagedElement=NODE06ST,SystemFunctions=1,SysM=1,Schema=ComLocalAuthorization
ManagedElement=NODE06ST,SystemFunctions=1,SysM=1,Schema=ComLdapAuthentication
ManagedElement=NODE06ST,SystemFunctions=1,SysM=1,Schema=ComSysM
ManagedElement=NODE06ST,SystemFunctions=1,SysM=1,Schema=ComFm
ManagedElement=NODE06ST,SystemFunctions=1,SysM=1,Schema=ComSnmp
ManagedElement=NODE06ST,SystemFunctions=1,SysM=1,Schema=ComFileM
ManagedElement=NODE06ST,SystemFunctions=1,SysM=1,Schema=CmwPm

(config-SystemFunctions=1)>show –r SysM=1 -m Schema -p identifier,baseModelVersion
ManagedElement=NODE06ST,SystemFunctions=1,SysM=1,Schema=ECIM_CommonLibrary
   identifier="ECIM_CommonLibrary"
   baseModelVersion="1.2"
ManagedElement=NODE06ST,SystemFunctions=1,SysM=1,Schema=ComTop
   identifier="ComTop"
   baseModelVersion="2.1.0"
ManagedElement=NODE06ST,SystemFunctions=1,SysM=1,Schema=ComSecM
   identifier="ComSecM"
   baseModelVersion="2.0"
ManagedElement=NODE06ST,SystemFunctions=1,SysM=1,Schema=ComLocalAuthorization
   identifier="ComLocalAuthorization"
   baseModelVersion="2.0.0"
ManagedElement=NODE06ST,SystemFunctions=1,SysM=1,Schema=ComLdapAuthentication
   identifier="ComLdapAuthentication"
   baseModelVersion="2.0"
ManagedElement=NODE06ST,SystemFunctions=1,SysM=1,Schema=ComSysM
   identifier="ComSysM"
   baseModelVersion="3.1.0"
ManagedElement=NODE06ST,SystemFunctions=1,SysM=1,Schema=ComFm
   identifier="ComFm"
   baseModelVersion="4.0.0"
ManagedElement=NODE06ST,SystemFunctions=1,SysM=1,Schema=ComSnmp
   identifier="ComSnmp"
   baseModelVersion="1.2"
ManagedElement=NODE06ST,SystemFunctions=1,SysM=1,Schema=ComFileM
   identifier="ComFileM"
   baseModelVersion="3.1.0"
ManagedElement=NODE06ST,SystemFunctions=1,SysM=1,Schema=CmwPm
   identifier="CmwPm"
   baseModelVersion="1.2"

Display Attributes Based on a Condition

Command show with option -c|--condition filters the existing MO instances and displays information for MO instances fulfilling the specified condition.

>show -r -m Schema -c version==11.0.0
ManagedElement=NODE06ST,SystemFunctions=1,SysM=1,Schema=ComLdapAuthentication
   baseModelIdentifier="ECIM_LDAP_Authentication"
   baseModelVersion="2.0"
   identifier="ComLdapAuthentication"
   version="11.0.0"
ManagedElement=NODE06ST,SystemFunctions=1,SysM=1,Schema=ComFileM
   baseModelIdentifier="ECIM_FileM"
   baseModelVersion="3.1.0"
   identifier="ComFileM"
   version="11.0.0"

(config-SystemFunctions=1)>show SysM=1 -m Schema -p identifier,baseModelIdentifier -c version==11.0.0
Schema=ComLdapAuthentication
   identifier="ComLdapAuthentication"
   baseModelIdentifier="ECIM_LDAP_Authentication"
Schema=ComFileM
   identifier="ComFileM"
   baseModelIdentifier="ECIM_FileM"

(config-SysM=1)>show -m Schema -p identifier,baseModelIdentifier -c version==3.1.0 && baseModelVersion==3.1.0
Schema=ComSysM
   identifier="ComSysM"
   baseModelIdentifier="ECIM_SysM"

Regular Expression Search

For examples of regular expression searching, see Example 76 through Example 78.

(config-SysM=1)>show -r -m SnmpTargetV3 -c operationalState=~EN
ManagedElement=NODE06ST,SystemFunctions=1,SysM=1,Snmp=1,SnmpTargetV3=1
   address="127.0.0.1"
   informRetryCount=3
   informTimeout=10
   operationalState=ENABLED

>show -r -m Snmp -c agentAddress=~"port=161"
ManagedElement=NODE06ST,SystemFunctions=1,SysM=1,Snmp=1
   administrativeState=LOCKED
   engineId="1234567890"
   operationalState=DISABLED
   agentAddress
      host="0.0.0.0"
      port=161

>show -r -m Snmp -c agentAddress=~"host=0\.0\.0\.0 port=161"
ManagedElement=NODE06ST,SystemFunctions=1,SysM=1,Snmp=1
   administrativeState=LOCKED
   engineId="1234567890"
   operationalState=DISABLED
   agentAddress
      host="0.0.0.0"
      port=161

3.3.9.3   Display MO Information in Tabular Format

Command show-table [-r|--recursive] [<path>] -m|--moc <moc_name> [-p|--property <attribute_name> [:<column_width>][,<attribute_name> [:<column_width>]] ...] [-c|--condition <condition>] [-s|--sort] displays the MO information based on a MOC in a tabular format. It displays the show verbose printout without metadata, for example, no tags are displayed in the table. The command does not display struct attributes and multivalued attributes.

The user can choose information based on attribute selection and can also specify the column width.

If the MOC contains hidden attributes, the command does not display them. To display hidden attributes, including the hidden attributes, use option –p|--property

With parameter s|--sort, MO instances are sorted according to their instance names.

(Pm=1)>show-table –m PmJob –p currentJobState,jobPriority,jobType,pmJobId
==================================================================
| currentJobState | jobPriority | jobType        | pmJobId       |
 =================================================================
| ACTIVE          | MEDIUM      | MEASUREMENTJOB | POT_15min_Job |
| ACTIVE          | LOW         | MEASUREMENTJOB | PU_15min_Job  |
| STOPPED         | MEDIUM      | THRESHOLDJOB   | VM_15min_Job  |
==================================================================

When using parameter –r|--recursive, a recursive search is done for the MOC. The parent MO LDN is displayed above the table. If there are instances under different parents, a new table is displayed for each parent.

Display Attributes with Show-Table

Command show-table with option parameter -p|--property displays the specific attributes under the MOC.

The width of the column can be specified, as shown in Example 80 and Example 81.

(config-ManagedElement=NODE06ST)>show-table -m AMoc -p userLabel:20
==================
|userLabel       |
==================
|UserLabelValue  |
==================

(config-ManagedElement=NODE06ST)>show-table –m AMoc -p MOCexId, userLabel
============================
|MOCexId  | userLabel      |
============================
|1        | UserLabelValue |
============================

If no value is available for an attribute, it displays as empty, as shown in Example 82.

(config-SystemFunctions=1)>show-table -m FileM
======================
|fileMId | userLabel |
======================
|1       |           |
======================

Display Attributes in Tabular Format Based on a Condition

Example 83 shows how to display attributes based on a condition.

(config-MOCex6=1)>show-table -m MOex9 -p administrativeState,defaultValue -c (defaultValue==0)
======================================
| administrativeState | defaultValue |
======================================
| UNLOCKED            | 0            |
======================================

Show-Table Width and Column Compression

The width of each column is automatically adjusted to the width of the content. Both the column heading, that is, the attribute name, and the content of each row are considered. If a table contains more than 100 rows, only the content of the first 100 rows are used to compute the widths.

If the terminal width is not enough to display all columns with their optimal widths, the columns are compressed. When the content of a table cell is too wide to be displayed in its entirety, it is compressed by replacing the middle part of the content with three dots, "...". For instance, MEASUREMENTJOB is compressed to MEAS...JOB, if the column is compressed to 10 characters.

If the column width for an attribute has been specified, it is used as the minimum width for that attribute. That is, if the table needs to be compressed, the column is not compressed to fewer characters than the specified width.

If the table is not possible to display within the current terminal width based on specified column widths, show-table returns an error message.

3.3.9.4   Auto-Completion of Attributes under Filter Options

Command show and show-table with option parameter –p|--property auto-completes the list of attributes under a MOC, specified with parameter -m|–-moc. The hidden attributes cannot be displayed in the auto-completion list.

(config-SysM=1)>show -m Snmp -p <Tab>
--condition
--recursive
--sort
--verbose
-c
-r
-s
-v
administrativeState
agentAddress
agentAddressDtls
enableSourceCheckForV1V2C
engineId
nodeCredential
operationalState
port
portDtls
snmpId
trustCategory
<cr>
(config-SysM=1)>show -m Snmp -p agentAddress, <Tab>
administrativeState
agentAddressDtls
enableSourceCheckForV1V2C
engineId
nodeCredential
operationalState
port
portDtls
snmpId
trustCategory

For command show-table, the multi-value and struct attributes are not be listed in the auto-completion list under option –p|-–property.

(config-SysM=1)>show-table -m Snmp -p <Tab>
administrativeState
enableSourceCheckForV1V2C
engineId
nodeCredential
operationalState
port
portDtls
snmpId
trustCategory
(config-SysM=1)>show-table -m Snmp -p administrativeState, <Tab>
enableSourceCheckForV1V2C
engineId
nodeCredential
operationalState
port
portDtls
snmpId
trustCategory

Note:  

Auto-completion for attributes under option parameter -c|--condition is not supported for commands show and show-table.

3.3.9.5   Display PM Measurements

Command show-counters is an optional command. It is available only if the ME supports displaying measurements through the CLI.

The support from the ME can also be at two different levels, resulting in that the two different versions of the command are possible. Version one supports displaying measurements for Managed Objects, and allows selection of measurements according the PM jobs they belong to. Version two supports displaying measurements also for other Measured Objects that are not Managed Objects, and also allows selection of measurements according to the PM Groups they belong to.

Version two also allows selection of how the output needs to be grouped, and allows wildcards in selection criteria. When using wildcards, the command response time can be significantly long, so filter criteria to the command needs to be wisely chosen to avoid long waiting time.

Note:  

The command can be cancelled at any time by pressing Ctrl+C.

The static help command output provides information on which version of show-counters commands that is active, if any.

The syntax for version 1 of show-counters is:
show-counters [<DN>] [-j|--pmJob <job_id>] [-v|--verbose] [-c|--counters <counter>[,<counter>] ...]

The syntax for version 2 of show-counters is:
show-counters [<DN>] [-j|--pmJob <job_id>] [-v|--verbose] [-c|--counters <counter>[,<counter>] ...] [-m|--mo <measObj>] [-g|--pmGroup <pmGroupId>[,<pmGroupId>] ...] [-f|--format <printoutFormat]

The command show-counters displays active PM counters for a Measured Object. The command works analogous to the other show commands, but displays PM counters associated with Measured Objects instead of attributes. Also, unlike multi-valued attributes, multi-valued counters are displayed one after each other on the same line, with comma as delimiter.

(MeasObj=1)>show-counters
MeasObj=1
   intCounterActive=123
   multivalueIntCounter=12, 14 <suspect>, 16
   floatCounterActive=123.456 <suspect>
   multivalueFloatCounter=1.345, 2.456, 3.5678 <suspect>

(MeasObj=1)>show-counters ManagedElement=1,MeasObj=1 
ManagedElement=1,MeasObj=1
  intCounterActive=123
  multivalueIntCounter=12, 14 <suspect>, 16
  floatCounterActive=123.456 <suspect>
  multivalueFloatCounter=1.345, 2.456, 3.5678 <suspect>

(MeasObj=1)>show-counters -v
MeasObj=1
   intCounterActive=123 <PmJob=1> <Gp=15 min>
   multivalueIntCounter=12, 14 <suspect>, 16 <PmJob=1> <Gp=15 min>
   floatCounterActive=123.456 <suspect> <PmJob=1> <Gp=15 min>
   multivalueFloatCounter=1.345, 2.456, 3.5678 <PmJob=1> <Gp=15 min>
   intCounterNonActive=[] <empty>
   floatCounterNonActive=[] <empty>

The number of displayed counters can be decreased by filtering out specific counters by name or from a selected PM job.

If there is a delay in fetching the measurements when version2 of show-counters command is executed, dots are printed on the CLI terminal until a response is received as shown in Example 89 and he command can be cancelled at any time by pressing Ctrl+C.

>show-counters -m MO1TryAgain3
......
MO1TryAgain3
measurement0=123
measurement1=1.2344534
measurement2=123, 456, 789
measurement3=1.2344534, 5.67867878, 8.987781434
>

3.3.9.5.1   Filtering options for show-counters

The number of displayed counters can be decreased by filtering out specific counters by name, PM job ids, PM group ids, measured object, or a combination of one or more of the mentioned. If no measured object/DN is mentioned explicitly, then the cursor location is considered as measured object. If both <DN> and -m options are specified, then preference is given to -m.

(MeasObj=1)>show-counters -c floatCounterNonActive floatCounterNonActive=[]
(MeasObj=1)>show-counters -v –c floatCounterActive,
                                someOtherCounter ––pmJob=aJob
floatCounterActive=123.456 <PmJob=aJob> <Gp=15 min>

>show-counters -m MO1
MO1
  measurement0=123
  measurement1=1.2344534
  measurement2=123, 456, 789
  measurement3=1.2344534, 5.67867878, 8.987781434
>

>show-counters -g group0,group1
MO1
  measurement0=123
  measurement3=1.2344534, 5.67867878, 8.987781434
MO12
  measurement0=123
  measurement2=123, 456, 789
  measurement3=1.2344534, 5.67867878, 8.987781434
>

Measurements of one or more group-Ids can be fetched by providing * in input as shown in the Example 93. All group names which starts with group are displayed in the output.

>show-counters -g group* -f PMGroup-DN-MT
group0
  MO1
     measurement3=1.2344534, 5.67867878, 8.987781434
group1
  MO12
     measurement2=123, 456, 789
     measurement3=1.2344534, 5.67867878, 8.987781434
group2
  MO123
     measurement0=123
     measurement1=1.2344534
     measurement3=1.2344534, 5.67867878, 8.987781434
>

Measurements of one or more measured objects can be fetched by providing * in input as shown in the Example 94. All measured objects which starts with MoAdd are displayed in the output.

>show-counters -m MoAdd*
MoAddACounter
  aSuspectPDFCounter=1 <suspect>, 2 <suspect>, 3 <suspect>,
  4 <suspect>, 5 <suspect>
  aSuspectCounter=12345 <suspect>
MoAddANanCounter
  singleNanCounter=<suspect>
  aSuspectPDFNanCounter=<suspect>, 2 <suspect>, 3 <suspect>,
  4 <suspect>, <suspect>
>

Measurements of one or more measurement types can be fetched by providing * in input as shown in the Example 95. All measurement types which starts with aSuspectPDF are displayed in the output.

>show-counters -c aSuspectPDF*
MoAddACounter
  aSuspectPDFCounter=1 <suspect>, 2 <suspect>, 3 <suspect>,
  4 <suspect>, 5 <suspect>
MoAddANanCounter
  aSuspectPDFNanCounter=<suspect>, 2 <suspect>, 3 <suspect>,
  4 <suspect>, <suspect>
>

3.3.9.5.2   Formatting the Output

The output can be formatted by using the format option -f / --format.

The valid values and their operations are as follows:

• DN-MT – Group by measured object then measurement type.
• MT-DN – Group by measurement type then measured object.
• PMGroup-DN-MT – Group by PM group then measured object then measurement type.
• PMGroup-MT-DN – Group by PM group then measurement type then measured object.

>show-counters -f DN-MT
MO1
  measurement0=123
MO12
  measurement0=123
  measurement1=1.2344534
MO123
  measurement0=123
  measurement1=1.2344534
>

>show-counters -f MT-DN
measurement0
  MO1 123
  MO12 123
measurement1
  MO12 1.2344534
  MO123 1.2344534
>

>show-counters -f PMGroup-DN-MT
AMeasuredObjectgroupId
  MoAddACounter
     aSuspectPDFCounter=1 <suspect>, 2 <suspect>, 3 <suspect>,
     4 <suspect>, 5 <suspect>
group0
  ManagedElement=1
     measurement0=123
>

>show-counters -f PMGroup-MT-DN
AMeasuredObjectgroupId
  aSuspectPDFCounter
     MoAddACounter 1 <suspect>, 2 <suspect>, 3 <suspect>,
     4 <suspect>, 5 <suspect>
group0
  measurement0
     ManagedElement=1 123
     ManagedElement=1,SystemFunctions=1,Pm=1 123
>

Table 22 lists the error messages for show-counters command

3.3.10   Error Indication when Displaying MO Information

If a command that displays information from multiple MO instances fails to retrieve information from a certain MO instance, or group of MO instances, an error message is displayed. Then, the command continues to display information from the following MO instances, if any. After the last MO instance has been displayed, an final error message is also displayed.

The error messages are always displayed left aligned, independent of how deep in the MO hierarchy the affected MO instance is. Example 100 shows how the error messages from show, show-config and show-mib can be displayed.

(config-SysM=1)>show -m Schema
ManagedElement=NODE06ST,SystemFunctions=1,SysM=1,Schema=ECIM_CommonLibrary
  baseModelIdentifier="ECIM_CommonLibrary"
  baseModelVersion="1.2"
  identifier="ECIM_CommonLibrary"
  version="1.2"
ManagedElement=NODE06ST,SystemFunctions=1,SysM=1,Schema=ComTop
ERROR: Failed to get attribute value(s) for ManagedElement=NODE06ST,SystemFunctions=1,SysM=1,
       Schema=ComTop
ManagedElement=NODE06ST,SystemFunctions=1,SysM=1,Schema=ComSecM
  baseModelIdentifier="ECIM_Security_Management"
  baseModelVersion="2.0"
  identifier="ComSecM"
  version="11.0.1"
ManagedElement=NODE06ST,SystemFunctions=1,SysM=1,Schema=ComLocalAuthorization
ERROR: Failed to get attribute value(s) for ManagedElement=NODE06ST,SystemFunctions=1,SysM=1,
       Schema=ComLocalAuthorization
ManagedElement=NODE06ST,SystemFunctions=1,SysM=1,Schema=ComLdapAuthentication
  baseModelIdentifier="ECIM_LDAP_Authentication"
  baseModelVersion="2.0"
  identifier="ComLdapAuthentication"
  version="11.0.0"
ERROR: Failed to read instances of class Schema under ManagedElement=1,SystemFunctions=1,SysM=1
ERROR: Failed to retrieve all requested information

The show-table command is an exception. It always displays any error messages after the table. See Example 101.

(Pm=1)>show-table –m PmJob –p currentJobState,jobPriority,jobType,pmJobId
==================================================================
| currentJobState | jobPriority | jobType        | pmJobId       |
=================================================================
| ACTIVE          | MEDIUM      | MEASUREMENTJOB | POT_15min_Job |
==================================================================
ERROR: Failed to get attribute value(s) for ManagedElement=1,SystemFunctions=1,Pm=1,
       PmJob=PU_15min_Job
ERROR: Failed to read instances of class PmJob under ManagedElement=1,SystemFunctions=1,Pm=1
ERROR: Failed to retrieve all requested information

3.4   Change and Display the Position in MO Tree

The MO position can be changed by navigation commands in both Exec mode and Config mode in the following ways:

• By entering the <path>. For example, to change position from root to ManagedElement and then to SysM:

  (config)>ManagedElement=NODE06ST (config-ManagedElement=NODE06ST)>SystemFunctions=1,⇒ SysM=1 (config-SysM=1)>

  By entering RDNs, the CLI position can be changed only to child MO instances, not to parent MO instances. The reason is that RDNs are interpreted relative to the CLI position.

• By entering the LDN. For example, to change position from SysM to SystemFunctions:

  (config-SysM=1)>ManagedElement=NODE06ST,SystemFunctions=1 (config-SystemFunctions=1)>

• By entering command dn followed by an LDN, to navigate to an MO instance. The difference between this command and navigation by just entering an LDN is that command dn does not create an MO instance.

  (config-Snmp=1)>dn ManagedElement=NODE06ST,SystemFunctions=1,SecM=1 (config-SecM=1)>

• By entering command dn, followed by -m or –moc, and a MOC, to navigate to the MOC instance. This is only applicable when there is one instance. If there are several MOC instances, the navigation can be qualified further by using parameter -c or –condition.

  (config-Snmp=1)>dn –m Fm ManagedElement=NODE06ST,SystemFunctions=1,Fm=1 (Fm=1)> >dn -m Schema -c schemaId=CmwPm ⇒ ManagedElement=NODE06ST,SystemFunctions=1,SysM=1,⇒ Schema=CmwPm (Schema=CmwPm)>

• By entering command back, to navigate back to the previous location in the MO tree.

  (config-SecM=1)>back (config-Snmp=1)>

• By typing .. or entering command up, to return to the superior MO in the tree. For example, to change the current location to the parent MO instance:

  (config-SystemFunctions=1)>up (config-ManagedElement=NODE06ST)>

  The .. element can be part of the RDN navigation command:

  (config-SysM=1)>..,Fm=1 (config-Fm=1)>

• By entering command top, to change the current location to the root position:

  (config-SystemFunctions=1)>top (config)>

• By entering command show-dn, to display the LDN of the current location in the MO tree.

  (config-Fm=1)>show-dn ManagedElement=NODE06ST,SystemFunctions=1,Fm=1

• By entering command prompt, to display the current location continuously.

  (config-Fm=1)>prompt $dn ManagedElement=NODE06ST,SystemFunctions=1,Fm=1>

3.4.1   Navigation Errors

The navigation error messages are described in Table 23.

3.5   Change MO Attributes

MO attributes can be changed in Config mode only. If the changes are entered without error (that is, no printout is provided), the change is added to the transaction and the changed MO is locked. The changes are applied after a successful commit of the transaction. The lock is released by transaction abort or commit, as initiated by CLI commands or session time-out.

This section describes how to change attributes of the following data types:

• Single-valued attribute, see Section 3.5.1 Change Single-Valued Attribute
• Single-valued attribute value deletion, see Section 3.5.2 Delete Value of Single-Valued Attribute
• Sequence, see Section 3.5.3 Change Attribute Defined as Sequence
• Struct, see Section 3.5.4 Change Attribute Defined as Struct
• Passwords, see Section 3.5.5 Change Attribute Defined as Password or Passphrase String
• MO reference, see Section 3.5.6 Change Attribute Defined as MO Reference

3.5.1   Change Single-Valued Attribute

Command [<path>,] <attribute_name>=<attribute_value> changes a single-valued attribute. If no printout is displayed as a result, the operation is verified against the data type specific rules defined in the model. Then the attribute change is added to the transaction, and the changed MO is locked. An error printout is displayed if the operation fails, examples are provided in Table 24.

The changes are applied after command commit and the locks are released on success.

The input syntax for the attribute data types is identical to the printout syntax, as described in Section 3.3.1 Display Single-Valued Attribute, with the following exceptions:

• Strings can be entered with or without double quotation marks (”). A string including characters with a special meaning in the CLI ([, comma, =, [], ", and ]) must be entered with quotation marks.
• Booleans are interpreted in a case-insensitive way (for example, "TRUE", "true", and "True") and are displayed in lower case.

Attributes defined as EcimEmpty cannot have any value, it conveys information by its presence or absence.

(config-ManagedElement=NODE06ST)>dnPrefix=test
(config-ManagedElement=NODE06ST)>commit

(config-agentAddress)>port=xyz
ERROR: Invalid value 'xyz' for attribute 'port'.
Valid values are in range : [0,4294967295]

(config-Snmp=1)>operationalState=DISABLED
ERROR: Attribute 'operationalState' is read-only.

(config-agentAddress)>host="$4546"
ERROR: Invalid value '$4546' for attribute 'host'.
Valid values are strings in a specified format.
Type: 'host?' for more information on the format to use

(config-ManagedElement=NODE06ST)>myEmptyAttribute
(config-ManagedElement=NODE06ST)>commit

3.5.2   Delete Value of Single-Valued Attribute

Command no <nillable_attribute_name> deletes an attribute value.

For examples on related verification rules and errors, see Table 25.

(config-ManagedElement=NODE06ST)>show userLabel
userLabel=[]
(config-ManagedElement=NODE06ST)>userLabel=xyz
(config-ManagedElement=NODE06ST)>commit -s
(config-ManagedElement=NODE06ST)>show userLabel
userLabel="xyz"
(config-ManagedElement=NODE06ST)>no userLabel
(config-ManagedElement=NODE06ST)>commit -s
(config-ManagedElement=NODE06ST)>show userLabel
userLabel=[]

(config-Snmp=1)>no operationalState
ERROR: Attribute 'operationalState' is read-only (can't
be deleted).

3.5.3   Change Attribute Defined as Sequence

This section describes how to change a sequence.

3.5.3.1   Initialize Sequence

Command <sequence_name>=[<sequence_element>,<sequence_element>,...] initializes a sequence.

(config-PlainMultivalueAttrs=1)>ddtStringMultivalueAttr=[ALABAMA,ALASKA,ARIZONA]
(config-PlainMultivalueAttrs=1)>commit -s
(config-PlainMultivalueAttrs=1)>show ddtStringMultivalueAttr
ddtStringMultivalueAttr
   "ALABAMA"
   "ALASKA"
   "ARIZONA"

3.5.3.2   Add Simple Type Element to Sequence

Command <attribute_name>=<sequence_element_value> adds an element to the last position of a sequence.

(config-PlainMultivalueAttrs=1)>ddtStringMultivalueAttr=[ALABAMA,ALASKA,ARIZONA]
(config-PlainMultivalueAttrs=1)>ddtStringMultivalueAttr=FLORIDA
(config-PlainMultivalueAttrs=1)>commit -s
(config-PlainMultivalueAttrs=1)>show ddtStringMultivalueAttr
ddtStringMultivalueAttr
   "ALABAMA"
   "ALASKA"
   "ARIZONA"
   "FLORIDA"

3.5.3.3   Insert Simple Type Elements to Sequence

Command insert [<path>,] <attribute_name>[<existing_sequence_element>]=<new_sequence_element> inserts a sequence element before the selected value of a sequence.

(config-PlainMultivalueAttrs=1)>show ddtStringMultivalueAttr
ddtStringMultivalueAttr
   "ALABAMA"
   "ALASKA"
   "ARIZONA"
(config-PlainMultivalueAttrs=1)>insert ddtStringMultivalueAttr⇒
[ALASKA]=FLORIDA
(config-PlainMultivalueAttrs=1)>show ddtStringMultivalueAttr
ddtStringMultivalueAttr
   "ALABAMA"
   "FLORIDA"
   "ALASKA"
   "ARIZONA"

3.5.3.4   Insert Simple Type Element in Sequence Using Index

Command insert [<path>,] <attribute_name>'['@<index>']'=<new_value> inserts a sequence element into a sequence with existing values. The positional index starts from 1. The index must address an existing position in the sequence. Values cannot be added after the last existing value.

(config-PlainMultivalueAttr=1)>show intMultivalueAttr
intMultivalueAttr
   42
   43
(config-PlainMultivalueAttr=1)>insert intMultivalueAttr[@1]=34
(config-PlainMultivalueAttr=1)>show intMultivalueAttr
intMultivalueAttr
   34
   42
   43

For examples on related verification rules and errors, see Table 26 and Table 29.

3.5.3.5   Change Sequence Element

Command [<path>,] <attribute_name>'['<existing_sequence_element>']'=<new_sequence_element_value> changes a sequence element.

(config-PlainMultivalueAttrs=1)>show ddtStringMultivalueAttr
ddtStringMultivalueAttr
   "ALASKA"
   "ALABAMA"
   "ARIZONA"
(config-PlainMultivalueAttrs=1)>ddtStringMultivalueAttr[ALABAMA]=⇒
FLORIDA
(config-PlainMultivalueAttrs=1)>commit -s
(config-PlainMultivalueAttrs=1)>show ddtStringMultivalueAttr
ddtStringMultivalueAttr
   "ALASKA"
   "FLORIDA"
   "ARIZONA"

3.5.3.6   Change or Add Sequence Element Using Index

Command [<path>,] <attribute_name>'['@<index>']'=<new_value> changes or adds a sequence element. The positional index starts from 1. If the index addresses an existing sequence element, that value is replaced. If the index is one greater than the current number of values, the new value is added to the sequence.

(config-PlainMultivalueAttr=1)>show intMultivalueAttr
intMultivalueAttr
   42
   43
(config-PlainMultivalueAttr=1)>intMultivalueAttr[@1]=34
(config-PlainMultivalueAttr=1)>show intMultivalueAttr
intMultivalueAttr
   34
   43

(config-PlainMultivalueAttr=1)>show intMultivalueAttr
intMultivalueAttr
   42
   43
(config-PlainMultivalueAttr=1)>intMultivalueAttr[@3]=34
(config-PlainMultivalueAttr=1)>show intMultivalueAttr
intMultivalueAttr
   42
   43
   34

For examples on related verification rules and errors, see Table 27 and Table 29.

To change a sequence attribute of type string when the value to be changed starts with character @, put the value within quotes to address it by value rather than by index.

(config-AMoc=1)>show userLabel
userLabel
   “AB”
   “@1”
(config-AMoc=1)>userLabel[“@1”]=Swift
(config-AMoc=1)>show userLabel
userLabel
   “AB”
   “Swift”

3.5.3.7   Delete Named Element from Sequence

Command no <attribute_name>=<sequence_element_value> deletes a named element from a sequence.

(config-PlainMultivalueAttrs=1)>show ddtStringMultivalueAttr
ddtStringMultivalueAttr
   "ALASKA"
   "ALABAMA"
   "ARIZONA"
config-PlainMultivalueAttrs=1)>no ddtStringMultivalueAttr=ALABAMA
(config-PlainMultivalueAttrs=1)>commit -s
(config-PlainMultivalueAttrs=1)>show ddtStringMultivalueAttr
ddtStringMultivalueAttr
   "ALASKA"
   "ARIZONA"

3.5.3.8   Delete Element in Sequence Using Index

Command no [<path>,] <attribute_name>'['@<index>']' deletes a sequence element in sequence. The positional index starts from 1. The index must address an existing position in the sequence.

(config-PlainMultivalueAttr=1)>show intMultivalueAttr
intMultivalueAttr
   42
   43
(config-PlainMultivalueAttr=1)>no intMultivalueAttr[@1]
(config-PlainMultivalueAttr=1)>show intMultivalueAttr
intMultivalueAttr
   43

For examples on related verification rules and errors, see and Table 29.

3.5.3.9   Delete All Elements from Sequence

Command no <sequence_name> deleted all elements from a sequence.

Note:  

Deleting all elements from a sequence with this command results in an empty attribute. If an attribute defined as a sequence is instead initialized to the empty sequence by <attribute_name>=[], it is guaranteed to be empty.

(config-PlainMultivalueAttrs=1)>show ddtStringMultivalueAttr
ddtStringMultivalueAttr
   "ALASKA"
   "ALABAMA"
   "ARIZONA"
(config-PlainMultivalueAttrs=1)>no ddtStringMultivalueAttr
(config-PlainMultivalueAttrs=1)>commit -s
(config-PlainMultivalueAttrs=1)>show ddtStringMultivalueAttr
ddtStringMultivalueAttr=[]

3.5.3.10   Change Element in Sequence of Struct without Key

If an attribute is defined as a sequence of struct and the struct has no key member, a sequence element can be identified using the positional index. Thus, an element in the sequence can be modified by addressing that element with the positional index. The positional index is supported only for sequence of keyless structs. The positional index is identified by character @ for all the struct elements in the sequence. The index numbering starts from 1.

(config-Snmp=1)>show -v agentAddress
agentAddress[@1]
   host="1.1.1.1"
   port=26343
agentAddress[@2]
   host="2.2.2.2"
   port=23154
(config-Snmp=1)>agentAddress[@2],host=4.4.4.4 port=4444
(config-Snmp=1)>show -v agentAddress
agentAddress[@1]
   host="1.1.1.1"
   port=26343
agentAddress[@2]
   host="4.4.4.4"
   port=4444

3.5.3.11   Add a New Keyless Struct Element to Sequence

A new element can be appended to the end of the sequence in the following ways:

• Without specifying the positional index:

  [<path>,] <noKeyStructSequence>

• Setting member without the specifying positional index:

  [<path>,] <noKeyStructSequence>,member_Name=<member_value>

• Specifying the positional index:

  [<path>,] <noKeyStructSequence>[@<N>]

• Setting member by specifying the positional index:

  [<path>,] <noKeyStructSequence>[@<N>],member_Name=<member_value>

A new struct instance is added to the end of the sequence. The user navigates to the newly created instance if the multiplicity for the attribute has not reached its maximum value.

If the struct members are set as part of the append operation, the specified values are set to the struct members.

(config-Snmp=1)>agentAddress
(config-agentAddress[@2])>up
(config-Snmp=1)>show -v agentAddress
agentAddress[@1]
   host="0.0.0.0"
   port=26343
agentAddress[@2]

(config-Snmp=1)>agentAddress[@2]
(config-agentAddress[@2])>up
(config-Snmp=1)>show -v agentAddress
agentAddress[@1]
   host="0.0.0.0"
   port=26343
agentAddress[@2]

(config-Snmp=1)>agentAddress,port=999
(config-Snmp=1)>show agentAddress
agentAddress
   host="0.0.0.0"
   port=26343
agentAddress
   port=999

(config-Snmp=1)>agentAddress[@3],host=9.9.9.9
(config-Snmp=1)>show agentAddress
agentAddress
   host="0.0.0.0"
   port=26343
agentAddress
   port=999
agentAddress
   host="9.9.9.9"

(config-Snmp=1)>agentAddress[@5]
ERROR: Invalid index '5' for a sequence containing 1 values. Use an index <=2

3.5.3.12   Delete Keyless Struct Sequence

Command no [<path>,] <noKeyStructSequence>[@<N>] deletes an element at position N in a sequence of keyless structs. All instances after position N are shifted up by one position.

Command no <noKeyStructSequence> deletes all struct elements in the sequence.

(config-Snmp=1)>show -v agentAddress
agentAddress[@1]
   host="0.0.0.0"
   port=26222
agentAddress[@2]
   host="9.9.9.9"
   port=9999
agentAddress[@3]
   host="2.2.2.2"
   port=2222
(config-Snmp=1)>no agentAddress[@2]
(config-Snmp=1)>show -v agentAddress
agentAddress[@1]
   host="0.0.0.0"
   port=26222
agentAddress[@2]
   host="2.2.2.2"
   port=2222

(config-Snmp=1)>show -v agentAddress
agentAddress[@1]
   host="0.0.0.0"
   port=26222
agentAddress[@2]
   host="9.9.9.9"
   port=9999
agentAddress[@3]
   host="2.2.2.2"
   port=2222
(config-Snmp=1)>no agentAddress[@2],host
(config-Snmp=1)>show -v agentAddress
agentAddress[@1]
   host="0.0.0.0"
   port=26222
agentAddress[@2]
   port=2222

(config-Snmp=1)>show agentAddress
agentAddress
   host="0.0.0.0"
   port=26222
agentAddress
   host="9.9.9.9"
   port=9999
agentAddress
   host="2.2.2.2"
   port=2222
(config-Snmp=1)>no agentAddress
(config-Snmp=1)>show agentAddress
agentAddress=[]

3.5.3.13   Insert Struct Element to a Sequence of Keyless Structs

Command insert [<path>,] <noKeyStructSequence>[@<N>] inserts a struct element at position N to a sequence of keyless structs. The struct elements after position N are moved down one position.

(config-Snmp=1)>insert agentAddress[@2]
(config-agentAddress[@2])>host=9.9.9.9
(config-agentAddress[@2])>port=9999
(config-agentAddress[@2])>up
(config-Snmp=1)>show -v agentAddress
agentAddress[@1]
   host="0.0.0.0"
   port=26222
agentAddress[@2]
   host="9.9.9.9"
   port=9999
agentAddress[@3]
   host="2.2.2.2"
   port=2222

3.5.3.14   Change Element in Sequence of Keyed Struct

If the attribute is defined as a sequence of struct and the struct has a key member, a sequence element can be identified and the CLI position can be changed in the sequence.

As a result, existing sequence elements can be changed and new elements can be added without changing the existing element, as shown in Example 130.

(config-PlainMultivalueAttrs=1)>countries=Sweden
(config-countries=Sweden)>capital=Stockholm
(config-countries=Sweden)>population=2000000
(config-countries=Sweden)>up
(config-PlainMultivalueAttrs=1)>countries=Norway
(config-countries=Norway)>capital=Oslo
(config-countries=Norway)>up
(config-PlainMultivalueAttrs=1)>show countries
countries="Sweden"
   capital="Stockholm"
   population=2000000
countries="Norway"
   capital="Oslo"
(config-PlainMultivalueAttrs=1)>show countries=Sweden
countries="Sweden"
   capital="Stockholm"
   population=2000000
(config-PlainMultivalueAttrs=1)>no countries=Sweden
(config-PlainMultivalueAttrs=1)>show countries
countries="Norway"
   capital="Oslo"

The country attribute of class PlainMultivalueAttrs is defined as a sequence of struct. The struct has the following members:

• "name", defined as string, that is, the key of the struct
• "capital", defined as a string
• population, defined as int64 with default value 0

3.5.3.15   Common Error Messages in Sequence Operations

The common error messages in sequence operations are shown in Table 29.

3.5.4   Change Attribute Defined as Struct

Command <struct_name,struct_element>=<struct_element_value> changes a struct. If nothing is displayed as a result, the changed struct is added to the transaction and the changed MO is locked. An error printout is displayed if the operation fails, see Table 30.

If struct property isExclusive is set, setting one struct member means that all other struct members are automatically unset.

The changes are applied after command commit and the locks are released on success. Navigating away from the MO can only be done if all members of a struct inside the MO are set correctly.

(config-ManagedElement=NODE06ST)>productIdentity=1,productDesignation=xyz
(config-ManagedElement=NODE06ST)>productIdentity=1,productNumber=1234
(config-ManagedElement=NODE06ST)>productIdentity=1,productRevision=1.1
(config-ManagedElement=NODE06ST)>commit -s

3.5.4.1   Struct of Sequence

A struct can have a sequence as its element. Initialization, adding, and modifying values of such struct elements is similar, as described in Section 3.5.3 Change Attribute Defined as Sequence.

3.5.5   Change Attribute Defined as Password or Passphrase String

Two types of passwords/passphrases exist and they are treated slightly differently in the CLI. In this section, the terms legacy password and passphrase string are used to distinguish the types.

Legacy passwords can appear only as single-valued attributes, whereas passphrase strings can appear both as single valued and as sequences, and both as attributes and struct members. Verbose help shows a legacy password as type password and a passphrase string as a type string with tag passphrase.

The way to enter values of both types interactively depends on how the ME is configured. Either they are entered visibly, similar to how other attribute types are assigned, or they are entered hidden using special prompts. For details, see Section 3.5.5.1 Visible Entry of Values and Section 3.5.5.2 Hidden Entry of Values.

When entered non-interactively, for example, in script mode or when commands are pasted into the CLI, the values are entered visibly.

3.5.5.1   Visible Entry of Values

A legacy password is entered in the following ways:

• An encrypted value can be assigned to a password attribute by <attribute_name>=<attribute_value>.
• A cleartext value can be assigned to a password attribute by <attribute_name>=<attribute_value> cleartext.

A passphrase string value is assigned by <attribute_name>=<attribute_value>, where <attribute_value> must be cleartext, unless the ME is configured to accept encrypted values. The information about whether a value is encrypted or not is in this case encoded within the value itself.

For an encrypted value to be valid, it must be taken from the output of an CLI show type command. An encrypted value is normally only valid on one ME, but MEs can be configured so that values can be copied between them. The encrypted values of legacy passwords and passphrase strings are only valid as input of the respective type, that is, encrypted values cannot be copied between the two types.

Cleartext values of both types become encrypted when they are entered. When displaying legacy passwords, the values are shown encrypted. When displaying passphrase strings, the values are normally not displayed, but an ME can be configured to display encrypted values.

(config-A=1)>myPassword=”foobarmypasswd398” cleartext
(config-A=1)>show myPassword
myPassword=”ei28fwisgieatge5646i”

(config-A=1)>myPassword=”34sfsSFGargy5ghyj124”
(config-A=1)>show myPassword
myPassword=”34sfsSFGargy5ghyj124”

(config-A=1)>myPassphrase=”foobarmypasswd398”
(config-A=1)>show myPassphrase
myPassword=”********”

(config-A=1)>myPassphrase=”foobarmypasswd398”
(config-A=1)>show myPassphrase
myPassphrase=”encrypted:hdg4jdldf8gfk5jd”
(config-A=1)>myPassphrase=”encrypted:hdg4jdldf8gfk5jd”
(config-A=1)>show myPassphrase
myPassphrase=”hdg4jdldf8gfk5jd”

3.5.5.2   Hidden Entry of Values

When interactively entering a legacy password or a passphrase string, the following applies:

• In the following cases, the cursor moves to a new line, where a special prompt is displayed for the entry of the value:
  • When the equals sign (=) is entered after the name of an attribute or struct member
  • When the Tab key is used to complete the name of such attribute or struct member

  The characters entered at this prompt are not echoed.

• When the CR or Enter key is pressed, a second prompt is displayed for the repeated entry of the value.

  If the CR or Enter key is pressed at this prompt, and if the two entered strings are identical, the normal command line is displayed again. A sequence of eight asterisks is representing the password, see Example 136.

(config-A=1)>myPassword=
Enter myPassword:
Repeat myPassword:
(config-A=1)>myPassword=******** 

The contents of the command line where the value is represented by asterisks cannot be edited.

If the type is legacy password, two alternatives are available:

• To change the attribute member, press the CR key or the Enter key.
• To clear the line, press Ctrl+C.

If the type is passphrase string, further attributes or struct members can be changed on the same line.

If the two entered values are not identical, an error message is displayed and the first password prompt is redisplayed, as shown in Example 137.

(config-A=1)>myPassword=
Enter myPassword:<password>
Repeat myPassword:<another_password>
ERROR: The inputs do not match
Enter myPassword:

To cancel the entry of the password strings, press Ctrl+C.

Note:  

An encrypted password cannot be entered in this way. The entered values are automatically treated as cleartext. If a legacy password attribute must be changed to an already encrypted value, this is done either in script mode or by pasting a full line including the encrypted value into the CLI. However, encrypted passphrase string values can be entered at these special prompts.

3.5.6   Change Attribute Defined as MO Reference

Changing an attribute of MO reference type is the same as changing a string attribute with the following special conditions:

• The MO reference attribute value is the LDN of the referred MO.
• If the definition of the MO reference attribute contains a certain MOC type, the referred MO must be an instance of this MOC.
• If the definition of the MO reference attribute has external Unidirectional Association, the referred MO accepts any arbitrary string.
• The referred MO instance does not have to exist. If the ManagedElement ID does not match the one defined in the system, the CLI automatically corrects it.

As an alternative to providing the full LDN, the CLI also allows the value to be an MO path relative to the current position, using the same rules as when navigating to an MO instance. This makes it possible to, for example, navigate to the MO instance that is to be referred to, and then give the MO reference attribute the value ".". When assigning the value, the CLI automatically translates the relative path to an LDN.

An MO reference value can, as any string, be entered unquoted, as long as it does not contain any space characters. If an MO instance name contains a space, only the MO instance name can be quoted within the DN. However, it is recommended to quote the full MO reference values, as syntactical ambiguities can arise, in particular in commands changing sequences of MO references.

3.5.7   Change Multiple Attributes on One Command Line

Multiple attributes belonging to the same MO instance can be changed on a single command line, by separating the subcommands with space characters.

The supported modifications are as follows:

• Change single-value attribute, see Section 3.5.1 Change Single-Valued Attribute.
• Initialize sequence, see Section 3.5.3.1 Initialize Sequence.
• Add single-value element to sequence, see Section 3.5.3.2 Add Simple Type Element to Sequence.

The CLI handles all subcommands on the same command line as one atomic command. That is, the result is either that all the subcommands on the command line are executed successfully or no changes are made.

(config-MocA=1)>intMultiValueAttr=1 stringAttr="abc" ⇒
enumMultiValueAttr=[ONE, TWO]
(config-MocA=1)>show
MocA=1
   intMultiValueAttr=1
   enumMultivalueAttr
      ONE
      TWO
   stringAttr="abc"

To change attributes outside the current MO location, give the path to the MO where the attributes are located, followed by a comma (,), and then list the attributes changes.

(config-MocC=1)>MocB=1,MocA=1,intMultiValueAttr=1 ⇒
stringAttr="abc" enumMultiValueAttr=[ONE, TWO]
(config-MocC=1)show MocB=1,MocA=1
MocA=1
   intMultiValueAttr=1
   enumMultivalueAttr
      ONE
      TWO
   stringAttr="abc"

Multiple struct members can also be set on one command line according to the principles that apply for attributes.

3.6   Create MO

MOs can be created in an atomic way in a transaction, that is, in Config mode only. As a consequence, the configuration changes are not applied by entering the changes, but after successful commit of the transaction.

To create an MO:

1. Enter Config mode:

   >configure

2. Check if the MO exists:

   (config)>show <path>

   The CLI command for MO creation is identical to the CLI command for changing the CLI position to an existing MO. The successes of both operations are indicated in the same way, by providing no printout.

3. Select the appropriate action according to the possible results:
   • No error message is displayed, but the requested MO is displayed. In this case, the MO exists. Continue by changing the MO attributes, as described in Section 3.5 Change MO Attributes, according to the required changes.
   • Error message ERROR: Specific element not found indicates that the MO does not exists. Continue with the next step.
4. Enter the name of the MO according to the MO naming rules (see Section 3.6.1 MO Naming Rules) to create the desired MO.

   Example of key attribute of type string:

   (config)>ManagedElement=NODE06ST,SystemFunctions=1,⇒ SysM=1,NtpServer=myServer

   If the MO key attribute is of enumeration type, press the Tab key to list the available values with information about which values that are not yet instantiated, for example:

   (config-KeyAttrMOC=1)>EnumKeyAttrMOC=<Tab> ONE THREE <new> TWO <new>

   The possible results are as follows:

   • If no error printout is displayed, the operation succeeded and the CLI position changes to the new MO. The parent of the newly created MO, and the MO itself, is locked, for example, (config-NtpServer=myServer)>.

     Note:  

     If the MO is created and the value of a mandatory attribute is not assigned, no error will be thrown and the CLI position will be changed. Mandatory and cardinality related constraints can be checked by issuing a validate or commit command.

     
     
   • An error message is displayed if verification fails against any available constraint. In this case, modify the DN to comply with the constraints. For examples of error messages, see Table 31.
5. Press the Tab key to list the available optional and mandatory attributes, for example:

   (config-NtpServer=AServer)><Tab> administrativeState serverAddress userLabel

6. Request Verbose Help to determine if the attribute is mandatory and if it has a default value, for example:

   (config-NtpServer=AServer)>administrativeState ? administrativeState BasicAdmState <LOCKED|UNLOCKED> [optional] Locks or unlocks the operation of the NTP client function. This is a convenience function to permit some or all NtpServer instances to be temporarily locked without having to delete the object.

7. Set the mandatory attributes and the needed optional attributes, for example:

   (config-NtpServer=myServer)>serverAddress="22.22.22.22"

8. Commit the creation:

   (config-NtpServer=myServer)>commit

9. Verify the result.

   The possible results are as follows:

   • If no result message is displayed, the MO creation succeeded. In this case, the CLI position is in the new MO position in Config mode and a new transaction is created automatically. The lock on the parent of the newly created MO is released.
   • If the MO creation failed, the error message is displayed on the error reason. In this case, act according to the error indication.