Home

TMA CLI

Contents

1. SELECT nMS SELECT nx64 SELECT powerOffDetection action Activate Configuration OK crocusSDSLTT modem line Edit Configuration gt 88 User manual TMA CLI Basic TMA CLI commands c The get m option Use this option to display as much simple attribute values on one line as possible The number of attributes that will be printed on one line depends on the environment variable cots refer to Section 4 9 The environment variables crocusSDSLTT modem Status gt get m testType NO test testOriginator unknown testStatus unknown errorCount 0 ifDescr Modem ifType 1 ifSpeed 0 ifOperStatus down OK crocusSDSLTT modem Status gt User manual 89 Basic TMA CLI commands TMA CLI d The get r option Use this option recursive get in order to obtain not only the attributes of the current object but also of the underlying objects The attributes on the same level are grouped by LIST and an underlying object is selected by the SELECT command This allows you to use the get command to create scripts You can then use these scripts to easily change identical attributes on other devices of the same type For more information on this matter refer to Section 6 5 9 Setting values obtained with the get command crocusSDSLTT Edit Configuration gt get r GET LIST sysName Crocus SDSL TT No 15 sysContact Syste
2. User manual 13 Installing TMA CLI TMA CLI 2 7 Location of the TMA CLI files lf you did not change the default file location during the set up then the TMA CLI related directories and files can be found in the directory Program Files TMA Windows or opt TMA UNIX This directory has the following subdirectories This directory contains snmp_ info the executables This comprises the TMA CLI executable and some extra executables TMA sometimes summons such as TML TmaTftp the configuration files These are the ini files If you create a custom txt file you should also place it here the log files Sometimes errors are logged to a file These files can be found in this directory the model files TMA needs the model files to be able to communicate with the Telindus devices These mod files are located in this directory the subsystem picture files These are the bmp and def files that are necessary to display the subsystem picture of a Telindus device the Telindus MIB files When using an SNMP browser you need the MIB files of the Telindus devices These mib files are located in this directory the SUM files The sum files give the relationship between the attributes as they are displayed in TMA and the parameters you can see using an SNMP browser 14 User manual TMA CLI Connecting to a device 3 Connecting to a device Once the TMA CLI application and t
3. crocusSDSLTT Edit Configuration gt get modem line Status GET SELECT modem SELECT line LIST timeSinceLastRetrain 0d Oh Om Os lineState idle lineAttenuation 62 0dB noiseMargin 16 0dB ifSpeed 0 ifOperStatus down OK crocusSDSLTT Edit Configuration gt User manual 83 Basic TMA CLI commands TMA CLI 6 3 5 The get command options The following table shows which options can be used in combination with the get command The options are explained in the following paragraphs ER eS 0 000 0 Description Refer to paragraph Use this option to oe only those values that are different a The get d option from the default or read oe values page 87 get f Use this option to retrieve the full non default configuration b The get f option independent of your current location in the containment tree In page 88 other words it displays all the attributes that are set to a value different from their default value The attributes on the same level are grouped by LIST and an underlying object is selected by the SELECT command This is the same as executing get r a when located in the top object of the containment tree et m Use this option to display as much simple attribute values on c The get m option one line as possible page 89 The number of attributes that will be printed on one line depends on the environment varia
4. Example Consider the script file perform cli containing the command to retrieve the h2Modem performance attribute values from a device What is more the values have to be displayed in a table get v and with a as value separator setenv VALUESEPARATOR get v modem h2Modem Performance Execute this script crocusSDSLTT Edit Configuration gt exec perform cli OK crocusSDSLTT Edit Configuration gt setenv VALUESEPARATOR OK crocusSDSLTT Edit Configuration gt get v modem h2Modem Performance GET SELECT modem validity period noSyncTime LIST valid 120min gt 105min 0d Oh 15m Os valid 105min gt 90min 0d Oh 15m Os valid 90min gt 75min O0d Oh 15m Os valid 75min gt 60min 0d Oh 15m Os valid 60min gt 45min 0d Oh 15m Os valid 45min gt 30min 0d Oh 15m Os valid 30min gt 15min 0d Oh 15m Os valid 15min gt Omin 0d Oh 15m Os OK crocusSDSLTT Edit Configuration gt After the script is finished the environment variables as set in the script are retained 174 Reference manual TMA CLI The Cms2Serv ini file 9 The Cms2Serv ini file The Cms2Serv ini file contains the communication parameters of TMA CLI In some cases it may be necessary to change some of these parameters Therefore this section lists and explains the different Cms2Serv ini fi
5. ReadAccess on WriteAccess on SecurityAccess on la password accessRights ReadAccess on WriteAccess on SecurityAccess on a password passw4 accessRights ReadAccess on WriteAccess on SecurityAccess on OK crocusSDSLTT Edit Configuration gt Continued on next page 106 User manual TMA CLI Basic TMA CLI commands The set ix option continued Inserting a row and setting a value at the same time You can insert a new row in a table and set a value in this row at the same time crocusSDSLTT Edit Configuration gt set security i2 password passw2 OK crocusSDSLTT Edit Configuration gt Alternatively you can use the following syntax crocusSDSLTT Edit Configuration gt set security i2 password passw2 OK crocusSDSLTT Edit Configuration gt Both notations displayed above result in the following crocusSDSLTT Edit Configuration gt get w security security a password accessRights ReadAccess on WriteAccess on SecurityAccess on 5 a password passw2 accessRights ReadAccess on WriteAccess on SecurityAccess on ae a password accessRights ReadAccess on WriteAccess on SecurityAccess on 5 a password passw4 accessRights ReadAccess on WriteAccess on SecurityAccess on 4 OK crocus
6. This command allows the user to start an action Actions are related to an object in a selected group In other words the available actions depend on the current place in the containment tree complex action value specification lt complex action value specification gt lt element name gt lt value gt with lt value gt lt simple value gt lt struct_value gt Examples An action without an argument crocusSDSLTT Edit Configuration gt action Activate Configuration OK crocusSDSLTT Edit Configuration gt An action with a simple action value specification mm crocusSDSLTT modem Performance gt action Test Activation testActivationType AL test OK crocusSDSLTT modem Performance gt An action with a complex action value specification 01003 router Performance gt action startPing pingData ipAddress 172 31 40 10 iterations 30 OK 01003 router Performance gt 158 Reference manual TMA CLI The TMA CLI commands 8 5 The cfgload command Syntax CFGLOAD lt config file name gt Description This command downloads a previously stored configuration from a file to an access device The configuration file should have the binary CMS2 formatting Such kind of file has the extension cms The file name may include a path name White spaces within the file name are not allowed Use the application program T
7. gt Continued on next page User manual 127 Basic TMA CLI commands TMA CLI Setting an attribute value to its default value continued Resetting an entire object The following command resets all the attribute values in the currently selected object to their default value crocusSDSLTT Edit Configuration gt set LIST OK crocusSDSLTT Edit Configuration Resetting an entire device You can reset all the attribute values in the entire containment tree of a device by loading the default configuration crocusSDSLTT Edit Configuration gt action Load Default Configuration OK crocusSDSLTT Edit Configuration gt 128 User manual TMA CLI Basic TMA CLI commands 6 6 Adding a user instantiatable object This section explains what user instantiatable objects are It also explains how to add and remove user instantiatable objects The following table gives an overview of this section s fe rr What is a user instantiatable object How to add a user instantiatable object How to remove a user instantiatable object User manual 129 Basic TMA CLI commands TMA CLI 6 6 1 What is a user instantiatable object On some device e g the Telindus 1421 SHDSL Router some objects are not present in the containment tree by default If you want to use the features associated with such an object then you have to add the obj
8. lt simple element name gt lt simple value gt lt complex element name gt lt element name gt lt value gt lt table attribute name gt lt row_specification gt lt simple element specification gt lt simple value gt lt complex element _name gt lt element name gt lt value gt SELECT lt relative_object_specification gt LIST lt value_specifications gt SELECT lt relative_object_specification gt LIST lt value_specifications gt Description This type of specification can be used to set the values of a number of attributes of an object Continued on next page Reference manual 171 The TMA CLI commands TMA CLI The set command continued Object instance value If the user instantiatable object you want to add remove has no instance value also called index then you do not have to specify an instance value SET SELECT lt object specification gt SET DELOBJ lt object _specification gt User instantiatable objects that have no instance value are objects of which only one can be present in the containment tree an instance value also called index then you have to specify an instance value SET SELECT lt object _specification gt lt object_ instance value gt SET DELOBJ lt obje
9. Description This command selects the specified group of attributes The different groups are Edit configuration configuration attributes i e the device settings Provided you have write and security access all configuration attributes can be changed Status status attributes These give you information on the current operational state of the device Performance performance attributes These give you statistical information on the performance and efficiency of the device a list of alarms and an indication of which alarm s is are currently active When you use the selgrp command without argument the command returns the currently selected group Example Select the Status group crocusSDSLTT Edit Configuration gt selgrp Status OK crocusSDSLTT Status gt Reference manual 169 The TMA CLI commands TMA CLI 8 13 The set command Syntax SET lt value specification gt SET SELECT lt object specification gt lt object instance value gt SET DELOBJ lt object _specification gt lt object_instance value gt Description This command allows you to e change a value of a configuration attribute e adda user instantiatable object to the containment tree e delete a user instantiatable object from the containment tree Value specification The parameter lt value _specification gt can represent the following e simple value specification
10. This section explains how to make a direct connection between the computer running TMA CLI and a Telindus device The following table gives an overview of this section am fe What is a direct connection To which Telindus devices can you make a direct connection DB25 DB9 interconnection cable User manual 17 Connecting to a device TMA CLI 3 2 1 What is a direct connection A direct connection is a connection between a COM port of the computer and the auxiliary port also called control port of a Telindus device Such a connection is made by means of a straight male female DB9 cable YD There are some exceptions The Orchid 1003 LAN for instance This device has an RJ45 control port Consequently the connection is made by means of a DB9 RJ45 cable This cable is delivered with the Orchid 1003 LAN The following figure shows an example of a direct connection to a Table Top and Card Version modem computer running TMA e Card Version modem 3 a ee Table Top modem i i kk keen auxiliary port eo tot y Cone m i i i a ER AA o O mnnn straight male female DB9 cable 5 o M ee ee ee eee e ee eee ee Once the connection is made then the computer running TMA CLI is able to reach the modem 18 User manual TMA CLI Connecting to a device 3 2 2 To which Telindus devices can you make a direct connection Every Telindus device that is manageable with TMA has a contr
11. OK crocusSDSLTT modem Performance gt E In order to stop a test that is currently running use the Test Activation action with the following argument crocusSDSLTT modem Performance gt action Test Activation testActivationType NO test OK crocusSDSLTT modem Performance Starting an action that has a structured argument Let us consider the startPing action in the router object Performance group of the Orchid 1003 LAN The argument of this action has several sub values ipAddress iterations interval dataLength and timeOut Suppose you want to perform a ping to IP address 172 31 40 10 and this 30 times The rest of the arguments may keep their default value In that case type 01003 router Performance gt action startPing pingData ipAddress 172 31 40 10 iterations 30 OK 01003 router Performance gt User manual 133 Basic TMA CLI commands TMA CLI 6 8 Scripting A script file is an ASCII text file containing a series of commands which are executed one after the other A script file may have any extension cli txt etc Scripting is mostly used in non interactive TMA CLI mode Scripting is very useful to for instance configure a lot of devices at once or to regularly retrieve status and performance information from all the access devices in the network The following example will give you an idea of how you can use scripting A scripting example
12. Refer to the examples above User manual 99 Basic TMA CLI commands TMA CLI 6 5 2 Setting a structured attribute value This section explains how to set the values within a bit string and a structure For the definition of bit string and structure refer to Section 6 3 2 Reading a structured attribute value Because a table is a quite complicated attribute value it is explained in Section 6 5 4 Performing actions on a table with a variable length Setting values in a bit string The following examples show you how to set a value s in a bit string Setting only one value in the alarmMask attribute crocusSDSLTT Edit Configuration gt set alarmMask RemoteAlarm enabled OK crocusSDSLTT Edit Configuration 5 Setting several values in the alarmMask attribute crocusSDSLTT Edit Configuration gt set alarmMask StrapChanged enabled Access enabled RemoteAlarm enabled OK crocusSDSLTT Edit Configuration gt Setting several values in the timeslots attribute ny crocusSDSLTT g703 Edit Configuration gt set timeslots tsO off tsl on ts2 on tsl10 on ts25 on OK crocusSDSLTT g703 Edit Configuration gt d Continued on next page 100 User manual TMA CLI Basic TMA CLI commands Setting a structured attribute value continued If you set one or more bits of a bit string to a certain value then the rem
13. Reference manual 179 Troubleshooting TMA CLI 10 1 Error messages When a TMA CLI executes a command successfully you will see OK in the output However when the command execution failed the reply has the following format If the source of the error is Then the format of the error message is a syntax error NOK lt line_number gt lt error_code gt lt error condition gt a failing answer from a device NOK lt error_code gt lt error condition gt Refer to Annex A error codes for a complete list of all the possible error codes 180 Reference manual TMA CLI Troubleshooting 10 2 Syntax errors In case of a syntax error the TMA CLI error message consists of four fields separated with a comma NOK oo femna Reference manual 181 Troubleshooting TMA CLI 10 3 Failing answer from a device The two main causes of a failing answer from a device are e There is no network connection towards the device Carefully check the connections between your computer running TMA CLI and the device you are trying to reach e There are no or outdated model files of the device present on your computer Reinstall the latest model files from the Telindus web site Refer to Section 2 6 How to upgrade the model files If no answer is received from a device the following error message appears NOK 15 NACK received from device errorcode lt communication_error gt where the lt communication_error gt is
14. Restore F TMA comms handler 56 User manual TMA CLI Opening a TMA CLI session 4 7 Defining TMA CLI users and passwords If a password has been configured in the Telindus access device this password has to be transmitted before a TMA CLI session can be opened on this device The TMA CLI password configuration tool TmaUserConf exe allows you to create TMA users and assign a password to these users The TMA users are related to the accounts that are defined on the management station Example Suppose user Y logs on to a Windows NT management station and starts a TMA session on a Telindus access device mm 1 meeen oS TMA CLI checks which TMA user is related with the account of user Y TMA CLI checks which password is assigned to this user TMA CLI sends this password to the Telindus access device 4 If this password e corresponds with the password defined in the Telindus access device then a TMA CLI session opens on the device e does not correspond with the password defined in the Telindus access device then no TMA CLI session opens If no passwords are defined in the Telindus access devices then you do not have to create TMA users and corresponding passwords However every time you start a TMA session on a device the following warning will appear Warning Could not read the user configuration file You can stop this warning from appearing by executing the TmaUserConf exe application and closing it without entering an
15. Suppose you want to retrieve some statistics from several modems in your network The output has to be logged to the file stats txt every weekday at 8 00 pm The TMA CLI script file script cli may contain something like this logging on stats txt get sysName get modem Performance get modem line Performance logging off Suppose you create a batch file stats bat for this purpose The batch file may contain something like this tmacli 172 31 5 1 exec script cli tmacli 172 31 5 2 exec script cli tmacli 172 31 5 5 exec script cli tmacli 172 31 5 10 exec script cli If you are working on a machine running Windows 95 you could use the Scheduled Task Wizard to define when the batch file should be executed Scheduled Task Wizard Eg Select the time and day you want this task to start Start time 20 00 Perform this task Start date 11 09 2000 z cms 134 User manual TMA CLI Basic TMA CLI commands 6 9 Importing a configuration file Section 6 5 9 Setting values obtained with the get command explained how you can easily create script files in order to set identical attributes on several devices of the same type There is also another way to get the same result This involves exporting a configuration file in TMA i e TMA with the GUI The configuration file should be formatted in the binary CMS2 format Such kind of file has the extension cms In TMA CLI you can then load
16. TMA CLI Connecting to a device 3 4 5 Basic management concentrator settings to enable a proxied IP connection To establish an IP connection between the computer running TMA and the non IP device a few basic parameters called attributes have to be set in the management concentrator e The first two attributes are the IP address and default gateway of the management concentrator itself These parameters are already explained in Section 3 3 IP connection to an IP device e The other attribute is the object table of the management concentrator nmsgroup objectTable The relevant elements in this table are ipAddress Use this attribute to assign an IP address to the non IP device The IP address should belong to the sub network of the management concentrator For example if the IP address of the management concentrator is 192 168 4 5 with subnetmask 255 255 255 0 then the IP address of the network unit should also be within the range from 192 168 4 1 to 192 168 4 254 addressType The management concentrator has to know how it can contact the connected non IP device Therefore use the addressType attribute to specify the type of address e arelative address e anabsolute address For more information on these address types refer to Section 4 2 6 Connecting using absolute addressing addressValue If you set the addressType attribute to absolute then use the addressValue attribute to specify the absolute address value Continued o
17. e complex value specification 1 e complex value specification 2 These different specifications are explained in the following three paragraphs Definition of a simple value specification Syntax lt simple value _specification gt lt specification gt lt simple value gt Description Refer to Section 8 8 The get command for a definition of lt specification gt YD e The lt specification gt cannot be an lt object _specification gt e The lt specification gt may contain an absolute or a relative object specification e The type of the specified attribute element or row should be a simple type Definition of a complex value specification 1 Syntax lt complex value _specification gt lt attribute specification gt lt element _name gt lt value gt with lt value gt lt simple value gt lt struct_value gt Description This type of specification can be used to set the value of a complex attribute one or more elements within the selected object It may start with an absolute or relative object specification Continued on next page 170 Reference manual TMA CLI The TMA CLI commands The set command continued Definition of a complex value specification 2 Syntax A shortened syntax of this type of specification can be described as SET LIST lt simple attribute name gt lt simple value gt lt complex attribute name gt
18. security a password sys admin a password user accessRights ReadAccess on WriteAccess off SecurityAccess off OK crocusSDSLTT Edit Configuration gt Continued on next page User manual 117 Basic TMA CLI commands TMA CLI Setting several attribute values at once continued Setting several attribute values on another object level You are also able to set several attribute values at once on another object level than the current one In that case you have to use the SELECT command to move to the other object The attributes within SELECT have to be surrounded by LIST This is shown in the following example crocusSDSLTT Edit Configuration gt set SELECT modem LIST tests detectRDL disabled channel central SELECT line LIST speed 128000 bps OK crocusSDSLTT Edit Configuration gt Continued on next page 118 User manual TMA CLI Basic TMA CLI commands Setting several attribute values at once continued Setting several attribute values on the current and another object level Of course combining the two previous examples allows you set several attributes on the current and other object levels at once This is shown in the following example crocusSDSLTT Edit Configuration gt set LIST sysName Crocus SDSL TT central sysContact System Administrator Tel 785612 sysLo
19. CLI session on the Card Version modem type the following TmaCli 10 0 11 1 r 0 rack3 5 B 40 User manual TMA CLI Opening a TMA CLI session 4 2 9 Connecting using relative addressing and an exit line TmaCli COM lt x gt IP O R lt nms gt LINE lt n gt Use this command to connect to a device located behind another device The addressing method that is used is relative addressing For more information on relative and absolute addressing refer to the Section 4 3 Relative and absolute addressing Address arguments In case the connection between your computer running TMA CLI and the first device you want to connect through is e adirect connection then specify the COM port of your computer com lt x gt e an IP connection then specify the IP address of the first device lt 1P gt Replace R lt nms gt by the relative address of the remote device you want to reach Replace LINE lt n gt by the line through which you can reach the remote device e A multi device i e a device that incorporates several devices on one card consequently has several different exit lines also called exit port Actually it has as many lines as there are devices on the card e Anon multi device only one device on one card only has one exit line also called exit port In that case you may drop the LINE lt n gt argument Example Suppose you have the following set up C Ges Crocus SDSL TT 1 sey PC runni
20. OK o1003 Edit Configuration gt Continued on next page 92 User manual TMA CLI Basic TMA CLI commands The get s option continued You can of course filter out rows specifying other values than character strings Suppose you want to display that line of the security table where the access rights are all set to on In that case type the following 01003 Edit Configuration gt get s security f accessRights ReadAccess on WriteAccess on SecurityAccess on FileSystemAccess on security a password sys_admin accessRights ReadAccess on WriteAccess on SecurityAccess on FileSystemAccess on OK o1003 Edit Configuration gt User manual 93 Basic TMA CLI commands TMA CLI f The get t command Use this option to retrieve nested tables This means that in case you perform a get t of a table in which structures and other tables i e nested tables appear you retrieve all the values present in these structures and tables The ordinary get command does not do this by default as some tables can be very complex and might take a very long time to retrieve The following shows you the difference between get and get t ona table containing nested tables pathman paths Edit Configuration gt get pathTable pathTable a name demo description demo sections OK pathman paths Edit Config
21. Os valid 22h gt 20h 0d 2h Om Os valid 20h gt 18h 0d 2h Om Os valid 18h gt 16h 0d 2h Om Os valid 16h gt 14h 0d 2h Om Os valid 14h gt 12h 0d 2h Om Os valid 12h gt 10h 0d 2h Om Os valid 10h gt 8h 0d 2h Om Os valid 8h gt 6h 0d 2h Om Os valid 6h gt 4h 0d 2h Om Os valid 4h gt 2h 0d 2h Om Os valid 2h gt Oh 0d 2h Om Os OK crocusSDSLTT modem Performance gt logging off Now you can import the log file into a spreadsheet application or database In MS Excel for instance you can easily delimit the columns by specifying the value separator In our example the value separator is a character Do not uses spaces in the file name of the log file For example do not use sdsl log file txt use sdsl log file txt instead If you do not specify a directory path in the logging on command i e logging on logfile txt the log file is placed in the directory where you invoked the TMA CLI application User manual 97 Basic TMA CLI commands TMA CLI 6 5 Setting attribute values This section explains how you can use the set command to set a simple value a structured or complex value a simple value within a structured value etc The following table gives an overview of this section SCR Setting a simple attribute value a Setting a structured attribute value Performing actions on a table with a fixed length Performin
22. Suppose that on all these Crocus SDSL TTs you want to set the following attributes e crocusSDSLTT sysContact Admin Tel 785612 e crocusSDSLTT sysLoaction Equipment Room e crocusSDSLTT bootFromFlash Flash 2 e crocusSDSLTT security password sys admin e crocusSDSLTT modem tests detectRDL disabled e crocusSDSLTT modem channel central e crocusSDSLTT modeml line speed 512000 bps First open a TMA or TMA CLI session on one of the Crocus SDSL TTs Set the attributes listed above to the wanted values then activate this configuration Now log the non default configuration of the Crocus SDSL TT crocusSDSLTT Edit Configuration gt logging on script cli OK crocusSDSLTT Edit Configuration gt get f OK crocusSDSLTT Edit Configuration gt logging off OK crocusSDSLTT Edit Configuration Using the get f option results in a log file that only contains those values that differ from the default values This results in a smaller easier to edit file It also saves bandwidth since you only upload a limited number of attributes towards the different devices Continued on next page 124 User manual TMA CLI Basic TMA CLI commands Creating a script file starting from a configured device continued Now open the script cli file in a text editor and check it Because you used the get f command this file contains e The non default config
23. TMA CLI session For more information on the different address arguments refer to Section 4 2 The TMA CLI connection possibilities The TMA CLI prompt If the TMA CLI session was successfully started on the device then the TMA CLI prompt appears displaying the top object of the device crocusSDSLTT Edit Configuration gt For more information on the TMA CLI prompt refer to Section 4 8 The TMA CLI command line prompt The TMA CLI commands At the prompt you can enter commands to communicate with the device Refer to Chapter 8 The TMA CLI commands for an overview and in depth description of all available commands The Cms2Serv ini file The Cms2Serv ini file located in the TMA config directory contains the communications parameters These parameters may have to be changed should you encounter difficulties connecting to a device Refer to Chapter 9 The Cms2Serv ini file for a description of the communication parameters How to stop TMA CLI in interactive mode You can stop your current TMA CLI session at any moment by typing the Disconnect or Exit command After such a command TMA CLI closes the communication with the device and exits the command line interface 54 User manual TMA CLI Opening a TMA CLI session 4 5 2 Starting TMA CLI in non interactive mode What is non interactive mode The main purpose of the non interactive mode is to execute TMA CLI commands and scripts from another applic
24. The memload command The select command The selgrp command The set command The setenv command The source command 154 Reference manual TMA CLI The TMA CLI commands 8 1 TMA CLI command overview The following table gives an overview of all available TMA CLI commands trigger an action download a binary configuration file cms to the device execute a script file get get the value of e asimple attribute a complex attribute an element i e a simple attribute within a complex attribute all the attributes in an object e all the attributes in the Edit Configuration group to select another attribute group set set the value of e asimple attribute e acomplex attribute setenv a P e list all environment variables e define an environment variable source execute a script file and export the environment variables after executing the script commands A e TMA CLI commands are not case sensitive whereas their parameters are e Do not confuse CLI with TMA CLI Whereas CLI is a management tool which runs on the Telindus access devices themselves TMA CLI is a program which you have to install on a computer TMA CLI is a more elaborate command line interface with more features and commands then CLI Whereas most of the TMA CLI commands are the same as the CLI commands some commands that exist in TMA CLI do not exist in CLI These commands are exit logging exec cfgload memload and source Refer to t
25. aster5 line pstn Edit Configuration gt Note that although in the GUI of TMA the unit is displayed after the attribute name you do not have to type this unit in TMA CLI In other words e type set answerToneTime e donot type set answerToneTime ms NOr set answerToneTime ms Continued on next page 114 User manual TMA CLI Basic TMA CLI commands Setting attribute values that have a certain unit continued Setting a time value Because the units of a time value are part of the value field they have to be specified However you do not always have to specify the complete value Suppose you want to set the consoleNoTrafficTimeOut attribute to e 12345 days 12 hours 34 minutes and 56 seconds then type gt set consoleNoTrafficTimeOut 12345d 12h 34m 56s e 5 days 2 hours 4 minutes and 6 seconds then type gt set consoleNoTrafficTimeOut 00005d 02h 04m 06s Or gt set consoleNoTrafficTimeOut 5d 2h 4m 6s e 2 hours 4 minutes and 6 seconds then type gt set consoleNoTrafficTimeOut 00000d 02h 04m 06s or gt set consoleNoTrafficTimeOut 02h 04m 06s Or gt set consoleNoTrafficTimeOut 2h 4m 6s e 55 seconds then type gt set consoleNoTrafficTimeOut 00000d 00h 00m 55s or gt set consoleNoTrafficTimeOut 55s e 12 hours then type gt set consoleNoTrafficTimeOut 00000d 12h 00m 00s or gt set consoleNoTrafficTimeOut 12h 00m 00s or gt set consoleNoTrafficTi
26. command it is only possible to download firmware to an IP device If you want to download new firmware to a non IP device you have to use the software distribution feature of one of the management concentrators The following example gives you an idea how this works Example Suppose you have a Crocus SDSL TT somewhere in your network It is connected to an Orchid 1003 LAN The Orchid has IP address 10 0 11 1 The Crocus SDSL TT its name in the objectTable of the Orchid is SDSL TT central The new firmware file for the Crocus SDSL TT is T2122013 00 and is located in the following directory on your machine C windows temp In order to download the new firmware to the Crocus SDSL TT proceed as follows Open a TMA CLI session on the Orchid 1003 LAN TmaCli 10 0 11 1 Download the Crocus SDSL TT firmware file located on your machine to the file system of the Orchid 1003 LAN 01003 Edit Configuration gt memload C windows temp T2122013 00 T2122013 00 OK 01003 Edit Configuration gt Now configure the downloadTable of the Orchid 1003 LAN as follows 01003 deviceSoftware Edit Configuration gt get downloadTable a name SDSL TT central sourceFile T2122013 00 destinationFile CONTROL immediateActivation disabled OK 01003 deviceSoftware Edit Configuration gt Activate this new configuration using the Activate Configuration action Now you can start downloading the n
27. is being managed by a management concentrator but is not yet configured in the object table of the management concentrator Using this command you can nevertheless open a TMA CLI session on the non configured device over the high speed bus of the card nest This command only works e if the management concentrator supports the connect to non configured device feature e if the device you want to connect to is a CMS2 device However although the Aster 4 Flash is a CMS2 device it does not support the connect to non configured device feature For more information on the object table refer to Section 3 4 Proxied IP connection to a non IP device and the manual of the management concentrator Address arguments In case the connection between your computer running TMA CLI and the management concentrator you want to connect through is e adirect connection then specify the COM port of your computer com lt x gt e an IP connection then specify the IP address of the management concentrator lt IP gt Replace RACK lt r gt lt p gt lt m gt by the hardware address of the non configured device The hardware address consists of three fields The following table explains what they mean rack address The rack address can be set by means of DIP switches located at the back of the card nest The address range goes from 0 to 6 Check the rack address of the card nest containing the Card Version modem you want to address Enter it in
28. on other devices of the same type For more information on this matter refer to Section 6 5 9 Setting values obtained with the get command User manual 75 Basic TMA CLI commands TMA CLI 6 3 2 Reading a structured attribute value There are three different structured or complex value types Type Description Example bit string A bit string is actually a special case of a simple value It The following configuration does have elements in this case the separate bits but you attribute is a bit string can not display these bits separately l e you can only display the complete bit string In other words a bit string is actually a simple value which in some cases is represented as a structured value crocusSDSLTT alarmMask structure A structure has several elements The elements of a The following configuration structure are always simple values You can display these attribute is a structure SIEMENS Separately crocusSDSLTT alarmLevel A table has several elements The elements of a table can The following configuration be simple values complex values or a combination of both attribute is a table You can display these elements separately crocusSDSLTT security Because a table is a quite complicated attribute value it is explained in Section 6 3 3 Reading a table Reading a bit string crocusSDSLTT Edit Configuration gt get alarmMask alarmMask NotResponding enabled AlarmSyncLoss
29. one card e Crocus SDSL CV Quad incorporates 4 SDSL modems on one card If you connect to such a multi device you can specify on which device A B C D etc you want open the TMA CLI session When making a direct connection to a Telindus device that is being managed by a management concentrator you might experience connection problems In this case it is best to make a connection through the management concentrator i e the management concentrator as proxy Address arguments Replace com lt x gt by one of the four possibilities listed below e COM1 e COM2 e COM3 e COM4 If you do not specify a COM port COM1 is taken as default Replace MoDEM lt n gt by one of the four possibilities listed below e MODEMA Or MODEMO e MODEMB OF MODEM1 e MODEMC OF MODEM2 e MODEMD Or MODEM3 Examples If you want to connect to modem A of a Crocus FO10M CV Twin connected to COM port 1 then type e TmaCli coml modemA or e TmaCli coml modem0 or e TmaCli modemA or e TmaCli modem0 If you want to connect to modem B of a Crocus HDSL CV Twin connected to COM port 4 then type e TmaCli com4 modemB or e TmaCli com4 modeml User manual 33 Opening a TMA CLI session TMA CLI 4 2 3 Connecting over IP TmaCli lt IP gt Use this command if you want to make a connection over an IP network as described in Section 3 3 IP connection to an IP device and Section 3 4 Proxied IP connection to a non IP device
30. one of the errors as listed in Annex A error codes Communication error codes 182 Reference manual TMA CLI Annexes Annexes 183 TMA CLI 184 Annexes TMA CLI Annex A error codes Annex A error codes This annex list all the error codes They are divided into four groups e the CLI error codes e the TMA CLI error codes e the TFTP error codes e the communication error codes Annexes 185 Annex A error codes TMA CLI CLI error codes eee a 9 Invalid value lt List of communication error codes gt Row specific get not allowed Option not valid in this combination 186 Annexes TMA CLI Annex A error codes TMA CLI error codes Annexes 187 Annex A error codes TMA CLI TFTP error codes Local file read error 208 Invalid tftp request Invalid tftp packet Invalid address type Unable to obtain download status Could not start TmaTftp exe Windows only Could not start tftp Unix only lt error message from tftp server gt Unix only 188 Annexes TMA CLI Annex A error codes Communication error codes Rejected data Annexes 189 Annex B abbreviations TMA CLI Annex B abbreviations The following table gives a list of abbreviations and their description 190 Annexes TMA CLI Annex C product information Annex C product information The following table displays the product information of TMA CLI Sales code Prod
31. specification followed by the name the attribute e g crocusSDSLTT sysName Of modem line speed row specification This is an attribute specification followed by a set of square brackets that enclose an option Depending on the command it is used with an option can have different meanings Read row number x of a table Append a row at the end of the table Change a value on row number x of a table Delete row number x from a table Delete all rows from a table element specification There are two possible element specifications oo e An attribute specification followed by a slash and an element name e g alarmMask Boot alarmLevel Access security password A row specification followed by a slash and an element name e g security 1 password security 1 accessRights ReadAccess Continued on next page 164 Reference manual TMA CLI The TMA CLI commands Specification continued group specification The group is specified at the end of the attribute element row specification separated by a double point A If no group specification is present the currently selected group is used Examples Refer to Section 6 3 Reading attribute values Reference manual 165 The TMA CLI commands TMA CLI 8 9 The logging command Syntax LOGGING ON lt log file name gt LOGGING OFF LOGGING Description The logging command controls the logging of TMA CLI input and output to a file LOGG
32. the different paths These are based on three criteria Path type The path type priorities are as follows CO fem highest Absolute path indexed i Example modem line 1 alarmLevel LinkDown medium Absolute path non indexed i Example modem line alarmLevel LinkDown lowest Relative path only non indexed allowed Example line alarmLevel LinkDown Presence of In case two or more absolute paths containing one or more indexed objects exist indexed objects then the path that contains the indexed object with the highest location in the containment tree has the highest priority Example quadE1 1 g703 1 alarmLevel 1linkDown has a higher priority than quadE1 g703 1 alarmLevel linkDown Located in Definitions located in specific device sections have a higher priority than definitions which section located in the common section 148 User manual i TMA CLI User defining values using the custom txt file 7 5 2 The attribute and element name Besides the path you also have to specify the attribute or element of an attribute in the definition Attribute and element syntax Attributes are separated from the path by a character Elements of an attribute are separated from the attribute and each other by a character Examples Suppose you have an Orchid 1003 LAN and you want to user define values for the attributes sysContact alarmFilter and the element portNumber sysContact management alar
33. the previously stored configuration using the cfgload command Suppose you have several Crocus SDSL TTs that have to be configured and you want to do this using a CMS2 configuration file In that case proceed as follows Action First open a TMA session on one of the Crocus SDSL TTs Configure this Crocus SDSL TT to your needs then activate this configuration Save in o bin I amp l hdsl config fle er cms 5 gelelels EET EE Download File name sdsl_config_file cms Connect Edit View MEOS Help Options Save as type Cms file cms Cancel i modem line gt Append E nms v35 Full ean i E 1464 Gelected attr powerOffDetection All attributes of crocusSDSLTT Hecurse oadule Now open a TMA CLI session on another Crocus SDSL TT Load the previously stored configuration using the cfgload command crocusSDSLTT Edit Configuration gt cfgload C data sdsl_config file cms OK crocusSDSLTT Edit Configuration gt Activate the new configuration using the Activate Configuration action crocusSDSLTT Edit Configuration gt action Activate Configuration OK crocusSDSLTT Edit Configuration gt Do not uses spaces in the file name of the configuration file For example do not use sdsl config file txt USe sdsl_ config file txt instead User manual 135 Basic TMA CLI commands TMA CLI 6 10 Downloading files Using the me
34. 0ccccccecceseceeceeeceeeeeceeeeueeueecueeueeeusuenueeueeuseuueneeeeseneeueeeuens 175 9 1 Parts of the Cms2ServVink file oo cece ceeceseccnecceecucceeecucecueecuceeececeeeseeeseeeneeeneesneeeaeenaes 176 9 2 Adding parts to the Cms2Serv ini file 2 20 0 ccceccceeecccceeeeeeeneeeeeeececeeeeeeeeeeeeeeeneneeeeeeneseenes 178 POT FOUTS SIN OOEING e aar ce ep aare ar aaa benene eden sense aaa aae EDES 179 10 1 FErfrormessadges nren internar na ta aed scamiurat Anat ator Fa ere AAEE AET tree ears aberne 180 VOS SSYA AK EF OF EET EAE TTE T 181 10 3 Failing answer from a device M01 sssssssrssrrrresere teske sees sete E REE RE ERNE NNE RE Ae aed tian 182 PaaS E T E 183 Annex Aerror codes AE E 185 GCEkerror Codes SE AN EN Een se a Ser ENE AAA Ar aA SKR EN sa MMe ta 186 TMA SCE error des 2 AAE are AEAT 187 TRTP Grror COdCS sii sr A E calcein ad ra ane cdi eed Mi ek een Pas ed ead ae 188 COMMUNICATION eror CodeS e aa a a aa a AA a a a aaan ar aa 189 Annex B abbreviations iicsccccccvececivc eck iat esade eee sins es eee eae 190 Annex C product information ccccccceeeeeeeeeeeeeeeeeeeeeeeeeeeeeeseeeeeeeeeeeeeeaeeeeeeeeeeeees 191 Annex D licence key reqQuest cceeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeneaeeseeeeeeeeeeeeeeaeeeeeeeeeeees 192 Which information has to be supplied 0 0 ceeeeccececeeceeeeeeeeceeeeseseaeeeeeeceesessesaeaeaeseeeeeeeeeea 192 Licence KEY request TAX rsrs ad och aed eee eae ee eee 192 TMA CLI User manu
35. 1 Displaying the same attribute in TMA CLI results in the following security a password sys admin accessRights ReadAccess on WriteAccess on SecurityAccess on password sys tech accessRights ReadAccess on WriteAccess on SecurityAccess off password user accessRights ReadAccess on WriteAccess off SecurityAccess off Now you can see the difference between a table with a fixed length and with a variable length A table with is indexed with a fixed length an integer number e g 1 a variable length the following character a Continued on next page User manual 69 Introducing the containment tree TMA CLI A containment tree example continued However also in a table with a variable length you can display only one row For example row 2 in the security table security 2 password sys_tech accessRights ReadAccess on WriteAccess on SecurityAccess off Every row of the security table contains two elements e a simple value password e abit string accessRights In this bit string the three bits grant ReadAccess WriteAccess SecurityAccess you are ready to try the commands of CLI 70 User manual TMA CLI Basic TMA CLI commands 6 Basic TMA CLI commands This chapter teaches you the basic TMA CLI commands These commands enable you to browse through the containme
36. 126 User manual TMA CLI Basic TMA CLI commands 6 5 10 Setting an attribute value to its default value Resetting a simple value a structured value or a table The following command resets the attribute sysName to its default value mm n crocusSDSL Edit Configuration gt set sysName OK crocusSDSL gt mmen Edit Configuration The following command resets the attribute alarmLevel to its default value mmen crocusSDSL Edit Configuration gt set alarmLevel OK crocusSDSLTT Edit Configuration gt The following command resets the telephoneTable of the Aster 4 to its default value aster4 dialler Edit Configuration gt set telephoneTable OK aster4 dialler Edit Configuration gt The following command resets the security table to its default value mmen crocusSDSL Edit Configuration gt set security OK crocusSDSL 1 Edit Configuration Resetting only one row of a table It is possible to reset only one row of a table Suppose you want to reset row 2 of the security table to its default value then enter the following command crocusSDSLTT Edit Configuration gt set security 2 OK crocusSDSLTT gt Edit Configuration Alternatively you can use the following syntax crocusSDSLTT Edit Configuration gt set security 2 OK crocusSDSLTT Edit Configuration
37. 2 How to add a user instantiatable object the combination set delobj does not Removing a user instantiatable object which has an index The following command removes the user instantiatable object routingFilter filter1 under the object router telindus1031 router Edit Configuration gt set delobj routingFilter filter1 OK telindus1031 router Edit Configuration gt 132 User manual TMA CLI Basic TMA CLI commands 6 7 Performing actions You can initiate actions on Telindus devices using the actions command An object in combination with a group may have actions assigned to them The available actions depend on the kind of device Some examples of actions are performing a cold boot activation of a configuration performing a test etc Starting an action that has no argument Use the following command to perform a cold boot on a device crocusSDSLTT Edit Configuration gt action Cold Boot OK crocusSDSLTT 5 Edit Configuration Use the following command to activate a configuration you previously entered or loaded crocusSDSLTT Edit Configuration gt action Activate Configuration OK crocusSDSLTT Edit Configuration Actions such as activation of a test need arguments The following example shows you how to start an AL test on a modem crocusSDSLTT modem Performance gt action Test Activation testActivationType AL test
38. Address argument Replace lt 1p gt by the IP address of the Telindus device you want to connect to Example If you want to connect to a device that has IP address 10 0 11 1 then type TmaCli 10 0 11 1 34 User manual TMA CLI Opening a TMA CLI session 4 2 4 Connecting to an application TmaCli COM lt x gt IP X lt hex string gt Use this command if you want to connect to an application This feature allows you to open a TMA CLI session on for example the Alarm Manager of TMA for HP OpenView on a machine that is not running HP OpenView Address arguments In case the connection between your computer running TMA CLI and the machine running the application you want to connect to is e adirect connection then specify the COM port of your computer com lt x gt e an IP connection then specify the IP address of the machine lt 1P gt Replace x lt hex string gt by the address of the application you want to connect to In case of the Alarm Manager for example the address is 6fbf Example If you want to connect to the Alarm Manager of TMA for HP OpenView which is running on a machine with IP address 10 0 11 1 then type TmaCli 10 0 11 1 X 6fbf User manual 35 Opening a TMA CLI session TMA CLI 4 2 5 Connecting to a non configured device TmaCli COM lt x gt IP RACK lt r gt lt p gt lt m gt Use this command if you want to connect to a device Card Version that is inserted in a card nest CN4 which
39. CD in the CD ROM drive Windows automatically starts the set up procedure for TMA for HP OpenView Press the Cancel button Run the following set up program instead D NT TmaCli Setup exe Possibly you have to replace D by another letter you use for your CD ROM drive e The InstallShield Wizard guides you through the set up process At a certain point you get the Component sslection Component selection screen Please select which component you would like to install or upgrade If you have selected Model Files a second At this point you can install installation program will be started e the TMA executable and the The latest model files can always be found by visiting our web site at www telindus com model files and or e the licence key TT Executables and Model Files I Licence key lt Back Cancel a The InstallShield Wizard guides you through the rest of the set up process 10 User manual TMA CLI Installing TMA CLI 2 4 Installing TMA CLI on Sun Solaris and HP UX This section explains how to install TMA CLI on the Sun Solaris or HP UX platform The installation files of TMA CLI are located on the CD ROM of TMA for HP OpenView In order to install TMA CLI on a Sun Solaris or HP UX system proceed as follows SOL TmaCli in case of Sun Solaris HPUX TmaCli in case of HP UX At a certain point you get the following screen Window Edit Options At this point you can install the
40. Configuration gt You can now enter the added object telindus1031 router Edit Configuration gt select routingFilter filter1 OK telindus1031 router routingFilter filter1 Edit Configuration gt The corresponding action in TMA looks as follows gt oute gt sendPortUnreact Ada madda x t Retrieve F5 gt send amp dminUnrea FFETE __ gt ripUpdatelnterval 5 Addmodule routingFilter i Reload gt sysSecret std Inparent router GIL bridg Delete hb nnncerrett able With name firer E snmp E H E management priorityPolicy The syntax description for the index can J fileSystem trafficPolicy be found on the statusbar OK Cancel The corresponding result in TMA looks as follows G router tunnels defaultN at Ea routingFilter filter1 C bridge N User manual 131 Basic TMA CLI commands TMA CLI 6 6 3 How to remove a user instantiatable object Remove a previously added user instantiatable object from the containment tree using the set delobj command Removing a user instantiatable object which has no index The following command removes the user instantiatable object proxy under the top object telindus1031 telindus1031 Edit Configuration gt set delobj proxy OK telindus1031 Edit Configuration Whereas the combination set select expects curled brackets behind the user instantiatable object name refer to Section 6 6
41. ING ON lt log file name gt Use this syntax to start logging TMA CLI input and output to a file The file name may include a path name White spaces within the file name are not allowed LOGGING OFF Use this syntax to stop the file logging LOGGING Use this syntax to check the status of the logging command If logging is and you type logging then the following is displayed LOGGING is on log file name LOGGING is off Example Start logging I O to the file C data cli logfile 1 txt crocusSDSLTT Edit Configuration gt logging on C data cli logfilel txt OK crocusSDSLTT Edit Configuration gt You can always ask the status of the logging command For the example above the result would be crocusSDSLTT Edit Configuration gt logging LOGGING is on logfilel txt OK crocusSDSLTT Edit Configuration gt 166 Reference manual TMA CLI The TMA CLI commands 8 10 The memload command Syntax MEMLOAD lt local file name gt lt remote file name gt Description This command download files to an IP device Using this command you can download e new firmware to the flash banks of an IP device e various files to the file system of an IP device For more information on this matter refer to Section 6 10 Downloading files Example Download firmware file T1042017 00 located on a floppy disk to flash bank 1 of the Orchid 1003 LAN o1003 Edit C
42. LI TMA CLI 1 3 What is a licence key To enable the TMA CLI software you need to enter a licence key This is a unique code For more information refer to Section 2 5 How to obtain and install the licence key 6 User manual TMA CLI Installing TMA CLI 2 Installing TMA CLI This chapter explains how to install TMA CLI on the Windows 95 98 NT and Sun Solaris platform First it gives you the system requirements Read these requirements carefully to make sure your computer will be able to run TMA CLI The following table gives an overview of this chapter ee System requirements The three installation components of TMA CLI EE Installing TMA CLI on Windows 95 98 NT 2000 11 EE DT User manual 7 Installing TMA CLI TMA CLI 2 1 System requirements TMA CLI is designed to run under Windows 95 98 NT 2000 Sun Solaris and HP UX The following table gives the system requirements for running TMA CLI Windows 95 98 HP UX I NT 2000 System specification Pentium 150 or more Sun Ultra 10 or more HP 9000 715 or more Operating system version Windows 95 98 Solaris 2 6 7 HP UX 10 20 11 0 I NT 4 0 2000 Available disk space 1Mbfor TMA CLI e 12Mbfor TMACLI e 12 Mb for TMA CLI 11 Mb for the e 9 Mb for the model e 9 Mb for the model model files files files Recommended RAM 16 MB for Windows 64 Mb or more 64 Mb or more 95 98 32 MB for Windows NT 4 0 64 MB for Wi
43. M or Router Interface crocusRouter lanInterface ipAddress e Crocus Inverse Multiplexer crocusInvMux laninterface ipAddress default gateway This is the gateway of the IP segment the IP device is connected to l e the IP address of the router which handles packets destined for another network Examples The following examples display the default gateway attribute location in the containment tree of some Telindus IP devices e Orchid 1003 LAN 01003 router defaultRoute gateway e Crocus Router 2M or Router Interface crocusRouter router defaultRoute gateway e Crocus Inverse Multiplexer crocusInvMux lanInterface defaultRoute G Once these attributes are set then the computer running TMA CLI is able to reach the IP device over an IP network User manual 23 Connecting to a device TMA CLI 3 4 Proxied IP connection to a non IP device As stated in Section 3 3 IP connection to an IP device it is not possible to make a true IP connection to a non IP device This because non IP devices do not have a dedicated LAN port through which you can connect them to a LAN However using a management concentrator you can make a proxied IP connection to a non IP device This is explained in this section The following table gives an overview of this section Psetn OO O S What is a management concentrator A proxied IP connection to a non IP device example 24 User manual TMA CLI Connecting to a device 3 4 1 What is a
44. MA to export a configuration to a CMS2 formatted file When exporting you can choose between two options e If the configuration file has been exported with the Full configuration selection all the attributes of the device that loads the configuration file are changed e If the configuration file has been exported with the Selected attributes or All attributes of selection only the attributes that were saved will be changed All other attributes remain unchanged See the TMA manual for in depth information about exporting a configuration Before importing configuration files for devices which only support TMA when connected via a management concentrator such as the Crocus HS first perform the Load Default Configuration action Example Importing the configuration file config cms located on a floppy disk into a Crocus SDSL crocusSDSLTT Edit Configuration gt cfgload a config cms OK crocusSDSLTT Edit Configuration gt Reference manual 159 The TMA CLI commands TMA CLI 8 6 The disconnect command Syntax DISCONNECT Description This command closes the current TMA CLI session on a device 160 Reference manual TMA CLI The TMA CLI commands 8 7 The exec command Syntax EXEC lt script file name gt Description This command executes TMA CLI scripts The file name may include a path name White spaces within the file name are not allowed e havea script that amo
45. SDSLTT Edit Configuration gt User manual 107 Basic TMA CLI commands TMA CLI c The set option Changing one value in a row In the security table of our example the passwords on the first and third row are still empty Now use the set command to enter a password in the first row crocusSDSLTT Edit Configuration gt set security 1 password passwl1 OK crocusSDSLTT Edit Configuration gt Alternatively you can use the following syntax crocusSDSLTT Edit Configuration gt set security 1 password passwl1 OK crocusSDSLTT Edit Configuration gt Both notations displayed above result in the following crocusSDSLTT Edit Configuration gt get w security security a password passwl accessRights ReadAccess on WriteAccess on SecurityAccess on pS Sh a password passw2 accessRights ReadAccess on WriteAccess on SecurityAccess on 3 a password accessRights ReadAccess on WriteAccess on SecurityAccess on 4 a password passw4 accessRights ReadAccess on WriteAccess on SecurityAccess on a OK crocusSDSLTT Edit Configuration gt Continued on next page 108 User manual TMA CLI Basic TMA CLI commands The set x option continued Changing several values in a row Suppose you want to change the currently empty password on t
46. TEL NDUS TMA CLI TMA CLI USER and REFERENCE MANUAL Version 1 5 182085 Telindus Technical Publications Geldenaaksebaan 335 B 3001 Leuven Belgium tel 32 16 382011 Copyright TMA CLI Copyright notice The information and descriptions contained in this publication are the property of Telindus Such information and descriptions must not be copied or reproduced by any means or disseminated or distributed without the express prior written permission of Telindus This publication could include technical inaccuracies or typographical errors for which Telindus never can or shall be held liable Changes are made periodically to the information herein these changes will be incorporated in new editions of this publication Telindus may make improvements and or changes in the product s described in this publication at any time without prior notice Version 1 5 24 December 2002 MRP 182085 TELINDUS TMA CLI Preface Preface Organisation of this manual This manual contains three main parts User manual introduces TMA CLI and explains how to install it It also shows you the basic functions of TMA CLI Reference manual details important topics about TMA CLI It contains a complete description for lookup purposes gives additional information The following table gives an overview of the chapters in the user manual Chapter This chapter gives an introduction to TMA CLI 2 explains how to install TMA CLI
47. TMA executable and the model files Select the component s you would like to install Typing a number will change the corresponding component If you have made all necessary changes press c to continue the licence key 1 Executable files and Model files y 2 Licence key n c Continue q Quit The script guides you through the rest of the set up process User manual 11 Installing TMA CLI TMA CLI 2 5 How to obtain and install the licence key To enable the TMA CLI software you need to enter a licence key The required licence key can be obtained by sending a fax or an email to Telindus Refer to Annex D licence key request To install the licence key proceed as follows Rerun the installation as described in e Section 2 3 Installing TMA CLI on Windows 95 98 NT 2000 or e Section 2 4 Installing TMA CLI on Sun Solaris and HP UX Enter the customer ID which you received after you submitted your licence key request Enter the licence key which you received after you submitted your licence key request 2 When you are prompted to select which component you want to install only select the licence key component For Windows the following Licence key For Sun Solaris and HP UX the following window appears Licence key window appears Installation procedure TMA CLI To obtain a licence key for this product you can either send a fax to 32 16 382515 or send an email to productinfo telind
48. The following are some examples of how to browse through the containment tree From the current object to a sub object relative addressing mm wy crocusSDSL gt select modem OK crocusSDSLTT modem Edit Configuration Edit Configuration From the current object two sub objects further relative addressing ttsts S mm qT crocusSDSLTT Edit Configuration gt select modem line OK crocusSDSLTT modem line Edit Configuration d From a sub object immediately to another sub object absolute addressing n crocusSDSLTT modem line Edit Configuration gt select crocusSDSLTT nMS OK crocusSDSLTT nMS Edit Configuration From the current objectgouponeobjectlevel m crocusSDSLTT modem Edit Configuration gt select OK crocusSDSLT1 Edit Configuration From the current object immediately tothe top object m crocusSDSLTT modem line Edit Configuration gt select OK crocusSDSLT1 gt Edit Configuration 72 User manual TMA CLI Basic TMA CLI commands 6 2 Selecting another group of attributes Using the se grp command you can select another group of attributes The four possible groups are e Edit Configuration e Status e Performance e Alarms crocusSDSLTT Edit Configuration gt selgrp Status OK crocusSDSLTT St
49. The rack address can be set by means of DIP switches located at the back of the card nest The address range goes from 0 to 6 Check the rack address of the card nest containing the Card Version modem you want to address Enter it in the first field For example 2 card position Also the position of the card in the card nest has to be known for addressing purposes The card slot range goes from 0 up to 14 Check the position of the card in the card nest Enter it in the second field For example 12 m modem If you want to address a certain device on a multi device you have to specify which device you want to address device A B C or D Verify which device you want to address Enter it in the third field For example B Continued on next page User manual 39 Opening a TMA CLI session TMA CLI Connecting using relative addressing and a hardware address continued Example Suppose you have the following set up Orchid 1003 LAN ipAddress 10 0 11 1 objectTable name Card Version modem addressType relative addressValue 0 exitPort exitPortType rack cardnestAddress 3 cardPosition 5 modem B PC running TMA high speed bus Card Nest connection rack address 3 HEH cooo cooo HEE ccoo occo til eee cece HEH coco cooo HEE ccoo occo HEH cece cece HEH cece cece HEHE cece coco HEE cece cece Card Version modem position 5 modem B relative address 0 In order to open a TMA
50. a O oa dl common Suppose that you want to give an understandable name to an otherwise very cryptic integer value such as the value of the attribute alarmFilter Suppose you want to do this for all devices that have the attribute alarmFilter in their management object In that case include the definition in the common section and format it as in the example crocusHDSLTT Suppose that for the Crocus HDSL TTs you want give an understandable name to the values of the elements LinkDown and SeverelyErroredSecond of the alarmLevel attribute of the line objects However suppose you want the LinkDown definition to apply to all line objects but the SeverelyErroredSecond definition to apply to line 1 only In that case format the definition as in the example User manual 151 TMA CLI Reference manual 152 Reference manual TMA CLI Reference manual 153 The TMA CLI commands TMA CLI 8 The TMA CLI commands This chapter gives a complete overview of all TMA CLI commands For each command it gives the exact syntax a description and some examples But first this chapter explains some keywords that are used to describe the syntax of the commands The following table gives an overview of this chapter TMA CLI command overview Keywords of the TMA CLI command syntax Possible values The action command The cfgload command 86 The disconnect command The exec command The get command a The logging command
51. a lt tab gt Use this option to display the values of a complex attribute value h The get w option on one line page 96 The number of elements that will be printed on one line depends on the environment variable cos refer to Section 4 9 The environment variables User manual 85 Basic TMA CLI commands TMA CLI 6 3 6 Combinations with the get command options Most but not all get command options can be combined In this way you can format the output to your needs The following is a non exhaustive list of combinations Option Description combination get d m Displays only those values that are different from the default or read only values and displays as much simple attribute values on one line as possible get d s Displays only those values that are different from the default or read only values and applies a filter on a table g d v et Displays only those values that are different from the default or read only values and displays the values of a table in rows and columns and separated by the value separator Displays only those values that are different from the default or read only values and displays the values of a complex attribute value on one line get r d Displays the values of the current and all underlying objects and displays only those values that are different from the default or read only values get r m Displays the values of the current and all underlying objects and displays as
52. able e Add two new rows with respectively passwords passw1 and passw2 to the table e Insert a row with password passw3 between the two rows that have been created in the previous step e Reset the third row to its default value Suppose that before you execute the combined table actions the security table looks as follows crocusSDSLTT Edit Configuration gt get w security security la password xxx accessRights ReadAccess on WriteAccess on SecurityAccess on 5 OK crocusSDSLTT Edit Configuration gt Now execute the combined table actions as discussed above crocusSDSLTT Edit Configuration gt set security d a password passwl a password passw2 i2 password passw3 3 OK crocusSDSLTT Edit Configuration gt The resulting security table is now crocusSDSLTT Edit Configuration gt get w security security a password passwl accessRights ReadAccess on WriteAccess on SecurityAccess on 5 a password passw3 accessRights ReadAccess on WriteAccess on SecurityAccess on g la password accessRights ReadAccess on WriteAccess on SecurityAccess on 5 OK crocusSDSLTT Edit Configuration gt User manual 113 Basic TMA CLI commands TMA CLI 6 5 6 Setting attribute values that have a certain unit Some attribute values have a cert
53. ail should contain the following information e your company name and location e the serial number which you can find on the CD ROM label e g S N 9943964 e the CD ROM code which you can find on the CD ROM label e g V S0007 00900 Licence key request fax The following page displays a prepared licence key request fax You can use this fax to obtain a licence key Proceed as follows Make a printout of the fax document displayed on the following page Fill in the required information on the dotted lines Send the fax to 32 16 382515 192 Annexes Fax To TELINDUS FROME eTe cts yada gated O EAA Fax 32 16 382515 Pages 1 Subject TMA CLI licence key request Date Sa Been eit Please send me a licence key for TMA CLI Company information Namen medea dul ote iue e e can dadokenls wars a a Ca ea a e aE aE a aaar a Addresse eeoa aa Bec AEE ne Mas des st SR EE E Telephone number cers ss sca ec ccssek asa ceases ani ccdanaink vee 40 rrr rtrt rrt uaa ae REELLE EEEn ERE E nnn Pak NUMBER seo eaae gar p stenart errors enker und te toe dey ti oie ER for op Emlail address 22107330 eres Mie es ra a Mt bes es dM neh Meee Other information The serial number on the CD ROM label is 0 cece ccc ee cccccecceeeeeeeeeeeeeeueeeeauaaaaes The CD ROM code on the CD ROM label is cccceeeeeeeeeeeeeeeeeeeeeeaaaeaaaaaauaes
54. ain unit e g bps Kbps ms etc Depending whether the value is an enumerated value or a real or integer value the unit has to be specified or not The following examples clarify this Setting an enumerated attribute value with unit Because the unit of an enumerated value is part of the value field it has to be specified Suppose you want to change the cTSDelay attribute of the V35 interface on a Crocus SDSL The corresponding action in TMA is shown at the right hand side crocusSDSLTT v35 Edit Configuration gt cTSDelay Ome gt set cTSDelay 4 ms OK crocusSDSLTT v35 Edit Configuration gt Note that in this case the value and the unit are separated by a space hence you have to use quotes n Suppose you want to change the rxSensitivity attribute on an Aster 5 The corresponding action in TMA is shown at the right hand side aster5 line pstn Edit Configuration gt Sensitivity 48dBm gt set rxSensitivity 38dBm a OK 48dBm asterS line pstn Edit Configuration gt Setting a real or integer attribute value with unit Because the unit of a real or integer value is not a part of the value field it does not have to be specified Suppose you want to change the answerToneTime attribute on an Aster 5 The corresponding action in TMA is shown at the right hand side aster5 line pstn Edit Configuration a answerToneTime ms 1000 N gt set answerToneTime 1000 OK
55. aining bits in that bit string are reset to their default value See the example below Suppose all the bits in the alarmMask attribute are enabled gt get w alarmMask alarmMask NotResponding enabled AlarmSyncLoss enabled StrapChanged enabled Access enabled RemoteAlarm enabled UnknownState enabled Boot enabled CodeConsistencyFail enabled ConfigConsistencyFail enabled OK crocusSDSLTT Edit Configuration gt If you now set the Boot bit within the alarmMask attribute to disabled then all the remaining bits are set to their default value crocusSDSLTT Edit Configuration gt set alarmMask Boot disabled OK crocusSDSLTT Edit Configuration gt get w alarmMask alarmMask NotResponding enabled AlarmSyncLoss enabled StrapChanged disabled Access disabled RemoteAlarm disabled UnknownState disabled Boot disabled CodeConsistencyFail disabled ConfigConsistencyFail disabled OK crocusSDSLTT Edit Configuration gt Continued on next page User manual 101 Basic TMA CLI commands TMA CLI Setting a structured attribute value continued Setting values in a structure The following examples show you how to set a value s in a structure Setting only one value in the alarmLevel attribute crocusSDSLTT Edit Configuration gt set alarmLevel RemoteAlarm 2 OK crocusSDSLTT Edit Configuration gt S
56. al User manual 1 TMA CLI User manual TMA CLI Introduction to TMA CLI 1 Introduction to TMA CLI This chapter gives an introduction to TMA CLI The following table gives an overview of this chapter What is TMA CLI 4 Which features has TMA CLI What is a licence key User manual 3 Introduction to TMA CLI TMA CLI 1 1 What is TMA CLI TMA CLI is an acronym for Telindus Maintenance Application Command Line Interface The main purpose of TMA CLI is to use its commands in scripts in order to automate management actions This is particularly useful in large networks TMA CLI is a complementary product to TMA and TMA for HP OpenView TMA CLI is available on e Windows 95 98 NT 4 0 2000 e Sun Solaris 2 6 7 e HP UX 10 20 11 0 4 User manual TMA CLI Introduction to TMA CLI 1 2 Which features has TMA CLI TMA CLI offers the following features Full control over any Telindus device in your network using a command line interface Connectivity over an IP network Has two operating modes interactive mode non interactive or script mode Allows the management of Telindus devices exactly like the graphical version of TMA Reading and changing the configuration of a device Retrieving status information of a device including the current alarm status Retrieving statistical information from the device Performing actions User manual Introduction to TMA C
57. ample this results in the following crocusSDSLTT Edit Configuration gt get w security security a password passwl accessRights ReadAccess on WriteAccess on SecurityAccess on Joa a password passw2 accessRights ReadAccess on WriteAccess on SecurityAccess on 5 a password passw4 accessRights ReadAccess on WriteAccess on SecurityAccess on 5 OK crocusSDSLTT Edit Configuration gt User manual 111 Basic TMA CLI commands TMA CLI e The set d option The following command deletes the entire security table crocusSDSLTT Edit Configuration gt set security d OK crocusSDSLTT Edit Configuration gt Alternatively you can use the following syntax crocusSDSLTT Edit Configuration gt set security d OK crocusSDSLTT Edit Configuration gt For the security table in our example this results in the following crocusSDSLTT Edit Configuration gt get security security OK crocusSDSLTT Edit Configuration gt 112 User manual TMA CLI Basic TMA CLI commands 6 5 5 Combining actions on a table with a variable length The table actions described in Section 6 5 4 Performing actions on a table with a variable length can be combined In the following example the combination of several table actions will e Delete the existing security t
58. ant This custom txt file is loaded and parsed when TMA CLI starts What is the location of the custom txt file You have to place the custom txt file in the TMA config directory typically C Program Files TMA config User manual 141 User defining values using the custom txt file TMA CLI 7 2 Creating the custom txt file In order to create the custom txt file proceed as follows Ce 1 rn BENE Go to the directory TMA config typically C Program Files TMA config Create a new plain text document Addiess C Program Addtess C Program Files TMA config z View Customize this Folder Arrange Icons Line Up leon Refresh Paste Paste Shortcut Undo Move J I Folder en Shortcut Text Document T Microsoft Word Document g Briefcase Microsoft Excel Worksheet Gail Microsoft Office Binder 7 Other Office Documents a Microsoft PowerPoint Presentation 3 Corel Media Folder BEES Rename this text document to custom txt Open the custom txt file and edit it using the syntax as described in the following sections Save the custom txt file and start TMA CLI 142 User manual TMA CLI User defining values using the custom txt file 7 3 The structure of the custom txt file This section explains the general structure of the custom txt file There are three main elements that make up the custom txt file BESS OOOO ee section The file is divided in
59. any lines as there are devices on the card e Anon multi device only one device on one card only has one exit line also called exit port In that case you may drop the LINE lt n gt argument 42 User manual TMA CLI Opening a TMA CLI session 4 3 Relative and absolute addressing This paragraph explains what relative and absolute addressing is If you want to open a TMA CLI session on a device you have to specify the address of the device You can apply three types of addressing methods relative This type of addressing is meant for a network topology where the modems are connected in line on management level E g with extended management links between two modems An extended management link is realised with a cross connect cable between the auxiliary connectors of two modems extended link PC running relative 0 relative 1 relative 2 relative 3 TMA To enable relative addressing no address has to be specified in the modem absolute This type of addressing is meant for a network topology where the modems are not connected in line on management level E g when there is a digital multipoint device present digital multipoint example SEER absolute 10 gt Va O s example PC running example example absolute 20 TMA absolute 0 absolute 1 EA example absolute 30 To enable absolute addressing an address has to be specified in the modem The absolute addressing range goes from 0 up to 65535 Refer to the ma
60. ation The non interactive mode syntax Start a shell program e g MS DOS in the Windows operating system At the prompt you can enter a command according to the following syntax TmaCli lt address arguments gt lt TMA CLI_command gt For more information on the different address arguments refer to Section 4 2 The TMA CLI connection possibilities Refer to Chapter 8 The TMA CLI commands for an overview and in depth description of all available commands Examples Suppose you want to retrieve all configuration attributes of a device that has the IP address 10 0 11 1 Type the following TmaCli 10 0 11 1 get r In non interactive mode you can easily redirect the same output to a file TmaCli 10 0 11 1 get r gt output txt If you want to execute more than one command then all the commands can be entered in a script file TmaCli 10 0 11 1 exec script cli In non interactive mode you can also interact with devices using flow control constructs of your scripting or programming environment For more information on scripting refer to Section 6 5 9 Setting values obtained with the get command and Section 6 8 Scripting Normally if you want to set a textual string value that contains characters that conflict with the syntax such as a comma a space an equal sign etc then you have to surround the string by a set of double quote characters However in MS DOS the quote character is an escape character This imp
61. ation gt get s security f password user security a password user accessRights ReadAccess on WriteAccess off SecurityAccess off FileSystemAccess off OK Continued on next page User manual 91 Basic TMA CLI commands TMA CLI The get s option continued In case of character strings it is possible to use wildcards The wildcard character is an asterisk Suppose you want to display that line of the security table where the password ends on admin In that case type the following 01003 Edit Configurati gt get s security f security a password sys_adm accessRights ReadAccess on WriteAccess on SecurityAccess FileSystemAccess on password admin in on OK o1003 Edit Configurati gt on on If you want to use the wildcard at the end of a string it is not necessary to type the wildcard character Suppose you want to display that line of the security table where the password begins with sys In that case type the following gt get s security f security a password sys password sys admin accessRights ReadAccess on WriteAccess on SecurityAccess on FileSystemAccess on password sys_tech accessRights ReadAccess on WriteAccess on SecurityAccess off FileSystemAccess on
62. atus gt User manual 73 Basic TMA CLI commands TMA CLI 6 3 Reading attribute values This section explains how you can use the get command to read a simple value a structured or complex value a simple value within a structured value etc The following table gives an overview of this section s fee O Reading a simple attribute value Reading a structured attribute value Reading all attribute values of the current object The get command options 888 onbisteninegtcommsenis DT 74 User manual TMA CLI Basic TMA CLI commands 6 3 1 Reading a simple attribute value Reading a simple attribute value crocusSDSLTT Edit Configuration gt get bootFromFlash bootFromFlash Auto OK crocusSDSLTT Edit Configuration Reading a simple attribute value located on a lower object level crocusSDSLTT Edit Configuration gt get modem line speed GET SE tA ECT modem SELECT line LIST speed 1152000 bps OK crocusSDSLTT Edit Configuration gt Because the get command for the attribute speed of the sub object line was executed in the top object crocusSDSLTT the underlying objects are selected by the SELECT command The speed attribute of the line object is grouped by LIST This allows you to use the get command to create scripts You can then use these scripts to easily change identical attributes
63. bility to use the name resolution feature of TMA for HP OpenView to open a TMA CLI session on a Telindus device For more information refer to Section 4 4 Connecting using name resolution User manual 31 Opening a TMA CLI session TMA CLI 4 2 1 Connecting direct TmaCli COM lt x gt Use this command if you want to make a direct also called serial connection as described in Section 3 2 Direct connection to a device In that case you have to specify which COM port of the computer is connected to the control port of the Telindus device When making a direct connection to a Telindus device that is being managed by a management concentrator you might experience connection problems In this case it is best to make a connection through the management concentrator i e the management concentrator as proxy Address argument Replace com lt x gt by one of the four possibilities listed below e COM1 e COM2 e COM3 e COM4 32 User manual TMA CLI Opening a TMA CLI session 4 2 2 Connecting direct and selecting a modem TmaCli COM lt x gt MODEM lt n gt Some Telindus devices incorporate several devices on one card This is called a multi device The different devices on a multi device are referred to using A B C D etc Examples of multi devices are e Crocus SHDSL CV Twin incorporates 2 SHDSL modems on one card e Crocus 2M CNV CV Twin incorporates 2 interface converters on
64. bination of both Each object has its own set of attributes attribute An attribute is a parameter related to a certain object It has a certain value simple value An attribute has a certain value which is e changeable in case of a configuration attribute provided you have write access e read only in case of a status performance and alarm attribute An attribute has a simple value when it has no underlying attributes or sub attributes which are called elements Hence we also call this attribute a simple attribute E g sysName sysLocation sysContact and bootFromFlash are simple attributes structured or An attribute has a structured or complex value when it has underlying attributes complex value or sub attributes which are called elements Hence we also call this attribute a structured or complex attribute There are three different structured or complex value types bit string A bit string is actually a special case of a simple value It 41001100 does have elements in this case the separate bits but you can not display these bits separately l e you can only display the complete bit string In other words a bit string is actually a simple value which in some cases is represented as a complex value An example of a bit string is the attribute alarmMask structure A structure has several elements The elements of a structure are always simple values You can display these elements separate
65. ble cors refer to Section 4 9 The environment variables get r Use this option recursive get to retrieve not only the attributes d The get r option of the current object but also of the underlying objects page 90 The attributes on the same level are grouped by LIST and an underlying object is selected by the SELECT command get s Use this option to use a filter on a table By doing so you can e The get s option selectively filter certain rows out of a table page 91 get t Use this option to retrieve nested tables This means that in f The get t case you perform a get t of a table in which structures and command page 94 other tables i e nested tables appear you retrieve all the values present in these structures and tables The ordinary get command does not do this by default as some tables can be very complex and might take a very long time to retrieve Note however that get f and get r implicitly retrieve nested tables Continued on next page 84 User manual TMA CLI Basic TMA CLI commands The get command options continued Use this option to display the values of a table in rows and g The get v option columns and separated by the value separator The first row of page 95 the output table represents the value names The used value separator depends on the environment variable VALUESEPARATOR refer to Section 4 9 The environment variables As default it is
66. bute values as possible on one line while taking the environment variable cons into account the filtered values of a table the nested tables the values of a table in rows and columns and oS by the value separator which is defined by the environment variable VALUESEPARATOR the values of a complex attribute value on one line while taking the environment variable coLs into account Continued on next page attribute values of the current and underlying objects The attributes on the same level are grouped by LIST and an underlying object is selected by the SELECT command Reference manual 163 The TMA CLI commands TMA CLI The get command continued Specification The parameter lt specification gt can represent the following lt specification gt lt object _specification gt lt attribute specification gt lt row_specification gt lt element specification gt lt group_specification gt The following table gives a description of the different kinds of specifications object specification There are two possible object specifications e An absolute object specification i e starting from the top object e g crocusSDSLTT modem A relative object specification i e starting from the current object e g modem line attribute specification Specifies an attribute within an object and selected group Possible notations the name of the attribute e g sysName an object
67. cardPosition modem 0 3 A 0 3 B 0 3 C 0 3 D OK 01003 nmsgroup Status gt User manual 95 Basic TMA CLI commands TMA CLI h The get w option Use this option to display the values of a complex attribute value on one line The number of elements that will be printed on one line depends on the environment variable cos refer to Section 4 9 The environment variables crocusSDSLTT Edit Configuration gt get w sysName Crocus SDSL TT No 15 sysContact System administrator Tel 785612 sysLocation Main building Equipment room security bootFromFlash Auto forwardTMATONMSPort enabled forwardTMAToLine enabled alarmMask NotResponding enabled AlarmSyncLoss enabled StrapChanged disabled Access disabled RemoteAlarm disabled UnknownState disabled Boot disabled CodeConsistencyFail disabled ConfigConsistencyFail disabled alarmLevel NotResponding 4 AlarmSyncLoss 4 StrapChanged 1 Access 1 RemoteAlarm 0 UnknownState 0 Boot 1 CodeConsistencyFail 1 ConfigConsistencyFail 1 alarmContactHighMask NotResponding disabled AlarmSyncLoss disabled StrapChanged disabled RemoteAlarm disabled Boot disabled Access disabled UnknownState disabled CodeConsistencyFail disabled ConfigConsistencyFail disabled alarmContactLowMask NotResponding disabled AlarmSyncLoss disabled StrapChanged disab
68. cation Main Building Equipment Room security a password sys admin a password user accessRights ReadAccess on WriteAccess off SecurityAccess off SELECT modem LIST tests detectRDL disabled channel central SELECT line LIST speed 128000 bps OK crocusSDSLTT Edit Configuration gt User manual 119 Basic TMA CLI commands TMA CLI 6 5 9 Setting values obtained with the get command As said in several previous sections you can use the logging command together with the get command in order to create scripts e Paragraph a Creating a script file starting from a non configured device explains how you can set the attributes of a device by logging the default configuration to a script file editing this file and then executing this script on the device e Paragraph b Creating a script file starting from a configured device explains how you can easily set identical attributes on other devices of the same type by first changing the configuration of one device logging this configuration to a script file and then executing this script on several devices 2 The script files that you create may have any extension cli txt etc However in order to distinguish your TMA CLI script files from other files it may be useful to use the extension cli 120 User manual TMA CLI Basic TMA CLI commands a Creating a script
69. crocusSDSLQuad unknownDevice alarmman crocusSDSLTT crocusSDSLCU crocusHDSLTT crocusHDSLCU crocusDxXC hdsl ocms2 orcms2 hscms hdsicms a4cms router inumux inumux2 fomtt fomcy sdslquad unknown alrmmo sdsltt sdslcy hdsltt hdslcu dxc a4cms2 e3mux router i IZ 144 User manual TMA CLI User defining values using the custom txt file 7 5 The definitions of the custom txt file This section gives more detailed information on the definitions of the custom txt file What is a definition One section can contain one or several definitions With these definitions you create the user defined values Definition syntax A definition has the following global syntax lt definition gt lt attribute specification gt lt value list gt with lt attribute specification gt lt path gt lt attribute name gt lt element name gt Definition description A definition can span multiple lines The end of the definition is marked with a character The other elements of the definition are listed below Element For more information refer to Section 7 5 1 The path page 146 lt attribute name gt 7 5 2 The attribute and element name page 149 lt element name gt 7 5 3 The value list page 150 User manual 145 User defining values using the custom txt file TMA CLI 7 5 1 The path What is a path A path specifies the way to reach a certain attribu
70. ct _specification gt lt object_instance value gt User instantiatable objects that have an instance value are objects of which several can be present in the containment tree The instance value distinguishes them from one another The parameter lt object instance value gt is the instance name you want to assign to the user instantiatable object It is a character string of maximum 24 characters Important remark When adding a user instantiatable object i e using the set select combination the curled brackets behind the user instantiatable object name have to be present This because TMA CLI expects curled brackets after a select command within a set command If you want you can insert more select commands or a list of attributes between these curled brackets When removing a user instantiatable object i e using the set delobj combination the curled brackets behind the user instantiatable object may not be present Examples Refer to Section 6 5 Setting attribute values and Section 6 6 2 How to add a user instantiatable object 172 Reference manual TMA CLI The TMA CLI commands 8 14 The setenv command Syntax SETENV SETENV lt environment variable gt lt integer value gt Description This command sets the environment variables These variables control the output behaviour of TMA CLI For more information on this subject refer to Section 4 9 The environment variabl
71. ctHighMask LinkDown disabled Retrain disabled HighBitError disabled owBitError disabled SeverelyErroredSecond disabled Unavailability disabled alarmContactLowMask LinkDown disabled Retrain disabled HighBitError disabled owBitError disabled SeverelyErroredSecond disabled Unavailability disabled OK crocusSDSLTT Edit Configuration gt Because the get command for the sub object line was executed in the top object crocusSDSLTT the underlying objects are selected by the SELECT command The attributes of the line object are grouped by LIST This allows you to use the get command to create scripts You can then use these scripts to easily change identical attributes on other devices of the same type For more information on this matter refer to Section 6 5 9 Setting values obtained with the get command Continued on next page 82 User manual TMA CLI Basic TMA CLI commands Reading all attribute values of the current object continued Reading all attribute values of an object in a group different from the current one Suppose your current location is the top object crocusSDSLTT in the Edit Configuration group If you for example want to read the status attribute values of the line object you can do this without having to change from the Edit Configuration group to the Status group In order to do so type the following
72. d Select device actions When there is no response from the device after this timeout the open and close frames are retransmitted the number of times which is specified in the Retries parameters PollPeriod 30 Once you are connected to a device it is regularly polled to see whether it is still there PollPeriod sets the poll interval in seconds ServerPort 31416 This is the TCP port on which the TMA Comms Handler listens WaitClose 300 The TMA Comms Handler normally closes when all TMA CLI sessions are closed However with WaitClose you can set a timeout in seconds for which the TMA Comms Handler will wait before it really closes down If you restart a new TMA CLI session within this timeout period the rebooting of the TMA Comms Handler will be accelerated This because the TMA Comms Handler was not yet closed down completely The Tftp part The Tftp part contains the following parameters Rexmt 30 Retransmission timeout in seconds for a TFTP connection Timeout 60 Total timeout in seconds for a TFTP connection l e retransmission continues until Timeout has expired Continued on next page 176 Reference manual TMA CLI The Cms2Serv ini file Parts of the Cms2Serv ini file continued The Comm part The Comm part contains the following parameters Speed 9600 This is the COM port speed in bits per second NormTimeOut 8 Normal CMS2 retransmission and reply timeout in seconds for a serial conn
73. device You can download several files towards the file system of the an IP device For example e a configuration file of a certain device in order to distribute this configuration towards several devices of the same type e a configuration file of a specific device in order to perform configuration consistency on this device e a firmware file of a certain device in order to distribute this firmware towards several devices of the same type e the models nms file e etc g Suppose you want to download a firmware file of a Crocus SDSL TT to the file system of the Orchid 1003 LAN This for instance to perform software consistency In that case type the following o1003 Edit Configuration gt memload 1T2122013 00 T2122013 00 OK o1003 Edit Configuration gt In this command the part e before the is the source file name on your system e behind the is the destination file name on the file system of the Orchid g g Suppose you want to download a previously exported configuration file of the Crocus SDSL TT to the file system of the Orchid 1003 LAN This for instance to perform configuration consistency In that case type the following 01003 Edit Configuration gt memload sdsl config file cms sdsl_config file cms OK 01003 Edit Configuration gt 138 User manual TMA CLI Basic TMA CLI commands 6 10 3 Downloading new firmware to a non IP device As said before using the memload
74. e does not start with a double quote The end of the string is the first space tab or end of line character that is encountered Note that using this encoding you can not use characters that conflict with the normal syntax Such as a comma a space an equal sign etc Use the STRING encoding instead Example alarmLevel Access low 0 high 10 The second part is the actual value for which this name is defined See the examples above 150 User manual TMA CLI User defining values using the custom txt file 7 6 An example of a custom txt file The following shows an example of a custom txt file common These are some common definitions alarmLevel Access Level low 0 Level medium 5 Level high 10 management alarmFilter lowSenseFilter 0 mediumSenseFilter 5 highSenseFilter 10 crocusHDSLTT The definition of the LinkDown alarm applies on both lines The definition of the SeverelyErroredSecond alarm applies on line 1 only line alarmLevel LinkDown low 0 medium 5 high 10 modem line 1 alarmLevel SeverelyErroredSecond low 0 medium 5 high 10 Sections The sections in this example are common and crocusHDSLTT The common section applies to all devices The section crocusHDSLTT applies to the Crocus HDSL F TT Remarks As you can see in the example some remarks are given These remarks are preceded by a character Definitions
75. e value has a different representation Refer to the following section 156 Reference manual TMA CLI The TMA CLI commands 8 3 Possible values The following table lists all possible attribute and element values integer one or more decimal digits no leading zeros Minus sign for negative values e g 12 12 not 012 enumerated the textual representation of the enumerated value If the textual representation contains characters that conflict with the syntax such as a comma a space an equal sign etc then the string has to be surrounded by a set of double quote characters printable string a string of printable characters e If the printable string contains characters that conflict with the syntax such as a comma a space an equal sign etc then the string has to be surrounded by a set of double quote characters e A null string is represented as two consecutive double quotes octet string the hexadecimal representation of the value surrounded by H e g 0355 H bit string a set of bits where each bit has a name The value of a bit string is shown in the same way as for an enumerated value IP address a formatted type existing of four decimal values separated by a dot character Reference manual 157 The TMA CLI commands TMA CLI 8 4 The action command Syntax ACTION lt action name gt lt action argument gt lt action value specification gt Description
76. ect If you add neither a parameter nor an option to the get command then you will obtain all attributes of the current object Reading all attribute values of the current object crocusSDSLTT powerOffDetection Edit Configuration gt get mode disabled alarmMask Open line disabled Remote power fail disabled Short circuit disabled alarmLevel Open line 3 Remote power fail 3 Short circuit 3 alarmContactHighMask Open line disabled Remote power fail disabled Short circuit disabled alarmContactLowMask Open line disabled Remote power fail disabled Short circuit disabled OK crocusSDSLTT powerOffDetection Edit Configuration gt Continued on next page User manual 81 Basic TMA CLI commands TMA CLI Reading all attribute values of the current object continued Reading all attribute values of an object on a lower object level crocusSDSLTT Edit Configuration gt get modem line GET SE s r ECT modem a SELECT line LIST speed 1152000 bps alarmMask LinkDown disabled Retrain disabled HighBitError disabled owBitError disabled SeverelyErroredSecond disabled Unavailability disabled alarmLevel LinkDown 3 Retrain 2 HighBitError 2 owBitError 1 SeverelyErroredSecond 2 Unavailability 2 alarmConta
77. ect first An object that can be added by the user is called a user instantiatable object Also referred to as a child object because it is added under a parent object 130 User manual TMA CLI Basic TMA CLI commands 6 6 2 How to add a user instantiatable object Add a user instantiatable object to the containment tree using the set select command Adding a user instantiatable object which has no index The following command adds the user instantiatable object proxy under the top object telindus1031 The proxy object has no index This because you can only add one proxy object to the containment tree telindus1031 Edit Configuration gt set select proxy OK telindus1031 Edit Configuration The curled brackets behind the user instantiatable object name have to be present This because TMA CLI expects curled brackets after a select command within a set command If you want you can insert more select commands or a list of attributes between these curled brackets g J The following command adds the user instantiatable object routingFilter under the object router You also have to specify an index for the routingFilter object e g filter1 This because you can add several routingFilter objects to the containment tree The index distinguishes the different routingFilter objects from on another telindus1031 router Edit Configuration gt set select routingFilter filter1 OK telindus1031 router Edit
78. ection The LAN part The LAN part contains the following parameters NormTimeOut 10 Normal CMS2 retransmission and reply timeout in seconds for an IP connection Reference manual 177 The Cms2Serv ini file TMA CLI 9 2 Adding parts to the Cms2Serv ini file You can set specific communication parameters for each IP address or COM port The communication parameters in this specific part overrule those in the general part of the Cms2Serv ini file Example Suppose you want to change the following parameters e NormTimeOut for IP address 194 7 26 4 e Speed for COM port 2 Proceed as follows For the part Proceed as follows aa a ec ere 1 Copy the LAN part and paste it at the end of the Cms2Serv ini file Rename LAN to LAN_ 194 7 26 4 Delete all the parameters except NormTimeOut Change the NormTimeOut value from 10 to for instance 30 1 Copy the Comm part and paste it at the end of the Cms2Serv ini file E Comm Rename Comm to Comm_2 Delete all the parameters except Speed 4 Change the Speed value from 9600 to for instance 57600 The added parts are then as follows LAN_194 7 26 4 NormTimeOut 30 Comm_2 Speed 57600 178 Reference manual TMA CLI Troubleshooting 10 Troubleshooting This section explains the error message syntax The following table gives an overview of this chapter er Te Failing answer from a device
79. eeeeeeeeeeeeeeeeeeeeeneneees 9 2 3 Installing TMA CLI on Windows 95 98 NT 2000 ccccecceecccceceeeeeeeeeeeeeeeeeeeeeeeeeees 10 2 4 Installing TMA CLI on Sun Solaris and HP UX GM GW GG G Gssssneeeeeerene eee eere rn eter ee eeeeenaaaeeeeeeeeeeee 11 2 5 How to obtain and install the licence key W W Wu u u u u dvdsseeeeeeeeeee renerne kernerne renen nn 12 2 6 How to upgrade the model files c cccc ccceeeeseseececeeceeeeeseenedeneceeeteeeeteesebneceteeceneeetenss 13 2 7 Location of the TMA CLI files ccc ccccccecceecceecceeeeeeeceeeeeeeeeeeeeeeeeeeeeeseeeeeeeereseeeeeseeerens 14 3 Connecting toa deVICes cca cin cndncnandndinduindndindndnindnunas 15 3 1 What are IP proxied IP and non IP devices cccccececccceceeceeseeeeeeeeeseeseeseaeeeseeeesseaees 16 3 2 Direct connection tO a device 2 0 e cece cceeeeeeeeeeeeeeeeeeeeeeeeeee eee eeeeeeeseneteneeteeeeeeeeeeeeeeeeeees 17 3 3 IP connection to an IP device ss scener 20 3 4 Proxied IP connection to a NON IP device 22 eee e cece cece cece cece ceeeeeeeeeeeeeeeeeeeeeeeeeeteteneeeneeess 24 4 Opening a TMA CLI session cccceeeeeeeeee eee eeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeees 29 4 1 Displaying help on TMA CLI connection possibilities cece ceeecceeeeeeeeeeeeeeeeeeeeees 30 4 2 The TMA CLI connection possibilities cc ccccccccccccceeceeeceeeceeeeeeeeeeeeeeeeeeeeeeeeeeeeeteees 31 4 3 Relative and absolu
80. ement concentrator lt IP gt Replace a lt nms gt by the absolute address as configured in the device and in the object table of the management concentrator Example Suppose you have the following set up COM 3 port 1 ye Orchid 1003 LAN nt ee PC running TMA Crocus modem SSS cms2Address 22 objectTable name Crocus modem addressType absolute addressValue 22 exitPort exitPortType port portNumber 1 In order to open a TMA CLI session on the Crocus modem type the following TmaCli com3 A 22 User manual 37 Opening a TMA CLI session TMA CLI 4 2 7 Connecting using relative addressing and an exit port TmaCli COM lt x gt IP R lt nms gt PORT lt p gt Use this command to connect to a device through one of the asynchronous ports of the management concentrator The addressing method that is used is relative addressing For more information on relative and absolute addressing refer to the Section 4 3 Relative and absolute addressing Address arguments In case the connection between your computer running TMA CLI and the management concentrator you want to connect through is e adirect connection then specify the COM port of your computer com lt x gt e an IP connection then specify the IP address of the management concentrator lt IP gt Replace R lt nms gt by the relative address of the device Replace PORT lt p gt by the asynchronous port number to which the dev
81. enabled StrapChanged disabled Access disabled RemoteAlarm disabled UnknownState disabled Boot disabled CodeConsistencyFail disabled ConfigConsistencyFail disabled OK crocusSDSLTT Edit Configuration gt Because this is a bit string you can not display the elements separately For instance you can not display the bit value NotResponding only Continued on next page 76 User manual TMA CLI Basic TMA CLI commands Reading a structured attribute value continued Reading a structure crocusSDSLTT Edit Configuration gt get alarmLevel alarmlevel NotResponding AlarmSyncLoss StrapChanged 1 Access 1 RemoteAlarm 0 UnknownState 0 Boot 1 CodeConsistencyFail 1 ConfigConsistencyFail 1 I I A A OK crocusSDSLTT Edit Configuration gt Because this is a structure you can display the elements separately See below Reading only one element in a structure gt get alarmLevel NotResponding alarmLevel NotResponding 4 OK crocusSDSLTT Edit Configuration gt User manual 77 Basic TMA CLI commands TMA CLI 6 3 3 Reading a table As already explained in Section 6 3 2 Reading a structured attribute value a table is a structured or complex value l e it has several elements These can be simple values combination of both You can display these values separately Reading a table You can for instance disp
82. ent possibilities Paragraph a The syntax sysName objectTable name page 48 Paragraph b The syntax IP address objectTable name page 49 Paragraph c The syntax sysName hardware connection page 50 Paragraph d The syntax IP address hardware connection page 51 User manual 47 Opening a TMA CLI session TMA CLI a The syntax sysName objectTable name TmaCli lt proxy sysName gt lt objectTable name gt Examples e Suppose you have a Crocus HDSL connected to an Orchid 1003 LAN The name for the Crocus HDSL in the Orchid its objectTable is hdsITT The Orchid 1003 LAN on its turn is connected to a LAN has an IP address and its is sysName 01003 In that case type the following TmaCli 01003 hdslTT e Suppose you have a Crocus DXC connected to an Orchid 1003 LAN The name for the Crocus DXC in the Orchid its objectTable is Crocus_DXC The Orchid 1003 LAN on its turn is connected to a LAN has an IP address and its is sysName Orchid_1003_LAN In that case type the following TmaCli Orchid 1003 LAN Crocus DXC 48 User manual TMA CLI Opening a TMA CLI session b The syntax IP address objectTable name TmaCli lt proxy IP gt lt objectTable name gt Example Suppose you have a Crocus HDSL connected to an Orchid 1003 LAN The name for the Crocus HDSL in the Orchid its objectTable is hdsITT The Orchid 1003 LAN on its turn is connected to a LAN and has IP address 12 3 45 100 In that case ty
83. es Depending on the syntax the command reacts differently ENV lt environment variabl gt lt int g r valu gt define an environment variable Examples Set the environment variable COLS to 60 crocusSDSLTT Edit Configuration gt setenv COLS 60 OK crocusSDSLTT Edit Configuration gt Set the environment variable VALUESEPARATOR to crocusSDSLTT Edit Configuration gt setenv VALUESEPARATOR OK crocusSDSLTT Edit Configuration gt In order to have tabs as value separator set the environment variable VALUESEPARATOR to l crocusSDSLTT Edit Configuration gt setenv VALUESEPARATOR I OK crocusSDSLTT Edit Configuration gt Reference manual 173 The TMA CLI commands TMA CLI 8 15 The source command Syntax SOURCE lt script file name gt Description This command executes TMA CLI scripts The file name may include a path name White spaces within the file name are not allowed After execution of the script the environment variables as set in the script are retained e have a script that among other things sets the environment variables e use the source command to run the script e are in interactive TMA CLI mode then the environment variables as set in the script are retained when the script is finished Also refer to the complementary command exec Section 8 7 The exec command
84. etting several values in the alarmLevel attribute crocusSDSLTT Edit Configuration gt set alarmLevel StrapChanged 2 Access 2 RemoteAlarm 2 OK crocusSDSLTT Edit Configuration gt 102 User manual TMA CLI Basic TMA CLI commands 6 5 3 Performing actions on a table with a fixed length A fixed table is a table with a fixed number of rows This means you can not add or remove rows from a fixed table Setting a value in a row of a fixed table The following example enters some values in the telephone table dialler table of an Aster 4 modem aster4 dialler Edit Configuration gt set telephoneTable 1 785612 10 784523 11 789512 OK crocusSDSLTT Edit Configuration gt Clearing an entire row of a fixed table The following command clears the third row in the dialler table aster4 dialler Edit Configuration gt set dialler c3 OK aster4 dialler Edit Configuration gt Alternatively you can use the following syntax aster4 dialler Edit Configuration gt set dialler c3 OK aster4 dialler Edit Configuration Clearing an entire fixed table The following command deletes the entire security table aster4 dialler Edit Configuration gt set dialler c OK aster4 dialler Edit Configuration gt Alternatively you can use the following syntax aster4 dialler Edit Configuration gt set dialle
85. ew firmware to the Crocus SDSL TT 01003 deviceSoftware Edit Configuration gt action Start Download OK 01003 deviceSoftware Edit Configuration gt User manual 139 User defining values using the custom txt file TMA CLI 7 User defining values using the custom txt file This chapter explains how you can user define values for attributes that have an integer as value You can do this using the custom txt file The following table gives an overview of this chapter sa fe fr What is user defining values Creating the custom txt file The sections of the custom txt file The definitions of the custom txt file An example of a custom ttt file 140 User manual TMA CLI User defining values using the custom txt file 7 1 What is user defining values What is user defining values The advantage of user defining values is that you are able to give a sensible name to an otherwise very cryptic integer value You can only user define values for integer attribute values Not for enumerated values IP addresses etc Examples of integer values are the values of the attributes cms2Address alarmFilter broadcastTimer etc How to user define values In order to user define values you have to create and edit a custom txt file this file is not created when TMA is installed What is the custom txt file The custom txt file is a plain text file containing special syntax which defines the values you w
86. file starting from a non configured device Suppose you have a Crocus SDSL TT that has not been configured yet i e it still has its default configuration Suppose you want to set the following attributes on this Crocus SDSL TT e crocusSDSLTT sysName Crocus SDSL TT central e crocusSDSLTT sysContact Sys Admin Tel 785612 e crocusSDSLTT sysLoaction Equipment Room e crocusSDSLTT bootFromFlash Flash 1 e crocusSDSLTT modem tests detectRDL disabled e crocusSDSLTT modem channel central e crocusSDSLTT modemlline speed 128000 bps First open a TMA CLI session on the Crocus SDSL TT Then log its full configuration crocusSDSLTT Edit Configuration gt logging on script cli OK crocusSDSLTT Edit Configuration gt get r OK crocusSDSLTT Edit Configuration gt logging off OK crocusSDSLTT Edit Configuration gt Continued on next page User manual 121 Basic TMA CLI commands TMA CLI Creating a script file starting from a non configured device continued Now open the script cli file in a text editor and edit it as follows e Remove the command prompt at the beginning and the end of the file e Remove the gt get r command at the beginning of the file e Replace the GET command at the beginning of the file by the SET command e Remove all attributes you do not want to change e Edit the attributes you want to change T
87. g actions on a table with a variable length Combining actions on a table with a variable length 113 113 Setting attribute values that have a certain unit Setting a choice value Setting several attribute values at once Setting values obtained with the get command Setting an attribute value to its default value Configuration changes are only activated after you executed the Activate Configuration command refer to Section 6 7 Performing actions 98 User manual TMA CLI Basic TMA CLI commands 6 5 1 Setting a simple attribute value Setting a simple attribute value The following examples show you how to set simple attribute values Editing the sysName attribute value crocusSDSLTT Edit Configuration gt set sysName Crocus SDSL TT central OK crocusSDSL gt mm n Edit Configuration Setting the bootFromFlash attribute value crocusSDSLTT Edit Configuration gt set bootFromFlash Flash 1 OK crocusSDSLT1 Edit Configuration Setting a simple attribute value located on a lower object level crocusSDSLTT Edit Configuration gt set modem line speed 128000 bps OK crocusSDSLTT Edit Configuration If you want to set a textual string value that contains characters that conflict with the syntax such as a comma a space an equal sign etc then you have to surround the string by a set of double quote characters
88. he following section for an overview of the keywords that can be assigned to a command Reference manual 155 The TMA CLI commands TMA CLI 8 2 Keywords of the TMA CLI command syntax TMA CLI commands have parameters that are composed as a set of keywords and values that are separated from each other by one or more white space characters A white space character may be a space character or a tab character The following table gives an overview of all the keywords lt object name gt the name of an object It is a combination of upper and lower case characters If an object type requires an instance value the ASCII representation of the instance value is given between square brackets e g line 2 lt group_name gt the name of the group to which the attribute or actions belongs It is a combination of upper lower case and white space characters lt attribute_name gt the name of the attribute It is a combination of upper and lower case characters lt element_name gt the name of an element within a structured attribute value also called complex attribute or complex attribute value It is a combination of upper and lower case characters lt action_name gt the name of the action It is a combination of upper and lower case characters and embedded spaces the name of a file either to import or to export lt value gt the representation of the value for the attribute or element Depending on the type th
89. he following table shows you the non edited script file and the edited script file side by side crocusSDSLTT Edit Configuration gt get r GET EIST LIST sysName Crocus SDSL TT central sysContact Sys Admin Tel 785612 sysName sysLocation Equipment Room sysContact bootFromFlash Flash 1 sysLocation ECT modem LISI tests detectRDL disabled hannel central ECT line LIST speed 128000 bps LECT LISI cms2Address 0 T powerOffDetection OK crocusSDSLTT Edit Configuration gt logging off Continued on next page 122 User manual TMA CLI Basic TMA CLI commands Creating a script file starting from a non configured device continued Run the script on the Crocus SDSL TT using the execute command crocusSDSLTT Edit Configuration gt exec script cli OK crocusSDSLTT Edit Configuration Activate the new configuration using the Activate Configuration action crocusSDSLTT Edit Configuration gt action Activate Configuration OK crocusSDSLITT gt Edit Configuration User manual 123 Basic TMA CLI commands TMA CLI b Creating a script file starting from a configured device Suppose you have several Crocus SDSL TTs that have to be configured
90. he model files are installed you are ready to interconnect the computer running TMA CLI and a Telindus device This is explained in this chapter First the terms P device proxied IP device and non IP device are explained for they are used in this and the following chapters The following table gives an overview of this chapter What are IP proxied IP and non IP devices Direct connection to a device IP connection to an IP device 20 Proxied IP connection to a non IP device User manual 15 Connecting to a device TMA CLI 3 1 What are IP proxied IP and non IP devices Because in this and the following chapters the terms P device proxied IP device and non IP device are often used they are explained in this section The following table gives a definition of each term together with an example IP device An IP device is a Telindus access device e in which you can configure an IP address e that has a dedicated LAN port through which you can connect the device to a LAN Example The Crocus Inverse Multiplexer is an IP device You can configure an IP address in the Crocus Inverse Multiplexer using the crocusInvMux lanInterface ipAddress attribute The Crocus Inverse Multiplexer can be connected to a LAN through its TPI port located at the back of the device Other IP devices are for instance Orchid 1003 LAN Crocus Router Interface Crocus Router 2M Telindus 1421 SHDSL Router non IP device A non IP device
91. he physical connection alone is not sufficient to establish an IP connection between the computer and the IP device A few basic settings have to be made in the IP device User manual 21 Connecting to a device TMA CLI 3 3 2 To which Telindus devices can you make an IP connection You can make an IP connection to every Telindus device that has a dedicated LAN port through which you can connect the device to a LAN Hence you can only make a connection via IP to a Telindus IP device not to a non IP device There is a way to make an IP connection to a non IP device However this involves using a management concentrator with a particular configuration In that case the non IP device becomes a proxied IP device For more information refer to Section 3 4 Proxied IP connection to a non IP device 22 User manual TMA CLI Connecting to a device 3 3 3 Basic IP device settings to enable an IP connection To establish an IP connection between the computer running TMA and the IP device a few basic parameters called attributes have to be set in the IP device These attributes are IP address This is a unique address which is assigned to the IP device By doing this other devices on the IP network can contact the IP device Examples The following examples display the IP address attribute location in the containment tree of some Telindus IP devices e Orchid 1003 LAN 01003 interfaces laninterface ipAddress e Crocus Router 2
92. he third row to passw3 You also want to change the corresponding access rights you only want to assign read access to this password In that case type the following crocusSDSLTT Edit Configuration gt set security 3 password passw3 accessRights ReadAccess on WriteAccess off SecurityAccess off OK crocusSDSLTT Edit Configuration gt Alternatively you can use the following syntax crocusSDSLTT Edit Configuration gt set security 3 password passw3 accessRights ReadAccess on WriteAccess off SecurityAccess off OK crocusSDSLTT Edit Configuration gt Both notations displayed above result in the following crocusSDSLTT Edit Configuration gt get w security security a password passwl accessRights ReadAccess on WriteAccess on SecurityAccess on 5 a password passw2 accessRights ReadAccess on WriteAccess on SecurityAccess on 5 a password passw3 accessRights ReadAccess on WriteAccess off SecurityAccess off 4 a password passw4 accessRights ReadAccess on WriteAccess on SecurityAccess on 5 OK crocusSDSLTT Edit Configuration gt Continued on next page User manual 109 Basic TMA CLI commands TMA CLI The set x option continued Changing the values in a row to their default value If you now want to reset the values
93. ice is connected Example Suppose you have the following set up COM 2 Crocus modem 1 Crocus modem 2 PC running TMA objectTable relative 0 relative 1 name Crocus modem 2 addressType relative addressValue 1 exitPort exitPortType port portNumber 5 In order to open a TMA CLI session on the Crocus modem 2 type the following TmaCli com2 r 1 port5 38 User manual TMA CLI Opening a TMA CLI session 4 2 8 Connecting using relative addressing and a hardware address TmaCli COM lt x gt IP R lt nms gt RACK lt r gt lt p gt lt m gt Use this command to connect to a device through the high speed bus of a card nest CN4 under management of a management concentrator The addressing method that is used is relative addressing For more information on relative and absolute addressing refer to the Section 4 3 Relative and absolute addressing Address arguments In case the connection between your computer running TMA CLI and the management concentrator you want to connect through is e adirect connection then specify the COM port of your computer com lt x gt e an IP connection then specify the IP address of the management concentrator lt IP gt Replace R lt nms gt by the relative address of the device Replace RACK lt r gt lt p gt lt m gt by the hardware address of the device The hardware address consists of three fields The following table explains what they mean rack address
94. inment tree A containment tree represents the parameters of a Telindus device in a hierarchical structure These parameters enable you to configure the device and they display information on the operational status of the device 5 2 How is the containment tree structured The following figure gives a simplified representation of how a containment tree is structured Containment tree consists of Objects Attributes have Values can be may have e Simple e Structured e Table can be contains e Simple e Structured The specific structure of the containment tree differs from device to device but the general structure is always the same as depicted above The following paragraph describes each element of the containment tree User manual 61 Introducing the containment tree TMA CLI 5 3 The containment tree terminology The following table explains the terminology associated with the containment tree containment tree The containment tree represents the hierarchical structure of a device It is composed of a number of objects that are ordered in a tree This tree resembles a Windows directory structure e itis also a levelled structure with nodes which can be expanded or reduced e the containment tree objects can be compared with file folders e the objects contain attributes like file folders contain files object An object represents a physical interface an application or a com
95. ions of the custom txt file sanse 145 7 6 An example of a custom txt file 222 151 Reference manuals SEE ara en oratorier 152 8 The TMA CLI commands scenerne E ELLE ELLE ELLE ELLE ELLE ELLE ELLE DEDEDER 154 8 1 TMA CLI command overview ssssseeeeer reen EEN 155 8 2 Keywords of the TMA CLI command syntax cece eeeeeeeeteeeeeeeeeeeeenaaeeeeeeeeeeeeea 156 8 37 Possible Valie S sorn events a i EE AA EE E a eel Gaedevecd etal hats 157 8 4 The action command scenerne EEN 158 8 5 The cfgload command W u u X u ssseeeeeeeeeeereren ennen eaesteescaatnceteesesee eee auconieeeesncanstees 159 8 6 The disconnect command cesser ee eeee eee eeeeeeeeseeeeseeeseeeseeeeeeeeeeeeeeees 160 8 7 The exec command ssssssereeererenerer ere EL EL ELERS 161 8 8 The get command 25552 eni ED nie sien AP ee A cee es 162 8 9 Thelogging command arrra aaa een I ARETE AEA Ae EK E 166 8 10 The memload command 2 cesser ennen ELLLER 167 8 11 Theselect commanderen e a aa E a E A a ait 168 8 12 The selgrp command ss sseneeerern ener ELERS 169 8 13 These COMMANG serrare En eaea E E EA RER EE 170 8 14 The setenv command ssssrrrrrrrrrrrrrrnrrttrttttttttttttttttEtEEEEEEEEEEEEEEEEEEEEEEEEEEEEEEEEEEEEEEt 173 8 15 The source command ssserrrrrrrrrrrnrrrnttttttttttttt ttrt ELLE ELERS 174 Continued on next page viii TMA CLI Table of contents Table of contents continued 9 The Cms2Serv ini file
96. is a Telindus access device e in which you can not configure an IP address e has no dedicated LAN port and therefore can not be connected directly to a LAN Example The Crocus SDSL F baseband modem is a non IP device You can not configure an IP address in the Crocus SDSL F and you can not connect it to a LAN through a dedicated LAN port Other non IP devices are for instance Aster 4 F Crocus HDSL F Crocus SDSL F Crocus FO10M proxied IP device A proxied IP device is actually a non IP device This means it is a Telindus access device e in which you can not configure an IP address However you can assign an IP address to the device using a management concentrator as proxy IP device refer to Section 3 4 Proxied IP connection to a non IP device has no dedicated LAN port and therefore can not be connected directly to a LAN This is done through a management concentrator which is an IP device and therefore can be connected to a LAN through its dedicated LAN port Example The Crocus SDSL F baseband modem is a non IP device However by connecting the Orchid 1003 LAN to the modem and by assigning an IP address to it in the Orchid 1003 LAN the modem becomes a proxied IP device The Orchid 1003 LAN on its turn is connected through its LAN port to a LAN l e it is as if the modem is connected to the LAN although not directly 16 User manual TMA CLI Connecting to a device 3 2 Direct connection to a device
97. isplaying this attribute in TMA CLI results in the following h2Modem 1 validity valid period 120min gt 105min noSyncTime 0d Oh 15m Os 8 validity valid period 15min gt Omin noSyncTime 0d Oh 15m Os As you can see in the TMA window the h2Modem table consists of several rows Displaying only one row e g row 4 of this table results in the following h2Modem 4 validity valid period 75min gt 60min noSyncTime 0d Oh 15m Os As you can see in the TMA window each row of the h2Modem table contains three elements validity period and noSyncTime Displaying only one attribute e g validity on one row of this table results in the following h2Modem 4 validity valid Continued on next page 68 User manual TMA CLI Introducing the containment tree A containment tree example continued The table discussed on the previous page is a table with a fixed length l e the h2Modem table always has 8 entries The following example is a table with variable length l e the number of entries is not a fixed number If you return to the Configuration group and the top object crocusSDSLTT you find the attribute security The first time you connect to the Crocus SDSL this table is empty However you can enter several lines in it For example security sezale en sys admin 111 p 1 gt 2 sys tech 011 gt 3 user 00
98. lay the security table crocusSDSLTT Edit Configuration gt get security security a password sys admin accessRights ReadAccess on WriteAccess on SecurityAccess on password sys tech accessRights ReadAccess on WriteAccess on SecurityAccess off password user accessRights ReadAccess on WriteAccess off SecurityAccess off OK crocusSDSLTT Edit Configuration gt complex values or a Continued on next page 78 User manual TMA CLI Basic TMA CLI commands Reading a table continued Reading only one row of a table You can also read only one row of the security table In the example below the first row of the security table is retrieved You can see that this row consists of the simple value password and the structured value accessRights crocusSDSLTT Edit Configuration gt get security 1 security 1 password sys admin accessRights ReadAccess on WriteAccess on SecurityAccess on OK crocusSDSLTT Edit Configuration gt Reading only one element in a row of a table You can also read only one attribute value in one row of the security table Suppose you want to read the password attribute value in the first row of the security table crocusSDSLTT Edit Configuration gt get security 1 password security 1 password sys admin OK crocusSDSLTT Edit Configuration gt Co
99. le of contents continued 6 Basic TMA CLI commands sssssssssssnsnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnn 71 6 1 Browsing through the containment tree W W u u ssssseeeeeeeeeee ne eneren eeeeeseenseeeeeeneeeenensees 72 6 2 Selecting another group of attributes W u sssseeeeeeeereenn renerne kr rr renee 73 6 3 Reading attribute values 2 hane ieee i ae sana anes Re rn Goel A SER Aaea 74 Ode LOGGING VOUT at D a TEE E E E A Erde 97 6 5 Setting attfibuteValbes nsir iiien o a or AT E aE TE NEE E 98 6 6 Adding a user instantiatable Object c ccccceccceeeeeeeesedeeeececeteeeeeeeseseneeeeeeeeeeeeeeeeaes 129 6 7 Performing actions 22222222 22 rr EDER needed awaa LEE LEE DENE ASETA rer eres dere 133 6 8 MUMIA kc cst ates onic bare ce ee ne este E a ae a OA wenn Pde ERE EA T 134 6 9 Importing a configuration file i sce2s cce acct seadeted ated pave tand lnadaindedeetaateadaatecdocaetpenesaanets 135 6 10 Downloading files 222 rer cong Ma eres seernes RE EEN bare ecaatsyeateveatneeedeeeesve dee 136 7 User defining values using the custom txt file css 140 7 1 What is user defining values W u sssssecssrsrerkseesssseses sees ene ela tare eke KE ELSE RANE Resen eee 141 7 2 Creating the custom txt file skr tas cde cecdinatcanntackaicntnerchteackts cont neectenddbameoce 142 7 3 The structure of the custom txt file sanse 143 7 4 The sections of the custom txt file ss ERE 144 7 5 The definit
100. le parameters It also explains how to add parameters to the Cms2Serv ini file The following table gives an overview of this chapter Parts of the Cms2Serv ini file Adding parts to the Cms2Serv ini file Reference manual 175 The Cms2Serv ini file TMA CLI 9 1 Parts of the Cms2Serv ini file The Cms2Serv ini file is divided into several parts Each part and its parameters is explained below The values behind the parameters are the default values The Cms2 part The Cms2 part contains the following parameters WindowSize 4 TMA CLI sends a number of frames to the device Then TMA CLI has to receive an acknowledgement from the device before it sends the following frames WindowSize is the number of frames which TMA CLI may send before it has to receive an acknowledgement from the device BufferSize 250 This is the number of bytes in one frame Retries 1 When there is no response from the device TMA CLI will retransmit the current frame a number of times before ending the session Retries sets the number of retransmissions LocalPollDelay 2 The local polling mechanism on itself has nothing to do with TMA CLI Fact is that TMA CLI is not allowed to send anything during a local polling session That is way the LocalPollDelay is used It gives an extra delay in seconds on the reply of a device ExtTimeOut 10 This is the timeout in seconds for opening and closing a session The timeout is used during Connect to network an
101. led Access disabled RemoteAlarm disabled UnknownState disabled Boot disabled CodeConsistencyFail disabled ConfigConsistencyFail disabled OK crocusSDSLTT Edit Configuration gt 96 User manual TMA CLI Basic TMA CLI commands 6 4 Logging your activity Using the logging command you can redirect the screen output to a file This can be particularly useful when you want to create scripts You can then use these scripts to easily change identical attributes on other devices of the same type For more information on this matter refer to Section 6 5 9 Setting values obtained with the get command Also using this log file importing status or performance data into a database or a spreadsheet application is very much simplified This is shown in the following example Example Suppose you want to export the values of the performance attribute h24Modem located in the modem object of the Crocus SDSL containment tree Suppose you want to import this data in a spreadsheet then use the get v command to format the data in rows and columns The name and location of the log file is C data logfile txt Proceed as follows crocusSDSLTT Edit Configuration gt selgrp Performance OK crocusSDSLTT Performance gt select modem OK crocusSDSLTT modem Performance gt logging on C data logfile txt OK crocusSDSLTT modem Performance gt get v h24Modem validity period noSyncTime valid 24h gt 22h 0d 2h Om
102. lies that you would be unable to set an attribute value containing a textual string using quotes in non interactive TMA CLI mode This is solved by placing a slash before each quote Example Do not use Tmacli 10 0 11 1 set sysName Crocus SDSL TT but use TmaCli 10 0 11 1 set sysName Crocus SDSL TT instead User manual 55 Opening a TMA CLI session TMA CLI 4 6 The TMA Comms Handler What is the TMA Comms Handler The TMA Comms Handler is a part of the TMA software that handles the communication towards the connected devices The TMA Comms Handler closing delay If you connect through one of the COM ports of your computer the TMA Comms Handler locks this COM port for other applications If you close all TMA sessions and even if you close the TMA application the TMA Comms Handler waits a certain period before it releases the previously used COM port s You can change this timeout with the WaitClose parameter in the Cms2Serv ini file As default this timeout period is set to 5 minutes For more information on this and other communication parameters refer to Chapter 9 The Cms2Serv ini file How to force the TMA Comms Handler to close However you can force the TMA Comms Handler to close even if the WaitClose time is not elapsed yet To do so proceed as follows Move the Windows arrow to the TMA Comms Handler icon on the taskbar Press on the right mouse button From the pop up menu choose Close
103. line alarmLevel LinkDown Priority low 0 Priority medium 5 Priority high 10 fmodem line 1 alarmLevel SeverelyErroredSecond low 0 medium 5 high 10 User manual 143 User defining values using the custom txt file TMA CLI 7 4 The sections of the custom txt file This section gives more detailed information on the sections of the custom txt file What is a section The custom txt file is divided into a number of sections Each section consists of a section header followed by a number of definitions lt section gt lt section header gt lt defintition gt Section header syntax The syntax for the section header is lt section header gt IDENTIFIER Section types There are two types of sections Section type common specific This is a common section Hence the name of this section is common All definitions in this section apply if possible to all devices This is a device specific section The name of this section is the name of the top object in the containment tree of the device All definitions in this section apply to one specific device only The top object name can also be found in the second column of the model nms file E g for a Crocus HDSL TT this is crocusHDSLTT for a Crocus DXC this is crocusDxc etc crocusHSCHS crocusHDSLCMS aster 4CHS crocusRouter crocusInvMux crocusInvMux crocusFOM16TT crocusFOM16CU
104. line prompt looks as follows crocusSDSLTT modem Edit Configuration gt If you now select another group for instance Status the command line prompt looks as follows crocusSDSLTT modem Status gt Continued on next page User manual 65 Introducing the containment tree TMA CLI A containment tree example continued Displaying the value of the simple attribute bootFromFlash in TMA CLI results in the following bootFromFlash Auto Displaying the value of the bit string alarmMask in TMA CLI results in the following alarmMask NotResponding enabled AlarmSyncLoss enabled StrapChanged disabled Access disabled RemoteAlarm disabled UnknownState disabled Boot disabled CodeConsistencyFail disabled ConfigConsistencyFail disabled Because this is a bit string it is not possible to display the value of one bit only Displaying the value of the complex attribute in this case a structure alarmLevel in TMA CLI results in the following alarmLevel NotResponding 4 AlarmSyncLoss 4 StrapChanged 1 Access 1 RemoteAlarm 0 UnknownState 0 Boot 1 CodeConsistencyFail ConfigConsistencyFail al 1 As you can see this complex attribute is made up of several simple attributes elements Displaying the value of only one simple attribute or element results in the following alarmLevel NotResponding 4 Continued on next page 66 User man
105. ly lt Struct gt An example of a structure is the attribute alarmLevel table A table has several elements The elements of a table can be simple values complex values or a combination of both You can display these elements separately lt Table gt An example of a table is the attribute security Continued on next page 62 User manual TMA CLI Introducing the containment tree The containment tree terminology continued Groups assemble a set of attributes related by functionality There are four groups configuration status performance alarms An object may have actions assigned to it in a certain group User manual 63 Introducing the containment tree TMA CLI 5 4 A containment tree example Consider the containment tree of a Crocus SDSL TT as an example If we open a TMA session on this device the graphical representation is as follows TMA comirel0 OF x Connect Edit View Tools Help BS S S S clot fig xl Containment tree lcocusSDSLTT crocusSDSLTT EF Configuration Status Performance fi Alarms iS modem aw line ns i v35 E n64 powerOffDetection sysName Crocus SDSL TT No 15 sysContact System administrator Tel 785612 sysLocation Main building Equipment room security lt Table gt bootFromFlash Auto forwardTMAToNMSPort enabled forwardT MAT oLine enabled alarmMask alarmLevel lt Struct gt alarmContactHighM a
106. m administrator Tel 785612 sysLocation Main building Equipment room bootFromFlash Auto alarmMask NotResponding enabled ConfigConsistencyFail disabled SELECT modem LIST tests keyboardET enabled aLDuration 0d Oh 3m Os channel remote SELECT line LIST speed 1152000 bps alarmMask LinkDown disabled Unavailability disabled OK crocusSDSLTT Edit Configuration gt 90 User manual TMA CLI Basic TMA CLI commands e The get s option Use this option to use a filter on a table By doing so you can selectively filter certain rows out of a table Suppose the security table of the Orchid 1003 LAN contains the following values 01003 Edit Configuration gt get security security a password sys admin accessRights ReadAccess on WriteAccess on SecurityAccess on FileSystemAccess on a password sys_tech accessRights ReadAccess on WriteAccess on SecurityAccess off FileSystemAccess on password user accessRights ReadAccess on WriteAccess off SecurityAccess off FileSystemAccess off OK o1003 Edit Configuration gt Suppose you only want to display that line of the security table where the password user is present In that case type the following o1003 Edit Configur
107. m txt file The path continued Indexed objects As you can see in the examples above some objects in the containment tree are indexed e g the objects line 1 line 2 and line 3 of a 3 pair Crocus HDSL As mentioned before the following applies to indexed objects to one of the indexed objects specifically also specify the index number in the path E g modem line 1 alarmLevel LinkDown to all indexed objects just omit the index number in the path E g modem line alarmLevel LinkDown e Omitting the index number of indexed objects is possible for both absolute and relative paths e Including the index number of indexed objects is only possible for absolute paths In other words relative paths with indexed objects are not allowed Example modem line 1 alarmLevel LinkDown gt ALLOWED line 1 alarmLevel LinkDown gt NOT ALLOWED Continued on next page User manual 147 User defining values using the custom txt file TMA CLI The path continued Path priority rules You may have written more than one definition with paths that all refer to the same attribute or element of an attribute Moreover these definitions may appear in the common section and in a device specific section For example modem line 1 alarmLevel LinkDown modem line alarmLevel LinkDown and line alarmLevel LinkDown all apply to the LinkDown element of the alarmLevel attribute Therefore priorities are assigned to
108. mFilter nmsgroup objectTable exitPort portNumber User manual 149 User defining values using the custom txt file TMA CLI 7 5 3 The value list What is a value list Using the value list you actually define the values for the corresponding attribute or element as you want to see them Value list syntax A value list has the following syntax lt value list gt lt string value list gt lt integer value _list gt 7 with lt string value list gt lt string value gt lt string value gt where lt string value gt IDENTIFIER STRING with lt integer value list gt lt integer_value gt lt integer_value gt where lt integer_value gt IDENTIFIER STRING NUM Integer values As mentioned before you can only user define values for integer attribute values A user defined integer value consists of two parts cs a ee The first part is the user defined name There are two ways to encode this name a fer STRING The value starts with a double quote character The end of the string is the next double quote character Within these two delimiters any character is allowed even the character i e it will not be considered as comment The closing double quote should appear before the end of the line Else the string is interpreted incorrectly Example alarmLevel Access level low 0 level high 10 IDENTIFIER The valu
109. management concentrator A management concentrator is a device that collects management information from the network units i e the Telindus devices in the network and passes it to a network management system e g HP OpenView So a management concentrator is situated between the network units and the network management system In other words it is a key element for centralised network management 3 4 2 Which Telindus devices are management concentrators Examples of management concentrator are e the Orchid 1003 LAN the predecessor of the Telindus 1035 Orchid e the Telindus 1031 1032 1033 and 1034 Router note that their management concentrator capabilities are limited due to hardware limitations e the Telindus 1035 Orchid the successor of the Orchid 1003 LAN 3 4 3 A management concentrator as a proxy IP device You can connect a Telindus non IP device e g a Crocus modem to a management concentrator In the management concentrator configuration you can assign an IP address to this non IP device In that case the non P device becomes a proxied IP device l e you can now access the non IP device over an IP network through the management concentrator In other words the management concentrator acts as proxy IP device for the non IP device This implies that as opposed to the management concentrator the non IP device is not directly connected through a dedicated LAN port to the IP network An example of an IP connection bet
110. meOut 12h e 6 days and 55 seconds then type gt set consoleNoTrafficTimeOut 00006d 00h 00m 55s or gt set consoleNoTrafficTimeOut 6d 00h 00m 55s Or gt set consoleNoTrafficTimeOut 6d 55s e etc User manual 115 Basic TMA CLI commands TMA CLI 6 5 7 Setting a choice value A choice value is a value which has two or more possible value types In other words you first have to make a pre selection which determines the value type e g direct editable enumerated bit string structured value etc and then you can edit the value itself The following example clarifies this Suppose you have an attribute bandwidth for which depending on the application you have to specify a speed or timeslots So you first make a selection between the choice value speed or timeslots and then you enter the value you want the corresponding action in TMA is shown under each CLI string e gt set bandwidth speed 128 116 User manual TMA CLI Basic TMA CLI commands 6 5 8 Setting several attribute values at once Setting several attribute values on the current object level In order to set several attribute values at once you have to group the attributes using LIST This is shown in the following example crocusSDSLTT Edit Configuration gt set LIST sysName Crocus SDSL TT central sysContact System Administrator Tel 785612 sysLocation Main Building Equipment Room
111. mload command you can download new firmware to the flash banks of an IP device You can also download other files firmware files of modems configuration files model files etc to the file system of an IP device These files can then be used for software consistency configuration consistency or are just necessary to establish certain connections The following table gives an overview of this section E frem 6 10 1 Downloading new firmware to an IP device 6 10 2 Downloading files to the file system of an IP device 6 10 3 Downloading new firmware to a non IP device You can only download files if you are connected via an IP connection to an IP device not via a serial connection 136 User manual TMA CLI Basic TMA CLI commands 6 10 1 Downloading new firmware to an IP device If you want to update the firmware of an IP device then type the following command memload Txxxxxxx 00 CONTROL where e Txxxxxxx Is the new firmware file that is present on your computer e CONTROL is the destination The destination possibilities are e CONTROL downloads the firmware into the non active flash bank e CONTROL1 downloads the firmware into flash bank 1 e CONTROL2 downloads the firmware into flash bank 2 Example o1003 Edit Configuration gt memload T1042017 00 CONTROL OK o1003 Edit Configuration gt User manual 137 Basic TMA CLI commands TMA CLI 6 10 2 Downloading files to the file system of an IP
112. much simple attribute values on one line as possible get r v Displays the values of the current and all underlying objects and displays the values of a table in rows and columns and separated by the value separator Applies a filter on a table and displays the nested tables get t v Displays the values of a table in rows and columns and separated by the value separator In this case however the nested tables are not displayed Displays the values of a complex attribute value on one line and displays the nested tables get t d Displays only those values that are different from the default or read only values including those in nested tables get r w Displays the values of the current and all underlying objects and displays the values of a complex attribute value on one line 86 User manual TMA CLI Basic TMA CLI commands a The get d option Use this option to display only those values which are different from the default or read only values crocusSDSLTT Edit Configuration gt get d sysName Crocus SDSL TT No 15 sysContact System administrator Tel 785612 sysLocation Main building Equipment room security a password sys admin a password sys_tech accessRights ReadAccess on WriteAccess on SecurityAccess off a password user accessRights ReadAccess on WriteAccess off SecurityAccess off OK cr
113. n next page User manual 27 Connecting to a device TMA CLI nmsgroup objectTable continued Attribute Description port The exit port specifies through which port of the management concentrator the or network unit can be reached exitPort In case of the exitPort attribute the underlying attributes are exitPortType Use this attribute to specify whether the non IP device is reachable through e one of the asynchronous ports of the management concentrator port In this case also set the attribute portNumber the high speed bus of the CN4 Card Nest rack In this case also set the attributes cardnestAddress cardPosition and modem portNumber Use this attribute to specify through which asynchronous port of the management concentrator the non IP device can be reached cardnestAddress Use this attribute to specify the CN4 Card Nest address in which the non IP device Card Version resides cardPosition Use this attribute to specify the position of the non IP device Card Version in the CN4 Card Nest modem Use this attribute to select the device on the non IP multi device Card Version Twin Quad etc A B C or D Once these attributes are set then the computer running TMA CLI is able to reach the non IP device over an IP network G 28 User manual TMA CLI Opening a TMA CLI session 4 Opening a TMA CLI session Once the physical connections are made you are able to open a TMA CLI se
114. ndows 2000 Communication port serial COM port Ethernet card Ethernet card 9600 8 N and or e Ethernet card Networking TCP IP networking TCP IP networking TCP IP networking installed and installed and installed and configured configured configured Additional hardware CD ROM drive CD ROM drive CD ROM drive YD Because the model files delivered with TMA CLI evolve as the devices evolve their size tends to increase with each new release The figures specified in the table above is the size of TMA CLI and the model files as it was when this manual was written For future releases of TMA CLI these figures may be incorrect 8 User manual TMA CLI Installing TMA CLI 2 2 The three installation components of TMA CLI The installation of TMA CLI comprises three components as listed below TMA CLI executable Provides the TMA command line interface Model files Provide per access device type the information TMA CLI needs to connect and exchange information with the access device Enables the use of TMA CLI User manual 9 Installing TMA CLI TMA CLI 2 3 Installing TMA CLI on Windows 95 98 NT 2000 This section explains how to install TMA CLI on the Windows 95 98 NT 2000 platform The installation files of TMA CLI are located on the CD ROM of TMA for HP OpenView In order to install TMA CLI on a Windows 95 98 NT 2000 system proceed as follows Pee oC BES Insert the installation
115. ng 4 Crocus SDSL TT 2 TMA Crocus SDSL Twin In order to reach Crocus SDSL TT 2 through the Crocus SDSL Twin type the following TmaCli coml O R 1 lineB Now also consider the following set up extended CJ 2 link FA RY SRE PC running modem A modem B modem C modem D TMA In order to reach modem D through the modem A type the following TmaCli com2 O R 3 User manual 41 Opening a TMA CLI session TMA CLI 4 2 10 Connecting using absolute addressing and an exit line TmaCli COM lt x gt IP O A lt nms gt LINE lt n gt Use this command to connect to a device located behind another device The addressing method that is used is absolute addressing For more information on relative and absolute addressing refer to the Section 4 3 Relative and absolute addressing Address arguments In case the connection between your computer running TMA CLI and the first device you want to connect through is e adirect connection then specify the COM port of your computer com lt x gt e an IP connection then specify the IP address of the first device lt IP gt Replace A lt nms gt by the absolute address of the remote device you want to reach Replace LINE lt n gt by the line through which you can reach the remote device e A multi device i e a device that incorporates several devices on one card consequently has several different exit lines also called exit port Actually it has as m
116. ng other things sets the environment variables e use the exec command to run the script e are in interactive TMA CLI mode then the environment variables as set in the script are not retained when the script is finished Also refer to the complementary command source Section 8 15 The source command Example Consider the script file status cli containing the command to retrieve the line status from a device get modem line Status From the shell prompt you can execute this script on a Crocus SDSL with IP address 172 31 5 200 TmaCli 172 31 5 200 exec status cli You can also execute the script in interactive mode crocusSDSLTT Edit Configuration gt exec status cli OK crocusSDSLTT Edit Configuration gt get modem line Status GET SELECT modem SELECT line LIST timeSinceLastRetrain Od Oh Om Os lineState idle lineAttenuation 62 0dB noiseMargin 16 0dB ifSpeed 0 ifOperStatus down OK Reference manual 161 The TMA CLI commands TMA CLI 8 8 The get command Syntax GET d f m r s t v w lt specification gt Description The get command retrieves the values of e asimple attribute e acomplex attribute e arow ofa table e an element within a complex attribute e all the attributes in an object e all the attributes in the Edit Configuration group As stated in the syntax
117. nt tree select another group read values set values and perform actions It also shows you how to log your activity This is particularly useful for scripting Furthermore this chapter describes how to import a configuration and how to download new firmware The following table gives an overview of this chapter Browsing through the containment tree 6 1 72 es aetna TTT rom a 6 9 Adding a user instantiatable object Performing actions Scripting Importing a configuration file 135 Downloading files A e TMA CLI commands are not case sensitive whereas their parameters are e Do not confuse CLI with TMA CLI Whereas CLI is a management tool which runs on the Telindus access devices themselves TMA CLI is a program which you have to install on a computer TMA CLI is a more elaborate command line interface with more features and commands then CLI Whereas most of the TMA CLI commands are the same as the CLI commands some commands that exist in TMA CLI do not exist in CLI These commands are exit logging exec cfgload memload and source User manual 71 Basic TMA CLI commands TMA CLI 6 1 Browsing through the containment tree Using the select command you can navigate through the containment tree The destination object is entered as an argument of the select command Depending on the presence or absence of the lt topObject gt at the beginning of the argument we speak of an absolute or a relative path
118. ntinued on next page User manual 79 Basic TMA CLI commands TMA CLI Reading a table continued Reading an element in a structured value in a row of a table Let us now consider the objectTable attribute of the Orchid 1003 LAN Retrieving only one row of this table results in the following 01003 nmsgroup Edit Configuration gt get objectTable 1 objectTable 1 name SDSL TT central centralRemote central configFileName lt OPT gt ipAddress lt OPT gt deviceType cms2 addressType relativ addressValue 0 exitPort exitPortType port portNumber 1 cardnestAddress 0 cardPosition 0 modem A pollTimeOut 3 mapNumber lt OPT gt filter 0 OK 01003 nmsgroup Edit Configuration gt As you can see this row consists of several simple values and one complex value exitPort Because the exitPort value is a structure refer to Section 6 3 2 Reading a structured attribute value you can also display its elements separately So displaying the simple value cardPosition in the complex value exitPort in the first row of the objectTable results in the following 01003 nmsgroup Edit Configuration gt get objectTable 1 exitPort cardPosition objectTable 1 exitPort cardPosition 0 OK 01003 nmsgroup Edit Configuration gt 80 User manual TMA CLI Basic TMA CLI commands 6 3 4 Reading all attribute values of the current obj
119. nual of the modem for more information relative and Relative and absolute addressing can be mixed E g use relative addressing for the absolute modems which are connected in line Use absolute addressing for the modems located after a digital multipoint device digital L neon example V absolute 1 GAT ne css lt example PC running relative 0 relative 1 absolute 2 TMA es example absolute 3 User manual 43 Opening a TMA CLI session TMA CLI 4 4 Connecting using name resolution The Alarm Manager a part of TMA for HP OpenView can act as a name resolution server As an alternative to the connection possibilities explained in Section 4 2 The TMA CLI connection possibilities you can start a TMA CLI session on a Telindus access device using this name resolution feature The following table gives an overview of this section se e Important remarks on name resolution 44 User manual TMA CLI Opening a TMA CLI session 4 4 1 Important remarks on name resolution e As you will see in the following sections name resolution makes use of the sysName and or the name entered in the objectTable of the management concentrator For name resolution to work properly the sysName or objectTable name may not contain white spaces Therefore do not use white space or use for example an underscore character instead E g 01003lan Orchid 1003 LAN crocusHDSL1 etc quotes e ti
120. ocusSDSLTT Edit Configuration gt User manual 87 Basic TMA CLI commands TMA CLI b The get f option Use this option to retrieve the full non default configuration independent of your current location in the containment tree In other words it displays all the attributes that are set to a value different from their default value It also includes the command Load Default Configuration at the beginning and Activate Configuration at the end of the attribute list The attributes on the same level are grouped by LIST and an underlying object is selected by the SELECT command This allows you to use the get command to create scripts You can then use these scripts to easily change identical attributes on other devices of the same type For more information on this matter refer to Section 6 5 9 Setting values obtained with the get command e Executing get is the same as executing get r a when located in the top object of the containment tree e If you want a full configuration i e not only the non default configuration then execute get r when located in the top object of the containment tree crocusSDSLTT modem line Edit Configuration gt get f action Load Default Configuration SET LIST sysName Crocus SDSL sysContact Sys Admin sysLocation Computer Room SELECT modem LIST channel central ECT line L
121. of the third row to their default value then type the following crocusSDSLTT Edit Configuration gt set security 3 OK crocusSDSLTT Edit Configuration gt Alternatively you can use the following syntax crocusSDSLTT Edit Configuration gt set security 1 OK crocusSDSLTT Edit Configuration gt Both notations displayed above result in the following crocusSDSLTT Edit Configuration gt get w security security a password passwl accessRights ReadAccess on WriteAccess on SecurityAccess on 5 a password passw2 accessRights ReadAccess on WriteAccess on SecurityAccess on 4 a password accessRights ReadAccess on WriteAccess on SecurityAccess on 3 a password passw4 accessRights ReadAccess on WriteAccess on SecurityAccess on 5 OK crocusSDSLTT Edit Configuration gt 110 User manual TMA CLI Basic TMA CLI commands d The set d option The following command deletes the third row in the security table crocusSDSLTT Edit Configuration gt set security d3 OK crocusSDSLTT gt Edit Configuration Alternatively you can use the following syntax crocusSDSLTT Edit Configuration gt set security d3 OK crocusSDSLTT Edit Configuration gt For the security table in our ex
122. ol port Hence you can make a direct connection to any of these devices regardless of the fact it is a non IP IP or proxied IP device 3 2 3 DB25 DB9 interconnection cable If the COM port you want to use has a DB25 connector then a different cable has to be used Such a cable has the following layout Female DB25 connector Male DB9 connector for connection towards the computer for connection towards the Telindus device Tee oi BLEE XD XD RTS CTS SR ND DTR a Tam 7 User manual 19 Connecting to a device TMA CLI 3 3 IP connection to an IP device This section explains how to make an IP connection between the computer running TMA CLI and a Telindus IP device The following table gives an overview of this section Psetn OO What is an IP connection To which Telindus devices can you make an IP connection Basic IP device settings to enable an IP connection 20 User manual TMA CLI Connecting to a device 3 3 1 What is an IP connection A connection via IP is a connection between e the LAN port of the IP device and the IP network at one side e the network port of the computer and the IP network at the other side The following figure shows an example of a connection via IP to an Orchid 1003 LAN Table Top and Card Version computer running TMA Table Top Orchid TA T GE a D E D ee amp M HB ha j o A Card Version Orchid As opposed to a direct connection making t
123. on a Windows 95 98 NT 2000 a Sun Solaris and a HP UX system 3 briefly describes how to connect the workstation running TMA CLI with a Telindus device 4 shows you how to open a TMA CLI session on a Telindus device It also says something about the TMA CLI command line prompt and environment variables introduces terms such as containment tree object attribute group etc teaches you the basics of the TMA CLI commands explains how you can user define values for attributes that have an integer as value You can do this using the custom txt file The following table gives an overview of the chapters in the reference manual a restenosis aii WRON ase connie etn Crezee The following table gives an overview of the annexes presents all error codes and their description gives a list of abbreviations shows ordering information tells you how to obtain the required licence key Preface TMA CLI Conventions used in this manual Typographical conventions The following typographical conventions are used in this manual The format is used to indicate Italic e new or emphasised words e file names and directory paths e g C Program Files TMA bin Tma exe computer output and code examples e g NOK 1 1 Invalid command Computer Bold text you have to enter at the prompt e g Get sysName Narrow objects and attributes in the containment tree of a device when they are mentioned in the normal te
124. onfiguration gt memload a T1042017 00 CONTROL1 OK o1003 Edit Configuration gt Reference manual 167 The TMA CLI commands TMA CLI 8 11 The select command Syntax SELECT lt object specification gt SELECT SELECT Description This command allows you to browse through the containment tree of a Telindus device SELECT lt obj ect specification gt go to the specified object There are two possible object specifications e An absolute object specification i e starting from the top object e g crocusSDSLTT modem e A relative object specification i e starting from the current object e g modem line go up one level in the containment tree go to the top object in the containment tree The select command may be used within a structured value assignment using the set command However in this case only a relative object specification is allowed For more information on this subject refer to Section 6 5 8 Setting several attribute values at once and Section 6 5 9 Setting values obtained with the get command Example From the top object to an underlying object crocusSDSLTT Edit Configuration gt select modem line OK crocusSDSLTT modem line Edit Configuration gt 168 Reference manual TMA CLI The TMA CLI commands 8 12 The selgrp command Syntax SELGRP SELGRP lt group name gt
125. ord accessRights ReadAccess on WriteAccess on SecurityAccess on 4 OK crocusSDSLTT Edit Configuration gt Appending a row and setting a value at the same time You can append a new row to a table and set a value in this row at the same time crocusSDSLTT Edit Configuration gt set security a password passw4 OK crocusSDSLTT Edit Configuration gt This results in the following gt get w security security la password accessRights ReadAccess on WriteAccess on SecurityAccess on 5 a password passw4 accessRights ReadAccess on WriteAccess on SecurityAccess on 4 OK crocusSDSLTT Edit Configuration gt User manual 105 Basic TMA CLI commands TMA CLI b The set i option Inserting a row with default values The following example creates a new row before the second row in the security table crocusSDSLTT Edit Configuration gt set security i2 OK crocusSDSLTT Edit Configuration gt Alternatively you can use the following syntax gt set security i2 OK crocusSDSLTT Edit Configuration gt By using the set i command without extra arguments all the values in the newly created row have their default value crocusSDSLTT Edit Configuration gt get w security security la password accessRights
126. ownload model files upgrade Carefully read the licence agreement for Telindus software e f you agree with the terms stated in the agreement then select agree and continue with step 3 e f you do not agree with the terms stated in the agreement then select don t agree Windows For TMA CLI on Windows select the following line TMA part 2 data files rev xxx xxxx Kbyte Save the executable file e g S0011015 exe in a temporary directory on your hard disk For TMA CLI on UNIX select the following line TMA part 2 data files UNIX rev xxx xxxx Kbyte Save the tar file xxx far Z in a temporary directory on your hard disk Windows For TMA CLI on Windows double click on the executable file Follow the instructions that appear on your screen For TMA CLI on UNIX do the following 1 If you downloaded the TAR file on a Windows station the file name suffix has been changed by the browser into _tar Z Transfer the file to a temporary directory on your UNIX workstation and change the file extension again into tar Z Uncompress the file using the command uncompress xxx tar Z Untar the resulting file xxx tar using the command tar xvf xxx tar Execute the install script from the temporary directory 2 The device firmware is backwards compatible with the model files This means that the latest TMA model files support not only the latest firmware version but also all previous firmware versions of the device
127. pe the following TmaCli 12 3 45 100 hdslTT User manual 49 Opening a TMA CLI session TMA CLI c The syntax sysName hardware connection TmaCli lt proxy sysName gt lt hardware connection gt where the hardware connection can be one of the following two Hardware connection Description ied Replace r lt nms gt by the relative address of the device Replace p lt x gt by the asynchronous port number of the management concentrator to which the device is connected R lt nms gt R lt r gt lt p gt lt m gt Replace R lt nms gt by the relative address of the device Replace R lt r gt lt p gt lt m gt by the hardware address of the device The hardware address consists of lt r gt rack address lt p gt position in the CN4 card nest lt m gt device position A B C or D For more information on the hardware address refer to Section 4 2 8 Connecting using relative addressing and a hardware address Note that the hardware connection syntax is different from the syntax used when connecting without name resolution as explained in Section 4 2 The TMA CLI connection possibilities Examples e Suppose you have a Crocus HDSL connected to an Orchid 1003 LAN via port 5 The Crocus HDSL has relative address 2 The Orchid 1003 LAN on its turn is connected to a LAN has an IP address and its sysName 01003 In that case type the following TmaCli 01003 R2P5 e Suppose you have a Croc
128. r c OK aster4 dialler Edit Configuration gt User manual 103 Basic TMA CLI commands TMA CLI 6 5 4 Performing actions on a table with a variable length A variable length table is a table with a variable number of rows This means you can add or remove rows from a variable length table Using the set command you can perform different actions in a variable length table depending on the option The options are explained in the following paragraphs set al Append a row at the end of the table a The set a option page 105 set ix Insert a row in a table before row number x b The set ix option page 106 set x Change a value on row number x of a table c The set x option page 108 set dx Delete row number x from a table d The set dx option page 111 set d Delete all rows from a table e The set d option page 112 104 User manual TMA CLI Basic TMA CLI commands a The set a option Appending a row with default values Suppose the security table of a device is empty Now use the set a command to create a row in the table crocusSDSLTT Edit Configuration gt set security a OK crocusSDSLTT Edit Configuration gt By using the set a command without extra arguments all the values in the newly created row have their default value crocusSDSLTT Edit Configuration gt get w security security la passw
129. relative nms with hardware address COM lt x gt IP 0 R lt nms gt LINE lt n gt relative 016 with exit line 9 3 or A D COon lt x gt IP 0 Az lt nms gt LINE lt n gt absolute 018 with exit line All the different connection options are explained in the following section 30 User manual TMA CLI Opening a TMA CLI session 4 2 The TMA CLI connection possibilities The following table lists once more the different connection possibilities as they are displayed in the TMA CLI help All the different possibilities are explained in the following sections Connection possibility This connection possibility is explained in Section COM lt x gt MODEM lt n gt 4 2 2 Connecting direct and selecting a modem page 33 4 2 4 Connecting to an application page 35 4 2 5 Connecting to a non configured device page 36 4 2 6 Connecting using absolute addressing page 37 COM lt x gt IP R lt nms gt PORT lt p gt 4 2 7 Connecting using relative addressing and an exit port page 38 COM lt x gt IP R lt nms gt RACK lt r gt lt p gt lt m gt 4 2 8 Connecting using relative addressing and a hardware address page 39 COM lt x gt IP O R lt nms gt LINE lt n gt 4 2 9 Connecting using relative addressing and an exit line page 41 COM lt x gt IP O A lt nms gt LINE lt n gt 4 2 10 Connecting using absolute addressing and an exit line page 42 YD If you have TMA for HP OpenView you also have the possi
130. s not possible to use the sysName of a proxied IP device Instead use the sysName of the proxy device i e the management concentrator underscore the name of the proxied device as defined in the object table of the management concentrator In other words lt proxy sysName gt _ lt objectTable name gt e lf the Alarm Manager resides on a remote system it is still possible to use its name resolution feature on your local system You only have to define the remote system its IP address on your local system Use the executable DnsConfigure exe for this purpose Refer to Section 4 4 4 The executable DnsConfigure exe User manual 45 Opening a TMA CLI session TMA CLI 4 4 2 Name resolution syntax for an IP device To start a TMA CLI session on an IP device using name resolution use the following syntax TmaCli lt sysName gt Examples e Suppose you have a Crocus E3 MUX connected to a LAN with an IP address and with sysName e3Mux In that case type the following TmaCli e3Mux e Suppose you have an Orchid 1003 LAN connected to a LAN with an IP address and with sysName Orchid_1003_LAN In that case type the following TmaCli Orchid 1003 LAN 46 User manual TMA CLI Opening a TMA CLI session 4 4 3 Name resolution syntax for a proxied IP device To start a TMA CLI session on a proxied IP device using name resolution you Can use several syntax possibilities The following paragraphs explain the differ
131. sk 000000000 alarmContactLowMask 000000000 gt Activate Configuration gt Load Saved Configuration gt Load Default Configuration gt Cold Boot gt gt gt gt r gt 4 4 b 4 4 m Bit Name Value gt NotResponding enabled gt AlarmSyncLoss enabled gt StrapChanged disabled b Access disabled gt Remotedlarm disabled gt UnknownState disabled gt Boot disabled gt CodeConsistencyF ail disabled gt ConfigConsistencyFail disabled eens The following paragraphs will help you to get acquainted with the containment tree its objects and attributes as they appear in CLI Continued on next page 64 User manual TMA CLI Introducing the containment tree A containment tree example continued If you open a TMA CLI session on this Crocus SDSL TT the initial command line prompt looks as follows crocusSDSLTT Edit Configuration gt This means you are currently in the top object crocusSDSLTT and the group Configuration As you can see in the graphical representation the top object crocusSDSLTT contains e several sub objects E g modem nMS powerOffDetection etc e several attributes with a simple value also called simple attributes E g sysName sysLocation bootFromFlash etc e several attributes with a structured or complex value also called complex attributes E g alarmMask alarmLevel security etc If you select a sub object for instance modem the command
132. ssion on a Telindus device First this chapter explains how to display the help on the TMA CLI connection possibilities Then it describes the different possibilities The following table gives an overview of this chapter Title Displaying help on TMA CLI connection possibilities The TMA CLI connection possibilities Relative and absolute addressing Connecting using name resolution Starting TMA CLI The TMA Comms Handler Defining TMA CLI users and passwords The TMA CLI command line prompt The environment variables User manual 29 Opening a TMA CLI session TMA CLI 4 1 Displaying help on TMA CLI connection possibilities To display a condensed version of the TMA CLI connection possibilities proceed as follows Open a shell program E g MS DOS in the Windows operating system At the prompt type TmaCli Or TmaCli h The following is displayed C gt tmacli h show customer ID show this help show version number HILL first serial device on COM lt x gt 1 4 COM lt x gt MODEM lt n gt specific serial device 8 3 or A D lt IP gt IP device COM lt x gt IP X lt hex string gt application address implicit 6FCF CO0H lt x gt IP RACKSr gt lt p gt lt m gt direct HS bus 8 6 8 14 68 3 or A D C0H lt x gt IP Aaz lt nms gt absolute nms COM lt x gt IP R lt nms gt PORT lt p gt relative nms with exit port 1 14 C0H lt x gt IP R lt nms gt RACK lt r gt lt p gt lt m gt
133. stem IP address gt or DnsConfigure lt remote system name gt In order to remove the path to the remote system then type DnsConfigure undo The DnsConfig file When you execute DnsConfigure exe a DnsConfig file is created in the directory lt TMA_path gt TMA config This file contains the IP address or name of the remote system Typing the DnsConfigure undo command removes the DnsConfig file from your system Example Suppose the Alarm Manager runs on a machine called MainSystem which has IP address 12 0 34 100 Then type at the command prompt of your local system DnsConfigure 12 0 34 100 or DnsConfigure MainSystem 52 User manual TMA CLI Opening a TMA CLI session 4 5 Starting TMA CLI TMA CLI can be started in interactive or non interactive mode from a shell program of the operating system The following table gives an overview of this section Starting TMA CLI in interactive mode Starting TMA CLI in non interactive mode User manual 53 Opening a TMA CLI session TMA CLI 4 5 1 Starting TMA CLI in interactive mode What is interactive mode In interactive mode the user invokes commands to TMA CLI at run time How to start TMA CLI in interactive mode To start TMA CLI in interactive mode start a shell program e g MS DOS in the Windows operating system At the prompt type Tmacli and then enter the necessary address arguments in order to reach the device on which you want to open a
134. te addressing cccccesesesseececeeeeeeeeeeeeseeeeeeceeeeeeeeeecenaneestenenens 43 4 4 Connecting using name resolution 222 cccccceeesesseeceeeeeeeeeeeeeeseneeneceeeeeeeseesenceenseeeeeees 44 45 Starting TMA OE ceca ca ED a tack astach adie coh cu auvema itea ip iaaa iin ide bicesedenta duct ededermcteate 53 4 6 The TMA Comms Hancler cccccccccccccceececeeeeeeeeeeeeeeeeceeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeereeeeeeeeeess 56 4 7 Defining TMA CLI users and passwords cccccceeeeteeeedeeseeeneeseeeeeseensneceesneeeeeeeees 57 4 8 The TMA CLI command line Prompt ccccccceccccccccecceeeeeeeeceeeeeeeeeeeeeeeeeeeeeeeeeseeeeeeetees 58 4 9 The environment Variables cccccccccccecccceceeeceecceeeeceeeceeeeeeceeeeeeeeeeeeceeeeeeeeeeeeeeeeeeeeeeess 59 5 Introducing the containment tree cccccceeeeeeneeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeees 60 5 1 What is a containment tree 0 ce cece cece cece eeeeeeeeeeeeeeeeeeeeee see seeeseeeeseeeeeeeeeeeeeeeeeeeeeees 61 5 2 How is the containment tree structured cccccceeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeseeeseees 61 5 3 The containment tree terminology wie sisccccccccasccteteesscce ees ece tess ceettcnenaddesaudvsi atieewteaweenaue 62 5 4 A containment tree CxAMple ccceccee cece cece eeeeeeeeeeeeee cece tees eee sees eeeeeeeeeeeeeeeeeeneeeeeeeeees 64 Continued on next page vii Table of contents TMA CLI Tab
135. te or element through the containment tree of a device Path syntax A path has the following syntax lt absolute path gt lt object name index gt lt relative path gt lt object name gt with lt object name index gt IDENTIFIER NUM IDENTIFIER lt object name gt IDENTIFIER Path types There are two types of paths cs eee absolute An absolute path starts with a character and specifies the full path to an object and so to an attribute or element This means the definition applies to one specific object of the containment tree Example modem line 1 alarmLevel LinkDown In this example the definition only applies to the LinkDown element of the alarmLevel attribute in the object line 1 The definition does not apply to the LinkDown element in the object line 2 or line 3 relative A relative path starts with the name of an object followed by a character and followed by another object or an attribute or element This means the definition applies to every object in the containment tree with this name and containing the attribute or element Example line alarmLevel LinkDown In this example the definition applies to the LinkKDown element of the alarmLevel attribute in all line objects l e the objects line 1 line 2 and line 3 Continued on next page 146 User manual TMA CLI User defining values using the custo
136. th the environment variables you can control the following LINES This variable controls the number of lines that are visible on the 24 terminal COLS This variable controls the number of characters that are put on a line The value ranges from 80 up to 512 If you enter a number outside this range the CoLs value is set to the nearest extreme of the range being 80 or 215 This variable only has an impact on the output not on the input The input solely depends on the maximum line length that TMA CLI can parse being 512 This variable is not used in the get v command EPARATOR This value defines the value separator character This character is used when retrieving a table with the get v command You can specify any character How to change the environment variables Using the command setenv you can also change the value of an environment variable For example gt setenv LINES 50 OK User manual 59 Introducing the containment tree TMA CLI 5 Introducing the containment tree This chapter explains what the containment tree of a device is It also introduces terms such as object attribute simple value structured or complex value etc At the end it gives an example of a containment tree and how it looks like in TMA CLI The following table gives an overview of this chapter am e O i 6 1 1 60 User manual TMA CLI Introducing the containment tree 5 1 What is a conta
137. the first field For example 2 card position Also the position of the card in the card nest has to be known for addressing purposes The card slot range goes from 0 up to 14 Check the position of the card in the card nest Enter it in the second field For example 12 m modem If you want to address a certain device on a multi device you have to specify which device you want to address device A B C or D Verify which device you want to address Enter it in the third field For example B Suppose you want to connect to modem B of a Crocus FO10M CV Twin that is inserted on position 5 of a card nest CN4 The card nest has card nest address 3 and is under control of an Orchid 1003 LAN that has IP address 10 0 11 1 In that case type the following TmaCli 10 0 11 1 rack3 5 B Example 36 User manual TMA CLI Opening a TMA CLI session 4 2 6 Connecting using absolute addressing TmaCli COM lt x gt IP A lt nms gt Use this command to connect through a management concentrator to a device that has an absolute address For more information on relative and absolute addressing refer to the Section 4 3 Relative and absolute addressing Address arguments In case the connection between your computer running TMA CLI and the management concentrator you want to connect through is e adirect connection then specify the COM port of your computer com lt x gt e an IP connection then specify the IP address of the manag
138. the get command has two basic formats e The first format can be used to retrieve values of a device in such a way that the result can be used as a base for creating a set command e The second format retrieves the values from a table and will produce an output that can be used to be imported in a spreadsheet This kind of output format can not be used as a base for creating a set command Depending on the kind of lt specification gt the get command gives a different output Get with no specification the values of the attributes within the selected object and the selected group an object specification the values of the attributes within the specified object and the selected or specified group an attribute specification the value of the specified attribute an element specification the value of the specified element within a complex attribute a row specification the value of the specified row of the attribute i e table Continued on next page 162 Reference manual TMA CLI The TMA CLI commands The get command continued Options Adding options to the get command allows you to format the output The option Results in showing only those values that are different from the default or read only values the full non default configuration including the actions Load Default Configuration and Activate Configuration respectively at the beginning and the end of the list as much simple attri
139. to a number of sections Each section consists of a section header followed by a number of definitions For more information on sections refer to Section 7 4 The sections of the custom txt file definition One section can contain one or several definitions With these definitions you create the user defined values For more information on definitions refer to Section 7 5 The definitions of the custom txt file comment Everything that is typed after a character is considered as comment until the end of the line This allows you to add personal comments to clarify the custom txt file Example The following figure shows an example of the structure of a custom txt file section section header comment definition ISP Tel 784512 Helpdesk Tel 1100 SysAdmin alarmMFilter lowSenseFilter 0 mediumSenseFilter 5 highSenseFi lt i 01003 nmsgroup objectTable name HDSL CY Central x HDSL TT Central x HDSL TT Remote x nmsgroup objectTable configFileHame HDSLCYCentral cms HDSLTTCentral cms HDSLTTRemote cms deviceSoftware downloadTable name HDSL CY Central x HDSL TT Central x HDSL TT Remote x deviceSoftware downloadTable sourceFile T1234567 00 T9876543 00 T9638527 00 crocusHDSLTT The definition of the LinkDown alarm applies on both lines The definition of the SeverelyErroredSecond alarm applies on line 1 only
140. ual TMA CLI Introducing the containment tree A containment tree example continued If you switch to the Performance group and go to the modem object the graphical representation in TMA is as follows TMA comtrel0 OF x Connect Edit View Tools Help Ses 5 5 olal fka x Containment tee ecrocusSDSLTT modem 222 ey Configuration amp Status Performance lt Alarms a crocusSDSLTT E E modem i line CI nas errorCount h2TimeSinceLastU pdate 00000d 00h 04m 26s O 35 ETUER i h2Modem ey A n64 h24TimeSinceLastUpdate 00000d 01h 19m 26s oe QO powerOffDetection h24Modem lt Table gt modem lt Struct gt gt Test Activation testActivationType NO test gt Force Full Retrain 7 h2Modem 120min gt 105min 00000d 00h 15m 00s 105min gt 30min 00000d 00h 15m 00s 90min gt 75min 00000d 00h 15m 00s 75min gt 60min 00000d 00h 15m 00s 6Omin gt 45min 00000d 00h 15m 00s 45min gt 30min 00000d 00h 15m 00s 30min gt 15min 00000d 00h 15m 00s 15min gt Omin 00000d 00h 15m 00s E The command line prompt now looks as follows b1 E2 3 b4 p 5 gt 6 b7 p 8 crocusSDSLTT modem Performance gt Continued on next page User manual 67 Introducing the containment tree TMA CLI A containment tree example continued The TMA window on the previous page displays the h2Modem attribute This is a complex attribute more specifically a table D
141. uct name Description 156688 TMA CLI WINDOWS NT Command Line Interface application for WINDOWS NT 3 years Maintenance contract for TMA HP OV mandatory 156687 TMA CLI SUN SOLARIS Command Line Interface application for SUN SOLARIS 3 years Maintenance contract for TMA HP OV mandatory E 169442 MANUAL TMA CLI Manuals are delivered with the product in electronic format CD ROM for environmental reasons If however a hardcopy print out of the manual is required this sales item can be used Between brackets an indication of the language The following table displays the product information on the maintenance contracts for TMA CLI and related products Sales code Product name Description 163135 TMA_CLI MAINT CONTRACT 3Y Yearly maintenance contract for TMA_CLI with a minimum duration of 3 years 163131 TMA_HP OV ENTRY LEVEL TMA_CLI Yearly maintenance contract for TMA_HP OV Entry Level MAINT CONTRACT 3Y Versions combined with TMA_CLI with a minimum duration of 3 years 163133 TMA_HP OV UNLIMITED TMA_CLI Yearly maintenance contract for TMA_HP OV Unlimited MAINT CONTRACT 3Y Versions combined with TMA_CLI with a minimum duration of 3 years Annexes 191 Annex D licence key request TMA CLI Annex D licence key request In order to obtain the required licence key do one of the following e send a fax to 32 16 382515 e send an email to productinfo telindus be Which information has to be supplied The fax or the em
142. uration gt get t pathTable pathTable a name demo description demo sections a description lt OPT gt endPointl device Orchid ShdslCvLeftModemB interface g703 bandwidth pdh endPoint2 device Orchid ShdslCvRightModemB interface v35 bandwidth speed 4 Nx64K type active OK pathman paths Edit Configuration gt 94 User manual TMA CLI Basic TMA CLI commands g The get v option Use this option to display the values of a table in rows and columns and separated by the value separator The first row of the output table represents the value names The used value separator depends on the environment variable VALUESEPARATOR refer to Section 4 9 The environment variables As default it is a lt tab gt Suppose the exitPortNoObjects status attribute of the Orchid 1003 LAN contains the following values 01003 nmsgroup Status gt get exitPortNoObjects exitPortNoObjects 1 cardnestAddress 0 cardPosition 3 modem A 2 cardnestAddress 0 cardPosition 3 modem B 3 cardnestAddress 0 cardPosition 3 modem C 4 cardnestAddress 0 cardPosition 3 modem D OK 01003 nmsgroup Status gt Displaying these values with the get v command results in the following 01003 nmsgroup Status gt get v exitPortNoObjects cardnestAddress
143. uration i e only those values that differ from the default values e The action Load Default Configuration at the beginning of the file e The action Activate Configuration at the end of the file action Load Default Configuration SET LIST sysContact Admin Tel 785612 sysLocation Equipment Room security a password sys admin bootFromFlash Flash 2 SELECT modem LIST tests detectRDL disabled hannel central Q SELECT line LIST speed 512000 bps SELECT nMS SELECT powerOffDetection action Activate Configuration Continued on next page User manual 125 Basic TMA CLI commands TMA CLI Creating a script file starting from a configured device continued Run the script on the different Crocus SDSL TTs using the execute command You can do this either in interactive or non interactive mode Mode Script execution interactive mode Open a TMA CLI session on the Crocus SDSL TT and execute the script cli file crocusSDSLTT Edit Configuration gt exec script cli OK crocusSDSLTT Edit Configuration gt disconnect non interactive mode Execute the script cli file from the DOS shell prompt TmaCli lt address arguments gt exec script cli Examples TmaCli coml exec script cli TmaCli 10 0 11 1 exec script cli
144. us HDSL connected to an Orchid 1003 LAN via the high speed bus of the CN4 card nest The CN4 card nest has address 1 the Crocus HDSL is in position 6 and you want to reach modem B The Crocus HDSL has relative address 1 The Orchid 1003 LAN on its turn is connected to a LAN has an IP address and its sysName 01003 In that case type the following TmaCli 01003 R1IR1 6 B 50 User manual TMA CLI Opening a TMA CLI session d The syntax IP address hardware connection TmaCli lt proxy IP gt lt hardware connection gt Refer to Paragraph c The syntax sysName hardware connection for the explanation of the hardware connection parameter Example Suppose you have a Crocus HDSL connected to an Orchid 1003 LAN via port 5 The Crocus HDSL has relative address 2 The Orchid 1003 LAN on its turn is connected to a LAN and has IP address 12 3 45 100 In that case type the following TmaCli 12 3 45 100 R2P5 User manual 51 Opening a TMA CLI session TMA CLI 4 4 4 The executable DnsConfigure exe What does this executable do It is possible that the Alarm Manager resides on a remote system Even in that case it is possible to use its name resolution feature on your local system Enable this by configuring the IP address of the remote system on your local system Use the executable DnsConfigure exe for this purpose The DnsConfigure exe syntax The DnsConfigure exe syntax is as follows DnsConfigure lt remote sy
145. us be with the following information Select the component s you would like to install the serial number you can find this on the CD ROM label Typing a number will change the corresponding component this station s IP address nat needed for TmaCli If you have made all necessary changes press c to continue y You will then receive a customer number and a licence key Executable files and Model files n 2 Licence key y lt To enable this product you must enter the following Continue information Quit Customer ID g Licence key Installing licence key se enter your Customer ID 1234 Please enter your licence key I lt Back Nest gt Cancel 12 User manual TMA CLI Installing TMA CLI 2 6 How to upgrade the model files The installation of the model files may occur separately from the TMA CLI executable installation This because the model files evolve as the devices evolve The model files delivered on the CD ROM correspond to the latest firmware version of the Telindus access devices at the creation time of the CD ROM If at a later time you want to add devices with a more recent firmware version a re installation of the model files of these devices may be required To download and install the most recent model files proceed as follows Go to the Telindus web site at http www telindusproducts com and select Products gt Maintenance amp Management gt TMA for HP OpenView gt D
146. value gt lt struct_value gt Horizontal ellipsis indicate that some portion of the code has been omitted Preface TMA CLI Software version This manual describes the features of TMA CLI version S0106 01100 Your feedback Your satisfaction about this purchase is an extremely important priority to all of us at Telindus Accordingly all electronic functional and cosmetic aspects of this new unit have been carefully and thoroughly tested and inspected If any fault is found with this unit or should you have any other quality related comment concerning this delivery please submit the Quality Comment Form on our web page at http www telindusproducts com quality vi TMA CLI Table of contents Table of contents User MANU A no ieee asd oct eects Ses kee eek etd ee ee 1 1 Introduction to TMA CLl ccccceeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeaeeeeeeeeeeeeaaaeeeeeeeeeeseeeenaes 3 Tidy Whatis EIA CU eea aaa AAE EREE ERE O eE EIEEE EAA EEEO AATE a deinen 4 1 2 Which features has TMA CLI cccccccecccccccccceecceeeceeeeeeeeeeeeeeeeeeeeeeeceeeeeeeeseeeeeeeseneeeeetenes 5 1 3 Wiel IS a licence KYS aar a aa araa aubenidetandahanietoessareetepncalene 6 2 Installing TMA CEN ose ces ede ceca cece aac peepee agenda nena needed 7 2 1 System requirements 62k autos neds sene Er E LENE ERE FEE ESSEN NANNA ERNE debs ikete esena aes 8 2 2 The three installation components of TMA CLl cccecccecececcceeccceeec
147. ween the computer running TMA CLI and a non IP device is given in the following paragraph User manual 25 Connecting to a device TMA CLI 3 4 4 A proxied IP connection to a non IP device example Consider the following components which have to be interconnected e the computer running TMA CLI e the IP network e a CN4 card nest e a Card Version modem e a Card Version Orchid 1003 LAN The following figure shows the interconnection between these components Card Version modem HB re Bimini C 00000000 nad m m LIL TER T or a m RE The following table gives an overview of the connections shown in the figure above The overview starts at the computer running TMA CLI network port of the computer IP network an RJ45 network cable TPI TPI port of the Orchid 1003 LAN of the Orchid 1003 LAN IP 1P network an an RJ45 network cable network cable e port of the Orchid 1003 o port of the CN4 card nest a SS EEE RJ45 cable NMS port of the CN4 card nest high speed NMS bus of the the high speed NMS bus on the Card Version modem backplane of the CN4 card nest As opposed to a direct connection making the physical connection alone is not sufficient to establish a proxied IP connection between the computer and the non IP device A few basic settings have to be made in the Orchid 1003 LAN These are shown in the following paragraph 26 User manual
148. xt l e when they are not a part of computer input or output Blue references to other parts in the manual e g refer to Chapter xx Technical specifications Blue underlined a hyperlink to a web site e g http www telindus com Icons The following icons are used throughout the manual ar em Teen Useful information or tips a Read the text that follows carefully in order to insure correct operation Continued on next page TMA CLI Preface Conventions used in this manual continued Command syntax symbols The following symbols are used for describing the syntax of TMA CLI commands Angle brackets Square brackets Parentheses Curled brackets Production symbol Disjunction symbol delimit composed literal strings that have to be interpreted as one string e g Edit Configuration delimit literal strings representing a parameter e g lt object specification gt delimit optional items e g get r recursive get group items in a simple value specification whereof you have to select only one item g a b can be a or b group items in a complex value specification select one or more items e g a bp can be a b ab declare production rules e g lt value specification gt lt simple value specification gt lt complex value specification gt combine several options from which you can choose e g lt value gt lt simple
149. y data However because you created no TMA user with corresponding password you will still get the following message Warning Using empty password User manual 57 Opening a TMA CLI session TMA CLI 4 8 The TMA CLI command line prompt This section introduces the TMA CLI command line prompt Syntax The TMA CLI command line prompt syntax is as follows lt list_of object names gt lt group name gt s gt The prompt elements As you can see the command prompt has the following elements am OOOO oen OOO O e absolute path Lists the currently selected object starting from the top crocusSDSLTT modem object The sub objects are separated by a Separates the absolute path from the group name ed group name Shows which group is currently selected Edit Configuration Edit Configuration Status Performance Alarms Example crocusHDSLCV modem line 1 Status gt 58 User manual TMA CLI Opening a TMA CLI session 4 9 The environment variables What are the environment variables The environment variables control the output behaviour of TMA CLI How to display the environment variables Using the command setenv you can list the environment variables and their corresponding value gt setenv SETENV LINES 24 SETENV COLS 80 SETENV VALUESEPARATOR I OK What can you control with the environment variables Wi

Download Pdf Manuals

Related Search

Related Contents

新生青銅聖衣  P5T30-B4 MAINBOARD User`s Manual  Hardware User Manual  Alcatel-Lucent OS6250-CBL-30  ENFit Brochure - Nutricia ENFit  English  NB6L11MMNGEVB Evaluation Board User`s Manual  Hardware AZ Analog Drives - Advanced Motion Controls  YETI TANDEM マニュアル BEETLE マニュアルと合わせてお読みください  電子書籍アワード受賞社に聞くアプリ制作の実際  

Copyright © All rights reserved. Failed to retrieve file