Cisco Systems OL-5742-01 manual

C-1 Cisco Signaling Gateway Manager User Guide OL-5742-01 APPENDIX C SGM Command Reference This appendix pro vides the format and a brief description of the follo win g SGM commands, listed alphabet ically . Each comma n d is av ailable in both Solaris and W indows, ex cept as indicated. • sgm, page C-7 • sgm ?, page C-7 • sgm accstats, page [...]

Appendix C SGM Command Reference C-2 Cisco Signaling Gateway Manager User Guide OL-5742-01 • sgm cleandb, page C-19 • sgm cleandisco ver , page C-20 • sgm cliconntimer , page C-21 • sgm client, pa ge C-22 • sgm clientlo gs, page C- 22 • sgm clitimeout, page C- 23 • sgm cmdlog, page C-24 • sgm console, page C-24 • sgm countas, pa g[...]

C-3 Cisco Signaling Gateway Manager User Guide OL-5742-01 Appendix C SGM Command Reference • sgm gttcli ent, page C-37 • sgm gttdir, page C-37 • sgm gttstats, page C-39 • sgm help, page C -41 • sgm inacti veuserday s, page C-42 • sgm installlog, page C-43 • sgm iosinfo, pag e C-43 • sgm ipaccess, page C-44 • sgm jspport, page C-45[...]

Appendix C SGM Command Reference C-4 Cisco Signaling Gateway Manager User Guide OL-5742-01 • sgm newle vel, page C-62 • sgm passwordage, page C-63 • sgm patchlog , page C-64 • sgm pcformat, page C-64 • sgm pclist, page C-65 • sgm poll, page C-66 • sgm pollertimeout, page C-66 • sgm print, page C-67 • sgm props, page C-67 • sgm p[...]

C-5 Cisco Signaling Gateway Manager User Guide OL-5742-01 Appendix C SGM Command Reference • sgm setpath, pa ge C-82 • sgm snmpcomm, page C-84 • sgm snmpconf, page C-84 • sgm snmpget, page C-85 • sgm snmphelp, page C-88 • sgm snmpnext, page C-89 • sgm snmpwalk, page C-92 • sgm sounddir , page C-96 • sgm ssl, page C-98 • sgm ssls[...]

Appendix C SGM Command Reference C-6 Cisco Signaling Gateway Manager User Guide OL-5742-01 • sgm statreps nullcaps, page C-111 • sgm statreps servratio, page C-112 • sgm statreps status, page C-112 • sgm statreps timemode, page C-11 3 • sgm statreps timer , page C-113 • sgm statreps utilrat io, page C-114 • sgm statreps xua, page C-11[...]

C-7 Cisco Signaling Gateway Manager User Guide OL-5742-01 Appendix C SGM Command Reference sgm • sgm webaccesslog, page C-128 • sgm weberrorlog, page C-129 • sgm weblogupdate, page C-129 • sgm webnames, page C-130 • sgm webport, page C -131 • sgm webu til, page C-131 • sgm who, page C-132 • sgm xtermpath, page C-132 • sgm xuastats[...]

Appendix C SGM Command Reference sgm accstats C-8 Cisco Signaling Gateway Manager User Guide OL-5742-01 List of SGM Commands • SGM Command Reference, page C-1 . sgm accstats Solaris Only Full S yntax sgm accstats [ node-list [ id-tag ]] [ sort-option ] [ quiet ] Command Description Generates SGM accounting statistics repor ts for links and linkse[...]

C-9 Cisco Signaling Gateway Manager User Guide OL-5742-01 Appendix C SGM Command Reference sgm accstats If you specify a node-lis t , you can also specify an id-tag to identify the reports. The id-tag can be any meaningful character string, but it cannot contain any spaces. The default v alue for id-tag is the process ID of the sgm accstats command[...]

Appendix C SGM Command Reference sgm adduser C-10 Cisco Signaling Gateway Manager User Guide OL-5742-01 List of SGM Commands • SGM Command Reference, page C-1 . sgm adduser Solaris Only Full S yntax sgm adduser [ username ] Command Description If SGM User-Based Access is enabled, adds the specified user to the authentic ation list. When you add a[...]

C-11 Cisco Signaling Gateway Manager User Guide OL-5742-01 Appendix C SGM Command Reference sgm authtype List of SGM Commands • SGM Command Reference, page C-1 . sgm authtype Solaris Only Full S yntax sgm authtype [ local | solaris ] Command Description Config ures SGM security authenticati on, as follo ws: • local —Allows creation of user ac[...]

Appendix C SGM Command Reference sgm backup C-12 Cisco Signaling Gateway Manager User Guide OL-5742-01 sgm backup Solaris Only Command Description Backs up SGM data files to the SGM installat ion directo ry . SGM auto matically backs up all data f iles at 1:30 AM each night, b ut you can use this command to back up the f iles at an y other time. ?[...]

C-13 Cisco Signaling Gateway Manager User Guide OL-5742-01 Appendix C SGM Command Reference sgm badloginalarm If you specify a ne w directory that does not exist, SGM do es not change the directory , and issues an appropriate message. Y ou must be logged in as th e root user or as a super user to use this command. List of SGM Commands • SGM Comma[...]

Appendix C SGM Command Reference sgm badlogindisa ble C-14 Cisco Signaling Gateway Manager User Guide OL-5742-01 List of SGM Commands • SGM Command Reference, page C-1 . sgm badlogindisable Solaris Only Full S yntax sgm badlogindisable [ number -of-attempts | clear ] Command Description If SGM User-Based Access is enabled, num be r of unsuccessfu[...]

C-15 Cisco Signaling Gateway Manager User Guide OL-5742-01 Appendix C SGM Command Reference sgm browserpath sgm browserpath Solaris Only Command Description Sets a user-def ined SGM W eb bro wser pa th, and verifies that the browser specified b y the user exists. Y ou must be logged in as the root u ser (not as a super user) to use this command. Li[...]

Appendix C SGM Command Reference sgm certtool C-16 Cisco Signaling Gateway Manager User Guide OL-5742-01 sgm certtool Full S yntax sgm certtool [ clear | delete alias | export alias [ -f ile filename ] | import alias [ -file fil e na m e ] | list ] Command Description If Secure Sockets Layer (SSL) i s imple mented in your SGM system, enable s you t[...]

C-17 Cisco Signaling Gateway Manager User Guide OL-5742-01 Appendix C SGM Command Reference sgm changes sgm changes Solaris Only Command Description Displays th e contents of th e SGM CHANG ES file. The CHANGES file lists all bugs that hav e been resolved in SGM, so rted by release, from the current release back to Rele ase 2.2. • If you installe[...]

Appendix C SGM Command Reference sgm checkroute C-18 Cisco Signaling Gateway Manager User Guide OL-5742-01 sgm checkroute Solaris Only Full S yntax sgm checkroute [ -l l ogf ilename ] fil ename signalingp ointname Command Description Checks the semantics and syntax of the spec ified route table file on the specified signaling po int. T o write deta[...]

C-19 Cisco Signaling Gateway Manager User Guide OL-5742-01 Appendix C SGM Command Reference sgm cleanall sgm cleanall Solaris Only Command Description Remove s all SGM data from the SGM server , including message log fi les, backup files, repo rt fil es, configurati on settin gs, and security sett ings. This command restores the SGM serv er to a ?[...]

Appendix C SGM Command Reference sgm cleandiscover C-20 Cisco Signaling Gateway Manager User Guide OL-5742-01 List of SGM Commands • SGM Command Reference, page C-1 . sgm cleandiscover Solaris Only Full S yntax sgm cleandiscover [ seed-node ] [ seed-node ]... Command Description Enables you to delete all cu rrent network data and begin a cle an d[...]

C-21 Cisco Signaling Gateway Manager User Guide OL-5742-01 Appendix C SGM Command Reference sgm cliconntimer sgm cliconntimer Solaris Only Full S yntax sgm cliconntimer [ number-of-seconds | clear ] Command Description Specif ies ho w long, in seconds, an SGM client is to w ait for a message from the SGM server before e xiting. If the timer e xpire[...]

Appendix C SGM Command Reference sgm client C-22 Cisco Signaling Gateway Manager User Guide OL-5742-01 sgm client Solaris Only Full S yntax sgm client [ hostname ] Command Description Starts an SGM client on the specif ied host. If no host name is sp ecified, starts an SGM client on the def ault host, as speci fied dur ing instal lation. See the ?[...]

C-23 Cisco Signaling Gateway Manager User Guide OL-5742-01 Appendix C SGM Command Reference sgm clitimeout List of SGM Commands • SGM Command Reference, page C-1 . sgm clitimeout Solaris Only Full S yntax sgm clitimeout [ number-of-m inutes | clear ] Command Description Specif ies ho w long, in minutes, an SGM client can be inacti ve before being[...]

Appendix C SGM Command Reference sgm cmdlog C-24 Cisco Signaling Gateway Manager User Guide OL-5742-01 sgm cmdlog Solaris Only Full S yntax sgm cmdlog [ clear | -r ] Command Description Uses P A GER to display the contents of the system command log. The system command log lists all sgm commands that hav e been entered for the SGM server , the time [...]

C-25 Cisco Signaling Gateway Manager User Guide OL-5742-01 Appendix C SGM Command Reference sgm countas sgm countas Solaris Only Command Description Displays a count of application serv ers in the current SGM database. Y ou must be logged in as th e root user or as a super user to use this command. List of SGM Commands • SGM Command Reference, pa[...]

Appendix C SGM Command Reference sgm countlinks C-26 Cisco Signaling Gateway Manager User Guide OL-5742-01 List of SGM Commands • SGM Command Reference, page C-1 . sgm countlinks Solaris Only Command Description Displays a count of links i n the current SGM database. Y ou must be logged in as th e root user or as a super user to use this command.[...]

C-27 Cisco Signaling Gateway Manager User Guide OL-5742-01 Appendix C SGM Command Reference sgm countobjects Y ou must be logged in as th e root user or as a super user to use this command. List of SGM Commands • SGM Command Reference, page C-1 . sgm countobjects Solaris Only Command Description Displays a co unt of all object s in the current SG[...]

Appendix C SGM Command Reference sgm countsgmp C-28 Cisco Signaling Gateway Manager User Guide OL-5742-01 sgm countsgmp Solaris Only Command Description Displays a count of signaling gate way mated pairs in the current S GM database. Y ou must be logged in as th e root user or as a super user to use this command. List of SGM Commands • SGM Comman[...]

C-29 Cisco Signaling Gateway Manager User Guide OL-5742-01 Appendix C SGM Command Reference sgm delete sgm delete Solaris Only Full S yntax sgm delete [ all | node [ all | node [ node ]...] | sp [ all | poin t-code : net [ point-code : net ]...] | linkset [ all | node / linkset [ node / linkset ]...] Command Description Deletes objects from the SGM[...]

Appendix C SGM Command Reference sgm deluser C-30 Cisco Signaling Gateway Manager User Guide OL-5742-01 sgm deluser Solaris Only Full S yntax sgm deluser [ username ] Command Description If SGM User-Based Access is enabled, deletes the specif ied user from the authentication list . T o add the user back to the list, use the sgm adduser command. See[...]

C-31 Cisco Signaling Gateway Manager User Guide OL-5742-01 Appendix C SGM Command Reference sgm disableuser If sgm authtype is set to sola ris , you can not use this command. Inst ead, you must manage passwords on the e xternal authentication serv ers. See the “Manually Disabling Users and Pass words (Solaris Only)” section on page 18-14 for mo[...]

Appendix C SGM Command Reference sgm discover C-32 Cisco Signaling Gateway Manager User Guide OL-5742-01 List of SGM Commands • SGM Command Reference, page C-1 . sgm discover Solaris Only Full S yntax sgm discover [ seed-node ] [ seed-node ]... Command Description Enables you to discover the ITP network from the command line. Use the seed-node ar[...]

C-33 Cisco Signaling Gateway Manager User Guide OL-5742-01 Appendix C SGM Command Reference sgm enableuser sgm enableuser Solaris Only Full S yntax sgm enableuser [ username ] Command Description If SGM User-Based Access is enabled, re-enables the specified user’ s authentication, whi ch had been disabled either automati cally b y SGM or by a sup[...]

Appendix C SGM Command Reference sgm eventeditor C-34 Cisco Signaling Gateway Manager User Guide OL-5742-01 sgm eventeditor Solaris Only Full S yntax sgm ev enteditor [ hostname ] Command Description Starts an SGM Ev ent Conf igurator on the specif ied host. If no host name is specified, starts an SGM Ev ent Configurat o r on the default ho st, as [...]

C-35 Cisco Signaling Gateway Manager User Guide OL-5742-01 Appendix C SGM Command Reference sgm evilstop List of SGM Commands • SGM Command Reference, page C-1 . sgm evilstop Solaris Only Command Description Forcefully stops all SGM servers on the local host. This c omma nd can be us eful if a norm al sgm stop does not stop the serv ers. Y ou mus[...]

Appendix C SGM Command Reference sgm fontstyle C-36 Cisco Signaling Gateway Manager User Guide OL-5742-01 • sgmp —Exports only signali ng gate way mated p air data. • sps —Exports only signaling p oint data. Y ou must be logged in as th e root user or as a super user to use this command. List of SGM Commands • SGM Command Reference, page [...]

C-37 Cisco Signaling Gateway Manager User Guide OL-5742-01 Appendix C SGM Command Reference sgm gttclient sgm gttclient Solaris Only Full S yntax sgm gttclient [ hostname ] Command Description Starts an SG M GTT client on th e specified host. If n o host name is sp ecified, starts an SGM GTT client on the default host, as specified during in stalla[...]

Appendix C SGM Command Reference sgm gttdir C-38 Cisco Signaling Gateway Manager User Guide OL-5742-01 The default GTT St aging Directory is located i n the SGM installation directory : • If you installed SGM i n the defau lt directory , /o pt , then the directory is /opt/CSCOsgm /gtt . • If you instal led SGM in a dif ferent direct ory , then [...]

C-39 Cisco Signaling Gateway Manager User Guide OL-5742-01 Appendix C SGM Command Reference sgm gttstats After you change the directory , or enable TFTP file transfer for the directory , SGM asks if you wa nt to restart the SGM server . The ne w directory and TFTP setting take ef fect when you restart the SGM server . Y ou must be logged in as th e[...]

Appendix C SGM Command Reference sgm gttstats C-40 Cisco Signaling Gateway Manager User Guide OL-5742-01 – T o include or exclude object s based on the contents of the user -defined nodes.include , linksets.include , nodes.exclu de , and linksets.exclude fil es , create the files, then specify default . This is also the def ault setting for this [...]

C-41 Cisco Signaling Gateway Manager User Guide OL-5742-01 Appendix C SGM Command Reference sgm help Thereafter , you need only enter this command once to generate the r eport. See the “Generating and V iewing Custom SG M Statistics Reports” section on page 15-113 for more information on t he use of this command. Y ou must be logged in as th e [...]

Appendix C SGM Command Reference sgm inactiveuserdays C-42 Cisco Signaling Gateway Manager User Guide OL-5742-01 sgm inactiveuserdays Solaris Only Full S yntax sgm inactiv euserdays [ number -of-days | clear ] Command Description If SGM User-Based Access is enabled, number of days a user can be inacti ve before disabling that user account. This fun[...]

C-43 Cisco Signaling Gateway Manager User Guide OL-5742-01 Appendix C SGM Command Reference sgm installlog sgm installlog Solaris Only Full S yntax sgm installlog [ server | client ] Command Description Displays th e latest inst all log for t he server or client . If you do no t specify serv er or client , displays the lat est install lo g for both[...]

Appendix C SGM Command Reference sgm ipaccess C-44 Cisco Signaling Gateway Manager User Guide OL-5742-01 sgm ipaccess Solaris Only Full S yntax sgm ipaccess [ add [ ip-addr ] | clear | edit | list | rem [ ip-addr ] | sample ] Command Description Enables you to create and manage a list of client IP addresses allowed to connect to the SGM ser ver . T[...]

C-45 Cisco Signaling Gateway Manager User Guide OL-5742-01 Appendix C SGM Command Reference sgm jspport sgm jspport Solaris Only Full S yntax sgm jspport [ port-number ] Command Description Sets a ne w port number for the JSP server , where port-number is the ne w , numeric port number . SGM verifies that the ne w port number is not already in use.[...]

Appendix C SGM Command Reference sgm killclients C-46 Cisco Signaling Gateway Manager User Guide OL-5742-01 Use the follo wing k eyw ords and ar guments with this command: • clear —Stops the SGM server , if necessary , and removes all SSL ke ys and certificates fro m the server . Before restar ting the serv er , you must either generate new SSL[...]

C-47 Cisco Signaling Gateway Manager User Guide OL-5742-01 Appendix C SGM Command Reference sgm linkstats sgm linkstats Solaris Only Full S yntax sgm linkstats [ node-list [ id-ta g ]] [ sort-option ] [ quiet ] Command Description Generate s SGM link a nd linkset stati stics summar y reports: • T o include or e xclude specific objects in t he rep[...]

Appendix C SGM Command Reference sgm linkstats C-48 Cisco Signaling Gateway Manager User Guide OL-5742-01 • T o specify t he sort order for the reports, specify one of the follo wing keyw ords for the sort-option argument: – -sco —Sort based on the av erage Congestion for each link ( Av g Cong % ), in descen ding order . – -sis —Sort base[...]

C-49 Cisco Signaling Gateway Manager User Guide OL-5742-01 Appendix C SGM Command Reference sgm li stgtt List of SGM Commands • SGM Command Reference, page C-1 . sgm listgtt Solaris Only Full S yntax sgm listgtt [ dir ectory ] Command Description Lists all current GTT f iles in the specif ied directory ( dir ectory must be a subdirectory of the G[...]

Appendix C SGM Command Reference sgm listusers C-50 Cisco Signaling Gateway Manager User Guide OL-5742-01 List of SGM Commands • SGM Command Reference, page C-1 . sgm listusers Solaris Only Full S yntax sgm listusers [ username ] Command Description If SGM User-Based Access is enabled, lis ts all currently def ined users in the authentic ation li[...]

C-51 Cisco Signaling Gateway Manager User Guide OL-5742-01 Appendix C SGM Command Reference sgm logger sgm logger Solaris Only Command Description Displays the system messages mes sageLog. txt file with tail -f. T o stop the display , enter Ctrl-c . List of SGM Commands • SGM Command Reference, page C-1 . sgm logtimemode Solaris Only Full S yntax[...]

Appendix C SGM Command Reference sgm maxasciirows C-52 Cisco Signaling Gateway Manager User Guide OL-5742-01 sgm maxasciirows Solaris Only Full S yntax sgm maxasciiro ws [ number -of-r ows ] Command Description Sets the maximum number of ro ws for SGM ASCII W eb output, su ch as displays of detailed deb ugging information. If you enter this command[...]

C-53 Cisco Signaling Gateway Manager User Guide OL-5742-01 Appendix C SGM Command Reference sgm maxhtmlrows If you enter this command without t he number -of-r ows argument, SGM displays the current maximum numb er of ro ws. Y ou can then change that v alue, or lea ve it as-is. The v alid range is 1 row to an unlimited number of ro ws. The default [...]

Appendix C SGM Command Reference sgm mldebug C-54 Cisco Signaling Gateway Manager User Guide OL-5742-01 sgm mldebug Solaris Only Full S yntax sgm mldeb ug [ mode ] Command Description Sets the mode for logging SGM deb ug messages: • normal —Logs all action, error , and info messages. Use sgm mldeb ug normal to re vert to the default settings i [...]

C-55 Cisco Signaling Gateway Manager User Guide OL-5742-01 Appendix C SGM Command Reference sgm mlrstats sgm mlrstats Solaris Only Full S yntax sgm mlrstats [ node-list [ id-tag ]] [ sort-opti on ] [ quiet ] Command Description Generates SGM MLR processed, ab orts, continues, subtriggers, and tri ggers reports: • T o include or e xclude specific [...]

Appendix C SGM Command Reference sgm mlrstats C-56 Cisco Signaling Gateway Manager User Guide OL-5742-01 If you specify a node-lis t , you can also specify an id-tag to identify the reports. The id-tag can be any meaningful character string, but it cannot contain any spaces. The default v alue for id-tag is the process ID of the sgm mlrstats comman[...]

C-57 Cisco Signaling Gateway Manager User Guide OL-5742-01 Appendix C SGM Command Reference sgm motd If you do not speci fy the quiet key word (that is, if you vie w the outp ut on your terminal), SGM di splays only instance-le vel statistics ( as listed in the description of the sort-option argument) . T o see the full set of trigg er-le vel stati[...]

Appendix C SGM Command Reference sgm msglog C-58 Cisco Signaling Gateway Manager User Guide OL-5742-01 If the message of the day is enabl ed, it is displayed whene ver a user attempts to launch an SGM or GTT client: • If the user accepts the message, the client launches. • If the user declines the message , the client does not launch. Use the f[...]

C-59 Cisco Signaling Gateway Manager User Guide OL-5742-01 Appendix C SGM Command Reference sgm msglogage Y ou must be logged in as th e root user or as a super user to use this command. List of SGM Commands • SGM Command Reference, page C-1 . sgm msglogage Solaris Only Full S yntax sgm msglogage [ number-of-days ] Command Description Sets the ma[...]

Appendix C SGM Command Reference sgm msglogsize C-60 Cisco Signaling Gateway Manager User Guide OL-5742-01 Note Do not set the ne w directory to an y of the following: /usr , /var , /opt , or /tmp . Do not set the ne w directory to th e same directory in which you are storing GTT files ( sgm g ttdir ), report f iles ( sgm r epdir ), or route table [...]

C-61 Cisco Signaling Gateway Manager User Guide OL-5742-01 Appendix C SGM Command Reference sgm netlog When changing the number of messages to display , keep in mind that e very 5000 messages require approximat ely 1 MB. Y ou need to balance your need to refer to old messages against the amount of space they take up. Y ou must be logged in as th e [...]

Appendix C SGM Command Reference sgm newlevel C-62 Cisco Signaling Gateway Manager User Guide OL-5742-01 List of SGM Commands • SGM Command Reference, page C-1 . sgm newlevel Solaris Only Full S yntax sgm newlevel [ username ] Command Description If SGM User-Based Access is enabled, ch anges the authentication le ve l for the specified user . V a[...]

C-63 Cisco Signaling Gateway Manager User Guide OL-5742-01 Appendix C SGM Command Reference sgm passwordage sgm passwordage Solaris Only Full S yntax sgm passwordage [ number-of-days | clear ] Command Description If SGM User-Based Access is ena bled and sgm authtype is set to local , number of days allo wed before forcin g users to change passwords[...]

Appendix C SGM Command Reference sgm patchlog C-64 Cisco Signaling Gateway Manager User Guide OL-5742-01 sgm patchlog Solaris Only Full S yntax sgm patchlog Command Description Uses P A GER to displa y the conten ts of th e patch log, which lists the patches that hav e been installed on the SGM server . The default path and f ilename for the patch [...]

C-65 Cisco Signaling Gateway Manager User Guide OL-5742-01 Appendix C SGM Command Reference sgm pclist • master —Restores the P ointC odeF or mat.xml file to the def ault settings. • res t ore —Restores the P ointCodeF ormat.xml f ile to the last saved copy . Any changes you make tak e effect when you restart the SGM server . SGM preserv es[...]

Appendix C SGM Command Reference sgm poll C-66 Cisco Signaling Gateway Manager User Guide OL-5742-01 sgm poll Solaris Only Full S yntax sgm poll [ node ] [ node ]... Command Description Enables you t o poll one or mo re known nodes from the command line. U se the node arg uments to specify the DNS names or IP addresses of one or more kno wn nodes. [...]

C-67 Cisco Signaling Gateway Manager User Guide OL-5742-01 Appendix C SGM Command Reference sgm print See the “Server Status Infor mation: Pollers” section on p age 2-38 for more information on demand pollers. Y ou must be logged in as th e root user or as a super user to use this command. List of SGM Commands • SGM Command Reference, page C-[...]

Appendix C SGM Command Reference sgm pushgtt C-68 Cisco Signaling Gateway Manager User Guide OL-5742-01 sgm pushgtt Solaris Only Full S yntax sgm pushgtt [ -l logfilename ] [ -u username ] [ -p passwor d ] [ -n enab leusername ] [ -e enablepassw or d ] [ -s stor ag ede vicename ] [ --ov erwrite | --no-ov erwrite ] [ --act ivate | --no-activate ] fi[...]

C-69 Cisco Signaling Gateway Manager User Guide OL-5742-01 Appendix C SGM Command Reference sgm pushroute sgm pushroute Solaris Only Full S yntax sgm pushrout e [ -l logf ilename ] [ -u usern ame ] [ -p passwor d ] [ -n enableusername ] [ -e enablepasswor d ] [ -s stora gede vicename ] [ --ov erwri te | --no-ove rwrite ] [ --activ ate | --no-activ [...]

Appendix C SGM Command Reference sgm readme C-70 Cisco Signaling Gateway Manager User Guide OL-5742-01 List of SGM Commands • SGM Command Reference, page C-1 . sgm readme Command Description Displays the contents of the README f ile for SGM. List of SGM Commands • SGM Command Reference, page C-1 . sgm reboot Solaris Only Command Description Reb[...]

C-71 Cisco Signaling Gateway Manager User Guide OL-5742-01 Appendix C SGM Command Reference sgm repcustage sgm repcustage Solaris Only Full S yntax sgm repcust age [ number-of-days ] Command Description Maximum number of days SGM is to archi ve custom reports. If you enter this command without the number-of-days ar gument, SGM display s the current[...]

Appendix C SGM Command Reference sgm repdir C-72 Cisco Signaling Gateway Manager User Guide OL-5742-01 See the “Changing the W a y SGM Handles Statistics Reports (Solaris Only)” section on page 15-3 for more information o n the use of this command. Y ou must be logged in as th e root user or as a super user to use this command. List of SGM Comm[...]

C-73 Cisco Signaling Gateway Manager User Guide OL-5742-01 Appendix C SGM Command Reference sgm rephelp Do not set the ne w directory to th e same directory in which you are storing GTT files ( sgm g ttdir ), message log f iles ( sgm msglogdir ), or route table f iles ( sgm routedir ). After you change the directory , SGM asks if you want to restar[...]

Appendix C SGM Command Reference sgm replog C-74 Cisco Signaling Gateway Manager User Guide OL-5742-01 If you enter this command without the number-of-days ar gument, SGM display s the current maximum number of days. Y ou can then change that v alue, or lea ve it as-is. The v a lid range is 1 day to an unlimited number of d ays. The defau lt v alue[...]

C-75 Cisco Signaling Gateway Manager User Guide OL-5742-01 Appendix C SGM Command Reference sgm restart sgm restart Solaris Only Full S yntax sgm restart [ jsp | pm | web ] Command Description Restarts SGM servers on the local host: • jsp —Restarts t he SGM JS P Server . • pm —Restarts the SGM Proce ss Mana ger and all managed processes. ?[...]

Appendix C SGM Command Reference sgm restoreprops C-76 Cisco Signaling Gateway Manager User Guide OL-5742-01 T o restore only specifi c parts of the SGM data f iles, use the follo wing k eyw ords: • gtt —Restores only SGM GTT f iles. • logs —Restores only SGM log files, such as th e message log files. • rep o rt s —Restores only SGM rep[...]

C-77 Cisco Signaling Gateway Manager User Guide OL-5742-01 Appendix C SGM Command Reference sgm rootvars sgm rootvars Solaris Only Command Description Displays the contents of the /etc/CSCOsgm.sh file, which deter mines the roo t location of the SGM serv er and client installation. List of SGM Commands • SGM Command Reference, page C-1 . sgm rout[...]

Appendix C SGM Command Reference sgm routedir C-78 Cisco Signaling Gateway Manager User Guide OL-5742-01 Note This command copies all f iles in the current directory to the ne w directory . If you are logged in as t he super user , and you do not o w n the ne w directory , you might not be able to cop y the f iles. If that is the case, you must spe[...]

C-79 Cisco Signaling Gateway Manager User Guide OL-5742-01 Appendix C SGM Command Reference sgm sechelp List of SGM Commands • SGM Command Reference, page C-1 . sgm sechelp Solaris Only Command Description Displays help for all commands related to SGM security . Y ou must be logged in as th e root user or as a super user to use this command. List[...]

Appendix C SGM Command Reference sgm secondaryserver C-80 Cisco Signaling Gateway Manager User Guide OL-5742-01 • Operating system configuration changes and program changes, at the Solaris lev el • SGM restarts • Failur es of computers, programs, communicati ons, and operations, at the Solaris le vel T o clear the log and restart the server ,[...]

C-81 Cisco Signaling Gateway Manager User Guide OL-5742-01 Appendix C SGM Command Reference sgm servername If you use the sgm secondaryserv er command to confi gure a secondary SGM server , but the primary SGM serv er fails before you laun ch the SGM client, then the SGM client has no kno wledge of the secondary server . T o list the secondary SGM [...]

Appendix C SGM Command Reference sgm services C-82 Cisco Signaling Gateway Manager User Guide OL-5742-01 Note Using the sgm servername command to reset the SGM serv er's def ault host name does not af fect communicatio n between the SG M server and the ITPs. List of SGM Commands • SGM Command Reference, page C-1 . sgm services Solaris Only C[...]

C-83 Cisco Signaling Gateway Manager User Guide OL-5742-01 Appendix C SGM Command Reference sgm setpath and appends lines such as these to the use r's .cshr c file : set path=($path /opt /CSCOsgm/bin /opt/CSCOsgmClient/bin) # Ci scoSGM Thereafter , you ca n enter SGM commands like this: sgm help instead of like this: /opt/CSCOsgm/bin/sgm help [...]

Appendix C SGM Command Reference sgm snmpcomm C-84 Cisco Signaling Gateway Manager User Guide OL-5742-01 sgm snmpcomm Solaris Only Full S yntax sgm snmpcomm [ name ] Command Description Enables you to set a ne w default SNMP read community name. SGM automatically updates th e name in the SNMP paramet ers f ile. The def ault path and filename fo r t[...]

C-85 Cisco Signaling Gateway Manager User Guide OL-5742-01 Appendix C SGM Command Reference sgm snmpget For inform ation about e xporting SNMP commun ity names from CiscoW orks2000 Resource Manager Essentials (RME), see the “Importing SNMP Communi ty Names from CiscoW orks2000 (Solaris Only)” section on page 19-2 . Y ou must be logged in as th [...]

Appendix C SGM Command Reference sgm snmpget C-86 Cisco Signaling Gateway Manager User Guide OL-5742-01 • -c community_string —SNMP communit y string. The def ault community string is specif ied in the SNMP parameters f ile, communities.conf . • -r re t r y —SNMP retry count. The default retry count is specif ied in the SNMP parameters file[...]

C-87 Cisco Signaling Gateway Manager User Guide OL-5742-01 Appendix C SGM Command Reference sgm snmpget • --resol ve-integer | --no-resolv e-integer —Specif ies the time format : – Specify --resolv e-integer to display inte gers using th e string descript ion in the MIB, such as a vaila ble or una vaila ble . – Specify --n o-resolv e-intege[...]

Appendix C SGM Command Reference sgm snmphelp C-88 Cisco Signaling Gateway Manager User Guide OL-5742-01 • --int-instance inte ger —Appends the sp ecified inte ger instance OID to each polling MIB v ariable. • --str -instance string —Appends string instance OIDs to each polling M IB v ariable. For e xample, the follo wing commands perform t[...]

C-89 Cisco Signaling Gateway Manager User Guide OL-5742-01 Appendix C SGM Command Reference sgm snmpnext sgm snmpnext Solaris Only Full S yntax sgm snmpnext [ -J JVM_ARG1 [ -J JVM_ARG2 ]...] [ -v snmp_version ] [ -c community_string ] [ -r re t r y ] [ -t timeout ] [ -d output_delimiter ] [ --header | --no-header ] [ --raw-octets | --no-raw-octets [...]

Appendix C SGM Command Reference sgm snmpnext C-90 Cisco Signaling Gateway Manager User Guide OL-5742-01 • --header | --no-head er —Specifies whether t o display v ariable names as table headers: – Specify --header to display v ariable names as table headers for tabular output, or to disp lay MIB va riable OIDs with the v alue for non-tabular[...]

C-91 Cisco Signaling Gateway Manager User Guide OL-5742-01 Appendix C SGM Command Reference sgm snmpnext • --re solve-bits | --no-r esolve-bits —Specif ies the time format: – Specify --r esolve-bits to disp lay bits using the string descri ption in the MIB, such as continue or ruleset . – Specify --no-r esolve-bits to display bits as number[...]

Appendix C SGM Command Reference sgm snmpwalk C-92 Cisco Signaling Gateway Manager User Guide OL-5742-01 • --str -instance string —Appends string instance OIDs to each polling M IB v ariable. For e xample, the follo wing commands perform the same function: sgm snmpget --str -instance link_1 router_1 cItpSpLinksetState sgm snmpget router_1 cItpS[...]

C-93 Cisco Signaling Gateway Manager User Guide OL-5742-01 Appendix C SGM Command Reference sgm snmpwalk Command Description Queries the specified ho stname , using SNMP GetN extRequests to “w alk” through the MIB. Use the followi ng optional ke ywo rds and argument s with this command: • -J JVM_ARG1 —JVM options. Th e -J ke yword and ar gu[...]

Appendix C SGM Command Reference sgm snmpwalk C-94 Cisco Signaling Gateway Manager User Guide OL-5742-01 • --getbul k | --no-getb ulk —(SNMP versi on 2c only) Specif ies whether to use the getbulk command to w alk the table: – Specify --getb ulk to use the getbulk command. This is the default setting. – Specify --no-getb ulk if you do not w[...]

C-95 Cisco Signaling Gateway Manager User Guide OL-5742-01 Appendix C SGM Command Reference sgm snmpwalk • --resol ve-integer | --no-resolv e-integer —Specif ies the time format : – Specify --resolv e-integer to display inte gers using th e string descript ion in the MIB, such as a vaila ble or una vaila ble . – Specify --n o-resolv e-integ[...]

Appendix C SGM Command Reference sgm sounddir C-96 Cisco Signaling Gateway Manager User Guide OL-5742-01 • --int-instance inte ger —Appends the sp ecified inte ger instance OID to each polling MIB v ariable. • --str -instance string —Appends string instance OIDs to each polling M IB v ariable. For e xample, the follo wing commands perform t[...]

C-97 Cisco Signaling Gateway Manager User Guide OL-5742-01 Appendix C SGM Command Reference sgm sounddir The default dir ectory for sound f iles is located in the SGM inst allation directory: • If you installed SGM in the def ault directory , /opt , then the default directory is /opt/CSCOsgm/sounds . • If you installed SG M in a dif ferent dire[...]

Appendix C SGM Command Reference sgm ssl C-98 Cisco Signaling Gateway Manager User Guide OL-5742-01 sgm ssl Solaris Only Full S yntax sgm ssl [ enable | disable | status ] Command Description If you ha ve ob tained the SSL-enabled v ersion of SGM and inst alled an SSL ke y/certif icate pair in SGM, you can use this command to man age SSL support in[...]

C-99 Cisco Signaling Gateway Manager User Guide OL-5742-01 Appendix C SGM Command Reference sgm start See the “Implementing SSL Suppo rt in SGM” section on page 18-26 for more information on the use of this command. Y ou must be logged in as the root u ser (not as a super user) to use this command. List of SGM Commands • SGM Command Reference[...]

Appendix C SGM Command Reference sgm start gttclient C-100 Cisco Signaling Gateway Manager User Guide OL-5742-01 If you T elnet into a remote workst ation, the DISPLA Y v ariable must be set to your local displa y , or you cannot use th is command. If th e DISPLA Y variable is not set automatically , you must set it manually . See the “Setting th[...]

C-101 Cisco Signaling Gateway Manager User Guide OL-5742-01 Appendix C SGM Command Reference sgm start jsp sgm start jsp Solaris Only Command Description Starts the SGM JSP Serv er on the local host. Y ou must be logged in as th e root user or as a super user to use this command. List of SGM Commands • SGM Command Reference, page C-1 . sgm start [...]

Appendix C SGM Command Reference sgm statreps acct C-102 Cisco Signaling Gateway Manager User Guide OL-5742-01 sgm statreps acct Solaris Only Full S yntax sgm statreps [ acct | noacct ] Command Description Specif ies whether SGM is to generate MTP3 accounting statistics reports: • acct —Generate MTP3 a ccounting st atistics reports. MTP3 accoun[...]

C-103 Cisco Signaling Gateway Manager User Guide OL-5742-01 Appendix C SGM Command Reference sgm statreps cleancustom List of SGM Commands • SGM Command Reference, page C-1 . sgm statreps cleancustom Solaris Only Full S yntax sgm statreps cleancustom [ ta g ] Command Description Remov es all data from one or more SGM custo m statistics reports, r[...]

Appendix C SGM Command Reference sgm statreps dailyage C-104 Cisco Signaling Gateway Manager User Guide OL-5742-01 If you enter this command without the number-of-days ar gument, SGM display s the current maximum number of days. Y ou can then change that v alue, or lea ve it as-is. The v a lid range is 1 day to an unlimited number of d ays. The def[...]

C-105 Cisco Signaling Gateway Manager User Guide OL-5742-01 Appendix C SGM Command Reference sgm statreps diskcheck sgm statreps diskcheck Solaris Only Full S yntax sgm statreps [ diskcheck | nodiskcheck ] Command Description Specif ies whether SGM is to v erify that a disk has at least 10 MB of sp ace remaining before generating network statisti c[...]

Appendix C SGM Command Reference sgm statreps enable C-106 Cisco Signaling Gateway Manager User Guide OL-5742-01 sgm statreps enable Solaris Only Full S yntax sgm statreps [ disable | ena ble ] Command Description Enables SGM to gener ate network stati stics and accounting repo rts: • enable —Generate network statistics and accounting repo rts.[...]

C-107 Cisco Signaling Gateway Manager User Guide OL-5742-01 Appendix C SGM Command Reference sgm statreps export sgm statreps export Solaris Only Full S yntax sgm statreps [ expor t | noexport ] Command Description Specif ies whether SGM is to generate ne twork statistics and accounting reports in expor t format: • export —Generate network stat[...]

Appendix C SGM Command Reference sgm statreps gtt C-108 Cisco Signaling Gateway Manager User Guide OL-5742-01 sgm statreps gtt Solaris Only Full S yntax sgm statreps [ gtt | nogtt ] Command Description Specif ies whether SGM is to genera te GTT accountin g statistics reports: • gtt —Generate GTT accounting statistics reports. GTT accounting mus[...]

C-109 Cisco Signaling Gateway Manager User Guide OL-5742-01 Appendix C SGM Command Reference sgm statreps iplinks See the “Changing the W a y SGM Handles Statistics Reports (Solaris Only)” section on page 15-3 for more information o n the use of this command. This command has the same functi on as the sgm rephou rlyage command. Y ou must be log[...]

Appendix C SGM Command Reference sgm statreps link C-110 Cisco Signaling Gateway Manager User Guide OL-5742-01 sgm statreps link Solaris Only Full S yntax sgm statreps [ link | nolink ] Command Description Specif ies whether SGM is to generate link and linkset statistics summary reports: • link —Generate link and linkset statistics summary repo[...]

C-111 Cisco Signaling Gateway Manager User Guide OL-5742-01 Appendix C SGM Command Reference sgm statreps nullcaps See the “V iewin g the MLR Statistics Daily Reports” section on page 15- 53 for more information on MLR reports. Y ou must be logged in as th e root user or as a super user to use this command. List of SGM Commands • SGM Command [...]

Appendix C SGM Command Reference sgm statreps servratio C-112 Cisco Signaling Gateway Manager User Guide OL-5742-01 sgm statreps servratio Solaris Only Full S yntax sgm statreps servratio [ fa ctor ] Command Description Displays a gray background in the InSrv cell i n a network statistics repor t, if the follo wing co ndition is met: Current In-Ser[...]

C-113 Cisco Signaling Gateway Manager User Guide OL-5742-01 Appendix C SGM Command Reference sgm statreps timemode sgm statreps timemode Solaris Only Full S yntax sgm statreps timemode [ 12 | 24 ] Command Description Sets the time mode for dates in netw ork statistics reports: • 12 —Use 12-hour time, with AM and PM. 1:00 in the afternoon is 1:0[...]

Appendix C SGM Command Reference sgm statreps utilratio C-114 Cisco Signaling Gateway Manager User Guide OL-5742-01 sgm statreps utilratio Solaris Only Full S yntax sgm statreps ut ilratio [ factor ] Command Description Displays a gray background in the Send Ut ilization or Receive Utilization cell in a network stat istics report, if the follo wing[...]

C-115 Cisco Signaling Gateway Manager User Guide OL-5742-01 Appendix C SGM Command Reference sgm statreps xua sgm statreps xua Solaris Only Full S yntax sgm statreps [ xua | noxua ] Command Description Specif ies whether SGM is to generate stat istics reports for application serv ers and application server processes: • xua —Generate statistics [...]

Appendix C SGM Command Reference sgm stop C-116 Cisco Signaling Gateway Manager User Guide OL-5742-01 sgm stop Solaris Only Command Description Stops all SGM servers on the local host. Y ou must be logged in as th e root user or as a super user to use this command. List of SGM Commands • SGM Command Reference, page C-1 . sgm stopclients Solaris O[...]

C-117 Cisco Signaling Gateway Manager User Guide OL-5742-01 Appendix C SGM Command Reference sgm stop pm List of SGM Commands • SGM Command Reference, page C-1 . sgm stop pm Solaris Only Command Description Stops the SGM Process Manager and al l managed processes on the local host. Y ou must be logged in as th e root user or as a super user to us[...]

Appendix C SGM Command Reference sgm superuser C-118 Cisco Signaling Gateway Manager User Guide OL-5742-01 sgm superuser Solaris Only Full S yntax sgm superuser [ username ] Command Description Enables the specified user to perform mo st function s that otherwise require the user to be logged in as t he root user . (The root user can still perform [...]

C-119 Cisco Signaling Gateway Manager User Guide OL-5742-01 Appendix C SGM Command Reference sgm tac See the “Manually Synchronizin g Local SGM Passw ords” section on page 18-21 for more information on the use of this command . Y ou must be logged in as the root u ser (not as a super user) to use this command. List of SGM Commands • SGM Comma[...]

Appendix C SGM Command Reference sgm tnproxy C-120 Cisco Signaling Gateway Manager User Guide OL-5742-01 sgm tnproxy Solaris Only Full S yntax sgm tnproxy [ disabl e | enable | status ] Command Description Manages a T elnet pro xy . A T elnet proxy resides on a server and forwards T elnet requests from clients to ITPs that are acce ssible only from[...]

C-121 Cisco Signaling Gateway Manager User Guide OL-5742-01 Appendix C SGM Command Reference sgm trapaccess The list of allo wed ITP IP addresses is contained in the tr apaccess.conf f ile. By default, wh en you f irst install SGM, the trapaccess.conf fi le does not e xist and SGM allows all IP addresses to send tr aps to the SGM server . T o creat[...]

Appendix C SGM Command Reference sgm trapsetup C-122 Cisco Signaling Gateway Manager User Guide OL-5742-01 sgm trapsetup Solaris Only Full S yntax sgm trapsetup [ disable ] Command Description Stops the SGM serv er , configu res SGM to recei ve SNMP traps (or pre vents SGM from receiving traps), then restarts th e SGM server . SGM give s you the op[...]

C-123 Cisco Signaling Gateway Manager User Guide OL-5742-01 Appendix C SGM Command Reference sgm uninstall • For hpov , SGM also displays the location o f the HP OpenV iew home directory . • Status for the sgmT rapReceiv er (such as Running or Stopped ). List of SGM Commands • SGM Command Reference, page C-1 . sgm uninstall Solaris Only Comma[...]

Appendix C SGM Command Reference sgm updateus er C-124 Cisco Signaling Gateway Manager User Guide OL-5742-01 Y ou must be logged in as th e root user or as a super user to use this command. List of SGM Commands • SGM Command Reference, page C-1 . sgm updateuser Solaris Only Full S yntax sgm updateuser [ username ] Command Description If SGM User-[...]

C-125 Cisco Signaling Gateway Manager User Guide OL-5742-01 Appendix C SGM Command Reference sgm useraccess List of SGM Commands • SGM Command Reference, page C-1 . sgm useraccess Solaris Only Full S yntax sgm useraccess [ disable | enable ] Command Description Enables or disables SGM User-Based Access. User-Based Access provides multi-le ve l pa[...]

Appendix C SGM Command Reference sgm userpass C-126 Cisco Signaling Gateway Manager User Guide OL-5742-01 sgm userpass Solaris Only Full S yntax sgm userpass [ username ] Command Description If SGM User-Based Access is enabled and sgm authtype is set to local , changes the specified user’ s SGM securi ty authentication password. If the user’ s [...]

C-127 Cisco Signaling Gateway Manager User Guide OL-5742-01 Appendix C SGM Command Reference sgm viewlog sgm viewlog Solaris Only Command Description Uses P AGER to display the contents of the system message log. T o sav e the current contents of the log, clear the log, and restart the server , enter sgm viewlog clear . T o display the contents of [...]

Appendix C SGM Command Reference sgm webaccesslog C-128 Cisco Signaling Gateway Manager User Guide OL-5742-01 SGM ignores quotat ion marks in message_strin g . T o include quotation marks, use the escape character () in combination with quotat ion marks. For example: ./sgm wall Example of the ”sgm wall” command. sends the follo wing message:[...]

C-129 Cisco Signaling Gateway Manager User Guide OL-5742-01 Appendix C SGM Command Reference sgm weberrorlog sgm weberrorlog Solaris Only Full S yntax sgm weberrorlog [ clear | -r ] Command Description Uses P AGER to display the SGM W eb server error log file for the server t o which you are connected, and w hich is currently runn ing the SGM serv [...]

Appendix C SGM Command Reference sgm webnames C-130 Cisco Signaling Gateway Manager User Guide OL-5742-01 Y ou must be logged in as th e root user or as a super user to use this command. List of SGM Commands • SGM Command Reference, page C-1 . sgm webnames Solaris Only Full S yntax sgm webnames [ display | re al ] Command Description Specif ies w[...]

C-131 Cisco Signaling Gateway Manager User Guide OL-5742-01 Appendix C SGM Command Reference sgm webport sgm webport Solaris Only Full S yntax sgm webport [ port-number ] Command Description Sets a ne w port number for the W eb server , where port-number is the ne w , numeric port number . SGM verifies that th e ne w port number i s not alre ady in[...]

Appendix C SGM Command Reference sgm who C-132 Cisco Signaling Gateway Manager User Guide OL-5742-01 Y ou must be logged in as th e root user or as a super user to use this command. List of SGM Commands • SGM Command Reference, page C-1 . sgm who Solaris Only Command Description Displays a li st of all client u ser name s and processes connected [...]

C-133 Cisco Signaling Gateway Manager User Guide OL-5742-01 Appendix C SGM Command Reference sgm xuastats sgm xuastats Solaris Only Full S yntax sgm xuastats [ node-list [ id-tag ]] [ sort-option ] [ quiet ] Command Description Generates SGM accounting statis tics reports for application servers and application server processes: • T o include or [...]

Appendix C SGM Command Reference sgm xuastats C-134 Cisco Signaling Gateway Manager User Guide OL-5742-01 If you specify a node-lis t , you can also specify an id-tag to identify the reports. The id-tag can be any meaningful character string, but it cannot contain any spaces. The default v alue for id-tag is the process ID of the sgm xuastats comma[...]

C-135 Cisco Signaling Gateway Manager User Guide OL-5742-01 Appendix C SGM Command Reference sgm xuastats Y ou must be logged in as th e root user or as a super user to use this command. List of SGM Commands • SGM Command Reference, page C-1 .[...]

Appendix C SGM Command Reference sgm xuastats C-136 Cisco Signaling Gateway Manager User Guide OL-5742-01[...]