You are on page 1of 1274

NokiaNetworks

WCDMA RAN, Rel. RU50 and


RU50 EP1, Operating
Documentation, Issue 05
Multicontroller RNC SCLI
Commands
Issue 03B
Approval Date 2015-02-19

MulticontrollerRNCSCLICommands

The information in this document applies solely to the hardware/software product (Product) specified
herein,andonlyasspecifiedherein.
ThisdocumentisintendedforusebyNokiaSolutionsandNetworks'customers(You)only,anditmaynot
beusedexceptforthepurposesdefinedintheagreementbetweenYouandNokiaSolutionsandNetworks
(Agreement) under which this document is distributed. No part of this document may be used, copied,
reproduced, modified or transmitted in any form or means without the prior written permission of Nokia
Solutions and Networks. If you have not entered into an Agreement applicable to the Product, or if that
Agreementhasexpiredorhasbeenterminated,YoumaynotusethisdocumentinanymannerandYou
areobligedtoreturnittoNokiaSolutionsandNetworksanddestroyordeleteanycopiesthereof.
The document has been prepared to be used by professional and properly trained personnel, and You
assumefullresponsibilitywhenusingit.NokiaSolutionsandNetworkswelcomeYourcommentsaspartof
theprocessofcontinuousdevelopmentandimprovementofthedocumentation.
This document and its contents are provided as a convenience to You. Any information or statements
concerningthesuitability,capacity,fitnessforpurposeorperformanceoftheProductaregivensolelyon
anasisandasavailablebasisinthisdocument,andNokiaSolutionsandNetworksreservestheright
tochangeanysuchinformationandstatementswithoutnotice.NokiaSolutionsandNetworkshasmadeall
reasonableeffortstoensurethatthecontentofthisdocumentisadequateandfreeofmaterialerrorsand
omissions, and Nokia Solutions and Networks will correct errors that You identify in this document. But,
NokiaSolutionsandNetworks'totalliabilityforanyerrorsinthedocumentisstrictlylimitedtothecorrection
ofsucherror(s).NokiaSolutionsandNetworksdoesnotwarrantthattheuseofthesoftwareintheProduct
willbeuninterruptedorerror-free.
NO WARRANTY OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO
ANY WARRANTY OF AVAILABILITY, ACCURACY, RELIABILITY, TITLE, NON-INFRINGEMENT,
MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE, IS MADE IN RELATION TO THE
CONTENT OF THIS DOCUMENT. IN NO EVENT WILL NOKIA SOLUTIONS AND NETWORKS BE
LIABLE FOR ANY DAMAGES, INCLUDING BUT NOT LIMITED TO SPECIAL, DIRECT, INDIRECT,
INCIDENTAL OR CONSEQUENTIAL OR ANY LOSSES, SUCH AS BUT NOT LIMITED TO LOSS OF
PROFIT, REVENUE, BUSINESS INTERRUPTION, BUSINESS OPPORTUNITY OR DATA THAT MAY
ARISEFROMTHEUSEOFTHISDOCUMENTORTHEINFORMATIONINIT,EVENINTHECASEOF
ERRORSINOROMISSIONSFROMTHISDOCUMENTORITSCONTENT.
ThisdocumentisNokiaSolutionsandNetworksproprietaryandconfidentialinformation,whichmaynotbe
distributed or disclosed to any third parties without the prior written consent of Nokia Solutions and
Networks.
Nokia is a registered trademark of Nokia Corporation. Other product names mentioned in this document
maybetrademarksoftheirrespectiveowners,andtheyarementionedforidentificationpurposesonly.
Copyright2015NokiaSolutionsandNetworks.Allrightsreserved.

Important Notice on Product Safety


Thisproductmaypresentsafetyrisksduetolaser,electricity,heat,andothersourcesofdanger.
Only trained and qualified personnel may install, operate, maintain or otherwise handle this
productandonlyafterhavingcarefullyreadthesafetyinformationapplicabletothisproduct.
The safety information is provided in the Safety Information section in the Legal, Safety and
EnvironmentalInformationpartofthisdocumentordocumentationset.

Nokia Solutions and Networks is continually striving to reduce the adverse environmental effects of its
productsandservices.Wewouldliketoencourageyouasourcustomersanduserstojoinusinworking
towardsacleaner,saferenvironment.Pleaserecycleproductpackagingandfollowtherecommendations
forpoweruseandproperdisposalofourproductsandtheircomponents.
IfyoushouldhavequestionsregardingourEnvironmentalPolicyoranyoftheenvironmentalserviceswe
offer,pleasecontactusatNokiaSolutionsandNetworksforanyadditionalinformation.

Issue:03B

MulticontrollerRNCSCLICommands

Table of Contents
Thisdocumenthas1274pages

Summaryofchanges................................................................... 91

Issue:03B

1
1.1
1.2
1.3
1.4
1.5
1.6
1.7

Introductiontothestructuredcommandlineinterface(SCLI)......92
Overview...................................................................................... 92
Basicusage..................................................................................92
ConfigurationmanagementwithSCLI......................................... 94
SCLIcommandnotation...............................................................94
SCLIhelp..................................................................................... 95
ToplevelSCLIcommands........................................................... 95
fsclish......................................................................................... 100

2
2.1
2.1.1
2.1.2
2.1.2.1
2.1.2.2
2.1.2.3
2.1.2.4
2.1.2.5
2.1.3
2.1.3.1
2.1.3.2
2.1.4
2.1.4.1
2.1.5
2.1.5.1
2.1.5.2
2.1.5.3
2.1.5.4
2.1.5.4.1
2.1.6
2.1.7
2.1.7.1
2.1.8
2.1.8.1
2.1.9
2.1.9.1
2.1.10
2.1.10.1
2.1.11
2.1.12

SCLICommands.......................................................................102
alarm......................................................................................... 102
alarmacknowledge................................................................... 103
alarmactive...............................................................................103
alarmactiveapplication-ids.......................................................105
alarmactivefilter-by.................................................................. 105
alarmactivemanaged-object-ids.............................................. 107
alarmactiveprobable-causes................................................... 107
alarmactivespecific-problems..................................................108
alarmactive-summary............................................................... 108
alarmactive-summarybrief.......................................................109
alarmactive-summaryreal-time................................................ 109
alarmalarm-count..................................................................... 109
alarmalarm-countfilter-by.........................................................110
alarmblocking-rule.................................................................... 112
alarmblocking-ruleactivate.......................................................113
alarmblocking-ruleall................................................................113
alarmblocking-ruledeactivate...................................................114
alarmblocking-rulerule-id......................................................... 114
alarmblocking-rulerule-id<rule-id>.......................................... 114
alarmclear.................................................................................115
alarmclear-matching-alarms..................................................... 115
alarmclear-matching-alarmsfilter-by........................................ 115
alarmfollow-history....................................................................117
alarmfollow-historyfilter-by.......................................................117
alarmhistory.............................................................................. 119
alarmhistoryfilter-by.................................................................121
alarmhistory-count....................................................................125
alarmhistory-countfilter-by.......................................................126
alarmmanual............................................................................ 129
alarmnotification-id................................................................... 129

MulticontrollerRNCSCLICommands

2.1.13
2.1.14
2.1.15
2.1.15.1
2.1.16
2.1.17
2.1.18
2.1.18.1
2.1.18.2
2.1.19
2.1.20
2.1.21
2.2
2.2.1
2.2.2
2.3
2.3.1
2.3.2
2.3.2.1
2.3.2.2
2.3.2.2.1
2.3.3
2.3.3.1
2.3.3.2
2.3.3.3
2.3.3.3.1
2.3.4
2.3.4.1
2.3.4.1.1
2.3.5
2.3.5.1
2.3.5.2
2.3.5.3
2.3.5.3.1
2.3.6
2.3.6.1
2.3.6.1.1
2.3.7
2.3.8
2.3.9
2.3.9.1
2.3.9.1.1
2.3.10
2.3.11
2.4
2.4.1

alarmprobable-causes..............................................................130
alarmraise................................................................................ 130
alarmrecovery-history...............................................................131
alarmrecovery-historyfilter-by..................................................132
alarmspecific-problems............................................................ 133
alarmtest-instructions............................................................... 133
alarmtype................................................................................. 134
alarmtypefrom-directory.......................................................... 135
alarmtypefrom-file................................................................... 135
alarmtype-all.............................................................................136
alarmtype-restore-defaults....................................................... 136
alarmunacknowledge............................................................... 137
app-parameter...........................................................................137
app-parameterconfiguration-parameter................................... 138
app-parameterfeature-optionality.............................................. 139
backup.......................................................................................140
backupactive............................................................................ 142
backupbackup-iso.................................................................... 143
backupbackup-isoall................................................................143
backupbackup-isoimage......................................................... 144
backupbackup-isoimage<backup-iso-name>.........................144
backupconfig............................................................................ 144
backupconfigall....................................................................... 145
backupconfigcurrent................................................................145
backupconfiglabel................................................................... 146
backupconfiglabel<label>.......................................................146
backupdatabase.......................................................................146
backupdatabasedb-name........................................................147
backupdatabasedb-name<db-name>.................................... 147
backupdelivery......................................................................... 148
backupdeliveryall.....................................................................148
backupdeliverycurrent............................................................. 149
backupdeliverylabel.................................................................149
backupdeliverylabel<label-name>..........................................150
backupfilesystem......................................................................150
backupfilesystemrg-name....................................................... 151
backupfilesystemrg-name<rg-name>.....................................151
backupfull................................................................................. 151
backuppartial............................................................................152
backupplugin............................................................................ 152
backuppluginplugin-name....................................................... 153
backuppluginplugin-name<plugin-name>.............................. 153
backupselective........................................................................154
backupstate..............................................................................154
built-in........................................................................................155
built-incli................................................................................... 155

Issue:03B

MulticontrollerRNCSCLICommands

2.4.1.1
2.4.1.1.1
2.4.1.2
2.4.1.2.1
2.4.1.2.2
2.4.1.2.2.1
2.4.1.2.3
2.4.1.2.3.1
2.4.1.2.4
2.4.1.2.4.1
2.4.1.2.5
2.4.1.2.5.1
2.4.1.2.6
2.4.1.2.6.1
2.4.1.2.7
2.4.1.2.7.1
2.4.1.2.8
2.4.1.2.8.1
2.4.1.2.9
2.4.1.2.9.1
2.4.1.2.10
2.4.1.2.10.1
2.4.1.2.11
2.4.1.2.11.1
2.4.1.2.12
2.4.1.2.12.1
2.4.1.2.13
2.4.1.2.13.1
2.4.1.3
2.4.1.4
2.4.1.4.1
2.4.1.4.1.1
2.4.1.4.2
2.4.1.4.3
2.4.1.4.4
2.4.1.4.4.1
2.4.1.5
2.4.1.5.1
2.4.1.5.2
2.4.1.5.2.1
2.4.1.6
2.4.1.6.1
2.4.1.6.2
2.4.1.6.2.1
2.4.1.7
2.4.1.7.1

Issue:03B

built-inclibatch-file....................................................................157
built-inclibatch-file<file>..........................................................157
built-inclibuilt-in........................................................................158
built-inclibuilt-in<properties>.................................................. 159
built-inclibuilt-inconfirmation-prompt.......................................161
built-inclibuilt-inconfirmation-prompt<on_off>........................161
built-inclibuilt-inconstraint-hint................................................ 161
built-inclibuilt-inconstraint-hint<on_off>................................. 162
built-inclibuilt-indebug.............................................................162
built-inclibuilt-indebug<debug_level>.................................... 163
built-inclibuilt-inecho-cmd.......................................................163
built-inclibuilt-inecho-cmd<on_off>........................................164
built-inclibuilt-inon-failure........................................................164
built-inclibuilt-inon-failure<stop_continue>............................ 164
built-inclibuilt-inoutput.............................................................165
built-inclibuilt-inoutput<output_format>................................. 165
built-inclibuilt-inprint-footer..................................................... 166
built-inclibuilt-inprint-footer<on_off>...................................... 166
built-inclibuilt-inprint-header................................................... 167
built-inclibuilt-inprint-header<on_off>.................................... 167
built-inclibuilt-inrelative-mode.................................................167
built-inclibuilt-inrelative-mode<on_off>..................................168
built-inclibuilt-inrows............................................................... 169
built-inclibuilt-inrows<number_of_rows>............................... 169
built-inclibuilt-insyntax-check..................................................169
built-inclibuilt-insyntax-check<on_off>...................................170
built-inclibuilt-invalidation-trace.............................................. 170
built-inclibuilt-invalidation-trace<validation-trace-level>........ 171
built-inclicache.........................................................................171
built-inclienv............................................................................ 172
built-inclienv<NAME>.............................................................175
built-inclienv<NAME><VALUE>............................................ 175
built-inclienv<save_mode>.....................................................175
built-inclienv<variable_name>................................................176
built-inclienvfile.......................................................................176
built-inclienvfile<filename>.................................................... 176
built-inclierrorstream................................................................177
built-inclierrorstream<destination>......................................... 178
built-inclierrorstreamfile.......................................................... 178
built-inclierrorstreamfile<filename>....................................... 179
built-inclioutstream.................................................................. 179
built-inclioutstream<destination>............................................180
built-inclioutstreamfile.............................................................180
built-inclioutstreamfile<filename>..........................................181
built-inclisession...................................................................... 181
built-inclisession<NAME>...................................................... 183

MulticontrollerRNCSCLICommands

2.4.1.7.1.1
2.4.1.7.2
2.4.1.7.3
2.4.1.7.3.1
2.4.1.8
2.4.1.8.1
2.4.1.8.2
2.4.1.8.2.1
2.4.1.9
2.4.2
2.4.2.1
2.4.3
2.4.4
2.4.4.1
2.4.4.1.1
2.4.4.1.1.1
2.4.4.1.2
2.4.4.1.2.1
2.4.5
2.4.6
2.4.7
2.4.7.1
2.4.7.1.1
2.4.7.1.2
2.4.7.2
2.4.7.2.1
2.4.7.2.1.1
2.4.7.2.2
2.4.8
2.5
2.6
2.6.1
2.6.2
2.6.3
2.6.4
2.6.5
2.7
2.7.1
2.7.2
2.7.2.1
2.7.2.1.1
2.7.2.1.1.1
2.7.3
2.7.3.1
2.7.3.2

built-inclisession<NAME><VALUE>......................................183
built-inclisession<variable_name>......................................... 184
built-inclisessionfile................................................................ 184
built-inclisessionfile<filename>..............................................184
built-inclitracestream............................................................... 185
built-inclitracestream<destination>.........................................186
built-inclitracestreamfile..........................................................186
built-inclitracestreamfile<filename>.......................................187
built-incliviews......................................................................... 187
built-incmdtree..........................................................................188
built-incmdtree<command>.....................................................188
built-inexit................................................................................. 188
built-inhelp................................................................................189
built-inhelpcmd-tree.................................................................189
built-inhelpcmd-treecmd-set...................................................190
built-inhelpcmd-treecmd-set<cmd-set>.................................191
built-inhelpcmd-treecommand................................................191
built-inhelpcmd-treecommand<command>...........................192
built-inhistory............................................................................ 192
built-inquit.................................................................................193
built-inshell............................................................................... 193
built-inshellbash...................................................................... 194
built-inshellbashfull.................................................................194
built-inshellbashlimited........................................................... 195
built-inshellscli......................................................................... 195
built-inshellsclinode................................................................ 195
built-inshellsclinode<node_name>........................................196
built-inshellsclipeer.................................................................196
built-inuser................................................................................197
cluster........................................................................................198
cmf............................................................................................ 198
cmfdisable................................................................................ 199
cmfenable.................................................................................199
cmfrestart................................................................................. 200
cmfstatus..................................................................................200
cmfyield.................................................................................... 201
config.........................................................................................202
config<full-object-name>..........................................................204
configattribute...........................................................................205
configattribute<full-object-name>............................................206
configattribute<full-object-name>attribute-list........................ 206
configattribute<full-object-name>attribute-list<attribute-name>..
207
configobject.............................................................................. 208
configobject<full-object-name>............................................... 208
configobject<parent-object>....................................................209

Issue:03B

MulticontrollerRNCSCLICommands

2.7.3.2.1
2.7.3.2.1.1
2.8
2.8.1
2.8.2
2.8.3
2.8.4
2.8.5
2.8.5.1
2.8.5.2
2.8.6
2.9
2.9.1
2.10
2.10.1
2.10.2
2.10.2.1
2.10.3
2.10.3.1
2.10.4
2.10.4.1
2.10.5
2.10.5.1
2.10.5.1.1
2.11
2.11.1
2.11.1.1
2.11.1.1.1
2.11.1.1.1.1
2.11.1.2
2.11.2
2.11.2.1
2.11.2.1.1
2.11.2.1.2
2.11.2.2
2.11.2.3
2.11.2.3.1
2.11.2.3.1.1
2.11.2.3.2
2.11.2.3.2.1
2.11.3
2.11.3.1
2.11.3.1.1
2.11.3.1.2

Issue:03B

configobject<parent-object>attribute-list................................ 209
configobject<parent-object>attribute-list<attribute-name>....210
config-mode.............................................................................. 210
config-mode<config-mode-exclusive>......................................211
config-mode<config-mode-off>................................................ 212
config-mode<config-mode-on>................................................ 213
config-mode<config-mode-touch>........................................... 213
config-mode<mass-config>......................................................214
config-mode<mass-config>off................................................. 214
config-mode<mass-config>on.................................................214
config-modestatus....................................................................215
directory.................................................................................... 215
directory<directory>................................................................. 216
file..............................................................................................216
file<file>....................................................................................217
filecontent.................................................................................218
filecontent<file>....................................................................... 218
filedisk-usage........................................................................... 218
filedisk-usage<directory>........................................................ 219
filelist........................................................................................ 219
filelist<directory>..................................................................... 219
filesha1sum.............................................................................. 219
filesha1sum<checksum-file>...................................................220
filesha1sum<checksum-file><directory>................................220
hardware................................................................................... 221
hardwareadmin-ignore............................................................. 222
hardwareadmin-ignore<yes-no>............................................. 222
hardwareadmin-ignore<yes-no>fru-location.......................... 223
hardwareadmin-ignore<yes-no>fru-location<fru-location-name>
................................................................................................... 223
hardwareadmin-ignoresync.....................................................223
hardwareconfig.........................................................................224
hardwareconfigcomponent......................................................225
hardwareconfigcomponent<component-name>.....................226
hardwareconfigcomponent<new-component-name>.............227
hardwareconfigdisk-storage.................................................... 227
hardwareconfigphysical-location............................................. 228
hardwareconfigphysical-location<physical-location>............. 228
hardwareconfigphysical-location<physical-location>cabinet-id...
229
hardwareconfigphysical-locationcabinet-id............................ 229
hardwareconfigphysical-locationcabinet-id<cabinet-id>........230
hardwarediagnostics................................................................ 230
hardwarediagnosticsfru-location............................................. 231
hardwarediagnosticsfru-location<fru-location>...................... 232
hardwarediagnosticsfru-location<frulocation>........................232

MulticontrollerRNCSCLICommands

2.11.3.2
2.11.3.2.1
2.11.3.2.2
2.11.3.2.2.1
2.11.3.3
2.11.3.4
2.11.3.4.1
2.11.3.4.1.1
2.11.3.5
2.11.3.5.1
2.11.3.5.1.1
2.11.3.5.2
2.11.3.5.2.1
2.11.3.6
2.11.3.6.1
2.11.3.6.1.1
2.11.3.7
2.11.3.8
2.11.3.8.1
2.11.3.8.1.1
2.11.4
2.11.4.1
2.11.4.1.1
2.11.4.2
2.11.4.2.1
2.11.4.2.2
2.11.5
2.11.5.1
2.11.5.1.1
2.11.5.1.1.1
2.11.5.2
2.11.5.2.1
2.11.5.2.1.1
2.11.6
2.11.6.1
2.11.6.1.1
2.11.7
2.11.7.1
2.11.7.2
2.11.7.2.1
2.12
2.12.1
2.12.1.1
2.12.1.1.1

hardwarediagnosticsreport......................................................233
hardwarediagnosticsreportall................................................. 234
hardwarediagnosticsreportfru-location................................... 234
hardwarediagnosticsreportfru-location<frulocation>............. 234
hardwarediagnosticsreport-details.......................................... 236
hardwarediagnosticsreport-list................................................ 236
hardwarediagnosticsreport-listfru-location............................. 236
hardwarediagnosticsreport-listfru-location<fru-location>...... 237
hardwarediagnosticsreport-status........................................... 237
hardwarediagnosticsreport-statusfru-location........................ 238
hardwarediagnosticsreport-statusfru-location<fru-location>. 238
hardwarediagnosticsreport-statusreport-name...................... 238
hardwarediagnosticsreport-statusreport-name<report-name>....
239
hardwarediagnosticstest-details..............................................239
hardwarediagnosticstest-detailsfru-location........................... 239
hardwarediagnosticstest-detailsfru-location<frulocation>..... 240
hardwarediagnosticstest-list....................................................240
hardwarediagnosticstest-readiness.........................................240
hardwarediagnosticstest-readinessfru-location......................241
hardwarediagnosticstest-readinessfru-location<frulocation>......
241
hardwareinventory....................................................................241
hardwareinventorycomponent.................................................242
hardwareinventorycomponent<component>..........................242
hardwareinventorylist.............................................................. 242
hardwareinventorylistbrief...................................................... 243
hardwareinventorylistdetailed.................................................243
hardwarepower........................................................................ 244
hardwarepoweroff....................................................................244
hardwarepoweroffnode...........................................................244
hardwarepoweroffnode<nodename>.................................... 245
hardwarepoweron................................................................... 245
hardwarepoweronnode.......................................................... 245
hardwarepoweronnode<nodename>.................................... 245
hardwarerestart........................................................................ 246
hardwarerestartnode............................................................... 246
hardwarerestartnode<nodename>.........................................246
hardwarestate.......................................................................... 247
hardwarestatelist..................................................................... 247
hardwarestatenode................................................................. 247
hardwarestatenode<nodename>........................................... 248
has............................................................................................ 248
hasattribute.............................................................................. 250
hasattribute<name>................................................................ 251
hasattribute<name><value>.................................................. 251

Issue:03B

MulticontrollerRNCSCLICommands

2.12.1.1.1.1
2.12.1.1.1.2
2.12.2
2.12.2.1
2.12.3
2.12.3.1
2.12.3.1.1
2.12.3.2
2.12.3.2.1
2.12.4
2.12.4.1
2.12.4.1.1
2.12.4.1.1.1
2.12.4.2
2.12.4.2.1
2.12.4.2.1.1
2.12.4.3
2.12.4.3.1
2.12.4.3.1.1
2.12.5
2.12.6
2.12.6.1
2.12.6.1.1
2.12.6.2
2.12.6.2.1
2.12.7
2.12.7.1
2.12.7.1.1
2.12.7.2
2.12.7.2.1
2.12.7.3
2.12.7.3.1
2.12.7.4
2.12.7.4.1
2.12.8
2.12.8.1
2.12.8.2
2.12.8.3
2.12.8.3.1
2.12.8.3.2
2.12.8.3.3
2.12.8.4
2.12.8.5
2.12.9

Issue:03B

hasattribute<name><value>managed-object........................252
hasattribute<name><value>managed-object-full-name........253
hasbare.................................................................................... 254
hasbare<mo-type>.................................................................. 254
haschildren...............................................................................255
haschildrenmanaged-object.................................................... 255
haschildrenmanaged-object<mo-name>................................256
haschildrenmanaged-object-full-name.................................... 256
haschildrenmanaged-object-full-name<mo-fullname>........... 257
hasconfig..................................................................................257
hasconfiglink........................................................................... 258
hasconfiglinknode-to-core...................................................... 258
hasconfiglinknode-to-core<component-name>.....................259
hasconfignode.........................................................................259
hasconfignodecomponent...................................................... 260
hasconfignodecomponent<component>............................... 261
hasconfignode-type.................................................................262
hasconfignode-typename.......................................................262
hasconfignode-typename<name>.........................................262
hasdependencies..................................................................... 263
hasforce-active.........................................................................263
hasforce-activemanaged-object.............................................. 264
hasforce-activemanaged-object<mo-name>..........................264
hasforce-activemanaged-object-full-name.............................. 265
hasforce-activemanaged-object-full-name<mo-fullname>..... 265
hasforcedswitchover................................................................ 266
hasforcedswitchoverlogical-group...........................................267
hasforcedswitchoverlogical-group<logical-group-name>.......267
hasforcedswitchovermanaged-object......................................267
hasforcedswitchovermanaged-object<mo-name>................. 268
hasforcedswitchovermanaged-object-full-name......................269
hasforcedswitchovermanaged-object-full-name<mo-fullname>...
269
hasforcedswitchovernew-active-recovery-unit........................ 270
hasforcedswitchovernew-active-recovery-unit<new-activerecovery-unit>........................................................................... 270
hasfunctional-unit..................................................................... 270
hasfunctional-unitcomp-addr-info............................................271
hasfunctional-unitgroup-addr-info........................................... 272
hasfunctional-unitstartup-info.................................................. 272
hasfunctional-unitstartup-infoparameter.................................273
hasfunctional-unitstartup-infophase-output............................ 273
hasfunctional-unitstartup-infostatistics................................... 274
hasfunctional-unitunit-info....................................................... 274
hasfunctional-unitunit-type-info............................................... 275
hasinert.................................................................................... 275

MulticontrollerRNCSCLICommands

2.12.9.1
2.12.9.1.1
2.12.9.1.1.1
2.12.9.1.2
2.12.9.1.2.1
2.12.10
2.12.10.1
2.12.10.1.1
2.12.10.2
2.12.10.2.1
2.12.11
2.12.11.1
2.12.11.1.1
2.12.11.2
2.12.11.2.1
2.12.11.3
2.12.11.3.1
2.12.12
2.12.12.1
2.12.12.1.1
2.12.13
2.12.13.1
2.12.13.1.1
2.12.13.2
2.12.13.2.1
2.12.14
2.12.14.1
2.12.14.1.1
2.12.14.1.1.1
2.12.14.1.2
2.12.14.1.2.1
2.12.14.2
2.12.14.2.1
2.12.14.2.1.1
2.12.14.2.2
2.12.14.2.2.1
2.12.15
2.12.15.1
2.12.15.1.1
2.12.15.1.2
2.12.15.1.2.1
2.12.15.1.3
2.12.15.1.3.1
2.12.15.1.4
2.12.15.1.4.1

10

hasinert<inert-mode>.............................................................. 276
hasinert<inert-mode>managed-object................................... 276
hasinert<inert-mode>managed-object<mo-name>...............277
hasinert<inert-mode>managed-object-full-name................... 277
hasinert<inert-mode>managed-object-full-name<mo-fullname>.
278
hasisolate................................................................................. 278
hasisolatemanaged-object...................................................... 279
hasisolatemanaged-object<mo-name>..................................279
hasisolatemanaged-object-full-name...................................... 280
hasisolatemanaged-object-full-name<mo-fullname>............. 280
haslock..................................................................................... 281
haslocklogical-group............................................................... 281
haslocklogical-group<logical-group-name>........................... 282
haslockmanaged-object.......................................................... 282
haslockmanaged-object<mo-name>......................................283
haslockmanaged-object-full-name.......................................... 283
haslockmanaged-object-full-name<mo-fullname>................. 284
haslogical-group-state..............................................................284
haslogical-group-statelogical-group........................................ 285
haslogical-group-statelogical-group<logical-group-name>.... 285
hasparent................................................................................. 286
hasparentmanaged-object...................................................... 286
hasparentmanaged-object<mo-name>.................................. 287
hasparentmanaged-object-full-name...................................... 287
hasparentmanaged-object-full-name<mo-fullname>............. 288
haspower..................................................................................288
haspoweroff.............................................................................289
haspoweroffmanaged-object.................................................. 290
haspoweroffmanaged-object<mo-name>............................. 290
haspoweroffmanaged-object-full-name.................................. 291
haspoweroffmanaged-object-full-name<mo-fullname>......... 291
haspoweron.............................................................................292
haspoweronmanaged-object..................................................292
haspoweronmanaged-object<mo-name>............................. 292
haspoweronmanaged-object-full-name..................................293
haspoweronmanaged-object-full-name<mo-fullname>.........293
hasprocess-family.................................................................... 294
hasprocess-familyattribute...................................................... 295
hasprocess-familyattributeall..................................................296
hasprocess-familyattributefamily-id........................................296
hasprocess-familyattributefamily-id<family-id>..................... 297
hasprocess-familyattributemaster-name................................ 297
hasprocess-familyattributemaster-name<master-name>......297
hasprocess-familyattributeprocess-name.............................. 298
hasprocess-familyattributeprocess-name<process-name>.. 298

Issue:03B

MulticontrollerRNCSCLICommands

2.12.15.2
2.12.15.3
2.12.15.3.1
2.12.15.3.1.1
2.12.15.3.2
2.12.15.3.2.1
2.12.15.3.3
2.12.15.3.3.1
2.12.15.4
2.12.15.4.1
2.12.15.4.1.1
2.12.15.4.2
2.12.15.4.2.1
2.12.15.4.3
2.12.15.4.3.1
2.12.15.4.4
2.12.15.4.4.1
2.12.15.4.5
2.12.15.4.5.1
2.12.15.4.6
2.12.15.4.6.1
2.12.15.4.7
2.12.15.4.7.1
2.12.15.4.8
2.12.15.4.8.1
2.12.15.4.9
2.12.15.4.9.1
2.12.15.4.10
2.12.15.4.10.1
2.12.15.4.11
2.12.15.4.11.1
2.12.16
2.12.16.1
2.12.16.1.1
2.12.16.1.1.1
2.12.16.1.2
2.12.16.1.2.1
2.12.17
2.12.17.1
2.12.17.1.1
2.12.17.2
2.12.17.2.1

Issue:03B

hasprocess-familysupervision................................................. 298
hasprocess-familysync-monitoring..........................................299
hasprocess-familysync-monitoringerrors............................... 300
hasprocess-familysync-monitoringerrorsunit-type.................300
hasprocess-familysync-monitoringlist.................................... 301
hasprocess-familysync-monitoringlistunit-type......................302
hasprocess-familysync-monitoringunit-type........................... 302
hasprocess-familysync-monitoringunit-type<unit-type-name>....
303
hasprocess-familywarming......................................................303
hasprocess-familywarmingcompare-all..................................304
hasprocess-familywarmingcompare-allunit-type................... 305
hasprocess-familywarmingcompare-buffer............................ 306
hasprocess-familywarmingcompare-bufferunit-type..............306
hasprocess-familywarmingcompare-state-data..................... 307
hasprocess-familywarmingcompare-state-dataunit-type.......307
hasprocess-familywarmingcompare-timer............................. 308
hasprocess-familywarmingcompare-timerunit-type...............309
hasprocess-familywarmingcompare-variables....................... 309
hasprocess-familywarmingcompare-variablesunit-type........ 310
hasprocess-familywarmingconfiguration................................ 311
hasprocess-familywarmingconfigurationunit-type..................311
hasprocess-familywarmingfamily........................................... 312
hasprocess-familywarmingfamilyunit-type............................ 312
hasprocess-familywarminginformation...................................313
hasprocess-familywarminginformationunit-type.................... 313
hasprocess-familywarmingprocess........................................ 314
hasprocess-familywarmingprocessunit-type......................... 315
hasprocess-familywarmingstatistics.......................................315
hasprocess-familywarmingstatisticsunit-type........................ 316
hasprocess-familywarmingsubscriptions................................317
hasprocess-familywarmingsubscriptionsunit-type.................317
hasreset-block..........................................................................318
hasreset-block<resetblock-value>.......................................... 319
hasreset-block<resetblock-value>managed-object................319
hasreset-block<resetblock-value>managed-object<mo-name>.
320
hasreset-block<resetblock-value>managed-object-full-name......
320
hasreset-block<resetblock-value>managed-object-full-name
<mo-fullname>.......................................................................... 321
hasrestart................................................................................. 321
hasrestartlogical-group............................................................323
hasrestartlogical-group<logical-group-name>........................323
hasrestartmanaged-object...................................................... 324
hasrestartmanaged-object<mo-name>.................................. 324

11

MulticontrollerRNCSCLICommands

2.12.17.3
2.12.17.3.1
2.12.18
2.12.18.1
2.12.18.1.1
2.12.18.2
2.12.18.2.1
2.12.18.3
2.12.18.3.1
2.12.19
2.12.19.1
2.12.19.1.1
2.12.19.2
2.12.19.2.1
2.12.19.3
2.12.19.3.1
2.12.20
2.12.20.1
2.12.20.1.1
2.12.20.2
2.12.20.2.1
2.12.21
2.12.21.1
2.12.21.1.1
2.12.21.2
2.12.21.2.1
2.12.21.3
2.12.21.3.1
2.12.21.4
2.12.21.4.1
2.12.22
2.12.22.1
2.12.22.1.1
2.12.22.1.1.1
2.12.22.1.2
2.12.22.1.2.1
2.12.23
2.12.23.1
2.12.23.2
2.12.23.2.1
2.12.23.3
2.12.23.3.1
2.12.23.4

12

hasrestartmanaged-object-full-name...................................... 325
hasrestartmanaged-object-full-name<mo-fullname>............. 325
hasshutdown............................................................................ 326
hasshutdownlogical-group...................................................... 327
hasshutdownlogical-group<logical-group-name>.................. 327
hasshutdownmanaged-object................................................. 328
hasshutdownmanaged-object<mo-name>.............................328
hasshutdownmanaged-object-full-name................................. 329
hasshutdownmanaged-object-full-name<mo-fullname>........ 329
hasstate....................................................................................330
hasstatelogical-group.............................................................. 332
hasstatelogical-group<logical-group-name>.......................... 332
hasstatemanaged-object.........................................................333
hasstatemanaged-object<mo-name>.................................... 333
hasstatemanaged-object-full-name.........................................334
hasstatemanaged-object-full-name<mo-fullname>................334
hassummary.............................................................................335
hassummarymanaged-object..................................................338
hassummarymanaged-object<mo-name>............................. 339
hassummarymanaged-object-full-name..................................339
hassummarymanaged-object-full-name<mo-fullname>.........340
hasswitchover.......................................................................... 340
hasswitchoverlogical-group.....................................................341
hasswitchoverlogical-group<logical-group-name>.................342
hasswitchovermanaged-object................................................342
hasswitchovermanaged-object<mo-name>........................... 343
hasswitchovermanaged-object-full-name................................343
hasswitchovermanaged-object-full-name<mo-fullname>.......344
hasswitchovernew-active-recovery-unit.................................. 344
hasswitchovernew-active-recovery-unit<new-active-recoveryunit>.......................................................................................... 345
hastest-state.............................................................................345
hastest-state<test-state-value>...............................................346
hastest-state<test-state-value>managed-object.................... 346
hastest-state<test-state-value>managed-object<mo-name>......
347
hastest-state<test-state-value>managed-object-full-name.... 347
hastest-state<test-state-value>managed-object-full-name<mofullname>...................................................................................348
hasunlock................................................................................. 348
hasunlockall............................................................................ 349
hasunlocklogical-group........................................................... 350
hasunlocklogical-group<logical-group-name>....................... 350
hasunlockmanaged-object...................................................... 350
hasunlockmanaged-object<mo-name>..................................351
hasunlockmanaged-object-full-name...................................... 352

Issue:03B

MulticontrollerRNCSCLICommands

2.12.23.4.1
2.12.24
2.12.24.1
2.12.24.1.1
2.12.24.2
2.12.24.2.1
2.12.24.3
2.12.24.3.1
2.12.24.4
2.13
2.14
2.14.1
2.14.1.1
2.14.1.1.1
2.14.1.1.1.1
2.14.1.1.1.2
2.14.1.1.1.3
2.14.1.1.2
2.14.1.1.2.1
2.14.1.1.2.2
2.14.1.1.2.3
2.14.2
2.14.2.1
2.14.2.2
2.14.2.3
2.14.2.4
2.14.3
2.14.3.1
2.14.3.1.1
2.14.3.1.2
2.14.3.1.3
2.14.3.1.4
2.14.3.2
2.14.3.2.1
2.14.3.2.2
2.14.3.2.3
2.14.3.2.4
2.14.4
2.14.4.1
2.14.4.2
2.14.4.2.1
2.14.4.2.1.1
2.14.4.2.2
2.14.4.2.2.1
2.14.4.3
2.14.4.4

Issue:03B

hasunlockmanaged-object-full-name<mo-fullname>............. 352
hasview.................................................................................... 353
hasviewlogical-group...............................................................354
hasviewlogical-group<logical-group-name>...........................354
hasviewmanaged-object......................................................... 354
hasviewmanaged-object<mo-name>..................................... 355
hasviewmanaged-object-full-name......................................... 356
hasviewmanaged-object-full-name<mo-fullname>................ 356
hasviewrecoverygroup............................................................ 357
hw..............................................................................................357
ipsec..........................................................................................358
ipsecinstance........................................................................... 360
ipsecinstance<instance_name>..............................................361
ipsecinstance<instance_name>rule.......................................362
ipsecinstance<instance_name>rule<rule-name>................. 363
ipsecinstance<instance_name>ruleall.................................. 365
ipsecinstance<instance_name>ruleconfig............................ 365
ipsecinstance<instance_name>vpn....................................... 366
ipsecinstance<instance_name>vpn<vpn-name>..................367
ipsecinstance<instance_name>vpnall.................................. 371
ipsecinstance<instance_name>vpnconfig............................ 371
ipsecrule...................................................................................372
ipsecrule<name>.....................................................................373
ipsecrule<rule-name>............................................................. 373
ipsecruleall.............................................................................. 375
ipsecruleconfig........................................................................ 375
ipsectemplate........................................................................... 376
ipsectemplateikev1..................................................................377
ipsectemplateikev1<name>................................................... 378
ipsectemplateikev1<template-name>.................................... 378
ipsectemplateikev1all............................................................. 380
ipsectemplateikev1config....................................................... 381
ipsectemplateikev2..................................................................381
ipsectemplateikev2<name>................................................... 382
ipsectemplateikev2<template-name>.................................... 382
ipsectemplateikev2all............................................................. 384
ipsectemplateikev2config....................................................... 384
ipsecvpn................................................................................... 385
ipsecvpn<name>.....................................................................386
ipsecvpn<vpn-name>..............................................................386
ipsecvpn<vpn-name>certificate............................................. 387
ipsecvpn<vpn-name>certificate<certificate-value>............... 387
ipsecvpn<vpn-name>secret................................................... 389
ipsecvpn<vpn-name>secret<secret-value>.......................... 390
ipsecvpnall.............................................................................. 390
ipsecvpnconfig........................................................................ 391

13

MulticontrollerRNCSCLICommands

2.15
2.15.1
2.15.2
2.15.2.1
2.15.2.1.1
2.15.3
2.15.4
2.15.4.1
2.15.5
2.15.5.1
2.15.5.1.1
2.15.5.1.2
2.15.5.2
2.15.5.2.1
2.15.5.2.1.1
2.15.5.3
2.15.5.3.1
2.15.5.3.1.1
2.15.5.4
2.15.5.4.1
2.15.5.4.1.1
2.15.5.4.1.2
2.15.5.4.2
2.15.5.4.2.1
2.15.5.4.3
2.15.5.4.3.1
2.15.6
2.15.6.1
2.15.6.1.1
2.15.6.1.1.1
2.15.7
2.15.7.1
2.15.7.1.1
2.15.7.1.1.1
2.15.8
2.15.8.1
2.15.9
2.15.10
2.15.10.1
2.16
2.16.1
2.16.2
2.16.2.1
2.16.2.2

14

license....................................................................................... 392
licenseall.................................................................................. 393
licensedetails............................................................................394
licensedetailsunique-id............................................................394
licensedetailsunique-id<unique_id>....................................... 395
licenseexpired.......................................................................... 395
licensefeature...........................................................................396
licensefeatureall...................................................................... 396
licensefeature-mgmt.................................................................397
licensefeature-mgmtall............................................................ 398
licensefeature-mgmtalllist.......................................................398
licensefeature-mgmtalltable................................................... 399
licensefeature-mgmtcode........................................................399
licensefeature-mgmtcode<feature-code>.............................. 400
licensefeature-mgmtcode<feature-code>feature-admin-state....
400
licensefeature-mgmtname.......................................................401
licensefeature-mgmtname<feature-name>............................ 402
licensefeature-mgmtname<feature-name>feature-admin-state..
402
licensefeature-mgmtusage......................................................403
licensefeature-mgmtusageall................................................. 404
licensefeature-mgmtusagealllist............................................404
licensefeature-mgmtusagealltable........................................ 405
licensefeature-mgmtusagecode............................................. 405
licensefeature-mgmtusagecode<feature-code>....................406
licensefeature-mgmtusagename............................................406
licensefeature-mgmtusagename<feature-name>................. 406
licensefile................................................................................. 407
licensefile<file>........................................................................407
licensefile<file>auto-set-features........................................... 408
licensefile<file>auto-set-features<auto-set-features>........... 408
licensefolder............................................................................. 410
licensefolder<folder>...............................................................410
licensefolder<folder>auto-set-features................................... 411
licensefolder<folder>auto-set-features<auto-set-features>.. 412
licensegeneric-license..............................................................413
licensegeneric-licenseall......................................................... 413
licensetarget-id.........................................................................414
licenseunique-id....................................................................... 414
licenseunique-id<unique-id>................................................... 415
log............................................................................................. 415
logaudit-trail..............................................................................416
logconfig...................................................................................418
logconfigaudit-trail................................................................... 418
logconfigconfig-dir-debug........................................................420

Issue:03B

MulticontrollerRNCSCLICommands

2.16.3
2.17
2.17.1
2.17.1.1
2.17.1.1.1
2.17.1.1.2
2.17.1.1.3
2.17.1.1.3.1
2.17.1.1.4
2.17.1.1.4.1
2.17.1.1.5
2.17.1.1.5.1
2.17.1.2
2.17.1.2.1
2.17.1.3
2.17.1.3.1
2.17.1.4
2.17.1.4.1
2.17.1.5
2.17.1.5.1
2.17.1.6
2.17.1.6.1
2.17.1.7
2.17.1.7.1
2.17.1.7.1.1
2.17.1.7.2
2.17.1.7.2.1
2.17.2
2.17.2.1
2.17.2.2
2.17.2.2.1
2.17.3
2.17.3.1
2.17.3.1.1
2.17.3.1.1.1
2.17.3.1.2
2.17.3.1.2.1
2.17.3.1.3
2.17.3.1.3.1
2.17.3.1.4
2.17.3.1.4.1
2.17.3.1.5
2.17.3.1.5.1
2.17.3.1.6
2.17.3.1.6.1
2.17.3.1.7

Issue:03B

logmaster-syslog...................................................................... 420
networking.................................................................................421
networkingaclrule..................................................................... 423
networkingaclrule<owner>...................................................... 424
networkingaclrule<owner>accept...........................................428
networkingaclrule<owner>drop.............................................. 428
networkingaclrule<owner>dscp-mark.................................... 428
networkingaclrule<owner>dscp-mark<DSCP>..................... 429
networkingaclrule<owner>pip-mark....................................... 429
networkingaclrule<owner>pip-mark<PIP>............................ 430
networkingaclrule<owner>set-vrf........................................... 430
networkingaclrule<owner>set-vrf<VRF>...............................430
networkingaclrulechain............................................................431
networkingaclrulechain<chain>..............................................431
networkingaclruleindex............................................................432
networkingaclruleindex<index>..............................................433
networkingaclruleinput-iface....................................................433
networkingaclruleinput-iface<input-iface>..............................434
networkingaclruleoutput-iface................................................. 435
networkingaclruleoutput-iface<output-iface>......................... 435
networkingaclruleowner.......................................................... 436
networkingaclruleowner<owner>........................................... 436
networkingaclruleruntime........................................................ 437
networkingaclruleruntimeipv6.................................................438
networkingaclruleruntimeipv6node........................................438
networkingaclruleruntimenode............................................... 439
networkingaclruleruntimenode<node>.................................. 439
networkingaddress................................................................... 440
networkingaddress<owner>.................................................... 441
networkingaddressdedicated.................................................. 443
networkingaddressdedicated<owner>................................... 444
networkingconnection.............................................................. 445
networkingconnectionruntime................................................. 446
networkingconnectionruntimenode........................................ 447
networkingconnectionruntimenode<node>........................... 448
networkingconnectionruntimeraw4.........................................448
networkingconnectionruntimeraw4node................................448
networkingconnectionruntimeraw6.........................................449
networkingconnectionruntimeraw6node................................449
networkingconnectionruntimetcp4..........................................450
networkingconnectionruntimetcp4node.................................450
networkingconnectionruntimetcp6..........................................451
networkingconnectionruntimetcp6node.................................451
networkingconnectionruntimeudp4........................................ 452
networkingconnectionruntimeudp4node............................... 452
networkingconnectionruntimeudp6........................................ 453

15

MulticontrollerRNCSCLICommands

2.17.3.1.7.1
2.17.4
2.17.4.1
2.17.4.1.1
2.17.4.1.1.1
2.17.4.2
2.17.4.2.1
2.17.4.2.1.1
2.17.5
2.17.5.1
2.17.6
2.17.6.1
2.17.6.1.1
2.17.6.1.1.1
2.17.6.1.2
2.17.6.1.2.1
2.17.7
2.17.7.1
2.17.7.1.1
2.17.7.1.1.1
2.17.7.1.1.2
2.17.7.1.2
2.17.7.1.2.1
2.17.7.1.3
2.17.7.1.3.1
2.17.7.1.3.2
2.17.7.1.4
2.17.7.1.4.1
2.17.7.1.5
2.17.7.1.5.1
2.17.7.1.6
2.17.7.1.6.1
2.17.7.1.6.2
2.17.7.1.6.3
2.17.7.1.6.4
2.17.7.1.6.5
2.17.7.1.7
2.17.7.1.7.1
2.17.7.1.7.2
2.17.7.1.8
2.17.7.1.8.1
2.17.7.1.9
2.17.7.1.9.1
2.17.7.1.9.2
2.17.7.1.9.3

16

networkingconnectionruntimeudp6node............................... 453
networkingdiagnostics..............................................................454
networkingdiagnosticsping...................................................... 454
networkingdiagnosticspingnode............................................. 455
networkingdiagnosticspingnode<node>................................455
networkingdiagnosticstraceroute.............................................456
networkingdiagnosticstraceroutenode....................................456
networkingdiagnosticstraceroutenode<node>...................... 457
networkingether........................................................................457
networkingether<owner>.........................................................460
networkingforwarding-table...................................................... 462
networkingforwarding-tableruntime......................................... 463
networkingforwarding-tableruntimeipv6................................. 463
networkingforwarding-tableruntimeipv6node........................ 463
networkingforwarding-tableruntimenode................................ 464
networkingforwarding-tableruntimenode<node>...................464
networkinginstance.................................................................. 465
networkinginstance<instance>................................................467
networkinginstance<instance>address.................................. 469
networkinginstance<instance>address<owner>................... 470
networkinginstance<instance>addressdedicated................. 472
networkinginstance<instance>connection............................. 474
networkinginstance<instance>connectionruntime................ 475
networkinginstance<instance>diagnostics.............................483
networkinginstance<instance>diagnosticsping..................... 483
networkinginstance<instance>diagnosticstraceroute............485
networkinginstance<instance>ether.......................................486
networkinginstance<instance>ether<owner>........................489
networkinginstance<instance>forwarding-table..................... 491
networkinginstance<instance>forwarding-tableruntime........ 491
networkinginstance<instance>interface................................. 494
networkinginstance<instance>interface<owner>.................. 496
networkinginstance<instance>interfaceall-internal............... 497
networkinginstance<instance>interfaceiface........................ 498
networkinginstance<instance>interfaceowner...................... 499
networkinginstance<instance>interfaceruntime.................... 500
networkinginstance<instance>link-state-detector.................. 504
networkinginstance<instance>link-state-detector<owner>... 505
networkinginstance<instance>link-state-detectormonitoringgroup......................................................................................... 507
networkinginstance<instance>linkaggr.................................. 511
networkinginstance<instance>linkaggr<owner>................... 514
networkinginstance<instance>monitoring.............................. 516
networkinginstance<instance>monitoringbfd........................ 518
networkinginstance<instance>monitoringicmp..................... 525
networkinginstance<instance>monitoringtwamp.................. 531

Issue:03B

MulticontrollerRNCSCLICommands

2.17.7.1.10
2.17.7.1.10.1
2.17.7.1.10.2
2.17.7.1.10.3
2.17.7.1.10.4
2.17.7.1.10.5
2.17.7.1.10.6
2.17.7.1.11
2.17.7.1.11.1
2.17.8
2.17.8.1
2.17.8.2
2.17.8.2.1
2.17.8.2.1.1
2.17.8.3
2.17.8.3.1
2.17.8.4
2.17.8.4.1
2.17.8.5
2.17.8.5.1
2.17.8.5.1.1
2.17.8.5.2
2.17.8.5.2.1
2.17.8.5.3
2.17.8.5.3.1
2.17.8.5.3.2
2.17.9
2.17.10
2.17.11
2.17.12
2.17.12.1
2.17.12.2
2.17.12.2.1
2.17.12.2.1.1
2.17.12.2.1.2
2.17.13
2.17.13.1
2.17.14
2.17.14.1
2.17.14.1.1
2.17.14.1.2
2.17.14.1.3
2.17.14.1.3.1
2.17.14.2

Issue:03B

networkinginstance<instance>neigh...................................... 535
networkinginstance<instance>neigh<owner>....................... 536
networkinginstance<instance>neighaddress........................ 537
networkinginstance<instance>neighiface............................. 538
networkinginstance<instance>neighlladdr............................ 539
networkinginstance<instance>neighowner........................... 540
networkinginstance<instance>neighruntime......................... 540
networkinginstance<instance>vlan........................................ 543
networkinginstance<instance>vlan<owner>......................... 546
networkinginterface.................................................................. 548
networkinginterface<owner>................................................... 549
networkinginterfaceall-internal................................................ 551
networkinginterfaceall-internal<owner>................................. 551
networkinginterfaceall-internal<owner>admin.......................551
networkinginterfaceiface......................................................... 552
networkinginterfaceiface<iface>.............................................552
networkinginterfaceowner....................................................... 553
networkinginterfaceowner<owner>........................................ 553
networkinginterfaceruntime..................................................... 553
networkinginterfaceruntimeiface............................................ 554
networkinginterfaceruntimeiface<iface>................................554
networkinginterfaceruntimenode............................................ 555
networkinginterfaceruntimenode<node>...............................555
networkinginterfaceruntimetable............................................ 555
networkinginterfaceruntimetableiface....................................556
networkinginterfaceruntimetablenode................................... 557
networkingipbr..........................................................................557
networkingipro..........................................................................564
networkingiubsnt...................................................................... 569
networkinglink-state-detector................................................... 572
networkinglink-state-detector<owner>.................................... 573
networkinglink-state-detectormonitoring-group....................... 575
networkinglink-state-detectormonitoring-group<owner>........ 576
networkinglink-state-detectormonitoring-group<owner>ifacemon-group.................................................................................578
networkinglink-state-detectormonitoring-group<owner>nexthopmon-group.................................................................................580
networkinglinkaggr................................................................... 582
networkinglinkaggr<owner>.................................................... 584
networkingmonitoring............................................................... 587
networkingmonitoringbfd......................................................... 589
networkingmonitoringbfdconfig.............................................. 590
networkingmonitoringbfdruntime............................................ 590
networkingmonitoringbfdsession............................................591
networkingmonitoringbfdsession<owner>.............................592
networkingmonitoringicmp...................................................... 595

17

MulticontrollerRNCSCLICommands

2.17.14.2.1
2.17.14.2.2
2.17.14.2.3
2.17.14.2.3.1
2.17.14.3
2.17.14.3.1
2.17.14.3.2
2.17.15
2.17.15.1
2.17.15.2
2.17.15.2.1
2.17.15.3
2.17.15.3.1
2.17.15.4
2.17.15.4.1
2.17.15.5
2.17.15.5.1
2.17.15.6
2.17.15.6.1
2.17.15.6.1.1
2.17.15.6.2
2.17.15.6.2.1
2.17.16
2.17.16.1
2.17.16.2
2.17.17
2.17.17.1
2.17.17.1.1
2.17.17.1.1.1
2.17.18
2.17.18.1
2.17.18.2
2.17.18.2.1
2.17.19
2.17.19.1
2.17.20
2.17.21
2.18
2.18.1
2.18.2
2.18.3
2.19
2.19.1
2.19.2
2.19.2.1
2.19.2.2

18

networkingmonitoringicmpconfig............................................596
networkingmonitoringicmpruntime......................................... 597
networkingmonitoringicmpsession......................................... 598
networkingmonitoringicmpsession<owner>.......................... 599
networkingmonitoringtwamp................................................... 602
networkingmonitoringtwampreflector..................................... 603
networkingmonitoringtwampsender....................................... 604
networkingneigh....................................................................... 609
networkingneigh<owner>........................................................ 610
networkingneighaddress..........................................................611
networkingneighaddress<address>....................................... 611
networkingneighiface.............................................................. 612
networkingneighiface<iface>..................................................612
networkingneighlladdr............................................................. 613
networkingneighlladdr<lladdr>............................................... 613
networkingneighowner............................................................ 614
networkingneighowner<owner>............................................. 614
networkingneighruntime.......................................................... 615
networkingneighruntimeipv6.................................................. 615
networkingneighruntimeipv6node......................................... 615
networkingneighruntimenode................................................. 616
networkingneighruntimenode<node>....................................616
networkingqos-profile............................................................... 617
networkingqos-profileidsp....................................................... 618
networkingqos-profileiphb....................................................... 621
networkingqset......................................................................... 625
networkingqset<name>...........................................................626
networkingqset<name>queue................................................627
networkingqset<name>queue<id>........................................627
networkingswitch......................................................................628
networkingswitchport-group.................................................... 629
networkingswitchport-to-vlan...................................................630
networkingswitchport-to-vlan<owner>....................................630
networkingvlan......................................................................... 631
networkingvlan<owner>.......................................................... 633
networkingvlanmapping........................................................... 635
networkingvrf............................................................................637
networking-service.................................................................... 639
networking-servicedhcp........................................................... 640
networking-servicedns............................................................. 640
networking-servicentp.............................................................. 642
radio-network............................................................................ 643
radio-networkall........................................................................644
radio-networkcspudist.............................................................. 645
radio-networkcspudistby-cspuid..............................................645
radio-networkcspudistfor-all-cspu........................................... 646

Issue:03B

MulticontrollerRNCSCLICommands

2.19.3
2.19.4
2.19.4.1
2.19.4.2
2.19.5
2.19.5.1
2.19.5.1.1
2.19.5.1.2
2.19.5.1.3
2.19.5.2
2.19.5.3
2.19.5.4
2.19.5.5
2.19.5.6
2.19.5.7
2.19.6
2.19.6.1
2.19.6.2
2.19.6.3
2.19.6.4
2.19.6.5
2.19.6.6
2.19.7
2.19.7.1
2.19.8
2.19.9
2.19.10
2.19.11
2.19.11.1
2.19.11.2
2.19.11.3
2.19.12
2.19.12.1
2.19.12.2
2.19.12.3
2.19.12.4
2.19.12.5
2.19.12.6
2.19.12.7
2.19.13
2.19.13.1
2.19.13.2
2.19.14
2.19.14.1
2.19.14.2
2.19.14.3

Issue:03B

radio-networkiuparams.............................................................646
radio-networkomsconn.............................................................646
radio-networkomsconninsecure-bsom-connections................647
radio-networkomsconnsecure-bsom-connections...................648
radio-networkomsconn-config.................................................. 648
radio-networkomsconn-configclient-tls-mode..........................649
radio-networkomsconn-configclient-tls-modeforced...............649
radio-networkomsconn-configclient-tls-modeoff.....................650
radio-networkomsconn-configclient-tls-modeprobing.............650
radio-networkomsconn-configinsecure-bsom-restart.............. 650
radio-networkomsconn-configmodify...................................... 651
radio-networkomsconn-configoms-conn-reset........................ 652
radio-networkomsconn-configoms-switchover........................ 652
radio-networkomsconn-configsecure-bsom-restart.................652
radio-networkomsconn-configserving-oms-selection.............. 653
radio-networkrebalancing.........................................................653
radio-networkrebalancingby-btsid........................................... 654
radio-networkrebalancingby-don-cscp.................................... 655
radio-networkrebalancingby-rcv-cscp..................................... 655
radio-networkrebalancingby-rebalancingid............................. 655
radio-networkrebalancingby-timerange...................................656
radio-networkrebalancingforce................................................656
radio-networkrnc-id.................................................................. 657
radio-networkrnc-idcontinue-to-confirmation...........................657
radio-networkrnw-plan-error-log...............................................658
radio-networkrnw-plan-operation............................................. 658
radio-networkrnw-plan-operation-log....................................... 658
radio-networksubs-trace...........................................................659
radio-networksubs-traceactivate-trace.................................... 659
radio-networksubs-tracedeactivate-trace................................ 660
radio-networksubs-tracedisplay-trace..................................... 660
radio-networktraffic-restriction.................................................. 660
radio-networktraffic-restrictionaacr-list.................................... 662
radio-networktraffic-restrictioncmob-list...................................663
radio-networktraffic-restrictiondisable......................................663
radio-networktraffic-restrictionenable...................................... 663
radio-networktraffic-restrictionrestriction-group-name.............664
radio-networktraffic-restrictionrestriction-level.........................664
radio-networktraffic-restrictionwcels-for-cmob.........................665
radio-networkwbtsstatus.......................................................... 665
radio-networkwbtsstatusall......................................................666
radio-networkwbtsstatuswbts.................................................. 666
radio-networkwcel-balance...................................................... 667
radio-networkwcel-balancebalance.........................................668
radio-networkwcel-balanceempty............................................668
radio-networkwcel-balancegraceful-balance...........................669

19

MulticontrollerRNCSCLICommands

2.19.14.4
2.19.14.5
2.19.15
2.19.15.1
2.19.15.2
2.19.15.3
2.19.16
2.19.16.1
2.19.16.2
2.19.16.3
2.20
2.20.1
2.20.2
2.20.2.1
2.20.2.2
2.20.2.3
2.20.2.3.1
2.20.3
2.20.4
2.20.4.1
2.20.4.1.1
2.20.5
2.20.5.1
2.20.5.2
2.20.5.3
2.20.5.3.1
2.20.6
2.20.6.1
2.20.6.1.1
2.20.7
2.20.8
2.20.8.1
2.20.8.2
2.20.8.3
2.20.9
2.20.10
2.20.10.1
2.20.10.1.1
2.20.11
2.20.12
2.21
2.21.1
2.21.1.1
2.21.1.1.1
2.21.1.1.1.1
2.21.1.1.2

20

radio-networkwcel-balancemove.............................................670
radio-networkwcel-balancesimulate........................................ 671
radio-networkwcel-state........................................................... 671
radio-networkwcel-stateusing-cell-id....................................... 672
radio-networkwcel-stateusing-lcr-id.........................................672
radio-networkwcel-stateusing-wbts-id..................................... 673
radio-networkwcelstatus...........................................................674
radio-networkwcelstatusall...................................................... 675
radio-networkwcelstatusblocked............................................. 676
radio-networkwcelstatusfilter...................................................676
restore....................................................................................... 678
restoreactive.............................................................................681
restoreconfig............................................................................ 682
restoreconfigall........................................................................682
restoreconfigcurrent................................................................ 683
restoreconfiglabel....................................................................683
restoreconfiglabel<label-name>.............................................683
restorecontent.......................................................................... 684
restoredatabase....................................................................... 684
restoredatabasedb-name........................................................ 685
restoredatabasedb-name<db-name>.....................................685
restoredelivery..........................................................................685
restoredeliveryall..................................................................... 686
restoredeliverycurrent............................................................. 686
restoredeliverylabel................................................................. 687
restoredeliverylabel<label-name>.......................................... 687
restorefilesystem...................................................................... 687
restorefilesystemrg-name........................................................688
restorefilesystemrg-name<rg-name>..................................... 688
restorefull................................................................................. 689
restoremode............................................................................. 689
restoremodeforce.................................................................... 690
restoremodeno-exec............................................................... 690
restoremodenormal................................................................. 691
restorepartial............................................................................ 691
restoreplugin............................................................................ 692
restorepluginplugin-name........................................................692
restorepluginplugin-name<plugin-name>...............................693
restoreselective........................................................................ 693
restorestate.............................................................................. 694
routing....................................................................................... 695
routingaggregate...................................................................... 696
routingaggregate<IP_PREFIX>.............................................. 698
routingaggregate<IP_PREFIX>aspath-truncate.................... 699
routingaggregate<IP_PREFIX>aspath-truncate<option>..... 699
routingaggregate<IP_PREFIX>contributing-protocol.............699

Issue:03B

MulticontrollerRNCSCLICommands

2.21.1.1.2.1
2.21.1.1.3
2.21.1.1.4
2.21.1.1.4.1
2.21.1.1.5
2.21.1.1.5.1
2.21.2
2.21.2.1
2.21.2.1.1
2.21.3
2.21.4
2.21.4.1
2.21.4.2
2.21.4.2.1
2.21.5
2.21.5.1
2.21.5.1.1
2.21.5.1.1.1
2.21.5.1.1.2
2.21.5.1.2
2.21.5.1.2.1
2.21.5.1.2.2
2.21.5.1.3
2.21.5.1.3.1
2.21.5.1.3.2
2.21.5.2
2.21.5.2.1
2.21.5.2.2
2.21.5.2.2.1
2.21.6
2.21.6.1
2.21.6.1.1
2.21.6.1.1.1
2.21.6.1.1.2
2.21.6.1.1.3
2.21.6.1.2
2.21.6.1.3
2.21.6.1.3.1
2.21.6.1.4
2.21.6.2
2.21.6.2.1
2.21.6.2.1.1
2.21.7
2.21.7.1
2.21.7.2

Issue:03B

routingaggregate<IP_PREFIX>contributing-protocol
<PROTOCOL>.......................................................................... 700
routingaggregate<IP_PREFIX>off......................................... 704
routingaggregate<IP_PREFIX>rank...................................... 704
routingaggregate<IP_PREFIX>rank<rank>.......................... 704
routingaggregate<IP_PREFIX>weight................................... 705
routingaggregate<IP_PREFIX>weight<weight>................... 705
routingaggregation................................................................... 705
routingaggregationconfig.........................................................706
routingaggregationconfigall.................................................... 706
routingbfd................................................................................. 706
routingbfd-static-holdtime.........................................................707
routingbfd-static-holdtime<holdtime>...................................... 708
routingbfd-static-holdtimeconfig.............................................. 708
routingbfd-static-holdtimeconfigall..........................................709
routingexport............................................................................ 709
routingexport<export-protocol>............................................... 711
routingexport<export-protocol>aggregate..............................712
routingexport<export-protocol>aggregate<IP_PREFIX>...... 712
routingexport<export-protocol>aggregateall......................... 714
routingexport<export-protocol>direct..................................... 715
routingexport<export-protocol>directall.................................716
routingexport<export-protocol>directinterface-name............ 717
routingexport<export-protocol>static-route............................ 719
routingexport<export-protocol>static-route<static-route>..... 720
routingexport<export-protocol>static-routeall........................721
routingexportconfig..................................................................723
routingexportconfigall............................................................. 723
routingexportconfigproto........................................................ 724
routingexportconfigproto<export-proto>................................724
routinginbound-filter................................................................. 724
routinginbound-filter<import-proto>.........................................726
routinginbound-filter<import-proto><IP_PREFIX>................. 727
routinginbound-filter<import-proto><IP_PREFIX><status>.. 729
routinginbound-filter<import-proto><IP_PREFIX>filter......... 730
routinginbound-filter<import-proto><IP_PREFIX>rank......... 738
routinginbound-filter<import-proto>accept............................. 739
routinginbound-filter<import-proto>rank.................................740
routinginbound-filter<import-proto>rank<rankvalue>............ 740
routinginbound-filter<import-proto>restrict............................. 740
routinginbound-filterconfig.......................................................741
routinginbound-filterconfigproto..............................................741
routinginbound-filterconfigproto<import-proto>..................... 741
routingipsrd.............................................................................. 742
routingipsrdkrt......................................................................... 743
routingipsrdresources..............................................................743

21

MulticontrollerRNCSCLICommands

2.21.7.3
2.21.8
2.21.8.1
2.21.8.2
2.21.8.2.1
2.21.9
2.21.9.1
2.21.9.1.1
2.21.9.1.1.1
2.21.9.1.1.2
2.21.9.1.1.3
2.21.9.1.1.4
2.21.9.1.2
2.21.9.1.2.1
2.21.9.1.2.2
2.21.9.1.2.3
2.21.9.1.2.4
2.21.9.2
2.21.9.3
2.21.9.3.1
2.21.9.4
2.21.9.4.1
2.21.9.4.2
2.21.9.4.2.1
2.21.9.4.3
2.21.9.4.3.1
2.21.9.4.4
2.21.9.4.4.1
2.21.9.4.5
2.21.9.4.6
2.21.9.4.7
2.21.9.4.7.1
2.21.9.4.8
2.21.9.4.8.1
2.21.9.4.9
2.21.9.4.9.1
2.21.9.4.10
2.21.9.4.10.1
2.21.9.4.11
2.21.9.4.11.1
2.21.9.5
2.21.9.5.1
2.21.9.6
2.21.9.6.1
2.21.9.7
2.21.9.7.1

22

routingipsrdversion..................................................................743
routingmax-path-splits..............................................................744
routingmax-path-splits<max-path-splits>................................ 744
routingmax-path-splitsconfig................................................... 745
routingmax-path-splitsconfigall...............................................745
routingospf............................................................................... 745
routingospfarea....................................................................... 747
routingospfarea<OSPF_AREA>............................................ 748
routingospfarea<OSPF_AREA><option>............................. 749
routingospfarea<OSPF_AREA>range.................................. 749
routingospfarea<OSPF_AREA>stub.....................................751
routingospfarea<OSPF_AREA>stub-network.......................754
routingospfarea<backbone>.................................................. 757
routingospfarea<backbone><option>................................... 758
routingospfarea<backbone>range........................................ 758
routingospfarea<backbone>stub-network.............................760
routingospfarea<backbone>virtual-link................................. 763
routingospfborder-routers........................................................775
routingospfconfig.....................................................................776
routingospfconfigall................................................................ 776
routingospfdatabase................................................................777
routingospfdatabase<output_level>....................................... 778
routingospfdatabasearea....................................................... 778
routingospfdatabasearea<area_ip_address>....................... 778
routingospfdatabaseareas......................................................779
routingospfdatabaseareas<output_level>............................. 780
routingospfdatabaseasbr-summary-lsa..................................780
routingospfdatabaseasbr-summary-lsa<output_level>......... 780
routingospfdatabasechecksum.............................................. 781
routingospfdatabasedatabase-summary................................781
routingospfdatabaseexternal-lsa............................................ 781
routingospfdatabaseexternal-lsa<output_level>................... 782
routingospfdatabasenetwork-lsa............................................ 782
routingospfdatabasenetwork-lsa<output_level>....................782
routingospfdatabaserouter-lsa............................................... 783
routingospfdatabaserouter-lsa<output_level>.......................783
routingospfdatabasesummary-lsa.......................................... 783
routingospfdatabasesummary-lsa<output_level>................. 784
routingospfdatabasetype........................................................784
routingospfdatabasetype<type_val>..................................... 784
routingospfdefault-ase-cost.....................................................785
routingospfdefault-ase-cost<default-ase-cost>...................... 786
routingospfdefault-ase-type.....................................................786
routingospfdefault-ase-type<default-ase-type>......................786
routingospferrors..................................................................... 787
routingospferrorsdd................................................................ 787

Issue:03B

MulticontrollerRNCSCLICommands

2.21.9.7.2
2.21.9.7.3
2.21.9.7.4
2.21.9.7.5
2.21.9.7.6
2.21.9.7.7
2.21.9.8
2.21.9.9
2.21.9.9.1
2.21.9.9.1.1
2.21.9.9.1.2
2.21.9.9.1.3
2.21.9.9.1.4
2.21.9.9.1.5
2.21.9.9.1.6
2.21.9.9.1.7
2.21.9.9.1.8
2.21.9.9.1.9
2.21.9.9.1.10
2.21.9.9.1.11
2.21.9.9.1.12
2.21.9.9.1.13
2.21.9.9.2
2.21.9.9.2.1
2.21.9.10
2.21.9.10.1
2.21.9.11
2.21.9.11.1
2.21.9.11.1.1
2.21.9.12
2.21.9.12.1
2.21.9.13
2.21.9.14
2.21.9.14.1
2.21.9.15
2.21.9.15.1
2.21.9.16
2.21.9.16.1
2.21.9.17
2.21.9.18
2.21.9.18.1
2.21.9.18.1.1
2.21.9.18.2
2.21.9.18.2.1
2.21.9.18.3
2.21.9.18.3.1

Issue:03B

routingospferrorshello............................................................ 788
routingospferrorsip................................................................. 788
routingospferrorslsack............................................................788
routingospferrorslsr................................................................ 789
routingospferrorslsu............................................................... 789
routingospferrorsprotocol....................................................... 789
routingospfevents....................................................................790
routingospfinterface.................................................................790
routingospfinterface<IFNAME>..............................................792
routingospfinterface<IFNAME>area......................................793
routingospfinterface<IFNAME>authtype............................... 794
routingospfinterface<IFNAME>bfd-detect-mult.....................798
routingospfinterface<IFNAME>bfd-monitoring......................799
routingospfinterface<IFNAME>bfd-rx-interval.......................801
routingospfinterface<IFNAME>bfd-tx-interval....................... 802
routingospfinterface<IFNAME>cost...................................... 804
routingospfinterface<IFNAME>dead-interval........................ 804
routingospfinterface<IFNAME>fast-hello-interval................. 805
routingospfinterface<IFNAME>hello-interval........................ 806
routingospfinterface<IFNAME>passive.................................806
routingospfinterface<IFNAME>priority.................................. 807
routingospfinterface<IFNAME>retransmit-interval................ 808
routingospfinterface<interface_name>...................................809
routingospfinterface<interface_name><detailed>.................809
routingospfinterfaces...............................................................809
routingospfinterfaces<detailed>............................................. 810
routingospfneighbor................................................................ 810
routingospfneighbor<neighbor_id>.........................................811
routingospfneighbor<neighbor_id><detailed>....................... 811
routingospfneighbors............................................................... 811
routingospfneighbors<detailed>.............................................812
routingospfpackets.................................................................. 812
routingospfrfc1583-compatibility............................................. 812
routingospfrfc1583-compatibility<option>.............................. 813
routingospfspf-delay................................................................813
routingospfspf-delay<spf_delay>........................................... 813
routingospfspf-holdtime...........................................................814
routingospfspf-holdtime<spf-holdtime>.................................. 814
routingospfsummary................................................................814
routingospfthrottle................................................................... 815
routingospfthrottlespf-delay....................................................815
routingospfthrottlespf-delay<spf_delay>............................... 816
routingospfthrottlespf-holdtime-max.......................................816
routingospfthrottlespf-holdtime-max<spf-holdtime-max>...... 816
routingospfthrottlespf-holdtime-start.......................................817
routingospfthrottlespf-holdtime-start<spf-holdtime-start>......817

23

MulticontrollerRNCSCLICommands

2.21.10
2.21.10.1
2.21.10.1.1
2.21.10.2
2.21.10.2.1
2.21.10.2.1.1
2.21.10.2.2
2.21.10.2.2.1
2.21.11
2.21.11.1
2.21.11.2
2.21.11.2.1
2.21.11.3
2.21.11.3.1
2.21.11.4
2.21.11.4.1
2.21.11.5
2.21.11.5.1
2.21.11.6
2.21.11.6.1
2.21.11.7
2.21.11.7.1
2.21.11.8
2.21.12
2.21.12.1
2.21.12.2
2.21.13
2.21.13.1
2.21.13.1.1
2.21.13.1.1.1
2.21.13.1.2
2.21.13.1.2.1
2.21.13.1.2.2
2.21.13.1.3
2.21.13.1.4
2.21.13.1.4.1
2.21.13.1.5
2.21.13.1.5.1
2.21.13.2
2.21.13.2.1
2.21.14
2.21.14.1
2.21.14.1.1
2.21.14.1.1.1
2.21.14.1.2
2.21.14.2

24

routingprotocol-rank................................................................. 817
routingprotocol-rankconfig.......................................................818
routingprotocol-rankconfigall.................................................. 819
routingprotocol-rankprotocol................................................... 819
routingprotocol-rankprotocolospf............................................820
routingprotocol-rankprotocolospfrank....................................820
routingprotocol-rankprotocolospfase......................................821
routingprotocol-rankprotocolospfaserank..............................821
routingroute.............................................................................. 822
routingroute<protocoltype>..................................................... 823
routingrouteall......................................................................... 823
routingrouteall<protocoltype>.................................................823
routingroutedestination............................................................824
routingroutedestination<destination_ip_address>................. 824
routingrouteexact.................................................................... 824
routingrouteexact<ipaddress_mask>..................................... 825
routingrouteinactive.................................................................825
routingrouteinactive<protocoltype>........................................ 825
routingrouteless-specific......................................................... 826
routingrouteless-specific<ipaddress_mask>.......................... 826
routingroutemore-specific........................................................826
routingroutemore-specific<ipaddress_mask>........................ 827
routingroutesummary.............................................................. 827
routingrouter-id.........................................................................827
routingrouter-id<router-id>...................................................... 828
routingrouter-idall.................................................................... 828
routingstatic-route.................................................................... 829
routingstatic-route<Destination>............................................. 830
routingstatic-route<Destination>mtu...................................... 832
routingstatic-route<Destination>mtu<mtu>........................... 832
routingstatic-route<Destination>nexthop............................... 833
routingstatic-route<Destination>nexthop<option>................ 834
routingstatic-route<Destination>nexthopgateway................. 834
routingstatic-route<Destination>off........................................ 848
routingstatic-route<Destination>rank..................................... 848
routingstatic-route<Destination>rank<rank>......................... 848
routingstatic-route<Destination>source................................. 849
routingstatic-route<Destination>source<source>................. 849
routingstatic-routeconfig..........................................................849
routingstatic-routeconfigall..................................................... 850
routingtrace.............................................................................. 850
routingtraceglobal....................................................................851
routingtraceglobal<GLOBAL_TRACEOPTION>.................... 852
routingtraceglobal<GLOBAL_TRACEOPTION><option>..... 852
routingtraceglobalconfig......................................................... 852
routingtracekernel................................................................... 853

Issue:03B

MulticontrollerRNCSCLICommands

2.21.14.2.1
2.21.14.2.1.1
2.21.14.2.2
2.21.14.3
2.21.14.3.1
2.21.14.3.1.1
2.21.14.3.2
2.21.15
2.21.15.1
2.21.15.2
2.21.15.2.1
2.21.15.3
2.21.15.3.1
2.22
2.22.1
2.22.1.1
2.22.1.1.1
2.22.1.1.1.1
2.22.1.1.1.2
2.22.1.1.1.3
2.22.1.1.1.4
2.22.1.1.1.5
2.22.1.1.1.6
2.22.1.1.1.7
2.22.1.1.2
2.22.1.1.2.1
2.22.1.1.3
2.22.1.1.4
2.22.1.1.4.1
2.22.1.1.4.2
2.22.1.1.5
2.22.1.1.5.1
2.22.1.1.5.2
2.22.1.1.6
2.22.1.1.7
2.22.1.1.8
2.22.1.1.9
2.22.1.2
2.22.1.2.1
2.22.1.2.1.1
2.22.2
2.22.2.1
2.22.2.2
2.22.2.2.1
2.22.2.2.2
2.22.2.2.2.1

Issue:03B

routingtracekernel<KERNEL_TRACEOPTION>....................854
routingtracekernel<KERNEL_TRACEOPTION><option>.....854
routingtracekernelconfig.........................................................854
routingtraceospf...................................................................... 855
routingtraceospf<OSPF_TRACEOPTION>........................... 856
routingtraceospf<OSPF_TRACEOPTION><option>............ 856
routingtraceospfconfig............................................................856
routingtracefile..........................................................................857
routingtracefileconfig............................................................... 857
routingtracefilemaxnum...........................................................858
routingtracefilemaxnum<maxnum>........................................858
routingtracefilesize.................................................................. 858
routingtracefilesize<size>.......................................................859
security......................................................................................859
securitycert...............................................................................860
securitycert<domain>..............................................................862
securitycert<domain>ca-cert..................................................863
securitycert<domain>ca-certall............................................. 864
securitycert<domain>ca-certca-id......................................... 865
securitycert<domain>ca-certcert-directory............................866
securitycert<domain>ca-certcert-file..................................... 868
securitycert<domain>ca-certintermediate............................. 869
securitycert<domain>ca-certissuer-id................................... 870
securitycert<domain>ca-certtrust-anchor..............................871
securitycert<domain>cert-chain............................................. 873
securitycert<domain>cert-chainee-cert.................................873
securitycert<domain>cmp...................................................... 873
securitycert<domain>cmp-request.........................................874
securitycert<domain>cmp-requestinitialize........................... 875
securitycert<domain>cmp-requestkey-update...................... 876
securitycert<domain>ee-candidate-key................................. 876
securitycert<domain>ee-candidate-keyauto-generate..........877
securitycert<domain>ee-candidate-keyfile............................877
securitycert<domain>ee-cert..................................................878
securitycert<domain>ee-cert-profile.......................................879
securitycert<domain>ee-private-key...................................... 881
securitycert<domain>validation-policy................................... 881
securitycertby-serial-nr............................................................882
securitycertby-serial-nree-cert................................................882
securitycertby-serial-nree-certissuer-id................................. 883
securitycred..............................................................................883
securitycredldap-and-cred.......................................................885
securitycredonly-cred.............................................................. 885
securitycredonly-credcred-service-file-path........................... 887
securitycredonly-credpasswd-file........................................... 888
securitycredonly-credpasswd-file<passwd_file_name>........ 888

25

MulticontrollerRNCSCLICommands

2.22.2.2.3
2.23
2.23.1
2.23.1.1
2.23.1.1.1
2.23.1.1.2
2.23.1.1.2.1
2.23.1.2
2.23.1.2.1
2.23.1.2.2
2.23.1.2.2.1
2.23.1.3
2.23.1.3.1
2.23.1.3.2
2.23.1.3.2.1
2.23.2
2.23.2.1
2.23.2.1.1
2.23.2.1.2
2.23.2.1.2.1
2.23.2.2
2.23.2.2.1
2.23.2.2.2
2.23.2.2.2.1
2.23.2.3
2.23.2.4
2.23.2.4.1
2.23.2.4.2
2.23.2.4.2.1
2.23.2.5
2.23.2.5.1
2.23.2.5.2
2.23.2.5.2.1
2.23.2.6
2.23.2.6.1
2.23.2.6.2
2.23.2.6.2.1
2.23.2.6.3
2.23.2.6.3.1
2.23.2.7
2.23.2.7.1
2.23.2.7.1.1
2.23.2.7.2
2.23.2.7.2.1
2.23.2.8

26

securitycredonly-credpassword..............................................889
signaling.................................................................................... 890
signalingglobal-title-translation.................................................891
signalingglobal-title-translationaction...................................... 893
signalingglobal-title-translationactionall..................................898
signalingglobal-title-translationactionname............................ 898
signalingglobal-title-translationactionname<name>.............. 898
signalingglobal-title-translationresult....................................... 899
signalingglobal-title-translationresultall.................................. 900
signalingglobal-title-translationresultname............................. 900
signalingglobal-title-translationresultname<name>...............901
signalingglobal-title-translationrule..........................................901
signalingglobal-title-translationruleall..................................... 903
signalingglobal-title-translationrulename................................903
signalingglobal-title-translationrulename<name>..................904
signalingsccp............................................................................904
signalingsccpconcerned-point-code........................................906
signalingsccpconcerned-point-codeall................................... 907
signalingsccpconcerned-point-codename..............................907
signalingsccpconcerned-point-codename<name>................908
signalingsccpconcerned-subsystem....................................... 908
signalingsccpconcerned-subsystemall...................................909
signalingsccpconcerned-subsystemname............................. 910
signalingsccpconcerned-subsystemname<name>............... 910
signalingsccpconnections........................................................911
signalingsccpdestination-point-code........................................911
signalingsccpdestination-point-codeall...................................912
signalingsccpdestination-point-codename............................. 912
signalingsccpdestination-point-codename<name>............... 913
signalingsccpown-point-code.................................................. 913
signalingsccpown-point-codeall............................................. 914
signalingsccpown-point-codename........................................ 914
signalingsccpown-point-codename<name>..........................915
signalingsccpsccp-timer-profile............................................... 915
signalingsccpsccp-timer-profileall.......................................... 918
signalingsccpsccp-timer-profilefrom-template........................918
signalingsccpsccp-timer-profilefrom-template<template-name>.
919
signalingsccpsccp-timer-profilename..................................... 921
signalingsccpsccp-timer-profilename<name>.......................922
signalingsccpssp-filter-timer....................................................923
signalingsccpssp-filter-timerstatus......................................... 924
signalingsccpssp-filter-timerstatus<status>.......................... 924
signalingsccpssp-filter-timervalue.......................................... 924
signalingsccpssp-filter-timervalue<value>............................ 925
signalingsccpsubsystem......................................................... 925

Issue:03B

MulticontrollerRNCSCLICommands

2.23.2.8.1
2.23.2.8.2
2.23.2.8.2.1
2.23.3
2.23.3.1
2.23.3.2
2.23.3.2.1
2.23.3.2.1.1
2.23.3.3
2.23.3.3.1
2.23.4
2.23.4.1
2.23.4.2
2.23.4.2.1
2.23.5
2.23.5.1
2.23.5.1.1
2.23.5.2
2.23.5.2.1
2.23.5.2.2
2.23.5.2.2.1
2.23.5.3
2.23.5.3.1
2.23.5.3.2
2.23.5.3.2.1
2.23.5.4
2.23.5.4.1
2.23.5.4.2
2.23.5.4.2.1
2.24
2.24.1
2.24.2
2.24.3
2.24.4
2.24.5
2.25
2.25.1
2.25.1.1
2.25.1.1.1
2.25.1.1.2
2.25.1.1.2.1
2.25.1.1.3
2.25.1.1.3.1
2.25.1.2
2.25.1.2.1
2.25.1.2.1.1

Issue:03B

signalingsccpsubsystemall.....................................................926
signalingsccpsubsystemname............................................... 927
signalingsccpsubsystemname<name>................................. 927
signalingsctp-profile................................................................. 927
signalingsctp-profileall.............................................................930
signalingsctp-profilefrom-template.......................................... 931
signalingsctp-profilefrom-template<template-name>............. 931
signalingsctp-profilefrom-template<template-name>name... 931
signalingsctp-profilename....................................................... 934
signalingsctp-profilename<name>......................................... 935
signalingservice-access-point.................................................. 937
signalingservice-access-pointall..............................................939
signalingservice-access-pointname........................................ 939
signalingservice-access-pointname<name>.......................... 939
signalingss7............................................................................. 940
signalingss7as.........................................................................941
signalingss7asall.................................................................... 942
signalingss7association.......................................................... 942
signalingss7associationall......................................................946
signalingss7associationid.......................................................946
signalingss7associationid<id>...............................................946
signalingss7local-as................................................................ 946
signalingss7local-asall........................................................... 948
signalingss7local-asname...................................................... 949
signalingss7local-asname<name>........................................949
signalingss7remote-as............................................................ 950
signalingss7remote-asall........................................................953
signalingss7remote-asname.................................................. 953
signalingss7remote-asname<name>.................................... 954
snapshot....................................................................................954
snapshotcurrent-startup........................................................... 957
snapshotcurrentall-startup........................................................958
snapshotlist.............................................................................. 959
snapshotlistall...........................................................................960
snapshotstartup........................................................................960
stats...........................................................................................961
statsdata...................................................................................972
statsdatacurrent...................................................................... 973
statsdatacurrentall-objects..................................................... 974
statsdatacurrentname............................................................ 974
statsdatacurrentname<name>.............................................. 974
statsdatacurrentobject-list-id.................................................. 975
statsdatacurrentobject-list-id<object-list-id>..........................975
statsdatareports...................................................................... 975
statsdatareportsid...................................................................976
statsdatareportsid<id_value>................................................ 976

27

MulticontrollerRNCSCLICommands

2.25.1.2.2
2.25.1.2.2.1
2.25.2
2.25.2.1
2.25.2.2
2.25.2.2.1
2.25.2.2.1.1
2.25.2.2.1.2
2.25.2.2.2
2.25.2.3
2.25.2.3.1
2.25.2.3.1.1
2.25.2.3.1.2
2.25.2.3.2
2.25.3
2.25.3.1
2.25.3.1.1
2.25.3.2
2.25.3.2.1
2.25.4
2.25.4.1
2.25.4.2
2.25.4.2.1
2.25.5
2.25.5.1
2.25.5.2
2.25.5.2.1
2.25.5.2.2
2.25.5.3
2.25.5.3.1
2.25.5.3.2
2.25.5.4
2.25.5.4.1
2.25.6
2.25.6.1
2.25.6.2
2.25.6.2.1
2.25.6.2.1.1
2.25.6.2.1.2
2.25.6.2.2
2.25.6.3
2.25.6.3.1
2.25.6.3.1.1
2.25.6.3.1.2
2.25.6.3.2
2.25.7

28

statsdatareportsname............................................................ 977
statsdatareportsname<name_value>....................................977
statsm-job.................................................................................978
statsm-joball............................................................................ 980
statsm-jobid.............................................................................981
statsm-jobid<id>.....................................................................981
statsm-jobid<id>disabled...................................................... 982
statsm-jobid<id>enabled....................................................... 982
statsm-jobid<id_value>.......................................................... 982
statsm-jobname.......................................................................983
statsm-jobname<name>........................................................ 983
statsm-jobname<name>disabled.......................................... 984
statsm-jobname<name>enabled...........................................984
statsm-jobname<name_value>..............................................985
statsm-period........................................................................... 985
statsm-periodid........................................................................985
statsm-periodid<id>................................................................986
statsm-periodname................................................................. 986
statsm-periodname<name>................................................... 986
statsm-type...............................................................................987
statsm-typeall.......................................................................... 987
statsm-typeid...........................................................................988
statsm-typeid<id>...................................................................988
statsobj-list............................................................................... 988
statsobj-listall...........................................................................989
statsobj-listid........................................................................... 990
statsobj-listid<id>................................................................... 990
statsobj-listid<id_value>.........................................................990
statsobj-listname..................................................................... 991
statsobj-listname<name>....................................................... 991
statsobj-listname<name_value>............................................ 991
statsobj-listomes..................................................................... 992
statsobj-listomes<omes>....................................................... 992
statst-job...................................................................................993
statst-joball.............................................................................. 995
statst-jobid...............................................................................995
statst-jobid<id>.......................................................................996
statst-jobid<id>disabled........................................................ 996
statst-jobid<id>enabled......................................................... 997
statst-jobid<id_value>............................................................ 997
statst-jobname.........................................................................997
statst-jobname<name>.......................................................... 998
statst-jobname<name>disabled............................................ 999
statst-jobname<name>enabled.............................................999
statst-jobname<name_value>................................................999
statst-values............................................................................. 999

Issue:03B

MulticontrollerRNCSCLICommands

2.25.7.1
2.25.7.1.1
2.25.7.2
2.25.7.2.1
2.26
2.26.1
2.26.1.1
2.26.1.1.1
2.26.1.2
2.26.1.2.1
2.26.1.2.2
2.26.2
2.26.2.1
2.26.2.2
2.26.2.3
2.26.2.4
2.26.2.5
2.26.2.6
2.26.2.6.1
2.26.2.6.1.1
2.26.2.6.2
2.26.2.7
2.26.3
2.26.3.1
2.26.3.2
2.26.3.2.1
2.26.4
2.26.5
2.26.5.1
2.26.5.2
2.26.5.2.1
2.26.6
2.26.6.1
2.26.7
2.26.7.1
2.26.7.1.1
2.26.7.1.2
2.26.7.1.2.1
2.26.7.1.3
2.26.7.1.3.1
2.26.7.2
2.26.7.2.1
2.26.7.2.2

Issue:03B

statst-valuesid....................................................................... 1000
statst-valuesid<id>............................................................... 1000
statst-valuesname................................................................. 1002
statst-valuesname<name>...................................................1002
sw-manage..............................................................................1003
sw-manageactivate................................................................ 1005
sw-manageactivatedelivery-label.......................................... 1006
sw-manageactivatedelivery-label<delivery-label>................1006
sw-manageactivatereconvert-running-config........................ 1007
sw-manageactivatereconvert-running-configno................... 1007
sw-manageactivatereconvert-running-configyes..................1007
sw-manageapp-sw-mgmt.......................................................1008
sw-manageapp-sw-mgmtactivate......................................... 1009
sw-manageapp-sw-mgmtbuilds............................................ 1010
sw-manageapp-sw-mgmtchange-name................................1010
sw-manageapp-sw-mgmtchange-status................................1011
sw-manageapp-sw-mgmtdatabase....................................... 1011
sw-manageapp-sw-mgmtfb-build.......................................... 1011
sw-manageapp-sw-mgmtfb-buildbuild-name....................... 1012
sw-manageapp-sw-mgmtfb-buildbuild-name<build-name>........
1012
sw-manageapp-sw-mgmtfb-buildoverwrite.......................... 1012
sw-manageapp-sw-mgmtnormalize...................................... 1013
sw-manageauto-return........................................................... 1013
sw-manageauto-returncriteria............................................... 1014
sw-manageauto-returnstate.................................................. 1015
sw-manageauto-returnstate<state>..................................... 1015
sw-manageconfig-import........................................................1016
sw-managecurrent................................................................. 1016
sw-managecurrentall.............................................................1017
sw-managecurrentnode........................................................ 1017
sw-managecurrentnode<node-name>................................. 1017
sw-managedelivery................................................................ 1017
sw-managedelivery<delivery-label>......................................1018
sw-manageembedded-sw...................................................... 1019
sw-manageembedded-swactivate.........................................1020
sw-manageembedded-swactivateall.................................... 1021
sw-manageembedded-swactivatefru-location......................1021
sw-manageembedded-swactivatefru-location<fru-location>.......
1021
sw-manageembedded-swactivatenode................................1022
sw-manageembedded-swactivatenode<node-name>........ 1022
sw-manageembedded-swrollback.........................................1023
sw-manageembedded-swrollbackall.................................... 1023
sw-manageembedded-swrollbackfru-location......................1024

29

MulticontrollerRNCSCLICommands

2.26.7.2.2.1
2.26.7.2.3
2.26.7.2.3.1
2.26.7.3
2.26.7.3.1
2.26.7.3.2
2.26.7.3.2.1
2.26.7.3.3
2.26.7.3.3.1
2.26.7.4
2.26.7.4.1
2.26.7.4.2
2.26.7.4.2.1
2.26.7.4.3
2.26.7.4.3.1
2.26.7.5
2.26.7.5.1
2.26.7.5.2
2.26.7.5.2.1
2.26.7.5.3
2.26.7.5.3.1
2.26.8
2.26.8.1
2.26.8.1.1
2.26.8.2
2.26.8.2.1
2.26.9
2.26.9.1
2.26.9.2
2.26.10
2.26.10.1
2.27
2.27.1
2.27.2
2.27.2.1
2.27.3
2.27.3.1
2.27.3.1.1
2.27.3.1.1.1
2.27.3.1.2
2.27.3.1.2.1
2.27.4
2.28

30

sw-manageembedded-swrollbackfru-location<fru-location>.......
1024
sw-manageembedded-swrollbacknode................................1025
sw-manageembedded-swrollbacknode<node-name>........ 1025
sw-manageembedded-swstatus........................................... 1026
sw-manageembedded-swstatusall.......................................1026
sw-manageembedded-swstatusfru-location.........................1027
sw-manageembedded-swstatusfru-location<fru-location>..1027
sw-manageembedded-swstatusnode.................................. 1027
sw-manageembedded-swstatusnode<node>..................... 1028
sw-manageembedded-swupgrade........................................1028
sw-manageembedded-swupgradeall................................... 1029
sw-manageembedded-swupgradefru-location..................... 1030
sw-manageembedded-swupgradefru-location<fru-location>......
1030
sw-manageembedded-swupgradenode...............................1032
sw-manageembedded-swupgradenode<node-name>....... 1032
sw-manageembedded-swversion......................................... 1034
sw-manageembedded-swversionall.....................................1034
sw-manageembedded-swversionfru-location.......................1034
sw-manageembedded-swversionfru-location<fru-location>........
1035
sw-manageembedded-swversionnode................................ 1035
sw-manageembedded-swversionnode<node>................... 1035
sw-manageinstall................................................................... 1036
sw-manageinstalldelivery...................................................... 1036
sw-manageinstalldelivery<delivery-name>.......................... 1037
sw-manageinstallremote-delivery..........................................1037
sw-manageinstallremote-delivery<remote-delivery-name>. 1038
sw-managelist........................................................................ 1038
sw-managelistarch................................................................ 1039
sw-managelistimgvar............................................................ 1039
sw-manageontop....................................................................1039
sw-manageontopinstall......................................................... 1040
symptom-report....................................................................... 1041
symptom-reportall.................................................................. 1043
symptom-reportgroup.............................................................1043
symptom-reportgroup<group>.............................................. 1044
symptom-reportname............................................................. 1044
symptom-reportname<report-name>.................................... 1045
symptom-reportname<report-name>from............................ 1049
symptom-reportname<report-name>fromdate-time............ 1050
symptom-reportname<report-name>to................................ 1053
symptom-reportname<report-name>todate-time................ 1054
symptom-reportplugin-list.......................................................1055
tools.........................................................................................1055

Issue:03B

MulticontrollerRNCSCLICommands

2.28.1
2.28.1.1
2.28.1.1.1
2.28.1.1.1.1
2.28.1.1.2
2.28.1.1.2.1
2.28.1.1.2.2
2.28.1.1.3
2.28.1.1.3.1
2.28.1.2
2.28.1.2.1
2.28.1.2.1.1
2.28.1.2.2
2.28.1.2.3
2.28.1.2.3.1
2.28.2
2.28.2.1
2.28.2.2
2.28.2.2.1
2.28.2.2.1.1
2.28.2.3
2.28.2.3.1
2.28.2.4
2.28.2.4.1
2.28.2.4.2
2.29
2.29.1
2.29.1.1
2.29.1.1.1
2.29.1.1.1.1
2.29.1.1.2
2.29.1.1.2.1
2.29.2
2.29.2.1
2.29.2.1.1
2.29.2.1.1.1
2.29.2.2
2.29.2.2.1
2.29.2.2.1.1
2.29.3
2.29.3.1
2.29.3.1.1
2.29.3.1.1.1
2.29.3.1.1.2
2.29.3.2

Issue:03B

toolssystem-status................................................................. 1056
toolssystem-statusbrief......................................................... 1057
toolssystem-statusbrieffru-location.......................................1058
toolssystem-statusbrieffru-location<fru-location>................1059
toolssystem-statusbrieflist.................................................... 1059
toolssystem-statusbrieflistfilter-by....................................... 1060
toolssystem-statusbrieflistsort-by........................................ 1067
toolssystem-statusbriefnode................................................ 1069
toolssystem-statusbriefnode<node>................................... 1069
toolssystem-statusdetailed....................................................1070
toolssystem-statusdetailedfru-location................................. 1071
toolssystem-statusdetailedfru-location<fru-location>.......... 1071
toolssystem-statusdetailedlist.............................................. 1072
toolssystem-statusdetailednode...........................................1073
toolssystem-statusdetailednode<node>..............................1073
toolssystem-time.................................................................... 1074
toolssystem-timecurrent........................................................ 1075
toolssystem-timedate............................................................ 1076
toolssystem-timedate<date>................................................ 1076
toolssystem-timedate<date>time........................................ 1077
toolssystem-timetime............................................................ 1077
toolssystem-timetime<time>................................................ 1078
toolssystem-timetime-zone................................................... 1078
toolssystem-timetime-zone<time-zone>.............................. 1079
toolssystem-timetime-zone<time-zone-offset>.....................1079
tracing..................................................................................... 1080
tracingbuffer........................................................................... 1081
tracingbuffer<buffer-name-value>......................................... 1082
tracingbuffer<buffer-name-value>all-nodes......................... 1083
tracingbuffer<buffer-name-value>all-nodessize.................. 1084
tracingbuffer<buffer-name-value>node................................ 1085
tracingbuffer<buffer-name-value>node<node-name-value>.......
1085
tracingbuffer-to-dest............................................................... 1087
tracingbuffer-to-destall-nodes................................................1088
tracingbuffer-to-destall-nodesbuffer..................................... 1088
tracingbuffer-to-destall-nodesbuffer<buffer-name-value>... 1089
tracingbuffer-to-destnode...................................................... 1090
tracingbuffer-to-destnode<node-name-value>..................... 1091
tracingbuffer-to-destnode<node-name-value>buffer...........1091
tracingconfig...........................................................................1094
tracingconfigbuffer.................................................................1095
tracingconfigbuffer<buffer-name-value>.............................. 1095
tracingconfigbuffer<buffer-name-value>all-nodes...............1096
tracingconfigbuffer<buffer-name-value>node..................... 1096
tracingconfigbuffer-list........................................................... 1097

31

MulticontrollerRNCSCLICommands

2.29.3.2.1
2.29.3.2.2
2.29.3.2.2.1
2.29.3.3
2.29.3.3.1
2.29.3.3.2
2.29.3.3.2.1
2.29.3.4
2.29.3.4.1
2.29.3.5
2.29.3.6
2.29.3.6.1
2.29.3.7
2.29.3.8
2.29.3.8.1
2.29.3.9
2.29.3.10
2.29.3.10.1
2.29.3.10.2
2.29.3.10.2.1
2.29.3.11
2.29.3.11.1
2.29.3.11.2
2.29.3.11.2.1
2.29.4
2.29.4.1
2.29.4.1.1
2.29.4.1.2
2.29.4.1.2.1
2.29.4.2
2.29.4.3
2.29.4.4
2.29.4.4.1
2.29.4.4.1.1
2.29.4.4.1.2
2.29.5
2.29.5.1
2.29.5.2
2.29.5.2.1
2.29.5.2.1.1
2.29.6
2.29.6.1
2.29.7
2.29.7.1
2.29.8
2.29.8.1

32

tracingconfigbuffer-listall-nodes............................................1097
tracingconfigbuffer-listnode.................................................. 1097
tracingconfigbuffer-listnode<node-name-value>................. 1098
tracingconfigbuffer-to-dest.....................................................1098
tracingconfigbuffer-to-destall-nodes..................................... 1098
tracingconfigbuffer-to-destnode........................................... 1099
tracingconfigbuffer-to-destnode<node-name-value>.......... 1099
tracingconfigdest................................................................... 1100
tracingconfigdest<dest-name-value>................................... 1100
tracingconfigdest-list..............................................................1100
tracingconfigfilter................................................................... 1100
tracingconfigfilter<name-value>........................................... 1101
tracingconfigfilter-list..............................................................1101
tracingconfigformat................................................................ 1101
tracingconfigformat<format-name-value>.............................1102
tracingconfigformat-list.......................................................... 1102
tracingconfigsrc-context.........................................................1102
tracingconfigsrc-contextall-nodes......................................... 1103
tracingconfigsrc-contextnode................................................1103
tracingconfigsrc-contextnode<node-name-value>.............. 1104
tracingconfigsrc-process........................................................1104
tracingconfigsrc-processall-nodes........................................ 1104
tracingconfigsrc-processnode...............................................1105
tracingconfigsrc-processnode<node-name-value>............. 1105
tracingcrash-file...................................................................... 1105
tracingcrash-fileall-nodes.......................................................1106
tracingcrash-fileall-nodesall-names...................................... 1107
tracingcrash-fileall-nodesname.............................................1107
tracingcrash-fileall-nodesname<process-name-value>.......1107
tracingcrash-filedetails...........................................................1108
tracingcrash-filelist.................................................................1108
tracingcrash-filenode............................................................. 1109
tracingcrash-filenode<node-name-value>............................ 1109
tracingcrash-filenode<node-name-value>all-names............1110
tracingcrash-filenode<node-name-value>name.................. 1110
tracingdest.............................................................................. 1111
tracingdest<dest-name-value>.............................................. 1112
tracingdestname.................................................................... 1112
tracingdestname<dest-name-value>.................................... 1112
tracingdestname<dest-name-value>dest-type.................... 1113
tracingfilter.............................................................................. 1115
tracingfilter<name-value>...................................................... 1115
tracingfollow-central-console-dest.......................................... 1116
tracingfollow-central-console-dest<dest-name-value>.......... 1116
tracingformat...........................................................................1116
tracingformat<format-name-value>....................................... 1117

Issue:03B

MulticontrollerRNCSCLICommands

2.29.9
2.29.9.1
2.29.9.1.1
2.29.9.1.1.1
2.29.10
2.29.10.1
2.29.10.1.1
2.29.10.1.1.1
2.29.10.1.1.2
2.29.10.1.2
2.29.10.1.2.1
2.29.11
2.29.11.1
2.29.11.1.1
2.29.11.1.1.1
2.29.11.1.1.2
2.29.11.1.2
2.29.11.1.2.1
2.29.12
2.29.12.1
2.29.12.2
2.29.12.3
2.29.12.3.1
2.29.12.4
2.29.12.4.1
2.29.12.5
2.29.12.5.1
2.29.12.6
2.29.12.6.1
2.29.13
2.29.13.1
2.29.13.2
2.29.13.2.1
2.30
2.31
2.31.1
2.31.1.1
2.31.1.2
2.31.1.3
2.31.1.3.1
2.31.1.3.1.1
2.31.1.4
2.31.2

Issue:03B

tracingsnapshot...................................................................... 1117
tracingsnapshotnode............................................................. 1117
tracingsnapshotnode<node-name-value>............................ 1118
tracingsnapshotnode<node-name-value>buffer.................. 1118
tracingsrc-level....................................................................... 1121
tracingsrc-level<tracing-level-value>..................................... 1122
tracingsrc-level<tracing-level-value>all-nodes..................... 1122
tracingsrc-level<tracing-level-value>all-nodescontext.........1123
tracingsrc-level<tracing-level-value>all-nodesprocess........1123
tracingsrc-level<tracing-level-value>node............................ 1124
tracingsrc-level<tracing-level-value>node<node-name-value>..
1124
tracingsrc-to-buffer................................................................. 1126
tracingsrc-to-buffer<buffer-name-value>............................... 1127
tracingsrc-to-buffer<buffer-name-value>all-nodes............... 1128
tracingsrc-to-buffer<buffer-name-value>all-nodescontext...1129
tracingsrc-to-buffer<buffer-name-value>all-nodesprocess..1130
tracingsrc-to-buffer<buffer-name-value>node...................... 1131
tracingsrc-to-buffer<buffer-name-value>node<node-namevalue>......................................................................................1132
tracingsystem-config...............................................................1135
tracingsystem-configalarm-on-load....................................... 1137
tracingsystem-configauto-generate....................................... 1138
tracingsystem-configctm-cpu-limit......................................... 1138
tracingsystem-configctm-cpu-limit<ctm-cpu-limit>................1139
tracingsystem-configntm-cpu-limit......................................... 1139
tracingsystem-configntm-cpu-limit<ntm-cpu-limit>............... 1140
tracingsystem-configsnapshot-at-core-dump-mode.............. 1140
tracingsystem-configsnapshot-at-core-dump-mode
<snapshotmode_value>.......................................................... 1141
tracingsystem-configtrace-reader-idle-time........................... 1141
tracingsystem-configtrace-reader-idle-time<idle_time>........1141
tracingtrace-file....................................................................... 1142
tracingtrace-fileall.................................................................. 1143
tracingtrace-filename............................................................. 1143
tracingtrace-filename<trace-name-value>............................1144
transaction............................................................................... 1144
troubleshooting........................................................................ 1146
troubleshootingapp-log........................................................... 1147
troubleshootingapp-logall...................................................... 1149
troubleshootingapp-logno-debug...........................................1149
troubleshootingapp-logrule.................................................... 1150
troubleshootingapp-logrulerule-id......................................... 1152
troubleshootingapp-logrulerule-id<rule-id>..........................1152
troubleshootingapp-logse...................................................... 1155
troubleshootingblackbox.........................................................1156

33

MulticontrollerRNCSCLICommands

2.31.2.1
2.31.3
2.31.3.1
2.31.3.2
2.31.3.3
2.31.3.4
2.31.3.5
2.31.4
2.31.4.1
2.31.4.2
2.31.4.3
2.31.4.3.1
2.31.4.3.2
2.31.5
2.31.5.1
2.31.5.1.1
2.31.5.2
2.31.5.3
2.31.5.4
2.31.5.5
2.31.5.6
2.31.5.7
2.31.5.8
2.31.5.9
2.31.5.10
2.31.5.11
2.31.5.12
2.31.5.13
2.31.6
2.31.6.1
2.31.7
2.31.7.1
2.31.8
2.31.9
2.31.9.1
2.31.9.1.1
2.31.9.1.2
2.31.9.2
2.31.9.3
2.31.9.3.1
2.31.9.3.2
2.31.10
2.31.11
2.31.11.1
2.31.11.2
2.31.11.3

34

troubleshootingblackboxlist................................................... 1156
troubleshootingcac................................................................. 1157
troubleshootingcacip..............................................................1157
troubleshootingcacipbr.......................................................... 1157
troubleshootingcacipro.......................................................... 1158
troubleshootingcacleg............................................................1158
troubleshootingcacowner-id...................................................1159
troubleshootingcall..................................................................1159
troubleshootingcallcall-list......................................................1160
troubleshootingcallcleared-hanging-resource....................... 1160
troubleshootingcallowner-id...................................................1160
troubleshootingcallowner-idallocated................................... 1161
troubleshootingcallowner-idchange-history.......................... 1161
troubleshootingcentralized-monitoring....................................1161
troubleshootingcentralized-monitoringadministration............ 1163
troubleshootingcentralized-monitoringadministrationinfo..... 1164
troubleshootingcentralized-monitoringall............................... 1164
troubleshootingcentralized-monitoringbuffer......................... 1165
troubleshootingcentralized-monitoringfilter............................1166
troubleshootingcentralized-monitoringfilter-condition............ 1167
troubleshootingcentralized-monitoringinformation.................1168
troubleshootingcentralized-monitoringlinux........................... 1168
troubleshootingcentralized-monitoringmonitored-message...1169
troubleshootingcentralized-monitoringse...............................1170
troubleshootingcentralized-monitoringtp-filter........................1171
troubleshootingcentralized-monitoringtrigger........................ 1171
troubleshootingcentralized-monitoringtrigger-condition.........1173
troubleshootingcentralized-monitoringup-filter...................... 1173
troubleshootingcore-reallocate............................................... 1174
troubleshootingcore-reallocatehistory....................................1174
troubleshootingerror-code...................................................... 1174
troubleshootingerror-code<error-code>.................................1175
troubleshootingevent-subscriptions........................................ 1175
troubleshootinggtp.................................................................. 1176
troubleshootinggtpcounters................................................... 1176
troubleshootinggtpcountersip............................................... 1177
troubleshootinggtpcounterstunnel........................................ 1177
troubleshootinggtpglo............................................................ 1177
troubleshootinggtptunnel....................................................... 1178
troubleshootinggtptunnelall.................................................. 1178
troubleshootinggtptunnelrange............................................. 1178
troubleshootingmegamon....................................................... 1179
troubleshootingsccp-user....................................................... 1179
troubleshootingsccp-userclear-counter................................. 1180
troubleshootingsccp-usercounter-info................................... 1181
troubleshootingsccp-userremote-pc-status-history................1181

Issue:03B

MulticontrollerRNCSCLICommands

2.31.11.3.1
2.31.11.3.2
2.31.11.3.2.1
2.31.11.4
2.31.11.5
2.31.11.6
2.31.12
2.31.12.1
2.31.12.1.1
2.31.12.1.2
2.31.12.1.2.1
2.31.12.1.3
2.31.12.1.3.1
2.31.12.1.4
2.31.12.1.5
2.31.12.1.5.1
2.31.12.1.6
2.31.12.1.6.1
2.31.12.2
2.31.12.2.1
2.31.12.2.2
2.31.12.2.2.1
2.31.12.2.2.2
2.31.12.2.3
2.31.13
2.31.13.1
2.31.13.1.1
2.31.13.1.2
2.31.13.1.3
2.31.13.2
2.31.13.2.1
2.31.13.2.2
2.31.13.2.3
2.31.13.2.4
2.31.13.2.4.1
2.31.13.2.4.2
2.31.13.2.4.3
2.31.13.2.4.4
2.31.13.2.4.5
2.31.13.2.5
2.31.13.2.5.1
2.31.13.2.5.2
2.31.14
2.31.14.1

Issue:03B

troubleshootingsccp-userremote-pc-status-historyall........... 1181
troubleshootingsccp-userremote-pc-status-historyremote-pc......
1182
troubleshootingsccp-userremote-pc-status-historyremote-pc
<remote-pc>............................................................................ 1182
troubleshootingsccp-usersag-long-time-res.......................... 1182
troubleshootingsccp-usersor-hand-info................................. 1183
troubleshootingsccp-usersor-long-time-res........................... 1183
troubleshootingsigiub..............................................................1183
troubleshootingsigiublink....................................................... 1184
troubleshootingsigiublinkall...................................................1185
troubleshootingsigiublinkcscp-index..................................... 1185
troubleshootingsigiublinkcscp-index<cscp-index>.............. 1186
troubleshootingsigiublinkgroup-id......................................... 1186
troubleshootingsigiublinkgroup-id<group-id>...................... 1186
troubleshootingsigiublinknot-connected............................... 1187
troubleshootingsigiublinkqniub-index................................... 1187
troubleshootingsigiublinkqniub-index<qniub-index>............1187
troubleshootingsigiublinkremote-ip....................................... 1188
troubleshootingsigiublinkremote-ip<remote-ip>.................. 1188
troubleshootingsigiubload......................................................1188
troubleshootingsigiubloadcscp............................................. 1189
troubleshootingsigiubloadgroup........................................... 1189
troubleshootingsigiubloadgroupall....................................... 1190
troubleshootingsigiubloadgroupgroup-id............................. 1190
troubleshootingsigiubloadqniub............................................ 1190
troubleshootingupm................................................................ 1191
troubleshootingupmconfig..................................................... 1192
troubleshootingupmconfigserv-counters...............................1192
troubleshootingupmconfigserv-desc.....................................1193
troubleshootingupmconfigunit-capacity................................ 1193
troubleshootingupmstatus..................................................... 1194
troubleshootingupmstatuscellhome...................................... 1195
troubleshootingupmstatuscounter........................................ 1196
troubleshootingupmstatusload............................................. 1196
troubleshootingupmstatusservice......................................... 1197
troubleshootingupmstatusservicecell-id...............................1197
troubleshootingupmstatusserviceowner-id.......................... 1198
troubleshootingupmstatusserviceservice-id.........................1199
troubleshootingupmstatusserviceservice-type.....................1199
troubleshootingupmstatusserviceunit..................................1200
troubleshootingupmstatusstatistics...................................... 1201
troubleshootingupmstatusstatisticsserv-number................. 1201
troubleshootingupmstatusstatisticsserv-usage................... 1205
troubleshootingz-commands.................................................. 1206
troubleshootingz-commandssyslog.......................................1207

35

MulticontrollerRNCSCLICommands

2.31.14.2
2.31.14.2.1
2.31.14.3
2.31.14.4
2.31.14.5
2.31.14.6
2.31.14.7
2.31.14.8
2.31.14.9
2.31.14.10
2.31.14.11
2.31.14.11.1
2.31.14.11.2
2.31.14.11.2.1
2.31.14.11.2.2
2.31.14.11.3
2.31.14.11.3.1
2.31.14.11.3.2
2.31.14.11.3.3
2.31.14.11.3.4
2.31.14.11.3.5
2.31.14.11.3.6
2.31.14.11.3.7
2.31.14.11.3.8
2.31.14.11.3.9
2.31.14.11.3.10
2.31.14.11.4
2.31.14.11.4.1
2.31.14.11.4.2
2.31.14.11.5
2.31.14.11.5.1
2.31.14.11.5.2
2.31.14.11.6
2.31.14.11.7
2.31.14.11.8
2.31.14.11.9
2.31.14.11.10
2.31.14.11.11

36

troubleshootingz-commandstcpdump................................... 1207
troubleshootingz-commandstcpdumpoptions.......................1208
troubleshootingz-commandstop............................................ 1208
troubleshootingz-commandszassoc......................................1209
troubleshootingz-commandszbfd.......................................... 1209
troubleshootingz-commandszbts.......................................... 1209
troubleshootingz-commandszdbindex...................................1210
troubleshootingz-commandszdoi.......................................... 1210
troubleshootingz-commandszfish..........................................1210
troubleshootingz-commandszifo............................................1211
troubleshootingz-commandszjane.........................................1211
troubleshootingz-commandszjaneza....................................1212
troubleshootingz-commandszjanezcp..................................1212
troubleshootingz-commandszjanezcpport-name................ 1213
troubleshootingz-commandszjanezcpport-number............. 1213
troubleshootingz-commandszjanezcpb................................1214
troubleshootingz-commandszjanezcpbactivate-monitoring-bitpattern..................................................................................... 1215
troubleshootingz-commandszjanezcpbactivate-monitoringbitmask....................................................................................1216
troubleshootingz-commandszjanezcpbactivate-monitoringconnection-id...........................................................................1216
troubleshootingz-commandszjanezcpbactivate-monitoringdouple-vlan-id..........................................................................1217
troubleshootingz-commandszjanezcpbactivate-monitoring-dstmac-addr................................................................................. 1218
troubleshootingz-commandszjanezcpbactivate-monitoring-srcmac-addr................................................................................. 1218
troubleshootingz-commandszjanezcpbactivate-monitoring-type.
1219
troubleshootingz-commandszjanezcpbactivate-monitoring-udfoffset........................................................................................1219
troubleshootingz-commandszjanezcpbactivate-monitoring-udf2offset........................................................................................1220
troubleshootingz-commandszjanezcpbactivate-monitoring-vlanid............................................................................................. 1220
troubleshootingz-commandszjanezf.....................................1221
troubleshootingz-commandszjanezfport-name................... 1221
troubleshootingz-commandszjanezfport-number................ 1222
troubleshootingz-commandszjanezi.....................................1222
troubleshootingz-commandszjaneziport-name................... 1223
troubleshootingz-commandszjaneziport-number................ 1223
troubleshootingz-commandszjanezlai.................................. 1224
troubleshootingz-commandszjanezm...................................1224
troubleshootingz-commandszjanezmac...............................1224
troubleshootingz-commandszjanezmap...............................1225
troubleshootingz-commandszjanezr.................................... 1225
troubleshootingz-commandszjanezreg................................ 1225

Issue:03B

MulticontrollerRNCSCLICommands

2.31.14.11.12
2.31.14.11.13
2.31.14.11.13.1
2.31.14.11.14
2.31.14.11.14.1
2.31.14.11.14.2
2.31.14.11.15
2.31.14.11.16
2.31.14.12
2.31.14.13
2.31.14.13.1
2.31.14.13.2
2.31.14.14
2.31.14.15
2.31.14.16
2.32
2.32.1
2.32.2
2.32.2.1
2.32.2.1.1
2.32.3
2.32.4
2.33
2.33.1
2.33.1.1
2.33.2
2.33.2.1
2.33.3
2.33.4
2.33.5
2.33.5.1
2.33.5.1.1
2.33.5.1.1.1
2.33.5.2
2.33.5.3
2.33.5.4
2.33.5.4.1
2.33.5.4.1.1
2.33.5.5
2.33.5.6
2.33.5.6.1
2.33.5.6.1.1

Issue:03B

troubleshootingz-commandszjanezrm................................. 1226
troubleshootingz-commandszjanezs....................................1226
troubleshootingz-commandszjanezsport.............................1227
troubleshootingz-commandszjanezss.................................. 1227
troubleshootingz-commandszjanezssclear-switch-port-counters.
1228
troubleshootingz-commandszjanezssshow-switch-port-counters
................................................................................................. 1229
troubleshootingz-commandszjanezt.....................................1230
troubleshootingz-commandszjanezu....................................1231
troubleshootingz-commandszmem....................................... 1231
troubleshootingz-commandszmon........................................ 1231
troubleshootingz-commandszmon<domain>....................... 1232
troubleshootingz-commandszmonall....................................1232
troubleshootingz-commandszrg............................................ 1232
troubleshootingz-commandszrole......................................... 1233
troubleshootingz-commandsztail...........................................1233
upgrade-mode.........................................................................1234
upgrade-mode<upgrade-mode-off>....................................... 1234
upgrade-mode<upgrade-mode-on>....................................... 1235
upgrade-mode<upgrade-mode-on>lock-timeout...................1235
upgrade-mode<upgrade-mode-on>lock-timeout<timeout>..1236
upgrade-mode<upgrade-mode-touch>.................................. 1236
upgrade-modestatus.............................................................. 1236
user-management................................................................... 1237
user-managementcracklib......................................................1238
user-managementcracklib<word-file>................................... 1239
user-managementgroup.........................................................1239
user-managementgroup<groupname>................................. 1240
user-managementgroup-from-permission..............................1242
user-managementgroup-to-permission.................................. 1242
user-managementpasswd......................................................1242
user-managementpasswdchange-passwd............................1244
user-managementpasswdchange-passwdpasswd-file.........1244
user-managementpasswdchange-passwdpasswd-file<passwdfilename>.................................................................................1244
user-managementpasswdlock-account.................................1245
user-managementpasswdset-root-aging-data...................... 1245
user-managementpasswdset-root-passwd........................... 1246
user-managementpasswdset-root-passwdpasswd-file........ 1246
user-managementpasswdset-root-passwdpasswd-file<passwdfile>..........................................................................................1247
user-managementpasswdset-user-aging-data......................1247
user-managementpasswdset-user-passwd.......................... 1248
user-managementpasswdset-user-passwdpasswd-file....... 1248
user-managementpasswdset-user-passwdpasswd-file<passwdfilename>.................................................................................1249

37

MulticontrollerRNCSCLICommands

2.33.5.7
2.33.5.8
2.33.6
2.33.7
2.33.7.1
2.33.7.2
2.33.7.3
2.33.7.4
2.33.7.5
2.33.7.5.1
2.33.7.5.1.1
2.33.7.5.1.2
2.33.7.5.2
2.33.7.5.2.1
2.33.7.5.2.2
2.33.7.5.3
2.33.7.5.4
2.33.7.5.5
2.33.7.5.6
2.33.7.5.6.1
2.33.7.5.6.2
2.33.7.5.7
2.33.8
2.33.9
2.33.9.1
2.33.10
2.33.11

38

user-managementpasswdshort-passwd-info........................ 1249
user-managementpasswdunlock-account.............................1249
user-managementpermission.................................................1250
user-managementruim........................................................... 1250
user-managementruimdisable...............................................1252
user-managementruimenable............................................... 1253
user-managementruimnms-ldap-account............................. 1253
user-managementruimnms-ldap-config................................ 1254
user-managementruimreplicator........................................... 1258
user-managementruimreplicatordelete................................ 1260
user-managementruimreplicatordeleteallusers................... 1261
user-managementruimreplicatordeleteusers.......................1261
user-managementruimreplicatordisable...............................1262
user-managementruimreplicatordisableallusers................. 1262
user-managementruimreplicatordisableusers..................... 1262
user-managementruimreplicatorinvalidate-users................. 1263
user-managementruimreplicatorlimited-mode......................1264
user-managementruimreplicatornormal-mode..................... 1264
user-managementruimreplicatorrefresh............................... 1265
user-managementruimreplicatorrefreshallusers..................1265
user-managementruimreplicatorrefreshusers..................... 1265
user-managementruimreplicatorshutdown...........................1266
user-managementsudo.......................................................... 1266
user-managementuser........................................................... 1267
user-managementuser<username>......................................1269
user-managementuser-from-group........................................ 1273
user-managementuser-to-group............................................ 1274

Issue:03B

MulticontrollerRNCSCLICommands

List of Tables

Issue:03B

Table1

ListoftoplevelSCLIcommands........................................................ 95

Table2

alarm................................................................................................102

Table3

alarmacknowledge..........................................................................103

Table4

alarmactive..................................................................................... 103

Table5

alarmactiveapplication-ids............................................................. 105

Table6

alarmactivefilter-by........................................................................ 105

Table7

alarmactivemanaged-object-ids.....................................................107

Table8

alarmactiveprobable-causes..........................................................107

Table9

alarmactivespecific-problems........................................................ 108

Table10

alarmactive-summary..................................................................... 108

Table11

alarmactive-summarybrief............................................................. 109

Table12

alarmactive-summaryreal-time...................................................... 109

Table13

alarmalarm-count............................................................................109

Table14

alarmalarm-countfilter-by............................................................... 110

Table15

alarmblocking-rule.......................................................................... 112

Table16

alarmblocking-ruleactivate............................................................. 113

Table17

alarmblocking-ruleall...................................................................... 113

Table18

alarmblocking-ruledeactivate......................................................... 114

Table19

alarmblocking-rulerule-id............................................................... 114

Table20

alarmblocking-rulerule-id<rule-id>................................................ 114

Table21

alarmclear....................................................................................... 115

Table22

alarmclear-matching-alarms........................................................... 115

Table23

alarmclear-matching-alarmsfilter-by.............................................. 115

Table24

alarmfollow-history.......................................................................... 117

Table25

alarmfollow-historyfilter-by............................................................. 117

Table26

alarmhistory.................................................................................... 119

Table27

alarmhistoryfilter-by....................................................................... 121

Table28

alarmhistory-count.......................................................................... 125

Table29

alarmhistory-countfilter-by............................................................. 126

Table30

alarmmanual...................................................................................129

Table31

alarmnotification-id......................................................................... 129

Table32

alarmprobable-causes.................................................................... 130

Table33

alarmraise.......................................................................................130

Table34

alarmrecovery-history..................................................................... 131

Table35

alarmrecovery-historyfilter-by........................................................ 132

Table36

alarmspecific-problems...................................................................133

Table37

alarmtest-instructions..................................................................... 133

Table38

alarmtype........................................................................................134

39

MulticontrollerRNCSCLICommands

40

Table39

alarmtypefrom-directory.................................................................135

Table40

alarmtypefrom-file..........................................................................135

Table41

alarmtype-all................................................................................... 136

Table42

alarmtype-restore-defaults..............................................................136

Table43

alarmunacknowledge......................................................................137

Table44

app-parameter................................................................................. 137

Table45

app-parameterconfiguration-parameter..........................................138

Table46

app-parameterfeature-optionality.................................................... 139

Table47

backup............................................................................................. 140

Table48

backupactive...................................................................................142

Table49

backupbackup-iso...........................................................................143

Table50

backupbackup-isoall...................................................................... 143

Table51

backupbackup-isoimage................................................................144

Table52

backupbackup-isoimage<backup-iso-name>............................... 144

Table53

backupconfig.................................................................................. 144

Table54

backupconfigall..............................................................................145

Table55

backupconfigcurrent...................................................................... 145

Table56

backupconfiglabel..........................................................................146

Table57

backupconfiglabel<label>............................................................. 146

Table58

backupdatabase............................................................................. 146

Table59

backupdatabasedb-name.............................................................. 147

Table60

backupdatabasedb-name<db-name>...........................................147

Table61

backupdelivery................................................................................148

Table62

backupdeliveryall........................................................................... 148

Table63

backupdeliverycurrent................................................................... 149

Table64

backupdeliverylabel....................................................................... 149

Table65

backupdeliverylabel<label-name>................................................ 150

Table66

backupfilesystem............................................................................ 150

Table67

backupfilesystemrg-name..............................................................151

Table68

backupfilesystemrg-name<rg-name>........................................... 151

Table69

backupfull....................................................................................... 151

Table70

backuppartial.................................................................................. 152

Table71

backupplugin.................................................................................. 152

Table72

backuppluginplugin-name..............................................................153

Table73

backuppluginplugin-name<plugin-name>.....................................153

Table74

backupselective.............................................................................. 154

Table75

backupstate.................................................................................... 154

Table76

built-in.............................................................................................. 155

Table77

built-incli..........................................................................................155

Table78

built-inclibatch-file.......................................................................... 157

Issue:03B

MulticontrollerRNCSCLICommands

Issue:03B

Table79

built-inclibatch-file<file>................................................................ 157

Table80

built-inclibuilt-in.............................................................................. 158

Table81

built-inclibuilt-in<properties>.........................................................159

Table82

built-inclibuilt-inconfirmation-prompt............................................. 161

Table83

built-inclibuilt-inconfirmation-prompt<on_off>.............................. 161

Table84

built-inclibuilt-inconstraint-hint...................................................... 161

Table85

built-inclibuilt-inconstraint-hint<on_off>....................................... 162

Table86

built-inclibuilt-indebug................................................................... 162

Table87

built-inclibuilt-indebug<debug_level>.......................................... 163

Table88

built-inclibuilt-inecho-cmd............................................................. 163

Table89

built-inclibuilt-inecho-cmd<on_off>.............................................. 164

Table90

built-inclibuilt-inon-failure.............................................................. 164

Table91

built-inclibuilt-inon-failure<stop_continue>.................................. 164

Table92

built-inclibuilt-inoutput................................................................... 165

Table93

built-inclibuilt-inoutput<output_format>........................................165

Table94

built-inclibuilt-inprint-footer............................................................166

Table95

built-inclibuilt-inprint-footer<on_off>............................................ 166

Table96

built-inclibuilt-inprint-header..........................................................167

Table97

built-inclibuilt-inprint-header<on_off>.......................................... 167

Table98

built-inclibuilt-inrelative-mode....................................................... 167

Table99

built-inclibuilt-inrelative-mode<on_off>........................................ 168

Table100

built-inclibuilt-inrows..................................................................... 169

Table101

built-inclibuilt-inrows<number_of_rows>..................................... 169

Table102

built-inclibuilt-insyntax-check........................................................ 169

Table103

built-inclibuilt-insyntax-check<on_off>......................................... 170

Table104

built-inclibuilt-invalidation-trace.....................................................170

Table105

built-inclibuilt-invalidation-trace<validation-trace-level>.............. 171

Table106

built-inclicache............................................................................... 171

Table107

built-inclienv...................................................................................172

Table108

built-inclienv<NAME>................................................................... 175

Table109

built-inclienv<NAME><VALUE>.................................................. 175

Table110

built-inclienv<save_mode>........................................................... 175

Table111

built-inclienv<variable_name>...................................................... 176

Table112

built-inclienvfile............................................................................. 176

Table113

built-inclienvfile<filename>.......................................................... 176

Table114

built-inclienvfile<filename><save_mode>...................................177

Table115

built-inclierrorstream...................................................................... 177

Table116

built-inclierrorstream<destination>............................................... 178

Table117

built-inclierrorstreamfile................................................................ 178

Table118

built-inclierrorstreamfile<filename>..............................................179

41

MulticontrollerRNCSCLICommands

42

Table119

built-inclierrorstreamfile<filename><write_mode>......................179

Table120

built-inclioutstream.........................................................................179

Table121

built-inclioutstream<destination>.................................................. 180

Table122

built-inclioutstreamfile................................................................... 180

Table123

built-inclioutstreamfile<filename>................................................ 181

Table124

built-inclioutstreamfile<filename><write_mode>........................ 181

Table125

built-inclisession............................................................................ 181

Table126

built-inclisession<NAME>.............................................................183

Table127

built-inclisession<NAME><VALUE>............................................ 183

Table128

built-inclisession<variable_name>................................................184

Table129

built-inclisessionfile.......................................................................184

Table130

built-inclisessionfile<filename>.................................................... 184

Table131

built-inclisessionfile<filename><save_mode>............................ 185

Table132

built-inclitracestream......................................................................185

Table133

built-inclitracestream<destination>............................................... 186

Table134

built-inclitracestreamfile................................................................ 186

Table135

built-inclitracestreamfile<filename>............................................. 187

Table136

built-inclitracestreamfile<filename><write_mode>..................... 187

Table137

built-incliviews................................................................................187

Table138

built-incmdtree................................................................................ 188

Table139

built-incmdtree<command>........................................................... 188

Table140

built-inexit....................................................................................... 188

Table141

built-inhelp...................................................................................... 189

Table142

built-inhelpcmd-tree....................................................................... 189

Table143

built-inhelpcmd-treecmd-set......................................................... 190

Table144

built-inhelpcmd-treecmd-set<cmd-set>....................................... 191

Table145

built-inhelpcmd-treecommand...................................................... 191

Table146

built-inhelpcmd-treecommand<command>................................. 192

Table147

built-inhistory.................................................................................. 192

Table148

built-inquit....................................................................................... 193

Table149

built-inshell......................................................................................193

Table150

built-inshellbash.............................................................................194

Table151

built-inshellbashfull....................................................................... 194

Table152

built-inshellbashlimited................................................................. 195

Table153

built-inshellscli............................................................................... 195

Table154

built-inshellsclinode...................................................................... 195

Table155

built-inshellsclinode<node_name>.............................................. 196

Table156

built-inshellsclipeer....................................................................... 196

Table157

built-inuser...................................................................................... 197

Table158

cluster.............................................................................................. 198

Issue:03B

MulticontrollerRNCSCLICommands

Issue:03B

Table159

cmf...................................................................................................198

Table160

cmfdisable...................................................................................... 199

Table161

cmfenable....................................................................................... 199

Table162

cmfrestart........................................................................................200

Table163

cmfstatus........................................................................................ 200

Table164

cmfyield.......................................................................................... 201

Table165

config............................................................................................... 202

Table166

config<full-object-name>................................................................ 204

Table167

configattribute................................................................................. 205

Table168

configattribute<full-object-name>.................................................. 206

Table169

configattribute<full-object-name>attribute-list...............................206

Table170

configattribute<full-object-name>attribute-list<attribute-name>.. 207

Table171

configattribute<full-object-name>attribute-list<attribute-name>
<attribute-value>..............................................................................207

Table172

configobject.................................................................................... 208

Table173

configobject<full-object-name>......................................................208

Table174

configobject<parent-object>.......................................................... 209

Table175

configobject<parent-object>attribute-list.......................................209

Table176

configobject<parent-object>attribute-list<attribute-name>.......... 210

Table177

configobject<parent-object>attribute-list<attribute-name><attributevalue>.............................................................................................. 210

Table178

config-mode.....................................................................................210

Table179

config-mode<config-mode-exclusive>............................................ 211

Table180

config-mode<config-mode-off>.......................................................212

Table181

config-mode<config-mode-on>.......................................................213

Table182

config-mode<config-mode-touch>..................................................213

Table183

config-mode<mass-config>............................................................ 214

Table184

config-mode<mass-config>off....................................................... 214

Table185

config-mode<mass-config>on....................................................... 214

Table186

config-modestatus.......................................................................... 215

Table187

directory...........................................................................................215

Table188

directory<directory>........................................................................216

Table189

file.................................................................................................... 216

Table190

file<file>.......................................................................................... 217

Table191

filecontent....................................................................................... 218

Table192

filecontent<file>............................................................................. 218

Table193

filedisk-usage..................................................................................218

Table194

filedisk-usage<directory>...............................................................219

Table195

filelist...............................................................................................219

Table196

filelist<directory>............................................................................219

Table197

filesha1sum.................................................................................... 219

43

MulticontrollerRNCSCLICommands

44

Table198

filesha1sum<checksum-file>......................................................... 220

Table199

filesha1sum<checksum-file><directory>...................................... 220

Table200

hardware..........................................................................................221

Table201

hardwareadmin-ignore....................................................................222

Table202

hardwareadmin-ignore<yes-no>....................................................222

Table203

hardwareadmin-ignore<yes-no>fru-location.................................223

Table204

hardwareadmin-ignore<yes-no>fru-location<fru-location-name>......
223

Table205

hardwareadmin-ignoresync........................................................... 223

Table206

hardwareconfig............................................................................... 224

Table207

hardwareconfigcomponent............................................................ 225

Table208

hardwareconfigcomponent<component-name>........................... 226

Table209

hardwareconfigcomponent<new-component-name>................... 227

Table210

hardwareconfigdisk-storage.......................................................... 227

Table211

hardwareconfigphysical-location................................................... 228

Table212

hardwareconfigphysical-location<physical-location>....................228

Table213

hardwareconfigphysical-location<physical-location>cabinet-id... 229

Table214

hardwareconfigphysical-location<physical-location>cabinet-id
<cabinet_id>.................................................................................... 229

Table215

hardwareconfigphysical-locationcabinet-id...................................229

Table216

hardwareconfigphysical-locationcabinet-id<cabinet-id>.............. 230

Table217

hardwarediagnostics.......................................................................230

Table218

hardwarediagnosticsfru-location....................................................231

Table219

hardwarediagnosticsfru-location<fru-location>.............................232

Table220

hardwarediagnosticsfru-location<frulocation>.............................. 232

Table221

hardwarediagnosticsreport............................................................ 233

Table222

hardwarediagnosticsreportall........................................................234

Table223

hardwarediagnosticsreportfru-location......................................... 234

Table224

hardwarediagnosticsreportfru-location<frulocation>....................234

Table225

hardwarediagnosticsreportfru-location<frulocation>all............... 235

Table226

hardwarediagnosticsreportfru-location<frulocation>report-name.....
235

Table227

hardwarediagnosticsreportfru-location<frulocation>report-name<rname>..............................................................................................235

Table228

hardwarediagnosticsreport-details.................................................236

Table229

hardwarediagnosticsreport-list.......................................................236

Table230

hardwarediagnosticsreport-listfru-location....................................236

Table231

hardwarediagnosticsreport-listfru-location<fru-location>.............237

Table232

hardwarediagnosticsreport-status................................................. 237

Table233

hardwarediagnosticsreport-statusfru-location...............................238

Table234

hardwarediagnosticsreport-statusfru-location<fru-location>........238

Issue:03B

MulticontrollerRNCSCLICommands

Issue:03B

Table235

hardwarediagnosticsreport-statusreport-name.............................238

Table236

hardwarediagnosticsreport-statusreport-name<report-name>.... 239

Table237

hardwarediagnosticstest-details.................................................... 239

Table238

hardwarediagnosticstest-detailsfru-location................................. 239

Table239

hardwarediagnosticstest-detailsfru-location<frulocation>............240

Table240

hardwarediagnosticstest-list.......................................................... 240

Table241

hardwarediagnosticstest-readiness............................................... 240

Table242

hardwarediagnosticstest-readinessfru-location............................ 241

Table243

hardwarediagnosticstest-readinessfru-location<frulocation>...... 241

Table244

hardwareinventory.......................................................................... 241

Table245

hardwareinventorycomponent....................................................... 242

Table246

hardwareinventorycomponent<component>................................ 242

Table247

hardwareinventorylist.....................................................................242

Table248

hardwareinventorylistbrief.............................................................243

Table249

hardwareinventorylistdetailed....................................................... 243

Table250

hardwarepower...............................................................................244

Table251

hardwarepoweroff.......................................................................... 244

Table252

hardwarepoweroffnode................................................................. 244

Table253

hardwarepoweroffnode<nodename>...........................................245

Table254

hardwarepoweron..........................................................................245

Table255

hardwarepoweronnode.................................................................245

Table256

hardwarepoweronnode<nodename>...........................................245

Table257

hardwarerestart.............................................................................. 246

Table258

hardwarerestartnode..................................................................... 246

Table259

hardwarerestartnode<nodename>............................................... 246

Table260

hardwarestate.................................................................................247

Table261

hardwarestatelist........................................................................... 247

Table262

hardwarestatenode........................................................................247

Table263

hardwarestatenode<nodename>..................................................248

Table264

has...................................................................................................248

Table265

hasattribute.....................................................................................250

Table266

hasattribute<name>.......................................................................251

Table267

hasattribute<name><value>.........................................................251

Table268

hasattribute<name><value>managed-object.............................. 252

Table269

hasattribute<name><value>managed-object<mo-name>..........252

Table270

hasattribute<name><value>managed-object-full-name.............. 253

Table271

hasattribute<name><value>managed-object-full-name<mofullname>......................................................................................... 253

Table272

hasbare...........................................................................................254

Table273

hasbare<mo-type>........................................................................ 254

45

MulticontrollerRNCSCLICommands

46

Table274

haschildren..................................................................................... 255

Table275

haschildrenmanaged-object.......................................................... 255

Table276

haschildrenmanaged-object<mo-name>...................................... 256

Table277

haschildrenmanaged-object-full-name.......................................... 256

Table278

haschildrenmanaged-object-full-name<mo-fullname>................. 257

Table279

hasconfig........................................................................................ 257

Table280

hasconfiglink..................................................................................258

Table281

hasconfiglinknode-to-core............................................................ 258

Table282

hasconfiglinknode-to-core<component-name>........................... 259

Table283

hasconfignode............................................................................... 259

Table284

hasconfignodecomponent............................................................ 260

Table285

hasconfignodecomponent<component>..................................... 261

Table286

hasconfignode-type....................................................................... 262

Table287

hasconfignode-typename............................................................. 262

Table288

hasconfignode-typename<name>............................................... 262

Table289

hasdependencies........................................................................... 263

Table290

hasforce-active............................................................................... 263

Table291

hasforce-activemanaged-object.................................................... 264

Table292

hasforce-activemanaged-object<mo-name>................................ 264

Table293

hasforce-activemanaged-object-full-name.................................... 265

Table294

hasforce-activemanaged-object-full-name<mo-fullname>........... 265

Table295

hasforcedswitchover.......................................................................266

Table296

hasforcedswitchoverlogical-group................................................. 267

Table297

hasforcedswitchoverlogical-group<logical-group-name>............. 267

Table298

hasforcedswitchovermanaged-object............................................ 267

Table299

hasforcedswitchovermanaged-object<mo-name>........................268

Table300

hasforcedswitchovermanaged-object-full-name............................ 269

Table301

hasforcedswitchovermanaged-object-full-name<mo-fullname>... 269

Table302

hasforcedswitchovernew-active-recovery-unit...............................270

Table303

hasforcedswitchovernew-active-recovery-unit<new-active-recoveryunit>.................................................................................................270

Table304

hasfunctional-unit........................................................................... 270

Table305

hasfunctional-unitcomp-addr-info.................................................. 271

Table306

hasfunctional-unitgroup-addr-info..................................................272

Table307

hasfunctional-unitstartup-info........................................................ 272

Table308

hasfunctional-unitstartup-infoparameter....................................... 273

Table309

hasfunctional-unitstartup-infophase-output.................................. 273

Table310

hasfunctional-unitstartup-infostatistics..........................................274

Table311

hasfunctional-unitunit-info..............................................................274

Table312

hasfunctional-unitunit-type-info......................................................275

Issue:03B

MulticontrollerRNCSCLICommands

Issue:03B

Table313

hasinert...........................................................................................275

Table314

hasinert<inert-mode>.................................................................... 276

Table315

hasinert<inert-mode>managed-object..........................................276

Table316

hasinert<inert-mode>managed-object<mo-name>..................... 277

Table317

hasinert<inert-mode>managed-object-full-name..........................277

Table318

hasinert<inert-mode>managed-object-full-name<mo-fullname>.278

Table319

hasisolate....................................................................................... 278

Table320

hasisolatemanaged-object.............................................................279

Table321

hasisolatemanaged-object<mo-name>........................................ 279

Table322

hasisolatemanaged-object-full-name.............................................280

Table323

hasisolatemanaged-object-full-name<mo-fullname>....................280

Table324

haslock........................................................................................... 281

Table325

haslocklogical-group......................................................................281

Table326

haslocklogical-group<logical-group-name>..................................282

Table327

haslockmanaged-object.................................................................282

Table328

haslockmanaged-object<mo-name>............................................ 283

Table329

haslockmanaged-object-full-name.................................................283

Table330

haslockmanaged-object-full-name<mo-fullname>........................284

Table331

haslogical-group-state.................................................................... 284

Table332

haslogical-group-statelogical-group...............................................285

Table333

haslogical-group-statelogical-group<logical-group-name>...........285

Table334

hasparent........................................................................................286

Table335

hasparentmanaged-object.............................................................286

Table336

hasparentmanaged-object<mo-name>........................................ 287

Table337

hasparentmanaged-object-full-name.............................................287

Table338

hasparentmanaged-object-full-name<mo-fullname>....................288

Table339

haspower........................................................................................ 288

Table340

haspoweroff................................................................................... 289

Table341

haspoweroffmanaged-object........................................................ 290

Table342

haspoweroffmanaged-object<mo-name>.................................... 290

Table343

haspoweroffmanaged-object-full-name........................................ 291

Table344

haspoweroffmanaged-object-full-name<mo-fullname>............... 291

Table345

haspoweron................................................................................... 292

Table346

haspoweronmanaged-object........................................................ 292

Table347

haspoweronmanaged-object<mo-name>....................................292

Table348

haspoweronmanaged-object-full-name........................................ 293

Table349

haspoweronmanaged-object-full-name<mo-fullname>............... 293

Table350

hasprocess-family...........................................................................294

Table351

hasprocess-familyattribute.............................................................295

Table352

hasprocess-familyattributeall........................................................ 296

47

MulticontrollerRNCSCLICommands

48

Table353

hasprocess-familyattributefamily-id.............................................. 296

Table354

hasprocess-familyattributefamily-id<family-id>............................297

Table355

hasprocess-familyattributemaster-name...................................... 297

Table356

hasprocess-familyattributemaster-name<master-name>............ 297

Table357

hasprocess-familyattributeprocess-name.....................................298

Table358

hasprocess-familyattributeprocess-name<process-name>.........298

Table359

hasprocess-familysupervision....................................................... 298

Table360

hasprocess-familysync-monitoring................................................ 299

Table361

hasprocess-familysync-monitoringerrors......................................300

Table362

hasprocess-familysync-monitoringerrorsunit-type....................... 300

Table363

hasprocess-familysync-monitoringerrorsunit-type<unit-type-name>.
301

Table364

hasprocess-familysync-monitoringlist...........................................301

Table365

hasprocess-familysync-monitoringlistunit-type............................ 302

Table366

hasprocess-familysync-monitoringlistunit-type<unit-type-name>.....
302

Table367

hasprocess-familysync-monitoringunit-type................................. 302

Table368

hasprocess-familysync-monitoringunit-type<unit-type-name>.... 303

Table369

hasprocess-familywarming............................................................ 303

Table370

hasprocess-familywarmingcompare-all........................................ 304

Table371

hasprocess-familywarmingcompare-allunit-type......................... 305

Table372

hasprocess-familywarmingcompare-allunit-type<unit-type-name>..
305

Table373

hasprocess-familywarmingcompare-buffer...................................306

Table374

hasprocess-familywarmingcompare-bufferunit-type.................... 306

Table375

hasprocess-familywarmingcompare-bufferunit-type<unit-typename>..............................................................................................306

Table376

hasprocess-familywarmingcompare-state-data............................307

Table377

hasprocess-familywarmingcompare-state-dataunit-type............. 307

Table378

hasprocess-familywarmingcompare-state-dataunit-type<unit-typename>..............................................................................................308

Table379

hasprocess-familywarmingcompare-timer....................................308

Table380

hasprocess-familywarmingcompare-timerunit-type..................... 309

Table381

hasprocess-familywarmingcompare-timerunit-type<unit-typename>..............................................................................................309

Table382

hasprocess-familywarmingcompare-variables............................. 309

Table383

hasprocess-familywarmingcompare-variablesunit-type...............310

Table384

hasprocess-familywarmingcompare-variablesunit-type<unit-typename>..............................................................................................310

Table385

hasprocess-familywarmingconfiguration.......................................311

Table386

hasprocess-familywarmingconfigurationunit-type........................ 311

Issue:03B

MulticontrollerRNCSCLICommands

Issue:03B

Table387

hasprocess-familywarmingconfigurationunit-type<unit-type-name>.
311

Table388

hasprocess-familywarmingfamily..................................................312

Table389

hasprocess-familywarmingfamilyunit-type...................................312

Table390

hasprocess-familywarmingfamilyunit-type<unit-type-name>......313

Table391

hasprocess-familywarminginformation......................................... 313

Table392

hasprocess-familywarminginformationunit-type.......................... 313

Table393

hasprocess-familywarminginformationunit-type<unit-type-name>...
314

Table394

hasprocess-familywarmingprocess.............................................. 314

Table395

hasprocess-familywarmingprocessunit-type................................315

Table396

hasprocess-familywarmingprocessunit-type<unit-type-name>.. 315

Table397

hasprocess-familywarmingstatistics............................................. 315

Table398

hasprocess-familywarmingstatisticsunit-type.............................. 316

Table399

hasprocess-familywarmingstatisticsunit-type<unit-type-name>. 316

Table400

hasprocess-familywarmingsubscriptions...................................... 317

Table401

hasprocess-familywarmingsubscriptionsunit-type....................... 317

Table402

hasprocess-familywarmingsubscriptionsunit-type<unit-type-name>.
318

Table403

hasreset-block................................................................................ 318

Table404

hasreset-block<resetblock-value>.................................................319

Table405

hasreset-block<resetblock-value>managed-object...................... 319

Table406

hasreset-block<resetblock-value>managed-object<mo-name>..320

Table407

hasreset-block<resetblock-value>managed-object-full-name...... 320

Table408

hasreset-block<resetblock-value>managed-object-full-name<mofullname>......................................................................................... 321

Table409

hasrestart........................................................................................321

Table410

hasrestartlogical-group.................................................................. 323

Table411

hasrestartlogical-group<logical-group-name>.............................. 323

Table412

hasrestartmanaged-object.............................................................324

Table413

hasrestartmanaged-object<mo-name>........................................ 324

Table414

hasrestartmanaged-object-full-name.............................................325

Table415

hasrestartmanaged-object-full-name<mo-fullname>....................325

Table416

hasshutdown.................................................................................. 326

Table417

hasshutdownlogical-group.............................................................327

Table418

hasshutdownlogical-group<logical-group-name>.........................327

Table419

hasshutdownmanaged-object........................................................328

Table420

hasshutdownmanaged-object<mo-name>................................... 328

Table421

hasshutdownmanaged-object-full-name........................................329

Table422

hasshutdownmanaged-object-full-name<mo-fullname>...............329

Table423

hasstate.......................................................................................... 330

49

MulticontrollerRNCSCLICommands

50

Table424

hasstatelogical-group.................................................................... 332

Table425

hasstatelogical-group<logical-group-name>................................ 332

Table426

hasstatemanaged-object............................................................... 333

Table427

hasstatemanaged-object<mo-name>...........................................333

Table428

hasstatemanaged-object-full-name............................................... 334

Table429

hasstatemanaged-object-full-name<mo-fullname>...................... 334

Table430

hassummary................................................................................... 335

Table431

hassummarymanaged-object........................................................ 338

Table432

hassummarymanaged-object<mo-name>....................................339

Table433

hassummarymanaged-object-full-name........................................ 339

Table434

hassummarymanaged-object-full-name<mo-fullname>............... 340

Table435

hasswitchover.................................................................................340

Table436

hasswitchoverlogical-group........................................................... 341

Table437

hasswitchoverlogical-group<logical-group-name>....................... 342

Table438

hasswitchovermanaged-object...................................................... 342

Table439

hasswitchovermanaged-object<mo-name>..................................343

Table440

hasswitchovermanaged-object-full-name...................................... 343

Table441

hasswitchovermanaged-object-full-name<mo-fullname>............. 344

Table442

hasswitchovernew-active-recovery-unit.........................................344

Table443

hasswitchovernew-active-recovery-unit<new-active-recovery-unit>..
345

Table444

hastest-state................................................................................... 345

Table445

hastest-state<test-state-value>..................................................... 346

Table446

hastest-state<test-state-value>managed-object.......................... 346

Table447

hastest-state<test-state-value>managed-object<mo-name>...... 347

Table448

hastest-state<test-state-value>managed-object-full-name.......... 347

Table449

hastest-state<test-state-value>managed-object-full-name<mofullname>......................................................................................... 348

Table450

hasunlock....................................................................................... 348

Table451

hasunlockall...................................................................................349

Table452

hasunlocklogical-group..................................................................350

Table453

hasunlocklogical-group<logical-group-name>..............................350

Table454

hasunlockmanaged-object.............................................................350

Table455

hasunlockmanaged-object<mo-name>........................................ 351

Table456

hasunlockmanaged-object-full-name.............................................352

Table457

hasunlockmanaged-object-full-name<mo-fullname>....................352

Table458

hasview...........................................................................................353

Table459

hasviewlogical-group..................................................................... 354

Table460

hasviewlogical-group<logical-group-name>................................. 354

Table461

hasviewmanaged-object................................................................354

Table462

hasviewmanaged-object<mo-name>........................................... 355

Issue:03B

MulticontrollerRNCSCLICommands

Issue:03B

Table463

hasviewmanaged-object-full-name................................................356

Table464

hasviewmanaged-object-full-name<mo-fullname>.......................356

Table465

hasviewrecoverygroup...................................................................357

Table466

hw.................................................................................................... 357

Table467

ipsec................................................................................................ 358

Table468

ipsecinstance..................................................................................360

Table469

ipsecinstance<instance_name>.................................................... 361

Table470

ipsecinstance<instance_name>rule............................................. 362

Table471

ipsecinstance<instance_name>rule<rule-name>........................363

Table472

ipsecinstance<instance_name>ruleall.........................................365

Table473

ipsecinstance<instance_name>ruleconfig...................................365

Table474

ipsecinstance<instance_name>vpn............................................. 366

Table475

ipsecinstance<instance_name>vpn<vpn-name>........................ 367

Table476

ipsecinstance<instance_name>vpn<vpn-name>certificate........367

Table477

ipsecinstance<instance_name>vpn<vpn-name>certificate
<certificate-value>........................................................................... 368

Table478

ipsecinstance<instance_name>vpn<vpn-name>secret............. 369

Table479

ipsecinstance<instance_name>vpn<vpn-name>secret<secretvalue>.............................................................................................. 370

Table480

ipsecinstance<instance_name>vpnall.........................................371

Table481

ipsecinstance<instance_name>vpnconfig...................................371

Table482

ipsecrule......................................................................................... 372

Table483

ipsecrule<name>........................................................................... 373

Table484

ipsecrule<rule-name>....................................................................373

Table485

ipsecruleall.....................................................................................375

Table486

ipsecruleconfig...............................................................................375

Table487

ipsectemplate................................................................................. 376

Table488

ipsectemplateikev1........................................................................ 377

Table489

ipsectemplateikev1<name>..........................................................378

Table490

ipsectemplateikev1<template-name>...........................................378

Table491

ipsectemplateikev1all................................................................... 380

Table492

ipsectemplateikev1config............................................................. 381

Table493

ipsectemplateikev2........................................................................ 381

Table494

ipsectemplateikev2<name>..........................................................382

Table495

ipsectemplateikev2<template-name>...........................................382

Table496

ipsectemplateikev2all................................................................... 384

Table497

ipsectemplateikev2config............................................................. 384

Table498

ipsecvpn......................................................................................... 385

Table499

ipsecvpn<name>........................................................................... 386

Table500

ipsecvpn<vpn-name>.................................................................... 386

Table501

ipsecvpn<vpn-name>certificate....................................................387

51

MulticontrollerRNCSCLICommands

52

Table502

ipsecvpn<vpn-name>certificate<certificate-value>..................... 387

Table503

ipsecvpn<vpn-name>secret......................................................... 389

Table504

ipsecvpn<vpn-name>secret<secret-value>.................................390

Table505

ipsecvpnall.....................................................................................390

Table506

ipsecvpnconfig...............................................................................391

Table507

license............................................................................................. 392

Table508

licenseall.........................................................................................393

Table509

licensedetails.................................................................................. 394

Table510

licensedetailsunique-id.................................................................. 394

Table511

licensedetailsunique-id<unique_id>............................................. 395

Table512

licenseexpired.................................................................................395

Table513

licensefeature................................................................................. 396

Table514

licensefeatureall.............................................................................396

Table515

licensefeature-mgmt....................................................................... 397

Table516

licensefeature-mgmtall.................................................................. 398

Table517

licensefeature-mgmtalllist............................................................. 398

Table518

licensefeature-mgmtalltable..........................................................399

Table519

licensefeature-mgmtcode.............................................................. 399

Table520

licensefeature-mgmtcode<feature-code>.....................................400

Table521

licensefeature-mgmtcode<feature-code>feature-admin-state.....400

Table522

licensefeature-mgmtcode<feature-code>feature-admin-state
<admin_state>.................................................................................401

Table523

licensefeature-mgmtname............................................................. 401

Table524

licensefeature-mgmtname<feature-name>.................................. 402

Table525

licensefeature-mgmtname<feature-name>feature-admin-state.. 402

Table526

licensefeature-mgmtname<feature-name>feature-admin-state
<admin_state>.................................................................................403

Table527

licensefeature-mgmtusage............................................................ 403

Table528

licensefeature-mgmtusageall........................................................404

Table529

licensefeature-mgmtusagealllist.................................................. 404

Table530

licensefeature-mgmtusagealltable...............................................405

Table531

licensefeature-mgmtusagecode................................................... 405

Table532

licensefeature-mgmtusagecode<feature-code>.......................... 406

Table533

licensefeature-mgmtusagename.................................................. 406

Table534

licensefeature-mgmtusagename<feature-name>........................406

Table535

licensefile........................................................................................407

Table536

licensefile<file>.............................................................................. 407

Table537

licensefile<file>auto-set-features..................................................408

Table538

licensefile<file>auto-set-features<auto-set-features>................. 408

Table539

licensefile<file>auto-set-features<auto-set-features>verbosity.. 409

Issue:03B

MulticontrollerRNCSCLICommands

Issue:03B

Table540

licensefile<file>auto-set-features<auto-set-features>verbosity
<verbosity>...................................................................................... 409

Table541

licensefolder................................................................................... 410

Table542

licensefolder<folder>..................................................................... 410

Table543

licensefolder<folder>auto-set-features......................................... 411

Table544

licensefolder<folder>auto-set-features<auto-set-features>.........412

Table545

licensefolder<folder>auto-set-features<auto-set-features>verbosity
..........................................................................................................412

Table546

licensefolder<folder>auto-set-features<auto-set-features>verbosity
<verbosity>...................................................................................... 412

Table547

licensegeneric-license.................................................................... 413

Table548

licensegeneric-licenseall................................................................413

Table549

licensetarget-id............................................................................... 414

Table550

licenseunique-id..............................................................................414

Table551

licenseunique-id<unique-id>..........................................................415

Table552

log....................................................................................................415

Table553

logaudit-trail.................................................................................... 416

Table554

logconfig......................................................................................... 418

Table555

logconfigaudit-trail......................................................................... 418

Table556

logconfigconfig-dir-debug.............................................................. 420

Table557

logmaster-syslog............................................................................ 420

Table558

networking....................................................................................... 421

Table559

networkingaclrule............................................................................423

Table560

networkingaclrule<owner>.............................................................424

Table561

networkingaclrule<owner>accept................................................. 428

Table562

networkingaclrule<owner>drop.................................................... 428

Table563

networkingaclrule<owner>dscp-mark...........................................428

Table564

networkingaclrule<owner>dscp-mark<DSCP>............................429

Table565

networkingaclrule<owner>pip-mark..............................................429

Table566

networkingaclrule<owner>pip-mark<PIP>...................................430

Table567

networkingaclrule<owner>set-vrf..................................................430

Table568

networkingaclrule<owner>set-vrf<VRF>..................................... 430

Table569

networkingaclrulechain.................................................................. 431

Table570

networkingaclrulechain<chain>.................................................... 431

Table571

networkingaclruleindex.................................................................. 432

Table572

networkingaclruleindex<index>.................................................... 433

Table573

networkingaclruleinput-iface.......................................................... 433

Table574

networkingaclruleinput-iface<input-iface>.................................... 434

Table575

networkingaclruleoutput-iface........................................................435

Table576

networkingaclruleoutput-iface<output-iface>................................435

Table577

networkingaclruleowner.................................................................436

53

MulticontrollerRNCSCLICommands

54

Table578

networkingaclruleowner<owner>..................................................436

Table579

networkingaclruleruntime...............................................................437

Table580

networkingaclruleruntimeipv6....................................................... 438

Table581

networkingaclruleruntimeipv6node.............................................. 438

Table582

networkingaclruleruntimeipv6node<node>.................................438

Table583

networkingaclruleruntimenode......................................................439

Table584

networkingaclruleruntimenode<node>........................................ 439

Table585

networkingaclruleruntimenode<node>ipv6.................................439

Table586

networkingaddress......................................................................... 440

Table587

networkingaddress<owner>.......................................................... 441

Table588

networkingaddressdedicated.........................................................443

Table589

networkingaddressdedicated<owner>..........................................444

Table590

networkingconnection.....................................................................445

Table591

networkingconnectionruntime........................................................446

Table592

networkingconnectionruntimenode...............................................447

Table593

networkingconnectionruntimenode<node>..................................448

Table594

networkingconnectionruntimeraw4............................................... 448

Table595

networkingconnectionruntimeraw4node...................................... 448

Table596

networkingconnectionruntimeraw4node<node>.........................449

Table597

networkingconnectionruntimeraw6............................................... 449

Table598

networkingconnectionruntimeraw6node...................................... 449

Table599

networkingconnectionruntimeraw6node<node>.........................450

Table600

networkingconnectionruntimetcp4................................................ 450

Table601

networkingconnectionruntimetcp4node....................................... 450

Table602

networkingconnectionruntimetcp4node<node>..........................451

Table603

networkingconnectionruntimetcp6................................................ 451

Table604

networkingconnectionruntimetcp6node....................................... 451

Table605

networkingconnectionruntimetcp6node<node>..........................452

Table606

networkingconnectionruntimeudp4...............................................452

Table607

networkingconnectionruntimeudp4node......................................452

Table608

networkingconnectionruntimeudp4node<node>.........................453

Table609

networkingconnectionruntimeudp6...............................................453

Table610

networkingconnectionruntimeudp6node......................................453

Table611

networkingconnectionruntimeudp6node<node>.........................454

Table612

networkingdiagnostics.................................................................... 454

Table613

networkingdiagnosticsping............................................................ 454

Table614

networkingdiagnosticspingnode................................................... 455

Table615

networkingdiagnosticspingnode<node>...................................... 455

Table616

networkingdiagnosticstraceroute................................................... 456

Table617

networkingdiagnosticstraceroutenode.......................................... 456

Issue:03B

MulticontrollerRNCSCLICommands

Issue:03B

Table618

networkingdiagnosticstraceroutenode<node>.............................457

Table619

networkingether.............................................................................. 457

Table620

networkingether<owner>............................................................... 460

Table621

networkingforwarding-table............................................................ 462

Table622

networkingforwarding-tableruntime............................................... 463

Table623

networkingforwarding-tableruntimeipv6........................................463

Table624

networkingforwarding-tableruntimeipv6node...............................463

Table625

networkingforwarding-tableruntimeipv6node<node>..................464

Table626

networkingforwarding-tableruntimenode...................................... 464

Table627

networkingforwarding-tableruntimenode<node>......................... 464

Table628

networkingforwarding-tableruntimenode<node>ipv6..................465

Table629

networkinginstance.........................................................................465

Table630

networkinginstance<instance>...................................................... 467

Table631

networkinginstance<instance>address........................................ 469

Table632

networkinginstance<instance>address<owner>......................... 470

Table633

networkinginstance<instance>addressdedicated........................472

Table634

networkinginstance<instance>addressdedicated<owner>.........473

Table635

networkinginstance<instance>connection....................................474

Table636

networkinginstance<instance>connectionruntime.......................475

Table637

networkinginstance<instance>connectionruntimenode..............476

Table638

networkinginstance<instance>connectionruntimenode<node>.......
476

Table639

networkinginstance<instance>connectionruntimeraw4.............. 477

Table640

networkinginstance<instance>connectionruntimeraw4node..... 477

Table641

networkinginstance<instance>connectionruntimeraw4node
<node>............................................................................................ 477

Table642

networkinginstance<instance>connectionruntimeraw6.............. 478

Table643

networkinginstance<instance>connectionruntimeraw6node..... 478

Table644

networkinginstance<instance>connectionruntimeraw6node
<node>............................................................................................ 479

Table645

networkinginstance<instance>connectionruntimetcp4............... 479

Table646

networkinginstance<instance>connectionruntimetcp4node...... 479

Table647

networkinginstance<instance>connectionruntimetcp4node<node>
..........................................................................................................480

Table648

networkinginstance<instance>connectionruntimetcp6............... 480

Table649

networkinginstance<instance>connectionruntimetcp6node...... 480

Table650

networkinginstance<instance>connectionruntimetcp6node<node>
..........................................................................................................481

Table651

networkinginstance<instance>connectionruntimeudp4..............481

Table652

networkinginstance<instance>connectionruntimeudp4node.....481

Table653

networkinginstance<instance>connectionruntimeudp4node
<node>............................................................................................ 482

55

MulticontrollerRNCSCLICommands

56

Table654

networkinginstance<instance>connectionruntimeudp6..............482

Table655

networkinginstance<instance>connectionruntimeudp6node.....482

Table656

networkinginstance<instance>connectionruntimeudp6node
<node>............................................................................................ 483

Table657

networkinginstance<instance>diagnostics................................... 483

Table658

networkinginstance<instance>diagnosticsping........................... 483

Table659

networkinginstance<instance>diagnosticspingnode.................. 484

Table660

networkinginstance<instance>diagnosticspingnode<node>..... 484

Table661

networkinginstance<instance>diagnosticstraceroute.................. 485

Table662

networkinginstance<instance>diagnosticstraceroutenode......... 485

Table663

networkinginstance<instance>diagnosticstraceroutenode<node>..
486

Table664

networkinginstance<instance>ether............................................. 486

Table665

networkinginstance<instance>ether<owner>.............................. 489

Table666

networkinginstance<instance>forwarding-table........................... 491

Table667

networkinginstance<instance>forwarding-tableruntime.............. 491

Table668

networkinginstance<instance>forwarding-tableruntimeipv6.......492

Table669

networkinginstance<instance>forwarding-tableruntimeipv6node....
493

Table670

networkinginstance<instance>forwarding-tableruntimeipv6node
<node>............................................................................................ 493

Table671

networkinginstance<instance>forwarding-tableruntimenode..... 493

Table672

networkinginstance<instance>forwarding-tableruntimenode
<node>............................................................................................ 494

Table673

networkinginstance<instance>forwarding-tableruntimenode
<node>ipv6.....................................................................................494

Table674

networkinginstance<instance>interface....................................... 494

Table675

networkinginstance<instance>interface<owner>........................ 496

Table676

networkinginstance<instance>interfaceall-internal......................497

Table677

networkinginstance<instance>interfaceall-internal<owner>.......497

Table678

networkinginstance<instance>interfaceall-internal<owner>admin..
498

Table679

networkinginstance<instance>interfaceall-internal<owner>admin
<admin-state>..................................................................................498

Table680

networkinginstance<instance>interfaceiface...............................498

Table681

networkinginstance<instance>interfaceiface<iface>.................. 499

Table682

networkinginstance<instance>interfaceowner.............................499

Table683

networkinginstance<instance>interfaceowner<owner>..............499

Table684

networkinginstance<instance>interfaceruntime.......................... 500

Table685

networkinginstance<instance>interfaceruntimeiface..................500

Table686

networkinginstance<instance>interfaceruntimeiface<iface>..... 501

Table687

networkinginstance<instance>interfaceruntimenode................. 501

Issue:03B

MulticontrollerRNCSCLICommands

Issue:03B

Table688

networkinginstance<instance>interfaceruntimenode<node>.... 501

Table689

networkinginstance<instance>interfaceruntimetable..................502

Table690

networkinginstance<instance>interfaceruntimetableiface......... 502

Table691

networkinginstance<instance>interfaceruntimetableiface<iface>..
503

Table692

networkinginstance<instance>interfaceruntimetablenode.........503

Table693

networkinginstance<instance>interfaceruntimetablenode<node>.
503

Table694

networkinginstance<instance>link-state-detector.........................504

Table695

networkinginstance<instance>link-state-detector<owner>..........505

Table696

networkinginstance<instance>link-state-detectormonitoring-group..
507

Table697

networkinginstance<instance>link-state-detectormonitoring-group
<owner>...........................................................................................508

Table698

networkinginstance<instance>link-state-detectormonitoring-group
<owner>iface-mon-group............................................................... 509

Table699

networkinginstance<instance>link-state-detectormonitoring-group
<owner>iface-mon-group<iface-group-name>.............................. 509

Table700

networkinginstance<instance>link-state-detectormonitoring-group
<owner>nexthop-mon-group.......................................................... 510

Table701

networkinginstance<instance>link-state-detectormonitoring-group
<owner>nexthop-mon-group<nexthop-group-name>....................510

Table702

networkinginstance<instance>linkaggr......................................... 511

Table703

networkinginstance<instance>linkaggr<owner>..........................514

Table704

networkinginstance<instance>monitoring.................................... 516

Table705

networkinginstance<instance>monitoringbfd.............................. 518

Table706

networkinginstance<instance>monitoringbfdruntime................. 519

Table707

networkinginstance<instance>monitoringbfdsession................. 520

Table708

networkinginstance<instance>monitoringbfdsession<owner>.. 521

Table709

networkinginstance<instance>monitoringbfdsessionconfig.......524

Table710

networkinginstance<instance>monitoringicmp............................525

Table711

networkinginstance<instance>monitoringicmpruntime...............526

Table712

networkinginstance<instance>monitoringicmpsession...............527

Table713

networkinginstance<instance>monitoringicmpsession<owner>......
528

Table714

networkinginstance<instance>monitoringicmpsessionconfig.... 531

Table715

networkinginstance<instance>monitoringtwamp.........................531

Table716

networkinginstance<instance>monitoringtwampreflector...........532

Table717

networkinginstance<instance>monitoringtwampsender.............532

Table718

networkinginstance<instance>neigh............................................ 535

Table719

networkinginstance<instance>neigh<owner>............................. 536

Table720

networkinginstance<instance>neighaddress...............................537

Table721

networkinginstance<instance>neighaddress<address>.............537

57

MulticontrollerRNCSCLICommands

58

Table722

networkinginstance<instance>neighiface....................................538

Table723

networkinginstance<instance>neighiface<iface>....................... 538

Table724

networkinginstance<instance>neighlladdr...................................539

Table725

networkinginstance<instance>neighlladdr<lladdr>.....................539

Table726

networkinginstance<instance>neighowner..................................540

Table727

networkinginstance<instance>neighowner<owner>...................540

Table728

networkinginstance<instance>neighruntime............................... 540

Table729

networkinginstance<instance>neighruntimeipv6........................541

Table730

networkinginstance<instance>neighruntimeipv6node...............541

Table731

networkinginstance<instance>neighruntimeipv6node<node>..542

Table732

networkinginstance<instance>neighruntimenode...................... 542

Table733

networkinginstance<instance>neighruntimenode<node>......... 542

Table734

networkinginstance<instance>neighruntimenode<node>ipv6..543

Table735

networkinginstance<instance>vlan...............................................543

Table736

networkinginstance<instance>vlan<owner>................................546

Table737

networkinginterface........................................................................ 548

Table738

networkinginterface<owner>......................................................... 549

Table739

networkinginterfaceall-internal.......................................................551

Table740

networkinginterfaceall-internal<owner>........................................551

Table741

networkinginterfaceall-internal<owner>admin............................. 551

Table742

networkinginterfaceall-internal<owner>admin<admin-state>..... 552

Table743

networkinginterfaceiface................................................................552

Table744

networkinginterfaceiface<iface>................................................... 552

Table745

networkinginterfaceowner..............................................................553

Table746

networkinginterfaceowner<owner>...............................................553

Table747

networkinginterfaceruntime........................................................... 553

Table748

networkinginterfaceruntimeiface...................................................554

Table749

networkinginterfaceruntimeiface<iface>...................................... 554

Table750

networkinginterfaceruntimenode.................................................. 555

Table751

networkinginterfaceruntimenode<node>..................................... 555

Table752

networkinginterfaceruntimetable...................................................555

Table753

networkinginterfaceruntimetableiface.......................................... 556

Table754

networkinginterfaceruntimetableiface<iface>............................. 556

Table755

networkinginterfaceruntimetablenode..........................................557

Table756

networkinginterfaceruntimetablenode<node>............................ 557

Table757

networkingipbr................................................................................ 557

Table758

networkingipro................................................................................ 564

Table759

networkingiubsnt.............................................................................569

Table760

networkinglink-state-detector..........................................................572

Table761

networkinglink-state-detector<owner>...........................................573

Issue:03B

MulticontrollerRNCSCLICommands

Issue:03B

Table762

networkinglink-state-detectormonitoring-group............................. 575

Table763

networkinglink-state-detectormonitoring-group<owner>.............. 576

Table764

networkinglink-state-detectormonitoring-group<owner>iface-mongroup............................................................................................... 578

Table765

networkinglink-state-detectormonitoring-group<owner>iface-mongroup<iface-group-name>.............................................................. 578

Table766

networkinglink-state-detectormonitoring-group<owner>iface-mongroup<ifacegrp_name>.................................................................. 579

Table767

networkinglink-state-detectormonitoring-group<owner>nexthopmon-group....................................................................................... 580

Table768

networkinglink-state-detectormonitoring-group<owner>nexthopmon-group<nexthop-group-name>.................................................580

Table769

networkinglink-state-detectormonitoring-group<owner>nexthopmon-group<nexthopgrp_name>..................................................... 581

Table770

networkinglinkaggr..........................................................................582

Table771

networkinglinkaggr<owner>...........................................................584

Table772

networkingmonitoring..................................................................... 587

Table773

networkingmonitoringbfd............................................................... 589

Table774

networkingmonitoringbfdconfig.....................................................590

Table775

networkingmonitoringbfdruntime.................................................. 590

Table776

networkingmonitoringbfdsession.................................................. 591

Table777

networkingmonitoringbfdsession<owner>................................... 592

Table778

networkingmonitoringicmp.............................................................595

Table779

networkingmonitoringicmpconfig.................................................. 596

Table780

networkingmonitoringicmpruntime................................................597

Table781

networkingmonitoringicmpsession................................................598

Table782

networkingmonitoringicmpsession<owner>.................................599

Table783

networkingmonitoringtwamp..........................................................602

Table784

networkingmonitoringtwampreflector............................................603

Table785

networkingmonitoringtwampsender..............................................604

Table786

networkingneigh............................................................................. 609

Table787

networkingneigh<owner>.............................................................. 610

Table788

networkingneighaddress................................................................ 611

Table789

networkingneighaddress<address>.............................................. 611

Table790

networkingneighiface.....................................................................612

Table791

networkingneighiface<iface>........................................................ 612

Table792

networkingneighlladdr....................................................................613

Table793

networkingneighlladdr<lladdr>......................................................613

Table794

networkingneighowner...................................................................614

Table795

networkingneighowner<owner>....................................................614

Table796

networkingneighruntime................................................................ 615

Table797

networkingneighruntimeipv6.........................................................615

59

MulticontrollerRNCSCLICommands

60

Table798

networkingneighruntimeipv6node................................................615

Table799

networkingneighruntimeipv6node<node>...................................616

Table800

networkingneighruntimenode....................................................... 616

Table801

networkingneighruntimenode<node>.......................................... 616

Table802

networkingneighruntimenode<node>ipv6...................................617

Table803

networkingqos-profile..................................................................... 617

Table804

networkingqos-profileidsp..............................................................618

Table805

networkingqos-profileiphb..............................................................621

Table806

networkingqset............................................................................... 625

Table807

networkingqset<name>................................................................. 626

Table808

networkingqset<name>queue...................................................... 627

Table809

networkingqset<name>queue<id>.............................................. 627

Table810

networkingswitch............................................................................ 628

Table811

networkingswitchport-group...........................................................629

Table812

networkingswitchport-to-vlan......................................................... 630

Table813

networkingswitchport-to-vlan<owner>.......................................... 630

Table814

networkingvlan................................................................................631

Table815

networkingvlan<owner>.................................................................633

Table816

networkingvlanmapping..................................................................635

Table817

networkingvrf.................................................................................. 637

Table818

networking-service...........................................................................639

Table819

networking-servicedhcp..................................................................640

Table820

networking-servicedns....................................................................640

Table821

networking-servicentp.....................................................................642

Table822

radio-network...................................................................................643

Table823

radio-networkall.............................................................................. 644

Table824

radio-networkcspudist.....................................................................645

Table825

radio-networkcspudistby-cspuid.................................................... 645

Table826

radio-networkcspudistfor-all-cspu..................................................646

Table827

radio-networkiuparams................................................................... 646

Table828

radio-networkomsconn................................................................... 646

Table829

radio-networkomsconninsecure-bsom-connections...................... 647

Table830

radio-networkomsconnsecure-bsom-connections......................... 648

Table831

radio-networkomsconn-config........................................................ 648

Table832

radio-networkomsconn-configclient-tls-mode................................ 649

Table833

radio-networkomsconn-configclient-tls-modeforced..................... 649

Table834

radio-networkomsconn-configclient-tls-modeoff........................... 650

Table835

radio-networkomsconn-configclient-tls-modeprobing................... 650

Table836

radio-networkomsconn-configinsecure-bsom-restart.................... 650

Table837

radio-networkomsconn-configmodify.............................................651

Issue:03B

MulticontrollerRNCSCLICommands

Issue:03B

Table838

radio-networkomsconn-configoms-conn-reset.............................. 652

Table839

radio-networkomsconn-configoms-switchover.............................. 652

Table840

radio-networkomsconn-configsecure-bsom-restart....................... 652

Table841

radio-networkomsconn-configserving-oms-selection.................... 653

Table842

radio-networkrebalancing............................................................... 653

Table843

radio-networkrebalancingby-btsid..................................................654

Table844

radio-networkrebalancingby-don-cscp...........................................655

Table845

radio-networkrebalancingby-rcv-cscp............................................655

Table846

radio-networkrebalancingby-rebalancingid....................................655

Table847

radio-networkrebalancingby-timerange......................................... 656

Table848

radio-networkrebalancingforce...................................................... 656

Table849

radio-networkrnc-id.........................................................................657

Table850

radio-networkrnc-idcontinue-to-confirmation................................. 657

Table851

radio-networkrnw-plan-error-log..................................................... 658

Table852

radio-networkrnw-plan-operation....................................................658

Table853

radio-networkrnw-plan-operation-log..............................................658

Table854

radio-networksubs-trace................................................................. 659

Table855

radio-networksubs-traceactivate-trace.......................................... 659

Table856

radio-networksubs-tracedeactivate-trace...................................... 660

Table857

radio-networksubs-tracedisplay-trace............................................660

Table858

radio-networktraffic-restriction........................................................ 660

Table859

radio-networktraffic-restrictionaacr-list...........................................662

Table860

radio-networktraffic-restrictioncmob-list......................................... 663

Table861

radio-networktraffic-restrictiondisable............................................ 663

Table862

radio-networktraffic-restrictionenable............................................ 663

Table863

radio-networktraffic-restrictionrestriction-group-name................... 664

Table864

radio-networktraffic-restrictionrestriction-level............................... 664

Table865

radio-networktraffic-restrictionwcels-for-cmob............................... 665

Table866

radio-networkwbtsstatus.................................................................665

Table867

radio-networkwbtsstatusall............................................................ 666

Table868

radio-networkwbtsstatuswbts........................................................ 666

Table869

radio-networkwcel-balance.............................................................667

Table870

radio-networkwcel-balancebalance............................................... 668

Table871

radio-networkwcel-balanceempty.................................................. 668

Table872

radio-networkwcel-balancegraceful-balance................................. 669

Table873

radio-networkwcel-balancemove................................................... 670

Table874

radio-networkwcel-balancesimulate.............................................. 671

Table875

radio-networkwcel-state..................................................................671

Table876

radio-networkwcel-stateusing-cell-id............................................. 672

Table877

radio-networkwcel-stateusing-lcr-id............................................... 672

61

MulticontrollerRNCSCLICommands

62

Table878

radio-networkwcel-stateusing-wbts-id........................................... 673

Table879

radio-networkwcelstatus................................................................. 674

Table880

radio-networkwcelstatusall............................................................ 675

Table881

radio-networkwcelstatusblocked....................................................676

Table882

radio-networkwcelstatusfilter......................................................... 676

Table883

restore............................................................................................. 678

Table884

restoreactive................................................................................... 681

Table885

restoreconfig...................................................................................682

Table886

restoreconfigall.............................................................................. 682

Table887

restoreconfigcurrent.......................................................................683

Table888

restoreconfiglabel.......................................................................... 683

Table889

restoreconfiglabel<label-name>................................................... 683

Table890

restorecontent.................................................................................684

Table891

restoredatabase..............................................................................684

Table892

restoredatabasedb-name.............................................................. 685

Table893

restoredatabasedb-name<db-name>........................................... 685

Table894

restoredelivery................................................................................ 685

Table895

restoredeliveryall........................................................................... 686

Table896

restoredeliverycurrent....................................................................686

Table897

restoredeliverylabel....................................................................... 687

Table898

restoredeliverylabel<label-name>................................................ 687

Table899

restorefilesystem............................................................................ 687

Table900

restorefilesystemrg-name.............................................................. 688

Table901

restorefilesystemrg-name<rg-name>........................................... 688

Table902

restorefull........................................................................................689

Table903

restoremode................................................................................... 689

Table904

restoremodeforce.......................................................................... 690

Table905

restoremodeno-exec......................................................................690

Table906

restoremodenormal....................................................................... 691

Table907

restorepartial...................................................................................691

Table908

restoreplugin...................................................................................692

Table909

restorepluginplugin-name.............................................................. 692

Table910

restorepluginplugin-name<plugin-name>..................................... 693

Table911

restoreselective.............................................................................. 693

Table912

restorestate.....................................................................................694

Table913

routing..............................................................................................695

Table914

routingaggregate............................................................................ 696

Table915

routingaggregate<IP_PREFIX>.....................................................698

Table916

routingaggregate<IP_PREFIX>aspath-truncate...........................699

Table917

routingaggregate<IP_PREFIX>aspath-truncate<option>............699

Issue:03B

MulticontrollerRNCSCLICommands

Issue:03B

Table918

routingaggregate<IP_PREFIX>contributing-protocol................... 699

Table919

routingaggregate<IP_PREFIX>contributing-protocol<PROTOCOL>.
700

Table920

routingaggregate<IP_PREFIX>contributing-protocol<PROTOCOL>
contributing-route.............................................................................700

Table921

routingaggregate<IP_PREFIX>contributing-protocol<PROTOCOL>
contributing-route<IP_PREFIX>..................................................... 701

Table922

routingaggregate<IP_PREFIX>contributing-protocol<PROTOCOL>
contributing-route<IP_PREFIX><filteroption>............................... 702

Table923

routingaggregate<IP_PREFIX>contributing-protocol<PROTOCOL>
contributing-route<IP_PREFIX><filteroption>on.......................... 702

Table924

routingaggregate<IP_PREFIX>contributing-protocol<PROTOCOL>
contributing-route<IP_PREFIX><option>...................................... 702

Table925

routingaggregate<IP_PREFIX>contributing-protocol<PROTOCOL>
contributing-routeall........................................................................ 703

Table926

routingaggregate<IP_PREFIX>contributing-protocol<PROTOCOL>
contributing-routeall<option>......................................................... 703

Table927

routingaggregate<IP_PREFIX>contributing-protocol<PROTOCOL>
off.....................................................................................................703

Table928

routingaggregate<IP_PREFIX>off................................................ 704

Table929

routingaggregate<IP_PREFIX>rank.............................................704

Table930

routingaggregate<IP_PREFIX>rank<rank>.................................704

Table931

routingaggregate<IP_PREFIX>weight......................................... 705

Table932

routingaggregate<IP_PREFIX>weight<weight>..........................705

Table933

routingaggregation..........................................................................705

Table934

routingaggregationconfig............................................................... 706

Table935

routingaggregationconfigall.......................................................... 706

Table936

routingbfd........................................................................................706

Table937

routingbfd-static-holdtime............................................................... 707

Table938

routingbfd-static-holdtime<holdtime>............................................ 708

Table939

routingbfd-static-holdtimeconfig.....................................................708

Table940

routingbfd-static-holdtimeconfigall................................................ 709

Table941

routingexport...................................................................................709

Table942

routingexport<export-protocol>......................................................711

Table943

routingexport<export-protocol>aggregate.................................... 712

Table944

routingexport<export-protocol>aggregate<IP_PREFIX>.............712

Table945

routingexport<export-protocol>aggregate<IP_PREFIX><option>....
713

Table946

routingexport<export-protocol>aggregate<IP_PREFIX>cost..... 713

Table947

routingexport<export-protocol>aggregate<IP_PREFIX>cost<cost>
..........................................................................................................714

Table948

routingexport<export-protocol>aggregateall................................714

Table949

routingexport<export-protocol>aggregateall<option>.................714

63

MulticontrollerRNCSCLICommands

64

Table950

routingexport<export-protocol>aggregateallcost........................ 715

Table951

routingexport<export-protocol>aggregateallcost<cost>............ 715

Table952

routingexport<export-protocol>direct............................................715

Table953

routingexport<export-protocol>directall....................................... 716

Table954

routingexport<export-protocol>directall<option>........................ 716

Table955

routingexport<export-protocol>directallcost............................... 717

Table956

routingexport<export-protocol>directallcost<cost>....................717

Table957

routingexport<export-protocol>directinterface-name...................717

Table958

routingexport<export-protocol>directinterface-name<IFNAME>......
718

Table959

routingexport<export-protocol>directinterface-name<IFNAME>
<option>...........................................................................................718

Table960

routingexport<export-protocol>directinterface-name<IFNAME>
cost.................................................................................................. 719

Table961

routingexport<export-protocol>directinterface-name<IFNAME>
cost<cost>...................................................................................... 719

Table962

routingexport<export-protocol>static-route...................................719

Table963

routingexport<export-protocol>static-route<static-route>............720

Table964

routingexport<export-protocol>static-route<static-route><option>...
720

Table965

routingexport<export-protocol>static-route<static-route>cost.... 721

Table966

routingexport<export-protocol>static-route<static-route>cost
<cost>..............................................................................................721

Table967

routingexport<export-protocol>static-routeall.............................. 721

Table968

routingexport<export-protocol>static-routeall<option>............... 722

Table969

routingexport<export-protocol>static-routeallcost...................... 722

Table970

routingexport<export-protocol>static-routeallcost<cost>...........723

Table971

routingexportconfig........................................................................ 723

Table972

routingexportconfigall................................................................... 723

Table973

routingexportconfigproto...............................................................724

Table974

routingexportconfigproto<export-proto>...................................... 724

Table975

routinginbound-filter........................................................................724

Table976

routinginbound-filter<import-proto>............................................... 726

Table977

routinginbound-filter<import-proto><IP_PREFIX>........................727

Table978

routinginbound-filter<import-proto><IP_PREFIX><status>.........729

Table979

routinginbound-filter<import-proto><IP_PREFIX>filter................730

Table980

routinginbound-filter<import-proto><IP_PREFIX>filterexact...... 731

Table981

routinginbound-filter<import-proto><IP_PREFIX>filterexactaccept.
731

Table982

routinginbound-filter<import-proto><IP_PREFIX>filterexactrestrict.
732

Table983

routinginbound-filter<import-proto><IP_PREFIX>filternormal....732

Issue:03B

MulticontrollerRNCSCLICommands

Issue:03B

Table984

routinginbound-filter<import-proto><IP_PREFIX>filternormal
accept.............................................................................................. 732

Table985

routinginbound-filter<import-proto><IP_PREFIX>filternormal
restrict..............................................................................................733

Table986

routinginbound-filter<import-proto><IP_PREFIX>filterrange......733

Table987

routinginbound-filter<import-proto><IP_PREFIX>filterrangeaccept.
733

Table988

routinginbound-filter<import-proto><IP_PREFIX>filterrangefrommasklen........................................................................................... 734

Table989

routinginbound-filter<import-proto><IP_PREFIX>filterrangefrommasklen<from_mask_length>........................................................ 734

Table990

routinginbound-filter<import-proto><IP_PREFIX>filterrangefrommasklen<from_mask_length>to-masklen......................................735

Table991

routinginbound-filter<import-proto><IP_PREFIX>filterrangefrommasklen<from_mask_length>to-masklen<to_mask_length>....... 735

Table992

routinginbound-filter<import-proto><IP_PREFIX>filterrangefrommasklen<from_mask_length>to-masklen<to_mask_length>accept..
736

Table993

routinginbound-filter<import-proto><IP_PREFIX>filterrangefrommasklen<from_mask_length>to-masklen<to_mask_length>restrict.
736

Table994

routinginbound-filter<import-proto><IP_PREFIX>filterrangerestrict.
737

Table995

routinginbound-filter<import-proto><IP_PREFIX>filterrefines.... 737

Table996

routinginbound-filter<import-proto><IP_PREFIX>filterrefines
accept.............................................................................................. 737

Table997

routinginbound-filter<import-proto><IP_PREFIX>filterrefines
restrict..............................................................................................738

Table998

routinginbound-filter<import-proto><IP_PREFIX>rank................738

Table999

routinginbound-filter<import-proto><IP_PREFIX>rank<rankvalue>.
739

Table1000

routinginbound-filter<import-proto><IP_PREFIX>rank<status>.739

Table1001

routinginbound-filter<import-proto>accept....................................739

Table1002

routinginbound-filter<import-proto>rank....................................... 740

Table1003

routinginbound-filter<import-proto>rank<rankvalue>.................. 740

Table1004

routinginbound-filter<import-proto>restrict................................... 740

Table1005

routinginbound-filterconfig............................................................. 741

Table1006

routinginbound-filterconfigproto.................................................... 741

Table1007

routinginbound-filterconfigproto<import-proto>........................... 741

Table1008

routinginbound-filterconfigproto<import-proto>all.......................742

Table1009

routingipsrd.....................................................................................742

Table1010

routingipsrdkrt................................................................................743

Table1011

routingipsrdresources.................................................................... 743

Table1012

routingipsrdversion........................................................................ 743

Table1013

routingmax-path-splits.................................................................... 744

65

MulticontrollerRNCSCLICommands

66

Table1014

routingmax-path-splits<max-path-splits>.......................................744

Table1015

routingmax-path-splitsconfig..........................................................745

Table1016

routingmax-path-splitsconfigall..................................................... 745

Table1017

routingospf......................................................................................745

Table1018

routingospfarea..............................................................................747

Table1019

routingospfarea<OSPF_AREA>...................................................748

Table1020

routingospfarea<OSPF_AREA><option>....................................749

Table1021

routingospfarea<OSPF_AREA>range.........................................749

Table1022

routingospfarea<OSPF_AREA>range<IP_PREFIX>................. 750

Table1023

routingospfarea<OSPF_AREA>range<IP_PREFIX><option>.. 750

Table1024

routingospfarea<OSPF_AREA>range<IP_PREFIX>restrict..... 751

Table1025

routingospfarea<OSPF_AREA>range<IP_PREFIX>restrict
<option>...........................................................................................751

Table1026

routingospfarea<OSPF_AREA>stub........................................... 751

Table1027

routingospfarea<OSPF_AREA>stub<option>............................ 752

Table1028

routingospfarea<OSPF_AREA>stubdefault-cost....................... 752

Table1029

routingospfarea<OSPF_AREA>stubdefault-cost<default-cost>......
753

Table1030

routingospfarea<OSPF_AREA>stubsummary........................... 753

Table1031

routingospfarea<OSPF_AREA>stubsummary<option>............ 753

Table1032

routingospfarea<OSPF_AREA>stub-network............................. 754

Table1033

routingospfarea<OSPF_AREA>stub-network<IP_PREFIX>......754

Table1034

routingospfarea<OSPF_AREA>stub-network<IP_PREFIX>
<option>...........................................................................................755

Table1035

routingospfarea<OSPF_AREA>stub-network<IP_PREFIX>
advertise-always..............................................................................755

Table1036

routingospfarea<OSPF_AREA>stub-network<IP_PREFIX>
advertise-always<enabled-disabled>............................................. 756

Table1037

routingospfarea<OSPF_AREA>stub-network<IP_PREFIX>cost....
756

Table1038

routingospfarea<OSPF_AREA>stub-network<IP_PREFIX>cost
<cost>..............................................................................................756

Table1039

routingospfarea<backbone>.........................................................757

Table1040

routingospfarea<backbone><option>..........................................758

Table1041

routingospfarea<backbone>range...............................................758

Table1042

routingospfarea<backbone>range<IP_PREFIX>....................... 759

Table1043

routingospfarea<backbone>range<IP_PREFIX><option>........ 759

Table1044

routingospfarea<backbone>range<IP_PREFIX>restrict........... 759

Table1045

routingospfarea<backbone>range<IP_PREFIX>restrict<option>..
760

Table1046

routingospfarea<backbone>stub-network................................... 760

Table1047

routingospfarea<backbone>stub-network<IP_PREFIX>............761

Issue:03B

MulticontrollerRNCSCLICommands

Issue:03B

Table1048

routingospfarea<backbone>stub-network<IP_PREFIX><option>...
761

Table1049

routingospfarea<backbone>stub-network<IP_PREFIX>advertisealways..............................................................................................762

Table1050

routingospfarea<backbone>stub-network<IP_PREFIX>advertisealways<enabled-disabled>............................................................. 762

Table1051

routingospfarea<backbone>stub-network<IP_PREFIX>cost.... 763

Table1052

routingospfarea<backbone>stub-network<IP_PREFIX>cost
<cost>..............................................................................................763

Table1053

routingospfarea<backbone>virtual-link........................................763

Table1054

routingospfarea<backbone>virtual-link<IP_ADDR>...................765

Table1055

routingospfarea<backbone>virtual-link<IP_ADDR>transit-area......
766

Table1056

routingospfarea<backbone>virtual-link<IP_ADDR>transit-area
<OSPF_AREA>...............................................................................767

Table1057

routingospfarea<backbone>virtual-link<IP_ADDR>transit-area
<OSPF_AREA><option>................................................................768

Table1058

routingospfarea<backbone>virtual-link<IP_ADDR>transit-area
<OSPF_AREA>authtype................................................................ 768

Table1059

routingospfarea<backbone>virtual-link<IP_ADDR>transit-area
<OSPF_AREA>authtypemd5........................................................ 769

Table1060

routingospfarea<backbone>virtual-link<IP_ADDR>transit-area
<OSPF_AREA>authtypemd5key................................................. 770

Table1061

routingospfarea<backbone>virtual-link<IP_ADDR>transit-area
<OSPF_AREA>authtypemd5key<keyid>....................................770

Table1062

routingospfarea<backbone>virtual-link<IP_ADDR>transit-area
<OSPF_AREA>authtypemd5key<keyid>off............................... 771

Table1063

routingospfarea<backbone>virtual-link<IP_ADDR>transit-area
<OSPF_AREA>authtypemd5key<keyid>secret......................... 771

Table1064

routingospfarea<backbone>virtual-link<IP_ADDR>transit-area
<OSPF_AREA>authtypemd5key<keyid>secret<secret_type>. 772

Table1065

routingospfarea<backbone>virtual-link<IP_ADDR>transit-area
<OSPF_AREA>authtypenone....................................................... 772

Table1066

routingospfarea<backbone>virtual-link<IP_ADDR>transit-area
<OSPF_AREA>authtypesimple.....................................................772

Table1067

routingospfarea<backbone>virtual-link<IP_ADDR>transit-area
<OSPF_AREA>authtypesimple<passwd>................................... 773

Table1068

routingospfarea<backbone>virtual-link<IP_ADDR>transit-area
<OSPF_AREA>dead-interval......................................................... 773

Table1069

routingospfarea<backbone>virtual-link<IP_ADDR>transit-area
<OSPF_AREA>dead-interval<dead-interval>............................... 773

Table1070

routingospfarea<backbone>virtual-link<IP_ADDR>transit-area
<OSPF_AREA>hello-interval......................................................... 774

Table1071

routingospfarea<backbone>virtual-link<IP_ADDR>transit-area
<OSPF_AREA>hello-interval<hello-interval>................................774

Table1072

routingospfarea<backbone>virtual-link<IP_ADDR>transit-area
<OSPF_AREA>retransmit-interval................................................. 775

67

MulticontrollerRNCSCLICommands

68

Table1073

routingospfarea<backbone>virtual-link<IP_ADDR>transit-area
<OSPF_AREA>retransmit-interval<retransmit-interval>............... 775

Table1074

routingospfborder-routers.............................................................. 775

Table1075

routingospfconfig........................................................................... 776

Table1076

routingospfconfigall.......................................................................776

Table1077

routingospfdatabase...................................................................... 777

Table1078

routingospfdatabase<output_level>............................................. 778

Table1079

routingospfdatabasearea..............................................................778

Table1080

routingospfdatabasearea<area_ip_address>..............................778

Table1081

routingospfdatabasearea<area_ip_address><output_level>..... 779

Table1082

routingospfdatabaseareas............................................................ 779

Table1083

routingospfdatabaseareas<output_level>................................... 780

Table1084

routingospfdatabaseasbr-summary-lsa........................................ 780

Table1085

routingospfdatabaseasbr-summary-lsa<output_level>................780

Table1086

routingospfdatabasechecksum.....................................................781

Table1087

routingospfdatabasedatabase-summary...................................... 781

Table1088

routingospfdatabaseexternal-lsa.................................................. 781

Table1089

routingospfdatabaseexternal-lsa<output_level>..........................782

Table1090

routingospfdatabasenetwork-lsa...................................................782

Table1091

routingospfdatabasenetwork-lsa<output_level>.......................... 782

Table1092

routingospfdatabaserouter-lsa......................................................783

Table1093

routingospfdatabaserouter-lsa<output_level>............................. 783

Table1094

routingospfdatabasesummary-lsa................................................ 783

Table1095

routingospfdatabasesummary-lsa<output_level>........................784

Table1096

routingospfdatabasetype.............................................................. 784

Table1097

routingospfdatabasetype<type_val>............................................784

Table1098

routingospfdatabasetype<type_val><output_level>................... 785

Table1099

routingospfdefault-ase-cost........................................................... 785

Table1100

routingospfdefault-ase-cost<default-ase-cost>............................ 786

Table1101

routingospfdefault-ase-type........................................................... 786

Table1102

routingospfdefault-ase-type<default-ase-type>............................ 786

Table1103

routingospferrors........................................................................... 787

Table1104

routingospferrorsdd...................................................................... 787

Table1105

routingospferrorshello...................................................................788

Table1106

routingospferrorsip........................................................................788

Table1107

routingospferrorslsack.................................................................. 788

Table1108

routingospferrorslsr.......................................................................789

Table1109

routingospferrorslsu......................................................................789

Table1110

routingospferrorsprotocol..............................................................789

Table1111

routingospfevents.......................................................................... 790

Issue:03B

MulticontrollerRNCSCLICommands

Issue:03B

Table1112

routingospfinterface....................................................................... 790

Table1113

routingospfinterface<IFNAME>.................................................... 792

Table1114

routingospfinterface<IFNAME>area............................................ 793

Table1115

routingospfinterface<IFNAME>area<area>................................793

Table1116

routingospfinterface<IFNAME>area<area><option>.................794

Table1117

routingospfinterface<IFNAME>authtype..................................... 794

Table1118

routingospfinterface<IFNAME>authtypemd5............................. 795

Table1119

routingospfinterface<IFNAME>authtypemd5key.......................795

Table1120

routingospfinterface<IFNAME>authtypemd5key<keyid>......... 796

Table1121

routingospfinterface<IFNAME>authtypemd5key<keyid>off.... 796

Table1122

routingospfinterface<IFNAME>authtypemd5key<keyid>secret....
796

Table1123

routingospfinterface<IFNAME>authtypemd5key<keyid>secret
<secret>...........................................................................................797

Table1124

routingospfinterface<IFNAME>authtypenone............................ 797

Table1125

routingospfinterface<IFNAME>authtypesimple.......................... 797

Table1126

routingospfinterface<IFNAME>authtypesimple<passwd>.........798

Table1127

routingospfinterface<IFNAME>bfd-detect-mult........................... 798

Table1128

routingospfinterface<IFNAME>bfd-detect-mult<value>............. 798

Table1129

routingospfinterface<IFNAME>bfd-monitoring............................ 799

Table1130

routingospfinterface<IFNAME>bfd-monitoring<bfd-monitoring>......
800

Table1131

routingospfinterface<IFNAME>bfd-rx-interval............................. 801

Table1132

routingospfinterface<IFNAME>bfd-rx-interval<interval>............ 801

Table1133

routingospfinterface<IFNAME>bfd-tx-interval............................. 802

Table1134

routingospfinterface<IFNAME>bfd-tx-interval<interval>.............803

Table1135

routingospfinterface<IFNAME>cost.............................................804

Table1136

routingospfinterface<IFNAME>cost<cost>.................................804

Table1137

routingospfinterface<IFNAME>dead-interval.............................. 804

Table1138

routingospfinterface<IFNAME>dead-interval<dead-interval>.... 805

Table1139

routingospfinterface<IFNAME>fast-hello-interval........................805

Table1140

routingospfinterface<IFNAME>fast-hello-interval<fast-hellointerval>........................................................................................... 805

Table1141

routingospfinterface<IFNAME>hello-interval...............................806

Table1142

routingospfinterface<IFNAME>hello-interval<hello-interval>..... 806

Table1143

routingospfinterface<IFNAME>passive....................................... 806

Table1144

routingospfinterface<IFNAME>passive<option>........................ 807

Table1145

routingospfinterface<IFNAME>priority........................................ 807

Table1146

routingospfinterface<IFNAME>priority<priority>........................ 808

Table1147

routingospfinterface<IFNAME>retransmit-interval...................... 808

69

MulticontrollerRNCSCLICommands

70

Table1148

routingospfinterface<IFNAME>retransmit-interval<retransmitinterval>........................................................................................... 808

Table1149

routingospfinterface<interface_name>......................................... 809

Table1150

routingospfinterface<interface_name><detailed>....................... 809

Table1151

routingospfinterfaces..................................................................... 809

Table1152

routingospfinterfaces<detailed>................................................... 810

Table1153

routingospfneighbor.......................................................................810

Table1154

routingospfneighbor<neighbor_id>............................................... 811

Table1155

routingospfneighbor<neighbor_id><detailed>............................. 811

Table1156

routingospfneighbors..................................................................... 811

Table1157

routingospfneighbors<detailed>................................................... 812

Table1158

routingospfpackets........................................................................ 812

Table1159

routingospfrfc1583-compatibility....................................................812

Table1160

routingospfrfc1583-compatibility<option>.....................................813

Table1161

routingospfspf-delay...................................................................... 813

Table1162

routingospfspf-delay<spf_delay>..................................................813

Table1163

routingospfspf-holdtime................................................................. 814

Table1164

routingospfspf-holdtime<spf-holdtime>........................................ 814

Table1165

routingospfsummary...................................................................... 814

Table1166

routingospfthrottle..........................................................................815

Table1167

routingospfthrottlespf-delay.......................................................... 815

Table1168

routingospfthrottlespf-delay<spf_delay>......................................816

Table1169

routingospfthrottlespf-holdtime-max............................................. 816

Table1170

routingospfthrottlespf-holdtime-max<spf-holdtime-max>............ 816

Table1171

routingospfthrottlespf-holdtime-start............................................. 817

Table1172

routingospfthrottlespf-holdtime-start<spf-holdtime-start>............ 817

Table1173

routingprotocol-rank........................................................................817

Table1174

routingprotocol-rankconfig............................................................. 818

Table1175

routingprotocol-rankconfigall........................................................ 819

Table1176

routingprotocol-rankprotocol..........................................................819

Table1177

routingprotocol-rankprotocolospf.................................................. 820

Table1178

routingprotocol-rankprotocolospfrank.......................................... 820

Table1179

routingprotocol-rankprotocolospfrank<rank>..............................820

Table1180

routingprotocol-rankprotocolospfase............................................ 821

Table1181

routingprotocol-rankprotocolospfaserank.................................... 821

Table1182

routingprotocol-rankprotocolospfaserank<rank>........................ 821

Table1183

routingroute.................................................................................... 822

Table1184

routingroute<protocoltype>............................................................823

Table1185

routingrouteall................................................................................823

Table1186

routingrouteall<protocoltype>....................................................... 823

Issue:03B

MulticontrollerRNCSCLICommands

Issue:03B

Table1187

routingroutedestination.................................................................. 824

Table1188

routingroutedestination<destination_ip_address>........................824

Table1189

routingrouteexact...........................................................................824

Table1190

routingrouteexact<ipaddress_mask>........................................... 825

Table1191

routingrouteinactive....................................................................... 825

Table1192

routingrouteinactive<protocoltype>.............................................. 825

Table1193

routingrouteless-specific................................................................826

Table1194

routingrouteless-specific<ipaddress_mask>................................ 826

Table1195

routingroutemore-specific.............................................................. 826

Table1196

routingroutemore-specific<ipaddress_mask>...............................827

Table1197

routingroutesummary.....................................................................827

Table1198

routingrouter-id............................................................................... 827

Table1199

routingrouter-id<router-id>.............................................................828

Table1200

routingrouter-idall...........................................................................828

Table1201

routingstatic-route...........................................................................829

Table1202

routingstatic-route<Destination>....................................................830

Table1203

routingstatic-route<Destination>mtu.............................................832

Table1204

routingstatic-route<Destination>mtu<mtu>................................. 832

Table1205

routingstatic-route<Destination>nexthop......................................833

Table1206

routingstatic-route<Destination>nexthop<option>.......................834

Table1207

routingstatic-route<Destination>nexthopgateway....................... 834

Table1208

routingstatic-route<Destination>nexthopgatewayaddress..........836

Table1209

routingstatic-route<Destination>nexthopgatewayaddress
<IPADDR>....................................................................................... 837

Table1210

routingstatic-route<Destination>nexthopgatewayaddress
<IPADDR>bfd-detect-mult.............................................................. 838

Table1211

routingstatic-route<Destination>nexthopgatewayaddress
<IPADDR>bfd-detect-mult<detect-multiplier>............................... 839

Table1212

routingstatic-route<Destination>nexthopgatewayaddress
<IPADDR>bfd-detect-mult<detect-multiplier>on.......................... 839

Table1213

routingstatic-route<Destination>nexthopgatewayaddress
<IPADDR>bfd-monitoring............................................................... 840

Table1214

routingstatic-route<Destination>nexthopgatewayaddress
<IPADDR>bfd-monitoring<bfd-monitoring>................................... 840

Table1215

routingstatic-route<Destination>nexthopgatewayaddress
<IPADDR>bfd-monitoring<bfd-monitoring>on.............................. 841

Table1216

routingstatic-route<Destination>nexthopgatewayaddress
<IPADDR>bfd-rx-interval................................................................ 842

Table1217

routingstatic-route<Destination>nexthopgatewayaddress
<IPADDR>bfd-rx-interval<interval>............................................... 842

Table1218

routingstatic-route<Destination>nexthopgatewayaddress
<IPADDR>bfd-rx-interval<interval>on.......................................... 843

71

MulticontrollerRNCSCLICommands

72

Table1219

routingstatic-route<Destination>nexthopgatewayaddress
<IPADDR>bfd-tx-interval................................................................ 843

Table1220

routingstatic-route<Destination>nexthopgatewayaddress
<IPADDR>bfd-tx-interval<interval>............................................... 844

Table1221

routingstatic-route<Destination>nexthopgatewayaddress
<IPADDR>bfd-tx-interval<interval>on.......................................... 845

Table1222

routingstatic-route<Destination>nexthopgatewayaddress
<IPADDR>off.................................................................................. 845

Table1223

routingstatic-route<Destination>nexthopgatewayaddress
<IPADDR>on.................................................................................. 845

Table1224

routingstatic-route<Destination>nexthopgatewayaddress
<IPADDR>priority........................................................................... 846

Table1225

routingstatic-route<Destination>nexthopgatewayaddress
<IPADDR>priority<priority>........................................................... 846

Table1226

routingstatic-route<Destination>nexthopgatewayaddress
<IPADDR>priority<priority>on...................................................... 847

Table1227

routingstatic-route<Destination>off...............................................848

Table1228

routingstatic-route<Destination>rank............................................848

Table1229

routingstatic-route<Destination>rank<rank>............................... 848

Table1230

routingstatic-route<Destination>source........................................849

Table1231

routingstatic-route<Destination>source<source>........................849

Table1232

routingstatic-routeconfig................................................................ 849

Table1233

routingstatic-routeconfigall............................................................850

Table1234

routingtrace.....................................................................................850

Table1235

routingtraceglobal.......................................................................... 851

Table1236

routingtraceglobal<GLOBAL_TRACEOPTION>.......................... 852

Table1237

routingtraceglobal<GLOBAL_TRACEOPTION><option>........... 852

Table1238

routingtraceglobalconfig............................................................... 852

Table1239

routingtracekernel..........................................................................853

Table1240

routingtracekernel<KERNEL_TRACEOPTION>.......................... 854

Table1241

routingtracekernel<KERNEL_TRACEOPTION><option>........... 854

Table1242

routingtracekernelconfig............................................................... 854

Table1243

routingtraceospf.............................................................................855

Table1244

routingtraceospf<OSPF_TRACEOPTION>..................................856

Table1245

routingtraceospf<OSPF_TRACEOPTION><option>...................856

Table1246

routingtraceospfconfig.................................................................. 856

Table1247

routingtracefile................................................................................ 857

Table1248

routingtracefileconfig..................................................................... 857

Table1249

routingtracefilemaxnum................................................................. 858

Table1250

routingtracefilemaxnum<maxnum>.............................................. 858

Table1251

routingtracefilesize.........................................................................858

Table1252

routingtracefilesize<size>............................................................. 859

Issue:03B

MulticontrollerRNCSCLICommands

Issue:03B

Table1253

security............................................................................................ 859

Table1254

securitycert..................................................................................... 860

Table1255

securitycert<domain>.................................................................... 862

Table1256

securitycert<domain>ca-cert........................................................ 863

Table1257

securitycert<domain>ca-certall....................................................864

Table1258

securitycert<domain>ca-certca-id............................................... 865

Table1259

securitycert<domain>ca-certca-id<ca_id>..................................866

Table1260

securitycert<domain>ca-certcert-directory.................................. 866

Table1261

securitycert<domain>ca-certcert-directory<directory-name>..... 867

Table1262

securitycert<domain>ca-certcert-file........................................... 868

Table1263

securitycert<domain>ca-certcert-file<file-name>....................... 868

Table1264

securitycert<domain>ca-certintermediate................................... 869

Table1265

securitycert<domain>ca-certissuer-id..........................................870

Table1266

securitycert<domain>ca-certissuer-id<issuer-id-value>............. 871

Table1267

securitycert<domain>ca-certtrust-anchor.................................... 871

Table1268

securitycert<domain>cert-chain................................................... 873

Table1269

securitycert<domain>cert-chainee-cert....................................... 873

Table1270

securitycert<domain>cmp............................................................ 873

Table1271

securitycert<domain>cmp-request............................................... 874

Table1272

securitycert<domain>cmp-requestinitialize................................. 875

Table1273

securitycert<domain>cmp-requestkey-update............................ 876

Table1274

securitycert<domain>ee-candidate-key........................................876

Table1275

securitycert<domain>ee-candidate-keyauto-generate................ 877

Table1276

securitycert<domain>ee-candidate-keyfile.................................. 877

Table1277

securitycert<domain>ee-cert........................................................ 878

Table1278

securitycert<domain>ee-cert-profile............................................. 879

Table1279

securitycert<domain>ee-private-key............................................ 881

Table1280

securitycert<domain>validation-policy..........................................881

Table1281

securitycertby-serial-nr.................................................................. 882

Table1282

securitycertby-serial-nree-cert...................................................... 882

Table1283

securitycertby-serial-nree-certissuer-id....................................... 883

Table1284

securitycertby-serial-nree-certissuer-id<issuer-id-value>...........883

Table1285

securitycred.................................................................................... 883

Table1286

securitycredldap-and-cred............................................................. 885

Table1287

securitycredonly-cred.................................................................... 885

Table1288

securitycredonly-credcred-service-file-path..................................887

Table1289

securitycredonly-credpasswd-file................................................. 888

Table1290

securitycredonly-credpasswd-file<passwd_file_name>.............. 888

Table1291

securitycredonly-credpassword.................................................... 889

Table1292

signaling.......................................................................................... 890

73

MulticontrollerRNCSCLICommands

74

Table1293

signalingglobal-title-translation....................................................... 891

Table1294

signalingglobal-title-translationaction.............................................893

Table1295

signalingglobal-title-translationactionall........................................ 898

Table1296

signalingglobal-title-translationactionname...................................898

Table1297

signalingglobal-title-translationactionname<name>.................... 898

Table1298

signalingglobal-title-translationresult............................................. 899

Table1299

signalingglobal-title-translationresultall.........................................900

Table1300

signalingglobal-title-translationresultname................................... 900

Table1301

signalingglobal-title-translationresultname<name>..................... 901

Table1302

signalingglobal-title-translationrule................................................ 901

Table1303

signalingglobal-title-translationruleall............................................903

Table1304

signalingglobal-title-translationrulename...................................... 903

Table1305

signalingglobal-title-translationrulename<name>........................ 904

Table1306

signalingsccp.................................................................................. 904

Table1307

signalingsccpconcerned-point-code.............................................. 906

Table1308

signalingsccpconcerned-point-codeall..........................................907

Table1309

signalingsccpconcerned-point-codename.................................... 907

Table1310

signalingsccpconcerned-point-codename<name>...................... 908

Table1311

signalingsccpconcerned-subsystem..............................................908

Table1312

signalingsccpconcerned-subsystemall......................................... 909

Table1313

signalingsccpconcerned-subsystemname....................................910

Table1314

signalingsccpconcerned-subsystemname<name>......................910

Table1315

signalingsccpconnections.............................................................. 911

Table1316

signalingsccpdestination-point-code.............................................. 911

Table1317

signalingsccpdestination-point-codeall......................................... 912

Table1318

signalingsccpdestination-point-codename....................................912

Table1319

signalingsccpdestination-point-codename<name>..................... 913

Table1320

signalingsccpown-point-code........................................................ 913

Table1321

signalingsccpown-point-codeall....................................................914

Table1322

signalingsccpown-point-codename.............................................. 914

Table1323

signalingsccpown-point-codename<name>................................ 915

Table1324

signalingsccpsccp-timer-profile..................................................... 915

Table1325

signalingsccpsccp-timer-profileall.................................................918

Table1326

signalingsccpsccp-timer-profilefrom-template.............................. 918

Table1327

signalingsccpsccp-timer-profilefrom-template<template-name>. 919

Table1328

signalingsccpsccp-timer-profilefrom-template<template-name>
name................................................................................................919

Table1329

signalingsccpsccp-timer-profilefrom-template<template-name>
name<name>................................................................................. 920

Table1330

signalingsccpsccp-timer-profilename........................................... 921

Table1331

signalingsccpsccp-timer-profilename<name>............................. 922

Issue:03B

MulticontrollerRNCSCLICommands

Issue:03B

Table1332

signalingsccpssp-filter-timer.......................................................... 923

Table1333

signalingsccpssp-filter-timerstatus................................................924

Table1334

signalingsccpssp-filter-timerstatus<status>.................................924

Table1335

signalingsccpssp-filter-timervalue.................................................924

Table1336

signalingsccpssp-filter-timervalue<value>...................................925

Table1337

signalingsccpsubsystem................................................................925

Table1338

signalingsccpsubsystemall........................................................... 926

Table1339

signalingsccpsubsystemname......................................................927

Table1340

signalingsccpsubsystemname<name>........................................927

Table1341

signalingsctp-profile........................................................................927

Table1342

signalingsctp-profileall................................................................... 930

Table1343

signalingsctp-profilefrom-template.................................................931

Table1344

signalingsctp-profilefrom-template<template-name>................... 931

Table1345

signalingsctp-profilefrom-template<template-name>name......... 931

Table1346

signalingsctp-profilefrom-template<template-name>name<name>.
932

Table1347

signalingsctp-profilename..............................................................934

Table1348

signalingsctp-profilename<name>................................................935

Table1349

signalingservice-access-point.........................................................937

Table1350

signalingservice-access-pointall.................................................... 939

Table1351

signalingservice-access-pointname...............................................939

Table1352

signalingservice-access-pointname<name>................................ 939

Table1353

signalingss7....................................................................................940

Table1354

signalingss7as............................................................................... 941

Table1355

signalingss7asall.......................................................................... 942

Table1356

signalingss7association.................................................................942

Table1357

signalingss7associationall............................................................ 946

Table1358

signalingss7associationid............................................................. 946

Table1359

signalingss7associationid<id>..................................................... 946

Table1360

signalingss7local-as...................................................................... 946

Table1361

signalingss7local-asall..................................................................948

Table1362

signalingss7local-asname............................................................ 949

Table1363

signalingss7local-asname<name>.............................................. 949

Table1364

signalingss7remote-as...................................................................950

Table1365

signalingss7remote-asall.............................................................. 953

Table1366

signalingss7remote-asname.........................................................953

Table1367

signalingss7remote-asname<name>.......................................... 954

Table1368

snapshot.......................................................................................... 954

Table1369

snapshotcurrent-startup..................................................................957

Table1370

snapshotcurrentall-startup.............................................................. 958

75

MulticontrollerRNCSCLICommands

76

Table1371

snapshotlist.....................................................................................959

Table1372

snapshotlistall................................................................................. 960

Table1373

snapshotstartup.............................................................................. 960

Table1374

stats................................................................................................. 961

Table1375

statsdata......................................................................................... 972

Table1376

statsdatacurrent.............................................................................973

Table1377

statsdatacurrentall-objects............................................................974

Table1378

statsdatacurrentname...................................................................974

Table1379

statsdatacurrentname<name>.....................................................974

Table1380

statsdatacurrentobject-list-id.........................................................975

Table1381

statsdatacurrentobject-list-id<object-list-id>................................ 975

Table1382

statsdatareports.............................................................................975

Table1383

statsdatareportsid......................................................................... 976

Table1384

statsdatareportsid<id_value>...................................................... 976

Table1385

statsdatareportsname...................................................................977

Table1386

statsdatareportsname<name_value>.......................................... 977

Table1387

statsm-job....................................................................................... 978

Table1388

statsm-joball.................................................................................. 980

Table1389

statsm-jobid................................................................................... 981

Table1390

statsm-jobid<id>........................................................................... 981

Table1391

statsm-jobid<id>disabled.............................................................982

Table1392

statsm-jobid<id>enabled............................................................. 982

Table1393

statsm-jobid<id_value>.................................................................982

Table1394

statsm-jobname............................................................................. 983

Table1395

statsm-jobname<name>...............................................................983

Table1396

statsm-jobname<name>disabled................................................ 984

Table1397

statsm-jobname<name>enabled................................................. 984

Table1398

statsm-jobname<name_value>.................................................... 985

Table1399

statsm-period..................................................................................985

Table1400

statsm-periodid.............................................................................. 985

Table1401

statsm-periodid<id>...................................................................... 986

Table1402

statsm-periodname........................................................................986

Table1403

statsm-periodname<name>..........................................................986

Table1404

statsm-type..................................................................................... 987

Table1405

statsm-typeall................................................................................ 987

Table1406

statsm-typeid................................................................................. 988

Table1407

statsm-typeid<id>......................................................................... 988

Table1408

statsobj-list......................................................................................988

Table1409

statsobj-listall................................................................................. 989

Table1410

statsobj-listid..................................................................................990

Issue:03B

MulticontrollerRNCSCLICommands

Issue:03B

Table1411

statsobj-listid<id>..........................................................................990

Table1412

statsobj-listid<id_value>............................................................... 990

Table1413

statsobj-listname............................................................................991

Table1414

statsobj-listname<name>............................................................. 991

Table1415

statsobj-listname<name_value>...................................................991

Table1416

statsobj-listomes............................................................................992

Table1417

statsobj-listomes<omes>..............................................................992

Table1418

statst-job......................................................................................... 993

Table1419

statst-joball.................................................................................... 995

Table1420

statst-jobid..................................................................................... 995

Table1421

statst-jobid<id>............................................................................. 996

Table1422

statst-jobid<id>disabled...............................................................996

Table1423

statst-jobid<id>enabled............................................................... 997

Table1424

statst-jobid<id_value>...................................................................997

Table1425

statst-jobname............................................................................... 997

Table1426

statst-jobname<name>.................................................................998

Table1427

statst-jobname<name>disabled.................................................. 999

Table1428

statst-jobname<name>enabled................................................... 999

Table1429

statst-jobname<name_value>...................................................... 999

Table1430

statst-values................................................................................... 999

Table1431

statst-valuesid..............................................................................1000

Table1432

statst-valuesid<id>......................................................................1000

Table1433

statst-valuesname....................................................................... 1002

Table1434

statst-valuesname<name>......................................................... 1002

Table1435

sw-manage.................................................................................... 1003

Table1436

sw-manageactivate.......................................................................1005

Table1437

sw-manageactivatedelivery-label................................................ 1006

Table1438

sw-manageactivatedelivery-label<delivery-label>...................... 1006

Table1439

sw-manageactivatereconvert-running-config...............................1007

Table1440

sw-manageactivatereconvert-running-configno..........................1007

Table1441

sw-manageactivatereconvert-running-configyes........................ 1007

Table1442

sw-manageapp-sw-mgmt............................................................. 1008

Table1443

sw-manageapp-sw-mgmtactivate................................................1009

Table1444

sw-manageapp-sw-mgmtbuilds...................................................1010

Table1445

sw-manageapp-sw-mgmtchange-name...................................... 1010

Table1446

sw-manageapp-sw-mgmtchange-status...................................... 1011

Table1447

sw-manageapp-sw-mgmtdatabase..............................................1011

Table1448

sw-manageapp-sw-mgmtfb-build.................................................1011

Table1449

sw-manageapp-sw-mgmtfb-buildbuild-name..............................1012

Table1450

sw-manageapp-sw-mgmtfb-buildbuild-name<build-name>.......1012

77

MulticontrollerRNCSCLICommands

78

Table1451

sw-manageapp-sw-mgmtfb-buildoverwrite.................................1012

Table1452

sw-manageapp-sw-mgmtnormalize.............................................1013

Table1453

sw-manageauto-return................................................................. 1013

Table1454

sw-manageauto-returncriteria......................................................1014

Table1455

sw-manageauto-returnstate.........................................................1015

Table1456

sw-manageauto-returnstate<state>............................................1015

Table1457

sw-manageconfig-import.............................................................. 1016

Table1458

sw-managecurrent........................................................................1016

Table1459

sw-managecurrentall................................................................... 1017

Table1460

sw-managecurrentnode...............................................................1017

Table1461

sw-managecurrentnode<node-name>....................................... 1017

Table1462

sw-managedelivery.......................................................................1017

Table1463

sw-managedelivery<delivery-label>............................................ 1018

Table1464

sw-manageembedded-sw............................................................ 1019

Table1465

sw-manageembedded-swactivate............................................... 1020

Table1466

sw-manageembedded-swactivateall.......................................... 1021

Table1467

sw-manageembedded-swactivatefru-location............................ 1021

Table1468

sw-manageembedded-swactivatefru-location<fru-location>..... 1021

Table1469

sw-manageembedded-swactivatefru-location<fru-location><eswtype>..............................................................................................1021

Table1470

sw-manageembedded-swactivatenode...................................... 1022

Table1471

sw-manageembedded-swactivatenode<node-name>...............1022

Table1472

sw-manageembedded-swactivatenode<node-name><esw-type>...
1023

Table1473

sw-manageembedded-swrollback............................................... 1023

Table1474

sw-manageembedded-swrollbackall.......................................... 1023

Table1475

sw-manageembedded-swrollbackfru-location............................ 1024

Table1476

sw-manageembedded-swrollbackfru-location<fru-location>..... 1024

Table1477

sw-manageembedded-swrollbackfru-location<fru-location><eswtype>..............................................................................................1024

Table1478

sw-manageembedded-swrollbacknode...................................... 1025

Table1479

sw-manageembedded-swrollbacknode<node-name>...............1025

Table1480

sw-manageembedded-swrollbacknode<node-name><esw-type>...
1025

Table1481

sw-manageembedded-swstatus..................................................1026

Table1482

sw-manageembedded-swstatusall............................................. 1026

Table1483

sw-manageembedded-swstatusfru-location............................... 1027

Table1484

sw-manageembedded-swstatusfru-location<fru-location>........ 1027

Table1485

sw-manageembedded-swstatusnode.........................................1027

Table1486

sw-manageembedded-swstatusnode<node>............................1028

Table1487

sw-manageembedded-swupgrade.............................................. 1028

Issue:03B

MulticontrollerRNCSCLICommands

Issue:03B

Table1488

sw-manageembedded-swupgradeall..........................................1029

Table1489

sw-manageembedded-swupgradefru-location........................... 1030

Table1490

sw-manageembedded-swupgradefru-location<fru-location>.... 1030

Table1491

sw-manageembedded-swupgradefru-location<fru-location><eswtype>..............................................................................................1031

Table1492

sw-manageembedded-swupgradenode..................................... 1032

Table1493

sw-manageembedded-swupgradenode<node-name>..............1032

Table1494

sw-manageembedded-swupgradenode<node-name><esw-type>..
1033

Table1495

sw-manageembedded-swversion................................................1034

Table1496

sw-manageembedded-swversionall........................................... 1034

Table1497

sw-manageembedded-swversionfru-location............................. 1034

Table1498

sw-manageembedded-swversionfru-location<fru-location>...... 1035

Table1499

sw-manageembedded-swversionnode.......................................1035

Table1500

sw-manageembedded-swversionnode<node>..........................1035

Table1501

sw-manageinstall..........................................................................1036

Table1502

sw-manageinstalldelivery............................................................ 1036

Table1503

sw-manageinstalldelivery<delivery-name>.................................1037

Table1504

sw-manageinstallremote-delivery................................................ 1037

Table1505

sw-manageinstallremote-delivery<remote-delivery-name>........1038

Table1506

sw-managelist...............................................................................1038

Table1507

sw-managelistarch.......................................................................1039

Table1508

sw-managelistimgvar...................................................................1039

Table1509

sw-manageontop.......................................................................... 1039

Table1510

sw-manageontopinstall................................................................1040

Table1511

symptom-report............................................................................. 1041

Table1512

symptom-reportall.........................................................................1043

Table1513

symptom-reportgroup................................................................... 1043

Table1514

symptom-reportgroup<group>.....................................................1044

Table1515

symptom-reportname................................................................... 1044

Table1516

symptom-reportname<report-name>...........................................1045

Table1517

symptom-reportname<report-name>from.................................. 1049

Table1518

symptom-reportname<report-name>fromdate-time.................. 1050

Table1519

symptom-reportname<report-name>fromdate-time<from-datevalue>............................................................................................ 1050

Table1520

symptom-reportname<report-name>fromdate-time<from-datevalue>to........................................................................................ 1051

Table1521

symptom-reportname<report-name>fromdate-time<from-datevalue>todate-time........................................................................ 1052

Table1522

symptom-reportname<report-name>fromdate-time<from-datevalue>todate-time<to-date-value>..............................................1052

Table1523

symptom-reportname<report-name>to.......................................1053

79

MulticontrollerRNCSCLICommands

80

Table1524

symptom-reportname<report-name>todate-time.......................1054

Table1525

symptom-reportname<report-name>todate-time<to-date-value>....
1054

Table1526

symptom-reportplugin-list............................................................. 1055

Table1527

tools............................................................................................... 1055

Table1528

toolssystem-status........................................................................1056

Table1529

toolssystem-statusbrief................................................................1057

Table1530

toolssystem-statusbrieffru-location............................................. 1058

Table1531

toolssystem-statusbrieffru-location<fru-location>...................... 1059

Table1532

toolssystem-statusbrieflist.......................................................... 1059

Table1533

toolssystem-statusbrieflistfilter-by..............................................1060

Table1534

toolssystem-statusbrieflistfilter-byhw-state............................... 1061

Table1535

toolssystem-statusbrieflistfilter-byhw-state<hw-state>............ 1062

Table1536

toolssystem-statusbrieflistfilter-byhw-state<hw-state>sort-by........
1062

Table1537

toolssystem-statusbrieflistfilter-byhw-state<hw-state>sort-by
<sort-by>....................................................................................... 1063

Table1538

toolssystem-statusbrieflistfilter-bynode-state............................1063

Table1539

toolssystem-statusbrieflistfilter-bynode-state<node-state>..... 1064

Table1540

toolssystem-statusbrieflistfilter-bynode-state<node-state>sort-by.
1064

Table1541

toolssystem-statusbrieflistfilter-bynode-state<node-state>sort-by
<sort-by>....................................................................................... 1065

Table1542

toolssystem-statusbrieflistfilter-byru-state................................ 1065

Table1543

toolssystem-statusbrieflistfilter-byru-state<ru-state>............... 1065

Table1544

toolssystem-statusbrieflistfilter-byru-state<ru-state>sort-by... 1066

Table1545

toolssystem-statusbrieflistfilter-byru-state<ru-state>sort-by<sortby>.................................................................................................1066

Table1546

toolssystem-statusbrieflistsort-by.............................................. 1067

Table1547

toolssystem-statusbrieflistsort-by<srt-by>................................ 1067

Table1548

toolssystem-statusbrieflistsort-by<srt-by>filter-by................... 1068

Table1549

toolssystem-statusbrieflistsort-by<srt-by>filter-by<filter-by>.. 1068

Table1550

toolssystem-statusbrieflistsort-by<srt-by>filter-by<filter-by><filtrvalue>............................................................................................ 1069

Table1551

toolssystem-statusbriefnode.......................................................1069

Table1552

toolssystem-statusbriefnode<node>..........................................1069

Table1553

toolssystem-statusdetailed.......................................................... 1070

Table1554

toolssystem-statusdetailedfru-location....................................... 1071

Table1555

toolssystem-statusdetailedfru-location<fru-location>................ 1071

Table1556

toolssystem-statusdetailedlist.....................................................1072

Table1557

toolssystem-statusdetailednode................................................. 1073

Table1558

toolssystem-statusdetailednode<node>.................................... 1073

Issue:03B

MulticontrollerRNCSCLICommands

Issue:03B

Table1559

toolssystem-time...........................................................................1074

Table1560

toolssystem-timecurrent.............................................................. 1075

Table1561

toolssystem-timedate...................................................................1076

Table1562

toolssystem-timedate<date>...................................................... 1076

Table1563

toolssystem-timedate<date>time...............................................1077

Table1564

toolssystem-timedate<date>time<time>...................................1077

Table1565

toolssystem-timetime...................................................................1077

Table1566

toolssystem-timetime<time>.......................................................1078

Table1567

toolssystem-timetime-zone..........................................................1078

Table1568

toolssystem-timetime-zone<time-zone>.....................................1079

Table1569

toolssystem-timetime-zone<time-zone-offset>........................... 1079

Table1570

tracing............................................................................................1080

Table1571

tracingbuffer..................................................................................1081

Table1572

tracingbuffer<buffer-name-value>............................................... 1082

Table1573

tracingbuffer<buffer-name-value>all-nodes................................1083

Table1574

tracingbuffer<buffer-name-value>all-nodessize........................ 1084

Table1575

tracingbuffer<buffer-name-value>all-nodessize<buffer-size>.. 1084

Table1576

tracingbuffer<buffer-name-value>all-nodessize<buffer-size-value>.
1085

Table1577

tracingbuffer<buffer-name-value>node...................................... 1085

Table1578

tracingbuffer<buffer-name-value>node<node-name-value>..... 1085

Table1579

tracingbuffer<buffer-name-value>node<node-name-value>size......
1086

Table1580

tracingbuffer<buffer-name-value>node<node-name-value>size
<buffer-size>..................................................................................1087

Table1581

tracingbuffer<buffer-name-value>node<node-name-value>size
<buffer-size-value>........................................................................ 1087

Table1582

tracingbuffer-to-dest..................................................................... 1087

Table1583

tracingbuffer-to-destall-nodes...................................................... 1088

Table1584

tracingbuffer-to-destall-nodesbuffer............................................1088

Table1585

tracingbuffer-to-destall-nodesbuffer<buffer-name-value>......... 1089

Table1586

tracingbuffer-to-destall-nodesbuffer<buffer-name-value>dest..1089

Table1587

tracingbuffer-to-destall-nodesbuffer<buffer-name-value>dest
<dest-name-value>........................................................................1090

Table1588

tracingbuffer-to-destnode............................................................ 1090

Table1589

tracingbuffer-to-destnode<node-name-value>........................... 1091

Table1590

tracingbuffer-to-destnode<node-name-value>buffer................. 1091

Table1591

tracingbuffer-to-destnode<node-name-value>buffer<buffer-namevalue>............................................................................................ 1092

Table1592

tracingbuffer-to-destnode<node-name-value>buffer<buffer-namevalue>dest.................................................................................... 1092

81

MulticontrollerRNCSCLICommands

82

Table1593

tracingbuffer-to-destnode<node-name-value>buffer<buffer-namevalue>dest<dest-name-value>.................................................... 1093

Table1594

tracingconfig................................................................................. 1094

Table1595

tracingconfigbuffer....................................................................... 1095

Table1596

tracingconfigbuffer<buffer-name-value>.....................................1095

Table1597

tracingconfigbuffer<buffer-name-value>all-nodes..................... 1096

Table1598

tracingconfigbuffer<buffer-name-value>node............................1096

Table1599

tracingconfigbuffer<buffer-name-value>node<node-name-value>...
1096

Table1600

tracingconfigbuffer-list................................................................. 1097

Table1601

tracingconfigbuffer-listall-nodes.................................................. 1097

Table1602

tracingconfigbuffer-listnode........................................................ 1097

Table1603

tracingconfigbuffer-listnode<node-name-value>....................... 1098

Table1604

tracingconfigbuffer-to-dest........................................................... 1098

Table1605

tracingconfigbuffer-to-destall-nodes........................................... 1098

Table1606

tracingconfigbuffer-to-destnode.................................................. 1099

Table1607

tracingconfigbuffer-to-destnode<node-name-value>.................1099

Table1608

tracingconfigdest..........................................................................1100

Table1609

tracingconfigdest<dest-name-value>..........................................1100

Table1610

tracingconfigdest-list.................................................................... 1100

Table1611

tracingconfigfilter..........................................................................1100

Table1612

tracingconfigfilter<name-value>..................................................1101

Table1613

tracingconfigfilter-list.................................................................... 1101

Table1614

tracingconfigformat...................................................................... 1101

Table1615

tracingconfigformat<format-name-value>................................... 1102

Table1616

tracingconfigformat-list.................................................................1102

Table1617

tracingconfigsrc-context............................................................... 1102

Table1618

tracingconfigsrc-contextall-nodes............................................... 1103

Table1619

tracingconfigsrc-contextnode...................................................... 1103

Table1620

tracingconfigsrc-contextnode<node-name-value>.....................1104

Table1621

tracingconfigsrc-process.............................................................. 1104

Table1622

tracingconfigsrc-processall-nodes.............................................. 1104

Table1623

tracingconfigsrc-processnode..................................................... 1105

Table1624

tracingconfigsrc-processnode<node-name-value>....................1105

Table1625

tracingcrash-file............................................................................ 1105

Table1626

tracingcrash-fileall-nodes............................................................. 1106

Table1627

tracingcrash-fileall-nodesall-names............................................ 1107

Table1628

tracingcrash-fileall-nodesname................................................... 1107

Table1629

tracingcrash-fileall-nodesname<process-name-value>............. 1107

Table1630

tracingcrash-filedetails................................................................. 1108

Table1631

tracingcrash-filelist....................................................................... 1108

Issue:03B

MulticontrollerRNCSCLICommands

Issue:03B

Table1632

tracingcrash-filenode................................................................... 1109

Table1633

tracingcrash-filenode<node-name-value>.................................. 1109

Table1634

tracingcrash-filenode<node-name-value>all-names.................. 1110

Table1635

tracingcrash-filenode<node-name-value>name.........................1110

Table1636

tracingcrash-filenode<node-name-value>name<process-namevalue>.............................................................................................1111

Table1637

tracingdest.....................................................................................1111

Table1638

tracingdest<dest-name-value>.....................................................1112

Table1639

tracingdestname...........................................................................1112

Table1640

tracingdestname<dest-name-value>...........................................1112

Table1641

tracingdestname<dest-name-value>dest-type...........................1113

Table1642

tracingdestname<dest-name-value>dest-typecentral-console. 1114

Table1643

tracingdestname<dest-name-value>dest-typecentral-file......... 1114

Table1644

tracingdestname<dest-name-value>dest-typecentral-file<filename-value>.................................................................................. 1114

Table1645

tracingfilter.....................................................................................1115

Table1646

tracingfilter<name-value>.............................................................1115

Table1647

tracingfollow-central-console-dest.................................................1116

Table1648

tracingfollow-central-console-dest<dest-name-value>.................1116

Table1649

tracingformat................................................................................. 1116

Table1650

tracingformat<format-name-value>..............................................1117

Table1651

tracingsnapshot.............................................................................1117

Table1652

tracingsnapshotnode....................................................................1117

Table1653

tracingsnapshotnode<node-name-value>...................................1118

Table1654

tracingsnapshotnode<node-name-value>buffer........................ 1118

Table1655

tracingsnapshotnode<node-name-value>buffer<buffer-namevalue>............................................................................................ 1119

Table1656

tracingsnapshotnode<node-name-value>buffer<buffer-namevalue>dest.................................................................................... 1120

Table1657

tracingsnapshotnode<node-name-value>buffer<buffer-namevalue>dest<dest-name-value>.................................................... 1120

Table1658

tracingsrc-level..............................................................................1121

Table1659

tracingsrc-level<tracing-level-value>........................................... 1122

Table1660

tracingsrc-level<tracing-level-value>all-nodes............................1122

Table1661

tracingsrc-level<tracing-level-value>all-nodescontext............... 1123

Table1662

tracingsrc-level<tracing-level-value>all-nodescontext<contextname-value>.................................................................................. 1123

Table1663

tracingsrc-level<tracing-level-value>all-nodesprocess.............. 1123

Table1664

tracingsrc-level<tracing-level-value>all-nodesprocess<processname-value>.................................................................................. 1124

Table1665

tracingsrc-level<tracing-level-value>node.................................. 1124

Table1666

tracingsrc-level<tracing-level-value>node<node-name-value>. 1124

83

MulticontrollerRNCSCLICommands

84

Table1667

tracingsrc-level<tracing-level-value>node<node-name-value>
context........................................................................................... 1125

Table1668

tracingsrc-level<tracing-level-value>node<node-name-value>
context<context-name-value>...................................................... 1125

Table1669

tracingsrc-level<tracing-level-value>node<node-name-value>
process.......................................................................................... 1125

Table1670

tracingsrc-level<tracing-level-value>node<node-name-value>
process<process-name-value>.................................................... 1126

Table1671

tracingsrc-to-buffer........................................................................1126

Table1672

tracingsrc-to-buffer<buffer-name-value>..................................... 1127

Table1673

tracingsrc-to-buffer<buffer-name-value>all-nodes......................1128

Table1674

tracingsrc-to-buffer<buffer-name-value>all-nodescontext......... 1129

Table1675

tracingsrc-to-buffer<buffer-name-value>all-nodescontext<contextname-value>.................................................................................. 1130

Table1676

tracingsrc-to-buffer<buffer-name-value>all-nodesprocess........ 1130

Table1677

tracingsrc-to-buffer<buffer-name-value>all-nodesprocess<processname-value>.................................................................................. 1131

Table1678

tracingsrc-to-buffer<buffer-name-value>node............................ 1131

Table1679

tracingsrc-to-buffer<buffer-name-value>node<node-name-value>...
1132

Table1680

tracingsrc-to-buffer<buffer-name-value>node<node-name-value>
context........................................................................................... 1133

Table1681

tracingsrc-to-buffer<buffer-name-value>node<node-name-value>
context<context-name-value>...................................................... 1133

Table1682

tracingsrc-to-buffer<buffer-name-value>node<node-name-value>
process.......................................................................................... 1134

Table1683

tracingsrc-to-buffer<buffer-name-value>node<node-name-value>
process<process-name-value>.................................................... 1134

Table1684

tracingsystem-config..................................................................... 1135

Table1685

tracingsystem-configalarm-on-load..............................................1137

Table1686

tracingsystem-configauto-generate............................................. 1138

Table1687

tracingsystem-configctm-cpu-limit............................................... 1138

Table1688

tracingsystem-configctm-cpu-limit<ctm-cpu-limit>...................... 1139

Table1689

tracingsystem-configntm-cpu-limit............................................... 1139

Table1690

tracingsystem-configntm-cpu-limit<ntm-cpu-limit>..................... 1140

Table1691

tracingsystem-configsnapshot-at-core-dump-mode.................... 1140

Table1692

tracingsystem-configsnapshot-at-core-dump-mode
<snapshotmode_value>................................................................ 1141

Table1693

tracingsystem-configtrace-reader-idle-time................................. 1141

Table1694

tracingsystem-configtrace-reader-idle-time<idle_time>.............. 1141

Table1695

tracingtrace-file............................................................................. 1142

Table1696

tracingtrace-fileall.........................................................................1143

Table1697

tracingtrace-filename................................................................... 1143

Table1698

tracingtrace-filename<trace-name-value>.................................. 1144

Issue:03B

MulticontrollerRNCSCLICommands

Issue:03B

Table1699

transaction..................................................................................... 1144

Table1700

troubleshooting.............................................................................. 1146

Table1701

troubleshootingapp-log................................................................. 1147

Table1702

troubleshootingapp-logall.............................................................1149

Table1703

troubleshootingapp-logno-debug................................................. 1149

Table1704

troubleshootingapp-logrule.......................................................... 1150

Table1705

troubleshootingapp-logrulerule-id............................................... 1152

Table1706

troubleshootingapp-logrulerule-id<rule-id>................................ 1152

Table1707

troubleshootingapp-logrulerule-id<rule-id>drop........................ 1153

Table1708

troubleshootingapp-logrulerule-id<rule-id>keep....................... 1154

Table1709

troubleshootingapp-logse............................................................ 1155

Table1710

troubleshootingblackbox............................................................... 1156

Table1711

troubleshootingblackboxlist..........................................................1156

Table1712

troubleshootingcac........................................................................1157

Table1713

troubleshootingcacip.................................................................... 1157

Table1714

troubleshootingcacipbr.................................................................1157

Table1715

troubleshootingcacipro.................................................................1158

Table1716

troubleshootingcacleg.................................................................. 1158

Table1717

troubleshootingcacowner-id......................................................... 1159

Table1718

troubleshootingcall........................................................................ 1159

Table1719

troubleshootingcallcall-list............................................................ 1160

Table1720

troubleshootingcallcleared-hanging-resource.............................. 1160

Table1721

troubleshootingcallowner-id......................................................... 1160

Table1722

troubleshootingcallowner-idallocated..........................................1161

Table1723

troubleshootingcallowner-idchange-history................................ 1161

Table1724

troubleshootingcentralized-monitoring.......................................... 1161

Table1725

troubleshootingcentralized-monitoringadministration.................. 1163

Table1726

troubleshootingcentralized-monitoringadministrationinfo............1164

Table1727

troubleshootingcentralized-monitoringall..................................... 1164

Table1728

troubleshootingcentralized-monitoringbuffer................................1165

Table1729

troubleshootingcentralized-monitoringfilter.................................. 1166

Table1730

troubleshootingcentralized-monitoringfilter-condition.................. 1167

Table1731

troubleshootingcentralized-monitoringinformation....................... 1168

Table1732

troubleshootingcentralized-monitoringlinux................................. 1168

Table1733

troubleshootingcentralized-monitoringmonitored-message......... 1169

Table1734

troubleshootingcentralized-monitoringse..................................... 1170

Table1735

troubleshootingcentralized-monitoringtp-filter.............................. 1171

Table1736

troubleshootingcentralized-monitoringtrigger...............................1171

Table1737

troubleshootingcentralized-monitoringtrigger-condition............... 1173

Table1738

troubleshootingcentralized-monitoringup-filter............................. 1173

85

MulticontrollerRNCSCLICommands

86

Table1739

troubleshootingcore-reallocate..................................................... 1174

Table1740

troubleshootingcore-reallocatehistory.......................................... 1174

Table1741

troubleshootingerror-code.............................................................1174

Table1742

troubleshootingerror-code<error-code>....................................... 1175

Table1743

troubleshootingevent-subscriptions.............................................. 1175

Table1744

troubleshootinggtp........................................................................ 1176

Table1745

troubleshootinggtpcounters......................................................... 1176

Table1746

troubleshootinggtpcountersip......................................................1177

Table1747

troubleshootinggtpcounterstunnel...............................................1177

Table1748

troubleshootinggtpglo.................................................................. 1177

Table1749

troubleshootinggtptunnel............................................................. 1178

Table1750

troubleshootinggtptunnelall......................................................... 1178

Table1751

troubleshootinggtptunnelrange................................................... 1178

Table1752

troubleshootingmegamon............................................................. 1179

Table1753

troubleshootingsccp-user..............................................................1179

Table1754

troubleshootingsccp-userclear-counter........................................1180

Table1755

troubleshootingsccp-usercounter-info..........................................1181

Table1756

troubleshootingsccp-userremote-pc-status-history...................... 1181

Table1757

troubleshootingsccp-userremote-pc-status-historyall................. 1181

Table1758

troubleshootingsccp-userremote-pc-status-historyremote-pc.....1182

Table1759

troubleshootingsccp-userremote-pc-status-historyremote-pc
<remote-pc>.................................................................................. 1182

Table1760

troubleshootingsccp-usersag-long-time-res.................................1182

Table1761

troubleshootingsccp-usersor-hand-info....................................... 1183

Table1762

troubleshootingsccp-usersor-long-time-res................................. 1183

Table1763

troubleshootingsigiub.................................................................... 1183

Table1764

troubleshootingsigiublink............................................................. 1184

Table1765

troubleshootingsigiublinkall......................................................... 1185

Table1766

troubleshootingsigiublinkcscp-index........................................... 1185

Table1767

troubleshootingsigiublinkcscp-index<cscp-index>..................... 1186

Table1768

troubleshootingsigiublinkgroup-id............................................... 1186

Table1769

troubleshootingsigiublinkgroup-id<group-id>.............................1186

Table1770

troubleshootingsigiublinknot-connected......................................1187

Table1771

troubleshootingsigiublinkqniub-index.......................................... 1187

Table1772

troubleshootingsigiublinkqniub-index<qniub-index>.................. 1187

Table1773

troubleshootingsigiublinkremote-ip............................................. 1188

Table1774

troubleshootingsigiublinkremote-ip<remote-ip>......................... 1188

Table1775

troubleshootingsigiubload............................................................ 1188

Table1776

troubleshootingsigiubloadcscp....................................................1189

Table1777

troubleshootingsigiubloadgroup.................................................. 1189

Issue:03B

MulticontrollerRNCSCLICommands

Issue:03B

Table1778

troubleshootingsigiubloadgroupall............................................. 1190

Table1779

troubleshootingsigiubloadgroupgroup-id....................................1190

Table1780

troubleshootingsigiubloadgroupgroup-id<group-id>................. 1190

Table1781

troubleshootingsigiubloadqniub.................................................. 1190

Table1782

troubleshootingupm...................................................................... 1191

Table1783

troubleshootingupmconfig............................................................1192

Table1784

troubleshootingupmconfigserv-counters..................................... 1192

Table1785

troubleshootingupmconfigserv-desc........................................... 1193

Table1786

troubleshootingupmconfigunit-capacity...................................... 1193

Table1787

troubleshootingupmstatus............................................................1194

Table1788

troubleshootingupmstatuscellhome............................................ 1195

Table1789

troubleshootingupmstatuscounter...............................................1196

Table1790

troubleshootingupmstatusload.................................................... 1196

Table1791

troubleshootingupmstatusservice............................................... 1197

Table1792

troubleshootingupmstatusservicecell-id..................................... 1197

Table1793

troubleshootingupmstatusservicecell-id<cell-id>...................... 1198

Table1794

troubleshootingupmstatusserviceowner-id................................ 1198

Table1795

troubleshootingupmstatusserviceowner-id<owner_id>.............1198

Table1796

troubleshootingupmstatusserviceservice-id............................... 1199

Table1797

troubleshootingupmstatusserviceservice-id<service-id>.......... 1199

Table1798

troubleshootingupmstatusserviceservice-type........................... 1199

Table1799

troubleshootingupmstatusserviceservice-type<service-type>.. 1200

Table1800

troubleshootingupmstatusserviceunit........................................ 1200

Table1801

troubleshootingupmstatusserviceunit<unit>............................. 1200

Table1802

troubleshootingupmstatusstatistics.............................................1201

Table1803

troubleshootingupmstatusstatisticsserv-number....................... 1201

Table1804

troubleshootingupmstatusstatisticsserv-numbercentral............1201

Table1805

troubleshootingupmstatusstatisticsserv-numberdistributed......1203

Table1806

troubleshootingupmstatusstatisticsserv-usage..........................1205

Table1807

troubleshootingupmstatusstatisticsserv-usagecentral.............. 1205

Table1808

troubleshootingupmstatusstatisticsserv-usagedistributed........ 1205

Table1809

troubleshootingz-commands........................................................ 1206

Table1810

troubleshootingz-commandssyslog............................................. 1207

Table1811

troubleshootingz-commandstcpdump..........................................1207

Table1812

troubleshootingz-commandstcpdumpoptions............................. 1208

Table1813

troubleshootingz-commandstop.................................................. 1208

Table1814

troubleshootingz-commandszassoc............................................ 1209

Table1815

troubleshootingz-commandszbfd.................................................1209

Table1816

troubleshootingz-commandszbts.................................................1209

Table1817

troubleshootingz-commandszdbindex......................................... 1210

87

MulticontrollerRNCSCLICommands

88

Table1818

troubleshootingz-commandszdoi.................................................1210

Table1819

troubleshootingz-commandszfish................................................ 1210

Table1820

troubleshootingz-commandszifo.................................................. 1211

Table1821

troubleshootingz-commandszjane............................................... 1211

Table1822

troubleshootingz-commandszjaneza.......................................... 1212

Table1823

troubleshootingz-commandszjanezcp........................................ 1212

Table1824

troubleshootingz-commandszjanezcpport-name.......................1213

Table1825

troubleshootingz-commandszjanezcpport-number....................1213

Table1826

troubleshootingz-commandszjanezcpb...................................... 1214

Table1827

troubleshootingz-commandszjanezcpbactivate-monitoring-bitpattern........................................................................................... 1215

Table1828

troubleshootingz-commandszjanezcpbactivate-monitoring-bitmask.
1216

Table1829

troubleshootingz-commandszjanezcpbactivate-monitoringconnection-id................................................................................. 1216

Table1830

troubleshootingz-commandszjanezcpbactivate-monitoring-douplevlan-id............................................................................................ 1217

Table1831

troubleshootingz-commandszjanezcpbactivate-monitoring-dst-macaddr............................................................................................... 1218

Table1832

troubleshootingz-commandszjanezcpbactivate-monitoring-src-macaddr............................................................................................... 1218

Table1833

troubleshootingz-commandszjanezcpbactivate-monitoring-type.......
1219

Table1834

troubleshootingz-commandszjanezcpbactivate-monitoring-udf-offset
........................................................................................................1219

Table1835

troubleshootingz-commandszjanezcpbactivate-monitoring-udf2offset.............................................................................................. 1220

Table1836

troubleshootingz-commandszjanezcpbactivate-monitoring-vlan-id...
1220

Table1837

troubleshootingz-commandszjanezf........................................... 1221

Table1838

troubleshootingz-commandszjanezfport-name..........................1221

Table1839

troubleshootingz-commandszjanezfport-number...................... 1222

Table1840

troubleshootingz-commandszjanezi........................................... 1222

Table1841

troubleshootingz-commandszjaneziport-name..........................1223

Table1842

troubleshootingz-commandszjaneziport-number.......................1223

Table1843

troubleshootingz-commandszjanezlai........................................ 1224

Table1844

troubleshootingz-commandszjanezm......................................... 1224

Table1845

troubleshootingz-commandszjanezmac..................................... 1224

Table1846

troubleshootingz-commandszjanezmap..................................... 1225

Table1847

troubleshootingz-commandszjanezr...........................................1225

Table1848

troubleshootingz-commandszjanezreg.......................................1225

Table1849

troubleshootingz-commandszjanezrm........................................1226

Table1850

troubleshootingz-commandszjanezs.......................................... 1226

Issue:03B

MulticontrollerRNCSCLICommands

Issue:03B

Table1851

troubleshootingz-commandszjanezsport................................... 1227

Table1852

troubleshootingz-commandszjanezss........................................ 1227

Table1853

troubleshootingz-commandszjanezssclear-switch-port-counters......
1228

Table1854

troubleshootingz-commandszjanezssclear-switch-port-counters
port-name...................................................................................... 1228

Table1855

troubleshootingz-commandszjanezssclear-switch-port-counters
port-number................................................................................... 1229

Table1856

troubleshootingz-commandszjanezssshow-switch-port-counters.....
1229

Table1857

troubleshootingz-commandszjanezssshow-switch-port-counters
port-name...................................................................................... 1229

Table1858

troubleshootingz-commandszjanezssshow-switch-port-counters
port-number................................................................................... 1230

Table1859

troubleshootingz-commandszjanezt........................................... 1230

Table1860

troubleshootingz-commandszjanezu.......................................... 1231

Table1861

troubleshootingz-commandszmem..............................................1231

Table1862

troubleshootingz-commandszmon...............................................1231

Table1863

troubleshootingz-commandszmon<domain>..............................1232

Table1864

troubleshootingz-commandszmonall.......................................... 1232

Table1865

troubleshootingz-commandszrg.................................................. 1232

Table1866

troubleshootingz-commandszrole................................................1233

Table1867

troubleshootingz-commandsztail................................................. 1233

Table1868

upgrade-mode............................................................................... 1234

Table1869

upgrade-mode<upgrade-mode-off>............................................. 1234

Table1870

upgrade-mode<upgrade-mode-on>............................................. 1235

Table1871

upgrade-mode<upgrade-mode-on>lock-timeout......................... 1235

Table1872

upgrade-mode<upgrade-mode-on>lock-timeout<timeout>........ 1236

Table1873

upgrade-mode<upgrade-mode-touch>.........................................1236

Table1874

upgrade-modestatus.....................................................................1236

Table1875

user-management......................................................................... 1237

Table1876

user-managementcracklib............................................................ 1238

Table1877

user-managementcracklib<word-file>......................................... 1239

Table1878

user-managementgroup............................................................... 1239

Table1879

user-managementgroup<groupname>........................................1240

Table1880

user-managementgroup-from-permission.................................... 1242

Table1881

user-managementgroup-to-permission........................................ 1242

Table1882

user-managementpasswd............................................................ 1242

Table1883

user-managementpasswdchange-passwd.................................. 1244

Table1884

user-managementpasswdchange-passwdpasswd-file............... 1244

Table1885

user-managementpasswdchange-passwdpasswd-file<passwdfilename>....................................................................................... 1244

89

MulticontrollerRNCSCLICommands

90

Table1886

user-managementpasswdlock-account....................................... 1245

Table1887

user-managementpasswdset-root-aging-data.............................1245

Table1888

user-managementpasswdset-root-passwd..................................1246

Table1889

user-managementpasswdset-root-passwdpasswd-file...............1246

Table1890

user-managementpasswdset-root-passwdpasswd-file<passwd-file>
........................................................................................................1247

Table1891

user-managementpasswdset-user-aging-data............................ 1247

Table1892

user-managementpasswdset-user-passwd.................................1248

Table1893

user-managementpasswdset-user-passwdpasswd-file..............1248

Table1894

user-managementpasswdset-user-passwdpasswd-file<passwdfilename>....................................................................................... 1249

Table1895

user-managementpasswdshort-passwd-info...............................1249

Table1896

user-managementpasswdunlock-account................................... 1249

Table1897

user-managementpermission....................................................... 1250

Table1898

user-managementruim................................................................. 1250

Table1899

user-managementruimdisable..................................................... 1252

Table1900

user-managementruimenable......................................................1253

Table1901

user-managementruimnms-ldap-account....................................1253

Table1902

user-managementruimnms-ldap-config.......................................1254

Table1903

user-managementruimreplicator..................................................1258

Table1904

user-managementruimreplicatordelete.......................................1260

Table1905

user-managementruimreplicatordeleteallusers......................... 1261

Table1906

user-managementruimreplicatordeleteusers............................. 1261

Table1907

user-managementruimreplicatordeleteusers<username>........1261

Table1908

user-managementruimreplicatordisable..................................... 1262

Table1909

user-managementruimreplicatordisableallusers........................1262

Table1910

user-managementruimreplicatordisableusers........................... 1262

Table1911

user-managementruimreplicatordisableusers<username>...... 1263

Table1912

user-managementruimreplicatorinvalidate-users....................... 1263

Table1913

user-managementruimreplicatorlimited-mode............................ 1264

Table1914

user-managementruimreplicatornormal-mode........................... 1264

Table1915

user-managementruimreplicatorrefresh..................................... 1265

Table1916

user-managementruimreplicatorrefreshallusers........................ 1265

Table1917

user-managementruimreplicatorrefreshusers............................1265

Table1918

user-managementruimreplicatorrefreshusers<username>...... 1266

Table1919

user-managementruimreplicatorshutdown................................. 1266

Table1920

user-managementsudo.................................................................1266

Table1921

user-managementuser................................................................. 1267

Table1922

user-managementuser<username>............................................ 1269

Table1923

user-managementuser-from-group...............................................1273

Table1924

user-managementuser-to-group...................................................1274

Issue:03B

MulticontrollerRNCSCLICommands

Summaryofchanges

Summary of changes
Changesbetweendocumentissuesarecumulative.Therefore,thelatestdocument
issuecontainsallchangesmadetopreviousissues.

Changes between issues 03A (2014-11-24, RU50 and RU50 EP1) and
03B (2015-02-19, RU50 and RU50 EP1)

TheSCLIcommandshavebeenalignedwiththelatestSWbuildinSCLI
Commands.

Changes between issues 03 (2014-08-27, RU50 and RU50 EP1) and


03A (2014-11-24, RU50 and RU50 EP1)

Thesectiontroubleshootingmegamonhasbeenupdated.
AnewmegamonSCLIconfigurationschemeusedformegamonmessage
monitoringhasbeenintroduced.FromnowonbothSFP21andSFP22portscanbe
sharedwhereastheSFP20portisnotsupportedanymore.

RU50 EP1 compatibility

RU50EP1compatibilityhasbeenupdatedwithinformationonFlexiNG(GGSN).

Changes between issues 02B (2014-05-20, RU40) and 03 (2014-08-27,


RU50 and RU50 EP1)

Issue:03B

Introductiontothestructuredcommandlineinterface(SCLI)hasbeenupdated.
TheSCLIcommandshavebeenalignedwiththelatestSWbuildinSCLI
Commands.
Thecommandsubs-tracehasbeenremovedfromthemainlevelofthecommand
hierarchyandisnowavailableonlyundertheradio-networkmenu.

91

Introductiontothestructuredcommandlineinterface
(SCLI)

MulticontrollerRNCSCLICommands

1 Introduction to the structured command line


interface (SCLI)
1.1 Overview
TheMulticontrollerRNC(mcRNC)usesastructuredcommandlineinterface(SCLI)for
configuration,administration,andmonitoringtasks.TheSCLIshellofthemcRNC,
fsclish,isanextensionofthecommandlineinterfacethatmakesiteasiertofindand
browsecommands.WithSCLI,theusercanbrowseavailablecommandsinacommand
syntaxtreeview,usecommandautocompletion,andaccesscontextsensitivehelp.
ThisSCLIReferenceGuidedescribestheuseofthemcRNCfsclishSCLIshelland
liststheavailablecommands,parameters,andvalues.
Useraccountswithfsclishasadefaultshellareloggedintothatshellautomatically.
Foruseraccountsthatdonothavefsclishsetasaloginshell,entertheinteractive
modebyusingfsclishcommand.
TheMulticontrollerRNCprovidesthedefaultsystemaccount:
username:_nokadmin
password:system
ThisaccountallowsuserstoinvokeanySCLIcommand.Defaultshellfor_nokadminis
SCLIshell.
ItisrecommendedtocreateregularuseraccountaftertheMulticontrollerRNC
commissioningandintegrationphaseiscompleted.Formoreinformationonuser
management,seeManagingUsersinmcRNCandFlexiDirectRNC.

1.2 Basic usage


TousetheSCLItools,youmustlogintothecorrectnodewithauseraccountthathas
appropriatepermissionstoexecutecommands.Todisplaythelistoftoplevel
commands,pressthetabbutton.
Thegenericsyntaxofonecommandlineis:
<operation> <domain> <rest of command>

The<operation>isatoplevelcommand.Itdescribesthetypeofoperation(s)
performedbyaparticularsub-moduleofthesystem.Itisfollowedbythe<domain>
command,whichisactuallydefinedbySCLImodules.
TheSCLIcommandsarestoredasatreeofcommands.Thecommandtreecanbe
displayedbyexecutingthecommandcmdtree.Userscanfollowthecommandtree
branchesbywritingacommandandpressingthetabbutton.Thesystemwillnot
executethecommandline,butshowsallpossiblecontinuationsofthecommandline,
instead.Ifthereisonlyonepossiblecontinuationofthecommand,thecommandlinewill
beautocompletedandtheusercancontinueeditingfromthatpoint.

92

Issue:03B

MulticontrollerRNCSCLICommands

Introductiontothestructuredcommandlineinterface
(SCLI)

Exampleofpossibleparameters,shownbytypingadd signaling ss7andpressing


tabbutton:
_nokadmin@CFPU-0 [RNC-38] > add signaling ss7
[X] association - Adds a new M3UA association.
[X] local-as
- Adds a new signaling local AS.
[X] remote-as
- Adds a new signaling remote AS

ThesymbolofXinsquarebracketsmeansexecutable.Onlyoneoftheexecutable
parameterscanbeusedatatime.
_nokadmin@CFPU-0 [RNC-38] > add signaling ss7 association
[MX] communication-type
- communication type [sgasp, ipsp]
[MX] id
- association id [1..65535]
[MX] local-as-name
- local AS name
[MX] local-ip-addr
- local end point ip address [IPv4,IPv6]
[MX] node
- local end point node name
[MX] remote-as-name
- remote AS name
[MX] remote-ip-addr
- remote end point ip address
[MX] remote-port
- remote end point port [1025..65535]
[MX] role
- local end point role in association [server,
client]
[GX] local-client-port
- local end point client port [1025..65535]
[GX] local-server-port
- local end point server port [1025..65535]
[OX] exchange-mode
- exchange mode [double, single]
[OX] priority
- Path priority, 0 being the highest priority
[0..1]
[OX] sctp-profile
- sctp profile name
[OX] vrf-name
- VRF name to be configured for all multihomed
local IP addresses

Belowisthedescriptionofthesymbolsdisplayedafterpressingtab:

[X]-meansthatuserisauthorizedtousethecommandorparameter.
[ ]-meansthatuserisnotauthorizedtousethecommand.
[OX]-meansthatuserisauthorizedtousetheoptionalparameter.
[O]-meansuserisnotauthorizedtousetheoptionalparameter.
[GX]-meansuserisauthorizedtousetheone-ofparameter.
[MX]-meansuserisauthorizedtousethemandatoryparameter.

Allmandatoryparametersmustbeusedinthecommand.Mandatoryparametersare
requiredtobepresentinthecommandline.Ifamandatoryparameterhasadefault
value,thentheframeworktakescareofsupplyingthedefaultvalueifmandatory
parameterisnotenteredbyuser.
Optionalparameterswithdefaultvaluesaremeaninglessandthereforenotallowed.
ToexecutetheSCLIcommandwritethewholecommandwithallparametersinthe
commandlineandpressenter.Thecommandwillthenbeexecuted.Forexample:
_nokadmin@CFPU-0 [RNC-38] > show networking-service ntp

Sampleprinout:
_nokadmin@CFPU-0 [RNC-38] > show networking-service ntp
CFPU-0@RNC-38
[2013-09-12 08:24:28 +0200]
forwarder: 10.44.143.22

Issue:03B

93

Introductiontothestructuredcommandlineinterface
(SCLI)

MulticontrollerRNCSCLICommands

Whenyouwanttoquitlongtextoutput,forexampleafterexecutingthecommand
cmdtree,presstheqbutton.
TheexitstatusoftheSCLIcommandthatindicatesthesuccessorfailureofthe
executedcommandisstoredintheauditlogentry.

1.3 Configuration management with SCLI


Configuration locking feature
SCLIprovidesamechanismtoavoidtheparallelmodificationoftheconfiguration
directoryserverbymultipleusers.Toprotectagainsttheparallelchanges,youmust
acquireaconfigurationlockbeforeexecutingtheconfigurationalteringcommands.
Configurationlockpreventsparallelmodificationinallmanagementinterfaces.
Theconfigurationlockcanbeusedwiththefollowingcommand:
set config-mode

Configuration transaction
Transactionsareusedtospeedupthebulkoperations,suchasaddinghundredsof
VLANs.However,theoperationsindifferentsubdomainscanbebundledintoone
transaction,forexample,firstaddaninterfaceandthenassignanIPaddresstoit.The
speeduphappensasthenetworkelementcanbundlethenecessarychangesandtake
themintouseatoncewhenthetransactioniscommitted.Thetransactionsalsoprovides
operatorstheabilitytorollbackchangestotheconfiguration.

NOTICE:ConfigurationtransactionisonlysupportedforLDAPconfiguration.
Theconfigurationtransactioncanbeusedwiththecommandsofthe
transactiondomain.

Configuration snapshot
TheSCLIprovidesamechanismtocreateandsavethesnapshotsoftheactive
configurationdata,andsetitasthestartupconfiguration.Thechangestotheactive
configurationdataaretransientandarelostoncethesystemisrestarted.Tomakethese
configurationchangespersistent,youshouldsavetheconfigurationsnapshot.
Theconfigurationsnapshotcanbeusedwiththecommandsofthe
snapshotdomain.

1.4 SCLI command notation


TheSCLIcommandsdescribedinthisdocumentationfollowunifiednotation.Someof
therulesfordescribingSCLIcommandsare:

94

Longcommands,whichdonotfitinonerowofthepage,arebrokentonextrowwith
symbol\.
Optionalparameters,whichdonothavetobeusedeverytime,areenclosedin
squarebrackets[].

Issue:03B

MulticontrollerRNCSCLICommands

Introductiontothestructuredcommandlineinterface
(SCLI)

Thevaluesofparametersoranyothervariableareenclosedinanglebrackets<>.
Thesymbol|canbereadaslogicalXOR.
Thevaluesofparameters,havingoneormoreparameterasoptions,areenclosedin
{}.Forexample:
set routing [instance <name>] node <node-name> export\
<export-protocol> direct {all | interface-name <name>} on
Inthiscommand,theparameterdirecthastheparametersallandinterfacenameasoptions.

1.5 SCLI help


BasichelpforSCLIcanbedisplayedbyexecutingthehelpcommand.
Fordisplayinghelpforaparticularcommand,writethecommandandpressthequestion
markbutton?.Adescriptionofthecommandisthenshown.Forexample,todisplaythe
helptextfortheshow networking gretunnelcommand,typethecommandand
press?.
_nokadmin@CFPU-0 [RNC-38] > show omsconn
Command shows RNC parameterization for RNC-OMS O&M connectivity.

Fordisplayingthetreeofcommandswithfullsyntax,executethecommandhelp cmdtree.Youcanalsogetthecommandtreeforaspecificcommandbywritingthe
commandafterhelp cmd-tree.Forexample:
_nokadmin@CFPU-0 [RNC-38] > help cmd-tree show signaling ss7 association
CFPU-0@RNC-38
[2013-09-12 08:27:23 +0200]
show signaling ss7 association all
show signaling ss7 association id <id>

1.6 Top level SCLI commands


ThelistoftheSCLItoplevelcommandsisasfollows:
Table1

Issue:03B

ListoftoplevelSCLIcommands

Command

Information

add

Thisfamilyofcommandsallowsyouto:

addalarm-relateddata.

addaspecificentitytotheselectivebackupsession.

addconfigurationdata.

addanewdirectory.

adddifferenthwmodules.

adddifferentmanagedobject.

addIPSecconfiguration.

installthelicense(s)intothenetworkelement.

addlog.

addanetworkingobject.

95

Introductiontothestructuredcommandlineinterface
(SCLI)

Table1

Command

cmdtree

MulticontrollerRNCSCLICommands

ListoftoplevelSCLIcommands(Cont.)

Information

addthenetworkingservicedata.

additemstoRNWconfiguration.

addaspecificentitytotheselectiverestoresession.

addsecuritydata.

addanewsignalingobject.

addstatistics-relatedconfigurationitems.

addtracingconfigurationitems.

addtroubleshootingrelatedconfigurationdata.

adduser-managementdata.

Thiscommandisdeprecated.Usehelp cmd-treeinstead.

Thehelp cmd-treecommandallowsyoutoviewthesyntaxtreeofa
particularcommand.
commit

96

Thisfamilyofcommandsallowsyouto:

committhesessionforcreatingbackup.

committhesessionforrestoringthesystem.

commitupgradestate.

commitConfigurationDirectorytransaction.

copy

Thiscommandallowsyoutocopyfiles.

delete

Thisfamilyofcommandsallowsyouto:

deletealarmrelateddata.

deletethebackupobjects.

deleteconfigurationdata.

deletethegivendirectory.

deletethegivenfile.

removedifferenthwmodules.

removedifferentmanagedobjects.

deletetheIPsecconfiguration.

deletealicensefromthenetworkelement.

deleteanetworkingobject.

deletethenetworkingservicedata.

deleteitemsfromRNWconfiguration.

deletesecuritydata.

deleteanexistingsignalingobject.

deletethenamedconfiguration.

deletesstatistics-relatedconfigurationitems.

SubscriberTraceHandlingcommands

removeasoftwaredelivery

Issue:03B

MulticontrollerRNCSCLICommands

Table1

Command

Introductiontothestructuredcommandlineinterface
(SCLI)

ListoftoplevelSCLIcommands(Cont.)

Information

deletethesymptomreports.

deletetracingconfigurationitems.

deletetroubleshootingrelatedconfigurationdata.

deleteuser-managementdata.

exit

Thiscommandallowsyoutoexitonelevelupinthecommandtree.

help

Thiscommandshowstheshellhelp.

history

Thiscommandshowscommandhistory.

initialise

Thiscommandinitializesthestoragesaccordingtodirectoryconfiguration.

load

Thisfamilyofcommandsallowsyouto:
LoadSCLIenvironmentvariablesfromafile

Loadssessionvariablesfromafile

quit

ThiscommandallowsyoutoquitthisshellsessionandenterintoLinuxbash
shell.

refresh

Thisfamilyofcommandsrefreshes:

reset

restore

rollback

save

Issue:03B

SCLIcache.

statisticscache.

Thisfamilyofcommandsallowsyouto:

resettheSCLIenvironmentvariables.

resettheclusterwithdelay.

resettroubleshooting-relatedconfigurationdata.

Thisfamilyofcommandsallowsyouto:

restoresecuritydata.

overwritecurrentconfiguration.

Thisfamilyofcommandsallowsyouto:

terminateanexistingbackupSession.

terminateanexistingRestoreSession.

rollbackupgradestate.

rollbackConfigurationDirectorytransaction.

Thisfamilyofcommandscanbeusedto:

97

Introductiontothestructuredcommandlineinterface
(SCLI)

Table1

Command

set

98

MulticontrollerRNCSCLICommands

ListoftoplevelSCLIcommands(Cont.)

Information

savestructuredCLIshellsessiondata.

savethelicense(s)toadirectory.

savethenamedconfiguration.

savesoftwaremanagement-relatedconfigurationdata.

savethesymptomreport.

savecentral-fileorlocal-filesnapshottracing.

Thisfamilyofcommandsallowsyouto:

setalarmrelateddata.

setoptionalityandconfigurationparameters.

setthestructuredSCLIshellsessiondata.

setCMFstate.

setconfigurationdata.

acquireorreleasetheconfigurationlock.

computesha1sum.

sethardwarerelatedsettings.

performadministrativeoperationsofMOs.

setlicense-managementandfeature-managementconfigurationdata.

setloginformation.

setanetworkingobject.

modifiythenetworkingservicedata.

modifiyRNWconfiguration.

setroutingconfiguration.

setsecuritydata.

setasignalingobject.

managetheclusterconfigurations.

setadministrativestateofjobs.

SubscriberTraceHandlingcommands.

Softwaremanagementsetoperations.

setdatausingvarioussmalltools.

settracingconfigurationitemsandparameters.

settroubleshootingrelatedconfigurationdata.

setUpgradelockcommands.

setauserforanewloginshell.

setuser-managementdata.

shell

Thiscommandallowsyoutostartanexternalbashshellsession.

show

Thisfamilyofcommandsallowsyouto:

showalarm-relateddata.

Showoptionalityandconfigurationparameters

Issue:03B

MulticontrollerRNCSCLICommands

Table1

Command

start

stop

Issue:03B

Introductiontothestructuredcommandlineinterface
(SCLI)

ListoftoplevelSCLIcommands(Cont.)

Information

showCMFstatus.

showconfigurationdata.

showconfigurationlockstatus.

showfile-relatedinformation.

showhardwareinformation.

showstateandstatusattributesofMOsorlogicalgroups.

showIPsecconfiguration.

showlicense-managementandfeature-managementinformation.

showloginformation.

shownetworkingobjects.

showthenetworkingservicedata.

showRNWobjectsruntimeinformation.

showthecontentsofthebackuparchiveimage.

showroutingconfiguration.

showsecuritydata.

showsignalinggatewayconfiguration.

showconfigurationsnapshots.

showstatistics-relatedconfigurationanddata.

SubscriberTraceHandlingcommands

showsoftwaredeliveries.

showthesymptomreport-relateddata.

showdatausingvarioussmalltools.

showtracingconfigurationitems.

showtroubleshootingrelatedinformation.

ShowUpgrademodestatus.

showuser-managementdata

Thisfamilyofcommandsallowsyouto:

startthesessionforbackup.

startcliactions.

starthardwarerelatedoperations.

startMOrelatedoperations.

startnetworkingrelatedoperations.

startRNWconfigurationrelatedoperations.

startthesessionforrestore.

startsecurity-relatedcommands.

startthesignalingdiagnostics.

StartConfigurationDirectorytransaction.

starttroubleshooting-relatedconfiguration.

Thisfamilyofcommandsallowsyouto:

99

Introductiontothestructuredcommandlineinterface
(SCLI)

Table1

Command

unset

MulticontrollerRNCSCLICommands

ListoftoplevelSCLIcommands(Cont.)

Information

stophardware-relatedoperations.

stopMOrelatedoperations.

stopthesignalingdiagnostics.

stoptroubleshooting-relatedconfiguration.

Thiscommandunsetsanenvironmentorsessionvariable.

1.7 fsclish
ThedefaultuseraccountofthemcRNC(_nokadmin)logsintothefsclishinteractive
modeautomatically.
Thefollowinginformationaboutfsclishdescribesasituationwheretheuseduser
accountdoesnotlogintofsclishinteractivemodeautomatically.
Loginwithauseraccountthatdoesnothavefsclishsetasaloginshell.Then,enter
theinteractivemodebyusingthefollowingcommand:
fsclish
Theinteractivemodeprovidesbasiccommandlineeditingfunctionalitiesandaccessto
variouscommandsimplementedbothaspartoftheframeworkandbySCLIframework
users.
Byexecutinghelpinthefsclishcommandlinethebasichelptextisdisplayed.Note
thatthehelpcommandisavailableundereveryrelativeroot.Commandexecutioncan
begracefullystoppedbypressingCtrl-CandforcefullykilledbypressingCtrl-C-Ctrl-Z.
Youcanalsostartfsclishinanon-interactivemode.Thismodeiseitherthesingle
commandmodeorbatchmode.
Singlecommandmodeallowsexecutingthefsclishprocesswiththepurposeof
runningonecommandinthecommandline,forexampel:
fsclish c single command
Inthesinglecommandmode,theshellstartsupandexecutesonecommandgivenasa
commandlineargument.Thereturncodeoftheshellisthereturncodeofthelast
executedactionoraninternalerrorcodeifactionexecutionfailedforsomereason.Error
canbeaninternalSCLIerror(forexample,theshellcouldnotreachtheSCLIserver),or
anerrorwhileevaluatingthecommandline(forexample,intermediateactionwhile
retrievingallowedvaluesforsometokenhastimedout).
EachcommandisexecutedinaseparateSCLIsession.Thepersistentsessionfeature
helpstoexecutemultiplesinglecommandsinthesameSCLIsession.Theusageof
persistentsessionscanbeenabledbyusingthefollowingcommand:
fsclish p <session-id> c single command

100

Issue:03B

MulticontrollerRNCSCLICommands

Introductiontothestructuredcommandlineinterface
(SCLI)

Wheresession-idisanameidentifyingthepersistentsession.Thisisanoptionalvalue,
ifnotspecifiedthenadefaultsession-idisused.Thesession-idvalueisusefuliftheuser
wantstostartmultiplepersistentsessions.
Bydefault,anunusedpersistentsessionwillexpireafter1hourofidletime.Thedefault
idlesessiontimeoutvaluecanbereplacedwiththeoption--persistent-sessiontimeoutwhenthesessionisfirstcreated.
Persistentsessionsimprovetheperformanceandareusefulwhenexecutingagroupof
commands,wherethestateofprecedingcommandsaffectthefollowingcommands.You
candeletethepersistentsessionbygiving-roptiontofsclish.
fsclish r <session-id>
Wheresession-idisastringidentifyingthesessiontoberemoved.Thisisanoptional
value,ifitisnotspecifiedthenthedefaultsessionisremoved.Thismeansthatthe
defaultsessionnameisusedandifsuchavsessionexists,itisremoved.Internalerror
codeistranslatedbyfsclishintoanerrormessageandisprintedintotheerror
stream.Internalerrorcodesoffsclishstartfrom150.
Inbatchmode,theshellstartsupandexecutescommandsfromabatchfileonebyone.
Avalidcommandshouldbelimitedtooneline;commandsspreadacrossmultiplelines
inthefilearenotsupported.Batchfilemayhavecommentsstartingfrom#atanypoint
intheline.
Incaseofanyerror,eveninon-failure -> continuemode,fsclishreturnsthe
non-zeroreturncodeofthefirstfailedaction.Inboththebatchandthesinglecommand
modes,currentlyexecutedcommandcanbeinterruptedwithCtrl-C(graceful
interruption)andCtrl-C-Ctrl-Z(forcedinterruption).Inbatchmode,thebatchfile
processingisstoppedandfsclishexits,evenifon-failurepropertyissettocontinue.

Issue:03B

101

SCLICommands

MulticontrollerRNCSCLICommands

2 SCLI Commands
2.1 alarm
Table2

alarm

Description
add
Thiscommandaddsalarmrelateddata.
delete
Thiscommanddeletesthealarmrelateddata.
set
Thiscommandmanagesalarmrelateddata.
show
Thiscommandshowsalarmrelateddata.
Parameter

Hint

Command

Range

Default

Dependency
None

add alarm blocking-rule {from-specific-problem <FROM-SPECIFICPROBLEM> to-specific-problem <TO-SPECIFIC-PROBLEM> [managedobject-id <MOID>]?}


None
add alarm type from-directory {dir-path <DIR-PATH>}
None
add alarm type from-file {file-path <FILE-PATH>}
None
delete alarm blocking-rule {rule-id <RULE-ID>}
None
set alarm acknowledge {alarm-id <ALARM-ID>}
None
set alarm blocking-rule activate {rule-id <RULE-ID>}

102

Issue:03B

MulticontrollerRNCSCLICommands

Table2

SCLICommands

alarm(Cont.)
None

set alarm blocking-rule deactivate {rule-id <RULE-ID>}


None
set alarm clear {alarm-id <ALARM-ID> [forced <FORCED>]?}
None
set alarm clear-matching-alarms {[forced <FORCED>]?} filter-by
{[specific-problem <SPECIFIC-PROBLEM>]? [managed-object
<MANAGED-OBJECT>]? [managed-object-full-name <MANAGED-OBJECTFULL-NAME>]? [identifying-application-additional-info
<IDENTIFYING-APPLICATION-ADDITIONAL-INFO>]? [application-id
<APPLICATION-ID>]? [severity <SEVERITY>]?}
None
set alarm raise {specific-problem <SPECIFIC-PROBLEM>
application-id <APPLICATION-ID> {managed-object <MANAGEDOBJECT> managed-object-full-name <MANAGED-OBJECT-FULL-NAME>}+
[identifying-application-additional-info <IDENTIFYINGAPPLICATION-ADDITIONAL-INFO>]? [event-time <EVENT-TIME>]?
[severity <SEVERITY>]? [application-additional-info
<APPLICATION-ADDITIONAL-INFO>]?}

2.1.1 alarm acknowledge


Table3

alarmacknowledge

Description
Thiscommandacknowledgesthespecifiedalarm.
Parameter

Hint

Range

Default

Theparameter"alarm-id"specifiesthealarmIDtobe
acknowledged.

alarmidentifier

NA

alarm-id

Note:Comma-separatedvaluesareallowedforthevalueof
theparameter"alarm-id".Forexample:5,6,7,andsoon.
Command

Dependency
None

set alarm acknowledge {alarm-id <ALARM-ID>}

2.1.2 alarm active


Table4

alarmactive

Description

Issue:03B

103

SCLICommands

Table4

MulticontrollerRNCSCLICommands

alarmactive(Cont.)

Thiscommandshowsalltheactivealarmsinthealarmsystem.
Parameter

Hint

Range

Default

Theparameter"from-index"specifiesthestartingindexof
theactivealarmstobefetchedfromthealarmsystem.

startindexofactive
alarms

NA

from-index

Theparameter"how-many"specifiesthenumberofactive
alarmsinthealarmsystemtobeshown.

numberofactive
alarmstobeshown

NA

how-many
Command

Dependency
None

show alarm active {[from-index <STARTING-INDEX-FOR-FETCHINGRECORDS>]? [how-many <HOW-MANY-RECORDS-SHOULD-BE-FETCHED>]?}


None
show alarm active {[from-index <STARTING-INDEX-FOR-FETCHINGRECORDS>]? [how-many <HOW-MANY-RECORDS-SHOULD-BE-FETCHED>]?}
application-ids {[from-index <STARTING-INDEX-FOR-FETCHINGRECORDS>]? [how-many <HOW-MANY-RECORDS-SHOULD-BE-FETCHED>]?}
None
show alarm active {[from-index <STARTING-INDEX-FOR-FETCHINGRECORDS>]? [how-many <HOW-MANY-RECORDS-SHOULD-BE-FETCHED>]?}
filter-by {[alarm-id <ALARM-ID>]? [specific-problem
<SPECIFIC_PROBLEM>]? [managed-object <MANAGED-OBJECT>]?
[managed-object-full-name <MANAGED-OBJECT-FULL-NAME>]?
[identifying-application-additional-info <IDENTIFYINGAPPLICATION-ADDITIONAL-INFO>]? [application-additional-info
<APPLICATION-ADDITIONAL-INFO>]? [application-id <APPLICATIONID>]? [severity <SEVERITY>]? [acknowledged <ACKNOWLEDGED>]?
[cleared <CLEARED>]?}
None
show alarm active {[from-index <STARTING-INDEX-FOR-FETCHINGRECORDS>]? [how-many <HOW-MANY-RECORDS-SHOULD-BE-FETCHED>]?}
managed-object-ids {[from-index <STARTING-INDEX-FOR-FETCHINGRECORDS>]? [how-many <HOW-MANY-RECORDS-SHOULD-BE-FETCHED>]?}
None
show alarm active {[from-index <STARTING-INDEX-FOR-FETCHINGRECORDS>]? [how-many <HOW-MANY-RECORDS-SHOULD-BE-FETCHED>]?}
probable-causes {[from-index <STARTING-INDEX-FOR-FETCHINGRECORDS>]? [how-many <HOW-MANY-RECORDS-SHOULD-BE-FETCHED>]?}
None
show alarm active {[from-index <STARTING-INDEX-FOR-FETCHINGRECORDS>]? [how-many <HOW-MANY-RECORDS-SHOULD-BE-FETCHED>]?}
specific-problems {[from-index <STARTING-INDEX-FOR-FETCHING-

104

Issue:03B

MulticontrollerRNCSCLICommands

Table4

SCLICommands

alarmactive(Cont.)

RECORDS>]? [how-many <HOW-MANY-RECORDS-SHOULD-BE-FETCHED>]?}

2.1.2.1
Table5

alarm active application-ids

alarmactiveapplication-ids

Description
ThiscommandshowstheapplicationIDsofactivealarmsthatmatchthecriteria.
Parameter

Hint

Range

Default

Theparameter'from-index'specifiesthestartingindexof
applicationidentifiersintheAlarmSystemtobefetched.

startindexof
applicationidentifiers

NA

from-index

Theparameter'how-many'specifiesthenumberof
applicationidentifiersintheAlarmSystemtobefetched.

numberofapplication
identifierstobeshown

NA

how-many
Command

Dependency
None

show alarm active {[from-index <STARTING-INDEX-FOR-FETCHINGRECORDS>]? [how-many <HOW-MANY-RECORDS-SHOULD-BE-FETCHED>]?}


application-ids {[from-index <STARTING-INDEX-FOR-FETCHINGRECORDS>]? [how-many <HOW-MANY-RECORDS-SHOULD-BE-FETCHED>]?}

2.1.2.2
Table6

alarm active filter-by

alarmactivefilter-by

Description
Thiscommandshowstheactivealarmsinthealarmsystemthatmatchesthespecifiedfilteringcriteria.
Parameter

Hint

Range

Default

Theparameter"acknowledged"specifiestheacknowledged
stateofthealarmstobematched.Itallowstwovalues"yes"or"no".Ifsetto"no",thenthealarmswhichwerenot
acknowledgedarematched.Otherwise,thealarmswhich
wereacknowledgedarematched.

acknowledgedstate

NA

Theparameter"alarm-id"specifiesthealarmidentifierofthe
activealarmstobematched.

alarmidentifier

NA

alarm-id

Theparameter"application-additional-info"specifiesthe
applicationadditionalinfopatternofthealarmstobe
matched.

applicationadditional
info

NA

applicationadditional-info

acknowledged

Note:Thisparametersupportstheasteriskwildcard
character(*).Toescapetheasteriskandpreserveitsliteral
value,prefixitwithabackslash(\*).

Issue:03B

105

SCLICommands

Table6

MulticontrollerRNCSCLICommands

alarmactivefilter-by(Cont.)

application-id

Theparameter"application-id"specifiestheapplicationID
patternofthealarmstobematched.

applicationIDname

NA

Theparameter"cleared"specifiestheclearedstateofthe
alarmstobematched.Itallowstwovalues-"yes"or"no".If
setto"no",thenthealarmswhichwerenotclearedare
matched.Otherwise,thealarmswhichwereclearedare
matched.

clearedstate

NA

Theparameter"identifying-application-additional-info"
specifiestheidentifyingapplicationadditionalinfopatternof
thealarmstobematched.

identifyingapplication
additionalinfo

NA

managedobjectname

NA

managedobjectname
infullDNformat

NA

Note:Thisparametersupportstheasteriskwildcard
character(*).Toescapetheasteriskandpreserveitsliteral
value,prefixitwithabackslash(\*).

cleared

identifyingapplicationadditional-info

managed-object

Note:Thisparametersupportstheasteriskwildcard
character(*).Toescapetheasteriskandpreserveitsliteral
value,prefixitwithabackslash(\*).
Theparameter"managed-object"specifiesthemanaged
objectpatternofthealarmstobematched.
Note:Thisparametersupportstheasteriskwildcard
character(*).Toescapetheasteriskandpreserveitsliteral
value,prefixitwithabackslash(\*).

managed-objectfull-name

Theparameter"managed-object-full-name"specifiesthe
managedobjectnameinfulldistinguishedname(DN)
pattern,ofthealarmstobematched.
Note:
-Thisparametersupportstheasteriskwildcardcharacter(*).
Toescapetheasteriskandpreserveitsliteralvalue,prefixit
withabackslash(\*).
-Whenusingauto-completion,entertheDNinreverse
order.
Theparameter"severity"specifiestheseveritylevelofthe
alarmstobematched.

severitylevel

NA

severity

Theparameter"specific-problem"specifiesthespecific
problemofthealarmstobematched.

specificproblem

NA

specific-problem
Command

Dependency
None

show alarm active {[from-index <STARTING-INDEX-FOR-FETCHINGRECORDS>]? [how-many <HOW-MANY-RECORDS-SHOULD-BE-FETCHED>]?}


filter-by {[alarm-id <ALARM-ID>]? [specific-problem
<SPECIFIC_PROBLEM>]? [managed-object <MANAGED-OBJECT>]?
[managed-object-full-name <MANAGED-OBJECT-FULL-NAME>]?
[identifying-application-additional-info <IDENTIFYINGAPPLICATION-ADDITIONAL-INFO>]? [application-additional-info

106

Issue:03B

MulticontrollerRNCSCLICommands

Table6

SCLICommands

alarmactivefilter-by(Cont.)

<APPLICATION-ADDITIONAL-INFO>]? [application-id <APPLICATIONID>]? [severity <SEVERITY>]? [acknowledged <ACKNOWLEDGED>]?


[cleared <CLEARED>]?}

2.1.2.3
Table7

alarm active managed-object-ids

alarmactivemanaged-object-ids

Description
ThiscommandshowsthemanagedobjectIDsofactivealarmsthatmatchthecriteria.
Parameter

Hint

Range

from-index

Theparameter'from-index'specifiesthestartingindexof
managedobjectidentifiersintheAlarmSystemtobe
fetched.

startindexofmanaged NA
objectidentifiers

how-many

Theparameter'how-many'specifiesthenumberof
managedobjectidentifiersintheAlarmSystemtobe
fetched.

numberofmanaged
objectidentifierstobe
shown

Command

Default

NA

Dependency
None

show alarm active {[from-index <STARTING-INDEX-FOR-FETCHINGRECORDS>]? [how-many <HOW-MANY-RECORDS-SHOULD-BE-FETCHED>]?}


managed-object-ids {[from-index <STARTING-INDEX-FOR-FETCHINGRECORDS>]? [how-many <HOW-MANY-RECORDS-SHOULD-BE-FETCHED>]?}

2.1.2.4
Table8

alarm active probable-causes

alarmactiveprobable-causes

Description
Thiscommandshowstheprobablecausesofactivealarmsthatmatchthecriteria.
Parameter

Hint

Range

Default

Theparameter'from-index'specifiesthestartingindexof
probablecausesintheAlarmSystemtobefetched.

startindexofprobable
causes.Default1.

NA

from-index

Theparameter'how-many'specifiesthenumberofprobable
causesintheAlarmSystemtobefetched.

numberofprobable
causestobeshown

NA

how-many
Command

Dependency
None

show alarm active {[from-index <STARTING-INDEX-FOR-FETCHINGRECORDS>]? [how-many <HOW-MANY-RECORDS-SHOULD-BE-FETCHED>]?}

Issue:03B

107

SCLICommands

Table8

MulticontrollerRNCSCLICommands

alarmactiveprobable-causes(Cont.)

probable-causes {[from-index <STARTING-INDEX-FOR-FETCHINGRECORDS>]? [how-many <HOW-MANY-RECORDS-SHOULD-BE-FETCHED>]?}

2.1.2.5
Table9

alarm active specific-problems

alarmactivespecific-problems

Description
Thiscommandshowsthespecificproblemsofactivealarmsthatmatchthecriteria.
Parameter

Hint

Range

Default

Theparameter'from-index'specifiesthestartingindexof
specificproblemsintheAlarmSystemtobefetched.

startindexofspecific
problems

NA

from-index

Theparameter'how-many'specifiesthenumberofspecific
problemsintheAlarmSystemtobefetched.

numberofspecific
problemstobeshown

NA

how-many
Command

Dependency
None

show alarm active {[from-index <STARTING-INDEX-FOR-FETCHINGRECORDS>]? [how-many <HOW-MANY-RECORDS-SHOULD-BE-FETCHED>]?}


specific-problems {[from-index <STARTING-INDEX-FOR-FETCHINGRECORDS>]? [how-many <HOW-MANY-RECORDS-SHOULD-BE-FETCHED>]?}

2.1.3 alarm active-summary


Table10

alarmactive-summary

Description
Thiscommanddisplaysasummaryofactivealarmsinthesystem.Bydefault,thesummaryisshownindetail.
Parameter

Hint

Command

Range

Default

Dependency
None

show alarm active-summary


None
show alarm active-summary brief
None
show alarm active-summary real-time {[delay <DELAY>]?}

108

Issue:03B

MulticontrollerRNCSCLICommands

2.1.3.1
Table11

SCLICommands

alarm active-summary brief

alarmactive-summarybrief

Description
Thiscommanddisplaysthebriefsummaryofactivealarmspresentinthesystem.
Parameter

Hint

Command

Range

Default

Dependency
None

show alarm active-summary brief

2.1.3.2
Table12

alarm active-summary real-time

alarmactive-summaryreal-time

Description
Thiscommanddisplaysinaseparatescreenthedynamicreal-timeviewoftheactivealarmsinthesystemindetailed
summary.Press"ctrl-c"toquitthecommand.
Note:Usingthiscommandmaycauseincreaseinsystemresourceusage.
Parameter

Hint

Range

Default

Theparameter"delay"specifies,inseconds,thetime
intervalbetweenthescreenupdates.Theacceptablevalue
ofthisparametershouldbeintherange[3..10].

delayintervalbetween
screenupdatesin
seconds.

NA

delay

Command

Dependency
None

show alarm active-summary real-time {[delay <DELAY>]?}

2.1.4 alarm alarm-count


Table13

alarmalarm-count

Description
Thiscommandshowsthecountofthenumberofactivealarmsinthealarmsystem.
Parameter
Command

Issue:03B

Hint

Range

Default

Dependency

109

SCLICommands

Table13

MulticontrollerRNCSCLICommands

alarmalarm-count(Cont.)
None

show alarm alarm-count


None
show alarm alarm-count filter-by {[alarm-id <ALARM-ID>]?
[specific-problem <SPECIFIC-PROBLEM>]? [managed-object
<MANAGED-OBJECT>]? [managed-object-full-name <MANAGED-OBJECTFULL-NAME>]? [identifying-application-additional-info
<IDENTIFYING-APPLICATION-ADDITIONAL-INFO>]? [applicationadditional-info <APPLICATION-ADDITIONAL-INFO>]? [application-id
<APPLICATION-ID>]? [severity <SEVERITY>]? [acknowledged
<ACKNOWLEDGE>]? [cleared <CLEARED>]?}

2.1.4.1
Table14

alarm alarm-count filter-by

alarmalarm-countfilter-by

Description
Thiscommandshowsthecountofthenumberofactivealarmspresentinthealarmsystem,andwhichmatchthespecified
filteringcriteria.
Note:Ifnofilteringparametersarespecified,thenthecountofalltheactivealarmsinthealarmsystemwillbeshown.
Parameter

Hint

Range

Default

Theparameter"acknowledged"specifiestheacknowledged
stateofthealarmstobematched.Itallowstwovalues"yes"or"no".Ifsetto"no",thenthealarmswhichwerenot
acknowledgedarematched.Otherwise,thealarmswhich
wereacknowledgedarematched.

acknowledgedstate

NA

Theparameter"alarm-id"specifiesthealarmidentifierofthe
activealarmstobematched.

alarmidentifier

NA

alarm-id

Theparameter"application-additional-info"specifiesthe
applicationadditionalinfopatternofthealarmstobe
matched.

applicationadditional
info

NA

applicationadditional-info

applicationIDname

NA

acknowledged

Note:Thisparametersupportstheasteriskwildcard
character(*).Toescapetheasteriskandpreserveitsliteral
value,prefixitwithabackslash(\*).

application-id

Theparameter"application-id"specifiestheapplicationID
patternofthealarmstobematched.
Note:Thisparametersupportstheasteriskwildcard
character(*).Toescapetheasteriskandpreserveitsliteral
value,prefixitwithabackslash(\*).

110

Issue:03B

MulticontrollerRNCSCLICommands

Table14

SCLICommands

alarmalarm-countfilter-by(Cont.)

cleared

identifyingapplicationadditional-info

managed-object

Theparameter"cleared"specifiestheclearedstateofthe
alarmstobematched.Itallowstwovalues-"yes"or"no".If
setto"no",thenthealarmswhichwerenotclearedare
matched.Otherwise,thealarmswhichwereclearedare
matched.

clearedstate

NA

Theparameter"identifying-application-additional-info"
specifiestheidentifyingapplicationadditionalinfopatternof
thealarmstobematched.

identifyingapplication
additionalinfo

NA

managedobjectname

NA

managedobjectname
infullDNformat

NA

Note:Thisparametersupportstheasteriskwildcard
character(*).Toescapetheasteriskandpreserveitsliteral
value,prefixitwithabackslash(\*).
Theparameter"managed-object"specifiesthemanaged
objectpatternofthealarmstobematched.
Note:Thisparametersupportstheasteriskwildcard
character(*).Toescapetheasteriskandpreserveitsliteral
value,prefixitwithabackslash(\*).

managed-objectfull-name

Theparameter"managed-object-full-name"specifiesthe
managedobjectnameinfulldistinguishedname(DN)
pattern,ofthealarmstobematched.
Note:
-Thisparametersupportstheasteriskwildcardcharacter(*).
Toescapetheasteriskandpreserveitsliteralvalue,prefixit
withabackslash(\*).
-Whenusingauto-completion,entertheDNinreverse
order.
Theparameter"severity"specifiestheseveritylevelofthe
alarmstobematched.

severitylevel

NA

severity

Theparameter"specific-problem"specifiesthespecific
problemofthealarmstobematched.

specificproblem

NA

specific-problem
Command

Dependency
None

show alarm alarm-count filter-by {[alarm-id <ALARM-ID>]?


[specific-problem <SPECIFIC-PROBLEM>]? [managed-object
<MANAGED-OBJECT>]? [managed-object-full-name <MANAGED-OBJECTFULL-NAME>]? [identifying-application-additional-info
<IDENTIFYING-APPLICATION-ADDITIONAL-INFO>]? [applicationadditional-info <APPLICATION-ADDITIONAL-INFO>]? [application-id
<APPLICATION-ID>]? [severity <SEVERITY>]? [acknowledged
<ACKNOWLEDGE>]? [cleared <CLEARED>]?}

Issue:03B

111

SCLICommands

MulticontrollerRNCSCLICommands

2.1.5 alarm blocking-rule


Table15

alarmblocking-rule

Description
add
Thiscommandaddsanewblockingrule.Ablockingrulespecifiesacombinationofrangeofspecificproblemsanda
managedobjectID(MOID),WhereMOIDisoptional.
Ifanyalarmiswithinthespecific-problemrangeandmatcheswiththeMOIDgivenintherule,thenthealarmwillnotbe
processed.
delete
Thiscommanddeletesthespecifiedblockingrule.
set
Thiscommandisusedtomanagetheblockingrule.
show
Thiscommandshowstheblockingrulesinthealarmsystem.
Parameter

from-specificproblem

Hint

Range

Theparameter"from-specific-problem"specifiesthelower
boundoftherangeofspecificproblemsinablockingrule.

lowerboundofspecific NA
problemrangeforrule

Theparameter"managed-object-id"specifiesthemanaged
managed-object-id objectidentifier'snametoblockthealarmsthatmatchwith
it.Tomatchapartoftheparameter"managed-object-id"in
thealarmsystem,enclosethevaluein"%".

Default

managedobjectname

NA

Theparameter"rule-id"specifiestheruleidoftheblocking
ruletobedeleted.

blockingruleidentifier

NA

Theparameter"to-specific-problem"specifiestheupper
boundoftherangeofspecificproblemsinablockingrule.

upperboundof
NA
specificproblemrange
forrule

Forexample,%MoId_1%MoId_2%.TheorderofMoId
stringsisalsomatchedhere.

rule-id

to-specificproblem
Command

Dependency
None

add alarm blocking-rule {from-specific-problem <FROM-SPECIFICPROBLEM> to-specific-problem <TO-SPECIFIC-PROBLEM> [managedobject-id <MOID>]?}

112

Issue:03B

MulticontrollerRNCSCLICommands

Table15

SCLICommands

alarmblocking-rule(Cont.)
None

delete alarm blocking-rule {rule-id <RULE-ID>}


None
set alarm blocking-rule activate {rule-id <RULE-ID>}
None
set alarm blocking-rule deactivate {rule-id <RULE-ID>}
None
show alarm blocking-rule all
None
show alarm blocking-rule rule-id <rule-id>

2.1.5.1
Table16

alarm blocking-rule activate

alarmblocking-ruleactivate

Description
Thiscommandactivatesthespecifiedblocking-rule.
Parameter

Hint

Range

Default

Theparameter"rule-id"specifiestheruleIDoftheblocking
ruletobeactivated.

blocking-ruleidentifier

NA

rule-id
Command

Dependency
None

set alarm blocking-rule activate {rule-id <RULE-ID>}

2.1.5.2
Table17

alarm blocking-rule all

alarmblocking-ruleall

Description
Thiscommandshowsalltheblocking-rule(s)whicharepresentinthealarmsystem.
Parameter

Hint

Command

Range

Default

Dependency
None

show alarm blocking-rule all

Issue:03B

113

SCLICommands

2.1.5.3
Table18

MulticontrollerRNCSCLICommands

alarm blocking-rule deactivate

alarmblocking-ruledeactivate

Description
Thiscommanddeactivatesthespecifiedblockingrule.
Parameter

Hint

Range

Default

Theparameter"rule-id"specifiestheruleIDoftheblocking
ruletobedeactivated.

blocking-ruleidentifier

NA

rule-id
Command

Dependency
None

set alarm blocking-rule deactivate {rule-id <RULE-ID>}

2.1.5.4
Table19

alarm blocking-rule rule-id

alarmblocking-rulerule-id

Description
Theparameter"rule-id"specifiestheruleIDoftheblockingrule.
Parameter

Hint

Command

Range

Default

Dependency
None

show alarm blocking-rule rule-id <rule-id>

2.1.5.4.1
Table20

alarm blocking-rule rule-id <rule-id>

alarmblocking-rulerule-id<rule-id>

Description
ThiscommandshowstheblockingruleforthespecifiedruleIDinthealarmsystem.
Parameter

Hint

Command

Range

Default

Dependency
None

show alarm blocking-rule rule-id <rule-id>

114

Issue:03B

MulticontrollerRNCSCLICommands

SCLICommands

2.1.6 alarm clear


Table21

alarmclear

Description
Thiscommandclearsthespecifiedalarmforcefully.
Parameter

Hint

Range

Default

Theparameter"alarm-id"specifiesthealarmIDtobe
cleared.

alarmidentifier

NA

alarm-id

Theparameter"forced"allowstwovalues

clearsalarmforcefully

NA

forced
Command

Dependency
None

set alarm clear {alarm-id <ALARM-ID> [forced <FORCED>]?}

2.1.7 alarm clear-matching-alarms


Table22

alarmclear-matching-alarms

Description
Thiscommandclearsthespecifiedalarm.
Parameter

Hint

Range

Default

Theparameter"forced"allowstwovalues

clearsalarmforcefully.

NA

forced
Command

Dependency
None

set alarm clear-matching-alarms {[forced <FORCED>]?} filter-by


{[specific-problem <SPECIFIC-PROBLEM>]? [managed-object
<MANAGED-OBJECT>]? [managed-object-full-name <MANAGED-OBJECTFULL-NAME>]? [identifying-application-additional-info
<IDENTIFYING-APPLICATION-ADDITIONAL-INFO>]? [application-id
<APPLICATION-ID>]? [severity <SEVERITY>]?}

2.1.7.1
Table23

alarm clear-matching-alarms filter-by

alarmclear-matching-alarmsfilter-by

Description
Thiscommandclearsthealarmsthatmatchthefiltercriteria.
Parameter

Issue:03B

Hint

Range

Default

115

SCLICommands

Table23

MulticontrollerRNCSCLICommands

alarmclear-matching-alarmsfilter-by(Cont.)

application-id

Theparameter"application-id"specifiestheapplicationID
patternofthealarmstobematched.

applicationIDname

NA

identifyingapplication
additionalinfo

NA

managedobject
pattern

NA

managedobject
patterninDNformat

NA

Note:Thisparametersupportstheasteriskwildcard
character(*).Toescapetheasteriskandpreserveitsliteral
value,prefixitwithabackslash(\*).

identifyingapplicationadditional-info

managed-object

Theparameter"identifying-application-additional-info"
specifiestheidentifyingapplicationadditionalinfopatternof
thealarmstobematched.
Note:Theparameter"identifying-application-additional-info"
supportstheasteriskwildcardcharacter(*).Toescapethe
asteriskandpreserveitsliteralvalue,prefixitwitha
backslash(\*).
Theparameter"managed-object"specifiesthemanaged
objectpatternofthealarmstobematched.
Note:Theparameter"managed-object"supportsthe
asteriskwildcardcharacter(*).Toescapetheasteriskand
preserveitsliteralvalue,prefixitwithabackslash(\*).

managed-objectfull-name

Theparameter"managed-object-full-name"specifiesthe
managedobjectnameinfulldistinguishedname(DN)
pattern,ofthealarmstobematched.
Note:
-Theparameter"managed-object-full-name"supportsthe
asteriskwildcardcharacter(*).Toescapetheasteriskand
preserveitsliteralvalue,prefixitwithabackslash(\*).
-Whenusingauto-completion,entertheDNinreverse
order.
Theparameter"severity"specifiestheseveritylevelofthe
alarmstobematched.

severitylevel

NA

severity

Theparameter"specific-problem"specifiesthespecific
problemofthealarmtobematched.

specificproblem

NA

specific-problem
Command

Dependency
None

set alarm clear-matching-alarms {[forced <FORCED>]?} filter-by


{[specific-problem <SPECIFIC-PROBLEM>]? [managed-object
<MANAGED-OBJECT>]? [managed-object-full-name <MANAGED-OBJECTFULL-NAME>]? [identifying-application-additional-info
<IDENTIFYING-APPLICATION-ADDITIONAL-INFO>]? [application-id
<APPLICATION-ID>]? [severity <SEVERITY>]?}

116

Issue:03B

MulticontrollerRNCSCLICommands

SCLICommands

2.1.8 alarm follow-history


Table24

alarmfollow-history

Description
Thiscommandshowsthedynamicreal-timeviewofthealarmeventsinthesystem.
Bydefaultthe"showalarmfollow-history"commandwillnotshowtheheartbeatalarm(70246)events.Inordertoseethe
heartbeatalarmeventsusetheinclude-heartbeat-alarmsoption.
Press"ctrl-c"toquitthecommand.
Note:Usingthiscommandmaycauseincreaseinsystemresourceusage.
Note:Beforeexecutingthiscommand,executetheSCLIcommand"setclibuilt-inrows-1"forcontinuousviewofthe
outputandtoavoidpagination.
Parameter

Hint

Range

Default

Theparameter"include-heartbeat-alarms"determines
whethertoincludeornotincludetheheartbeatalarmsin
real-timeviewofthealarmhistory.

includeheartbeat
alarms(default:no)

NA

includeheartbeat-alarms
Command

Dependency
None

show alarm follow-history {[include-heartbeat-alarms <INCLUDEHEARTBEAT-ALARMS>]?}


None
show alarm follow-history {[include-heartbeat-alarms <INCLUDEHEARTBEAT-ALARMS>]?} filter-by {[specific-problem <SPECIFICPROBLEM>]? [alarm-id <ALARM-ID>]? [managed-object <MANAGEDOBJECT>]? [managed-object-full-name <MANAGED-OBJECT-FULLNAME>]? [application-id <APPLICATION-ID>]? [applicationadditional-info <APPLICATION-ADDITIONAL-INFO>]? [identifyingapplication-additional-info <IDENTIFYING-APPLICATIONADDITIONAL-INFO>]? [acknowledged <ACKNOWLEDGED>]? [cleared
<CLEARED>]?}

2.1.8.1
Table25

alarm follow-history filter-by

alarmfollow-historyfilter-by

Description
Thiscommandshowsthedynamicreal-timeviewofthealarmeventsinthesystemwiththespecifiedfilteringcriteria.
Press"ctrl-c"toquitthecommand.
Note:Usingthiscommandmaycauseincreaseinsystemresourceusage.
Parameter

Issue:03B

Hint

Range

Default

117

SCLICommands

Table25

MulticontrollerRNCSCLICommands

alarmfollow-historyfilter-by(Cont.)
Theparameter"acknowledged"specifiestheacknowledged
stateofthealarmstobematched.Itallowstwovalues"yes"or"no".Ifsetto"no",thenthealarmswhichwerenot
acknowledgedarematched.Otherwise,thealarmswhich
wereacknowledgedarematched.

acknowledgedstate

NA

Theparameter"alarm-id"specifiesthealarmIDofthe
alarmstobefetched.

alarmID

NA

alarm-id

Theparameter"application-additional-info"specifiesthe
applicationadditionalinfopatternofthealarmeventstobe
matched.

applicationadditional
info

NA

applicationadditional-info

applicationIDname

NA

Theparameter"cleared"specifiestheclearedstateofthe
alarmstobematched.Itallowstwovalues-"yes"or"no".If
setto"no",thenthealarmswhichwerenotclearedare
matched.Otherwise,thealarmswhichwereclearedare
matched.

clearedstate

NA

Theparameter"identifying-application-additional-info"
specifiestheidentifyingapplicationadditionalinfopatternof
thealarmeventstobematched.

identifyingapplication
additionalinfo

NA

managedobjectname

NA

acknowledged

Note:Thisparametersupportstheasteriskwildcard
character(*).Toescapetheasteriskandpreserveitsliteral
value,prefixitwithabackslash(\*).

application-id

Theparameter"application-id"specifiestheapplicationID
patternofthealarmstobematched.
Note:Thisparametersupportstheasteriskwildcard
character(*).Toescapetheasteriskandpreserveitsliteral
value,prefixitwithabackslash(\*).

cleared

identifyingapplicationadditional-info

managed-object

Note:Thisparametersupportstheasteriskwildcard
character(*).Toescapetheasteriskandpreserveitsliteral
value,prefixitwithabackslash(\*).
Theparameter"managed-object"specifiesthemanaged
objectpatternofthealarmstobematched.
Note:Thisparametersupportstheasteriskwildcard
character(*).Toescapetheasteriskandpreserveitsliteral
value,prefixitwithabackslash(\*).

118

Issue:03B

MulticontrollerRNCSCLICommands

Table25

SCLICommands

alarmfollow-historyfilter-by(Cont.)

managed-objectfull-name

Theparameter"managed-object-full-name"specifiesthe
managedobjectnameinfulldistinguishedname(DN)
pattern,ofthealarmstobematched.

managedobjectname
infullDNformat

NA

specificproblem

NA

Note:
-Thisparametersupportstheasteriskwildcardcharacter(*).
Toescapetheasteriskandpreserveitsliteralvalue,prefixit
withabackslash(\*).
-Whenusingauto-completion,entertheDNinreverse
order.

specific-problem

Theparameter"specific-problem"specifiesthespecific
problemofthealarmeventstobematched.

Command

Dependency
None

show alarm follow-history {[include-heartbeat-alarms <INCLUDEHEARTBEAT-ALARMS>]?} filter-by {[specific-problem <SPECIFICPROBLEM>]? [alarm-id <ALARM-ID>]? [managed-object <MANAGEDOBJECT>]? [managed-object-full-name <MANAGED-OBJECT-FULLNAME>]? [application-id <APPLICATION-ID>]? [applicationadditional-info <APPLICATION-ADDITIONAL-INFO>]? [identifyingapplication-additional-info <IDENTIFYING-APPLICATIONADDITIONAL-INFO>]? [acknowledged <ACKNOWLEDGED>]? [cleared
<CLEARED>]?}

2.1.9 alarm history


Table26

alarmhistory

Description
Thiscommandshowsthealarmeventsfromalarmhistory,usingdifferentoptionsandfilteringcriteria.Themostrecent
eventsareshownfirst.
AlarmSystemiscapableofstoringabignumberofalarmeventsinthealarmhistorylimitedbyconfigurationanddisksize.
Whenthealarmhistorysizelimitisreached,theAlarmSystemwillremovetheoldesthistoryevents,inordertomakeroom
fornewevents.
Fromuser'spointofview,theremovalofoldesthistoryeventsappearstohappenasynchronously,whichmaycause
randomvariationsintheoutput.Forexamplethesame"showalarmhistory"commandatonepointdisplaysonesetof
alarmeventsandlaterthesamecommanddisplaysdifferentsetofalarmevents.Thisisbecausesomeoftheoldest
eventsarenotpresentanymore.
Note:Theremovalofoldesthistoryeventsandconsequentvariationsoftheoutputofthiscommandcanalsooccurdueto
theinflowoftheheartbeatalarmevents.
HeartbeatalarmsareinternallygeneratedalarmeventswhosepurposeistobesenttotheNetworkManagementSystem
atregularintervalstoindicatethatAlarmSystemandtheentireNetworkElementisfunctional.Bydefaultthe"showalarm
history"commandwillnotshowtheheartbeatalarm(70246)events.Inordertoviewtheheartbeatalarmeventsusethe
include-heartbeat-alarmsoption.

Issue:03B

119

SCLICommands

Table26
Parameter

from-index

MulticontrollerRNCSCLICommands

alarmhistory(Cont.)
Hint

Range

Theparameters"from-index"and"how-many"areusedto
startindexofalarm
specifythesubset("window")ofeventsthatwillbeshown,
events(default:1)
fromtheselectedsetofalarmevents.Asetofalarmevents
isselectedbyusingthe"filter-by"parametersofthis
command,anditcanbehuge.Becauseofthat,itispractical
tobeableto"navigate"throughthesetandshowonlya
subset,forexampleasubset("window")of100events
startingfromthe5000thoneisdefinedby"from-index5000
how-many100".

Default
NA

"from-index"specifiesthestartingindexwithintheselected
setofalarmeventsand"how-many"specifiesthenumberof
eventsthatwillbeshown.
Foreveryselectedsetofalarmevents,theeventmost
recentlygeneratedhasanindexof"1",theonebeforeitis
"2",andthecountingcontinuesuptothelasteventinthe
set,whichistheonethatoccurredtheearliest.Notethatthe
resultingsubsetofalarmeventscanalsohaveanoutput
thatislessthanthespecified"how-many"events,incases
whentheselectedsetofalarmsdoesnothaveenough
eventsstartingfromtheonewithindex"from-index".
Becauseoftherelativenatureofelement'sindex,therewill
bemostprobablydifferentalarmeventwhichhasanindex
equalto1ifdifferentfiltersareapplied.Incaseswhenfilter
isnotspecifiedoriftheupperboundary("to-notification-id"
or"to-event-time"parametersof"filter-by")isnotspecified,
theeventwithanindexequal1mightbedifferentevery
time.Thisisbecauseneweventsmaycometothealarm
systembetweentwoinvocationsofthiscommand,andthe
eventwithindexequal1willalwayspointtothenewest
alarmeventinthealarmsystem,whichdidnotexistearlier
inpreviousinvocation.Forexample,thisisthecommand
thatwillalwaysshowonlythenewestalarmevent:
showalarmhistoryfrom-index1how-many1

how-many

Theparameters"from-index"and"how-many"areusedto
numberofrecordsto
specifythesubset("window")ofeventsthatwillbeshown,
beshown
fromtheselectedsetofalarmevents.Asetofalarmevents
isselectedbyusingthe"filter-by"parametersofthis
command,anditcanbehuge.Becauseofthat,itispractical
tobeableto"navigate"throughthesetandshowonlya
subset,forexampleasubset("window")of100events
startingfromthe5000thoneisdefinedby"from-index5000
how-many100".

NA

"from-index"specifiesthestartingindexwithintheselected
setofalarmeventsand"how-many"specifiesthenumberof
eventsthatwillbeshown.
Foreveryselectedsetofalarmevents,theeventmost
recentlygeneratedhasanindexof"1",theonebeforeitis
"2",andthecountingcontinuesuptothelasteventinthe
set,whichistheonethatoccurredtheearliest.Notethatthe
resultingsubsetofalarmeventscanalsohaveanoutput

120

Issue:03B

MulticontrollerRNCSCLICommands

Table26

SCLICommands

alarmhistory(Cont.)
thatislessthanthespecified"how-many"events,incases
whentheselectedsetofalarmsdoesnothaveenough
eventsstartingfromtheonewithindex"from-index".
Becauseoftherelativenatureofelement'sindex,therewill
bemostprobablydifferentalarmeventwhichhasanindex
equalto1ifdifferentfiltersareapplied.Incaseswhenfilter
isnotspecifiedoriftheupperboundary("to-notification-id"
or"to-event-time"parametersof"filter-by")isnotspecified,
theeventwithanindexequal1mightbedifferentevery
time.Thisisbecauseneweventsmaycometothealarm
systembetweentwoinvocationsofthiscommand,andthe
eventwithindexequal1willalwayspointtothenewest
alarmeventinthealarmsystem,whichdidnotexistearlier
inpreviousinvocation.Forexample,thisisthecommand
thatwillalwaysshowonlythenewestalarmevent:
showalarmhistoryfrom-index1how-many1

includeheartbeat-alarms

Theparameter"include-heartbeat-alarms"determines
whethertoincludeornotincludetheheartbeatalarms
duringdisplayofalarmhistory.

Command

includetheheartbeat
alarmeventsornot
whiledisplayingalarm
history

NA

Dependency
None

show alarm history {[include-heartbeat-alarms <INCLUDEHEARTBEAT-ALARMS>]? [from-index <STARTING-INDEX-FOR-FETCHINGRECORDS>]? [how-many <HOW-MANY-RECORDS-SHOULD-BE-FETCHED>]?}


None
show alarm history {[include-heartbeat-alarms <INCLUDEHEARTBEAT-ALARMS>]? [from-index <STARTING-INDEX-FOR-FETCHINGRECORDS>]? [how-many <HOW-MANY-RECORDS-SHOULD-BE-FETCHED>]?}
filter-by {[alarm-id <ALARM-ID>]? [specific-problem <SPECIFICPROBLEM>]? [from-event-time <FROM-EVENT-TIME>]? [to-event-time
<TO-EVENT-TIME>]? [from-notification-id <FROM-NOTIFICATIONID>]? [to-notification-id <TO-NOTIFICATION-ID>]? [managedobject <MANAGED-OBJECT>]? [managed-object-full-name <MANAGEDOBJECT-FULL-NAME>]? [application-id <APPLICATION-ID>]?
[application-additional-info <APPLICATION-ADDITIONAL-INFO>]?
[identifying-application-additional-info <IDENTIFYINGAPPLICATION-ADDITIONAL-INFO>]? [acknowledged <ACKNOWLEDGED>]?
[cleared <CLEARED>]?}

2.1.9.1
Table27

alarm history filter-by

alarmhistoryfilter-by

Description
Thiscommandfetchesthealarmevents(history)inthealarmsystemthatmatcheswiththespecifiedfilteringcriteria.Note:
Themostrecenteventsareshownfirst.

Issue:03B

121

SCLICommands

Table27

MulticontrollerRNCSCLICommands

alarmhistoryfilter-by(Cont.)

Parameter

Hint

Range

Default

Theparameter"acknowledged"specifiestheacknowledged
stateofthealarmstobematched.Itallowstwovalues"yes"or"no".Ifsetto"no",thenthealarmswhichwerenot
acknowledgedarematched.Otherwise,thealarmswhich
wereacknowledgedarematched.

acknowledgedstate

NA

Theparameter"alarm-id"specifiesthealarmidentifierofthe
alarmeventstobematched.

alarmidentifier

NA

alarm-id

Theparameter"application-additional-info"specifiesthe
applicationadditionalinfopatternofthealarmeventstobe
matched.

applicationadditional
info

NA

applicationadditional-info

applicationIDname

NA

Theparameter"cleared"specifiestheclearedstateofthe
alarmstobematched.Itallowstwovalues-"yes"or"no".If
setto"no",thenthealarmswhichwerenotclearedare
matched.Otherwise,thealarmswhichwereclearedare
matched.

clearedstate

NA

Theparameter"from-event-time"specifiesthestartingtime
tofetchthealarmhistoryevents.

startevent-timeto
NA
fetchalarmhistory;
DateformatisDD-MMYYYY.HH:MM:SS

acknowledged

Note:Thisparametersupportstheasteriskwildcard
character(*).Toescapetheasteriskandpreserveitsliteral
value,prefixitwithabackslash(\*).

application-id

Theparameter"application-id"specifiestheapplicationID
patternofthealarmstobematched.
Note:Thisparametersupportstheasteriskwildcard
character(*).Toescapetheasteriskandpreserveitsliteral
value,prefixitwithabackslash(\*).

cleared

from-event-time

Note:1."from-event-time"shouldbelessthanorequalto
"to-event-time".2.Parameters"from-event-time"and"toevent-time"refertotheevent-timeandnottothealarm-time
thatisactuallyvisibleintheoutputofthiscommand.The
event-timeisthetimewhenthealarmsystemhasgenerated
analarmeventasaresultofprocessinganalarm
notification.Ontheotherhand,thealarm-timeisthetime
whenthecomponentorapplicationdetectedthealarm
situationandsentanalarmnotificationforittotheAlarm
System.
Theevent-timewillbealwaysgreaterthanthealarm-time.
Thedifferencebetweenalarm-timeandevent-timecanbea
fewseconds,anddependsonthesystemload.Ifthealarmdetectingcomponentorapplicationsendsalarmnotifications
withanalarm-timeinthepast,thedifferencemightbeeven
morethanafewseconds.

fromnotification-id

122

Theparameter"from-notification-id"specifiesthe
startnotification-id
notification-idoftheeventwherethefetchstartsinthealarm
history.

NA

Issue:03B

MulticontrollerRNCSCLICommands

Table27

SCLICommands

alarmhistoryfilter-by(Cont.)
Everyalarmeventinthealarmhistoryhasitsownfixed
notificationID.Itisguaranteedthatforanytwoalarm
events,theonegeneratedlaterwillhaveanotificationID
withabiggervaluethantheonegeneratedearlier.This
characteristicofthenotificationIDmonotonouslygrowing
allowsaccuratefilteringbasedontherangeofthe
notificationIDs,eveninsituationswhenfilteringbasedon
timemaybecomeinaccuratebecauseof,forexample,
systemtimemovingbackwards.
Note:1."from-notification-id"shouldbelessthanorequalto
"to-notification-id".Otherwise,noeventswillberetrieved.2.
Parameters"from-notification-id"and"to-notification-id"are
usedtoselecttherangeofalarmhistoryeventsbasedon
thenotification-id.Thesearethealternativeto"from-eventtime"and"to-event-time"parameterswhichareusedto
selecttherangeofalarmhistoryeventsbasedontheevent
time.Bothwaysofselectingtherangecannotbeusedina
singlecommand.

identifyingapplicationadditional-info

managed-object

Theparameter"identifying-application-additional-info"
specifiestheidentifyingapplicationadditionalinfopatternof
thealarmeventstobematched.

identifyingapplication
additionalinfo

NA

managedobjectname

NA

managedobjectname
infullDNformat

NA

NA

Note:Thisparametersupportstheasteriskwildcard
character(*).Toescapetheasteriskandpreserveitsliteral
value,prefixitwithabackslash(\*).
Theparameter"managed-object"specifiesthemanaged
objectpatternofthealarmstobematched.
Note:Thisparametersupportstheasteriskwildcard
character(*).Toescapetheasteriskandpreserveitsliteral
value,prefixitwithabackslash(\*).

managed-objectfull-name

Theparameter"managed-object-full-name"specifiesthe
managedobjectnameinfulldistinguishedname(DN)
pattern,ofthealarmstobematched.
Note:
-Thisparametersupportstheasteriskwildcardcharacter(*).
Toescapetheasteriskandpreserveitsliteralvalue,prefixit
withabackslash(\*).
-Whenusingauto-completion,entertheDNinreverse
order.
Theparameter"specific-problem"specifiesthespecific
problemofthealarmeventstobematched.

specificproblem

specific-problem

to-event-time

Theparameter"to-event-time"specifiestheendingtimeto
fetchthealarmhistoryevents.

endevent-timetofetch NA
alarmhistory;Date
formatisDD-MMYYYY.HH:MM:SS

Note:1."from-event-time"shouldbelessthanorequalto
"to-event-time".2.Parameters"from-event-time"and"toevent-time"refertotheevent-timeandnottothealarm-time
thatisactuallyvisibleintheoutputofthiscommand.The

Issue:03B

123

SCLICommands

Table27

MulticontrollerRNCSCLICommands

alarmhistoryfilter-by(Cont.)
event-timeisthetimewhenthealarmsystemhasgenerated
analarmeventasaresultofprocessinganalarm
notification.Ontheotherhand,thealarm-timeisthetime
whenthecomponentorapplicationdetectedthealarm
situationandsentanalarmnotificationforittotheAlarm
System.
Theevent-timewillbealwaysgreaterthanthealarm-time.
Thedifferencebetweenalarm-timeandevent-timecanbea
fewseconds,anddependsonthesystemload.Ifthealarmdetectingcomponentorapplicationsendsalarmnotifications
withanalarm-timeinthepast,thedifferencemightbeeven
morethanafewseconds.

to-notificationid

Theparameter"to-notification-id"specifiesthenotification-id
oftheeventwherethefetchendsinthealarmhistory.

endnotification-id

NA

Everyalarmeventinthealarmhistoryhasitsownfixed
notificationID.Itisguaranteedthatforanytwoalarm
events,theonegeneratedlaterwillhaveanotificationID
withabiggervaluethantheonegeneratedearlier.This
characteristicofthenotificationIDmonotonouslygrowing
allowsaccuratefilteringbasedontherangeofthe
notificationIDs,eveninsituationswhenfilteringbasedon
timemaybecomeinaccuratebecauseof,forexample,
systemtimemovingbackwards.
Note:1."from-notification-id"shouldbelessthanorequalto
"to-notification-id".Otherwise,noeventswillberetrieved.2.
Parameters"from-notification-id"and"to-notification-id"are
usedtoselecttherangeofalarmhistoryeventsbasedon
thenotification-id.Thesearethealternativeto"from-eventtime"and"to-event-time"parameterswhichareusedto
selecttherangeofalarmhistoryeventsbasedontheevent
time.Bothwaysofselectingtherangecannotbeusedina
singlecommand.

Command

Dependency
None

show alarm history {[include-heartbeat-alarms <INCLUDEHEARTBEAT-ALARMS>]? [from-index <STARTING-INDEX-FOR-FETCHINGRECORDS>]? [how-many <HOW-MANY-RECORDS-SHOULD-BE-FETCHED>]?}


filter-by {[alarm-id <ALARM-ID>]? [specific-problem <SPECIFICPROBLEM>]? [from-event-time <FROM-EVENT-TIME>]? [to-event-time
<TO-EVENT-TIME>]? [from-notification-id <FROM-NOTIFICATIONID>]? [to-notification-id <TO-NOTIFICATION-ID>]? [managedobject <MANAGED-OBJECT>]? [managed-object-full-name <MANAGEDOBJECT-FULL-NAME>]? [application-id <APPLICATION-ID>]?
[application-additional-info <APPLICATION-ADDITIONAL-INFO>]?
[identifying-application-additional-info <IDENTIFYINGAPPLICATION-ADDITIONAL-INFO>]? [acknowledged <ACKNOWLEDGED>]?
[cleared <CLEARED>]?}

124

Issue:03B

MulticontrollerRNCSCLICommands

SCLICommands

2.1.10 alarm history-count


Table28

alarmhistory-count

Description
Thiscommandshowsthecountofthealarmeventswhichwouldbereturnedby"showalarmhistory"commandwhenused
withthesamefilteringcriteriaandoptions.
AlarmSystemiscapableofstoringabignumberofalarmeventsinthealarmhistorylimitedbyconfigurationanddisksize.
Whenthealarmhistorysizelimitisreached,theAlarmSystemwillremovetheoldesthistoryevents,inordertomakeroom
fornewevents.
Fromuser'spointofview,theremovalofoldesthistoryeventsappearstohappenasynchronously,whichmaycause
randomvariationsintheoutput.Forexample,thesame"showalarmhistory-count"commandatonepointdisplayscertain
countandlaterthesamecommanddisplaysdifferentcount.Thisisbecausesomeoftheoldesteventsarenotpresentany
more.
Note:Theremovalofoldesthistoryeventsandconsequentvariationsoftheoutputofthiscommandcanalsooccurdueto
theinflowoftheheartbeatalarmevents.
HeartbeatalarmsareinternallygeneratedalarmeventswhosepurposeistobesenttotheNetworkManagementSystem
atregularintervals,toindicatethatAlarmSystemandtheentireNetworkElementisfunctional.Bydefault,historyevents
countdisplayedby"showalarmhistory-count"commanddoesnotincludetheheartbeatalarm(70246)eventscount.In
ordertogetthehistoryeventscountwhichincludestheheartbeatalarmscountusetheinclude-heartbeat-alarmsoption.
Parameter

includeheartbeat-alarms

Hint

Range

Default

Theparameter"include-heartbeat-alarms"specifieswhether
toincludeornottheheartbeatalarmevents.

includetheheartbeat
alarmeventsornot
whiledisplayingalarm
eventscount

NA

Command

Dependency
None

show alarm history-count {[include-heartbeat-alarms <INCLUDEHEARTBEAT-ALARMS>]?}


None
show alarm history-count {[include-heartbeat-alarms <INCLUDEHEARTBEAT-ALARMS>]?} filter-by {[alarm-id <ALARM-ID>]?
[specific-problem <SPECIFIC-PROBLEM>]? [from-event-time <FROMEVENT-TIME>]? [to-event-time <TO-EVENT-TIME>]? [fromnotification-id <FROM-NOTIFICATION-ID>]? [to-notification-id
<TO-NOTIFICATION-ID>]? [managed-object <MANAGED-OBJECT>]?
[managed-object-full-name <MANAGED-OBJECT-FULL-NAME>]?
[application-id <APPLICATION-ID>]? [application-additional-info
<APPLICATION-ADDITIONAL-INFO>]? [identifying-applicationadditional-info <IDENTIFYING-APPLICATION-ADDITIONAL-INFO>]?
[acknowledged <ACKNOWLEDGED>]? [cleared <CLEARED>]?}

Issue:03B

125

SCLICommands

2.1.10.1
Table29

MulticontrollerRNCSCLICommands

alarm history-count filter-by

alarmhistory-countfilter-by

Description
Thiscommandshowsthecountofthealarmevents(history)inthealarmsystem,andwhichmatchthespecifiedfiltering
criteria.
Note:Ifnofilteringparametersarespecified,thenthecountofallthealarmeventsinthealarmsystemwillbeshown.
Parameter

Hint

Range

Default

Theparameter"acknowledged"specifiestheacknowledged
stateofthealarmstobematched.Itallowstwovalues"yes"or"no".Ifsetto"no",thenthealarmswhichwerenot
acknowledgedarematched.Otherwise,thealarmswhich
wereacknowledgedarematched.

acknowledgedstate

NA

Theparameter"alarm-id"specifiesthealarmidentifierofthe
alarmeventstobematched.

alarmidentifier

NA

alarm-id

Theparameter"application-additional-info"specifiesthe
applicationadditionalinfopatternofthealarmeventstobe
matched.

applicationadditional
info

NA

applicationadditional-info

applicationIDname

NA

Theparameter"cleared"specifiestheclearedstateofthe
alarmstobematched.Itallowstwovalues-"yes"or"no".If
setto"no",thenthealarmswhichwerenotclearedare
matched.Otherwise,thealarmswhichwereclearedare
matched.

clearedstate

NA

Theparameter"from-event-time"specifiesthestartingtime
tofetchthealarmhistoryevents.

startevent-timeto
NA
fetchalarmhistory;
DateformatisDD-MMYYYY.HH:MM:SS

acknowledged

Note:Thisparametersupportstheasteriskwildcard
character(*).Toescapetheasteriskandpreserveitsliteral
value,prefixitwithabackslash(\*).

application-id

Theparameter"application-id"specifiestheapplicationID
patternofthealarmstobematched.
Note:Thisparametersupportstheasteriskwildcard
character(*).Toescapetheasteriskandpreserveitsliteral
value,prefixitwithabackslash(\*).

cleared

from-event-time

Note:1."from-event-time"shouldbelessthanorequalto
"to-event-time".2.Parameters"from-event-time"and"toevent-time"refertotheevent-timeandnottothealarm-time
thatisactuallyvisibleintheoutputofthiscommand.The
event-timeisthetimewhenthealarmsystemhasgenerated
analarmeventasaresultofprocessinganalarm
notification.Ontheotherhand,thealarm-timeisthetime
whenthecomponentorapplicationdetectedthealarm
situationandsentanalarmnotificationforittotheAlarm
System.

126

Issue:03B

MulticontrollerRNCSCLICommands

Table29

SCLICommands

alarmhistory-countfilter-by(Cont.)
Theevent-timewillbealwaysgreaterthanthealarm-time.
Thedifferencebetweenalarm-timeandevent-timecanbea
fewseconds,anddependsonthesystemload.Ifthealarmdetectingcomponentorapplicationsendsalarmnotifications
withanalarm-timeinthepast,thedifferencemightbeeven
morethanafewseconds.

fromnotification-id

Theparameter"from-notification-id"specifiesthe
startnotification-id
notification-idoftheeventwherethefetchstartsinthealarm
history.

NA

Everyalarmeventinthealarmhistoryhasitsownfixed
notificationID.Itisguaranteedthatforanytwoalarm
events,theonegeneratedlaterwillhaveanotificationID
withabiggervaluethantheonegeneratedearlier.This
characteristicofthenotificationIDmonotonouslygrowing
allowsaccuratefilteringbasedontherangeofthe
notificationIDs,eveninsituationswhenfilteringbasedon
timemaybecomeinaccuratebecauseof,forexample,
systemtimemovingbackwards.
Note:1."from-notification-id"shouldbelessthanorequalto
"to-notification-id".Otherwise,noeventswillberetrieved.2.
Parameters"from-notification-id"and"to-notification-id"are
usedtoselecttherangeofalarmhistoryeventsbasedon
thenotification-id.Thesearethealternativeto"from-eventtime"and"to-event-time"parameterswhichareusedto
selecttherangeofalarmhistoryeventsbasedontheevent
time.Bothwaysofselectingtherangecannotbeusedina
singlecommand.

identifyingapplicationadditional-info

managed-object

Theparameter"identifying-application-additional-info"
specifiestheidentifyingapplicationadditionalinfopatternof
thealarmeventstobematched.

identifyingapplication
additionalinfo

NA

managedobjectname

NA

Note:Thisparametersupportstheasteriskwildcard
character(*).Toescapetheasteriskandpreserveitsliteral
value,prefixitwithabackslash(\*).
Theparameter"managed-object"specifiesthemanaged
objectpatternofthealarmstobematched.
Note:Thisparametersupportstheasteriskwildcard
character(*).Toescapetheasteriskandpreserveitsliteral
value,prefixitwithabackslash(\*).

Issue:03B

127

SCLICommands

Table29

MulticontrollerRNCSCLICommands

alarmhistory-countfilter-by(Cont.)

managed-objectfull-name

Theparameter"managed-object-full-name"specifiesthe
managedobjectnameinfulldistinguishedname(DN)
pattern,ofthealarmstobematched.

managedobjectname
infullDNformat

NA

NA

Note:
-Thisparametersupportstheasteriskwildcardcharacter(*).
Toescapetheasteriskandpreserveitsliteralvalue,prefixit
withabackslash(\*).
-Whenusingauto-completion,entertheDNinreverse
order.
Theparameter"specific-problem"specifiesthespecific
problemofthealarmeventstobematched.

specificproblem

specific-problem

to-event-time

Theparameter"to-event-time"specifiestheendingtimeto
fetchthealarmhistoryevents.

endevent-timetofetch NA
alarmhistory;Date
formatisDD-MMYYYY.HH:MM:SS

Note:1."from-event-time"shouldbelessthanorequalto
"to-event-time".2.Parameters"from-event-time"and"toevent-time"refertotheevent-timeandnottothealarm-time
thatisactuallyvisibleintheoutputofthiscommand.The
event-timeisthetimewhenthealarmsystemhasgenerated
analarmeventasaresultofprocessinganalarm
notification.Ontheotherhand,thealarm-timeisthetime
whenthecomponentorapplicationdetectedthealarm
situationandsentanalarmnotificationforittotheAlarm
System.
Theevent-timewillbealwaysgreaterthanthealarm-time.
Thedifferencebetweenalarm-timeandevent-timecanbea
fewseconds,anddependsonthesystemload.Ifthealarmdetectingcomponentorapplicationsendsalarmnotifications
withanalarm-timeinthepast,thedifferencemightbeeven
morethanafewseconds.

to-notificationid

Theparameter"to-notification-id"specifiesthenotification-id
oftheeventwherethefetchendsinthealarmhistory.

endnotification-id

NA

Everyalarmeventinthealarmhistoryhasitsownfixed
notificationID.Itisguaranteedthatforanytwoalarm
events,theonegeneratedlaterwillhaveanotificationID
withabiggervaluethantheonegeneratedearlier.This
characteristicofthenotificationIDmonotonouslygrowing
allowsaccuratefilteringbasedontherangeofthe
notificationIDs,eveninsituationswhenfilteringbasedon
timemaybecomeinaccuratebecauseof,forexample,
systemtimemovingbackwards.
Note:1."from-notification-id"shouldbelessthanorequalto
"to-notification-id".Otherwise,noeventswillberetrieved.2.
Parameters"from-notification-id"and"to-notification-id"are
usedtoselecttherangeofalarmhistoryeventsbasedon
thenotification-id.Thesearethealternativeto"from-eventtime"and"to-event-time"parameterswhichareusedto
selecttherangeofalarmhistoryeventsbasedontheevent
time.Bothwaysofselectingtherangecannotbeusedina
singlecommand.

128

Issue:03B

MulticontrollerRNCSCLICommands

Table29

SCLICommands

alarmhistory-countfilter-by(Cont.)

Command

Dependency
None

show alarm history-count {[include-heartbeat-alarms <INCLUDEHEARTBEAT-ALARMS>]?} filter-by {[alarm-id <ALARM-ID>]?


[specific-problem <SPECIFIC-PROBLEM>]? [from-event-time <FROMEVENT-TIME>]? [to-event-time <TO-EVENT-TIME>]? [fromnotification-id <FROM-NOTIFICATION-ID>]? [to-notification-id
<TO-NOTIFICATION-ID>]? [managed-object <MANAGED-OBJECT>]?
[managed-object-full-name <MANAGED-OBJECT-FULL-NAME>]?
[application-id <APPLICATION-ID>]? [application-additional-info
<APPLICATION-ADDITIONAL-INFO>]? [identifying-applicationadditional-info <IDENTIFYING-APPLICATION-ADDITIONAL-INFO>]?
[acknowledged <ACKNOWLEDGED>]? [cleared <CLEARED>]?}

2.1.11 alarm manual


Table30

alarmmanual

Description
Thiscommandshowsthealarmmanualforthealarmtype.
Note:Thealarmtestinstructionsisnotpartofthealarmmanualbutisdisplayedusing"showalarmtest-instructions"
command.
Parameter

Hint

Range

Default

Theparameter"specific-problem"specifiesthespecific
problemforwhichthealarmmanualistobefetched.

specificproblemfor
whichalarmmanual
information

NA

specific-problem

Command

Dependency
None

show alarm manual {specific-problem <SPECIFIC-PROBLEM>}

2.1.12 alarm notification-id


Table31

alarmnotification-id

Description
ThiscommandshowsallnotificationIDsofaspecificalarm.
Parameter

Issue:03B

Hint

Range

Default

129

SCLICommands

Table31

MulticontrollerRNCSCLICommands

alarmnotification-id(Cont.)
Theparameter"alarm-id"specifiesthealarmIDofthe
alarmstobefetched.

alarmID

NA

alarm-id

Theparameter'from-index'specifiesthestartingindexof
notificationidentifiersintheAlarmSystemtobefetched.

startindexof
notificationidentifiers

NA

from-index

Theparameter'how-many'specifiesthenumberof
notificationidentifiersintheAlarmSystemtobefetched.

numberofnotification
identifierstobeshown

NA

how-many
Command

Dependency
None

show alarm notification-id {alarm-id <ALARM-ID> [from-index


<STARTING-INDEX-FOR-FETCHING-RECORDS>]? [how-many <HOW-MANYRECORDS-SHOULD-BE-FETCHED>]?}

2.1.13 alarm probable-causes


Table32

alarmprobable-causes

Description
Thiscommandshowstheprobablecausesusedinthealarmsystem.
Parameter

Hint

Command

Range

Default

Dependency
None

show alarm probable-causes

2.1.14 alarm raise


Table33

alarmraise

Description
Thiscommandraisesanalarmwiththespecifiedfiltercriteria.
Parameter

applicationadditional-info

application-id

Hint

Range

Default

Theparameter"application-additional-info"specifiesthe
additionalinformationofthealarmtoberaised.

applicationadditional
information

NA

Theparameter"application-id"specifiestheapplicationIDof applicationID
thealarmtoberaised.

NA

Theparameter"event-time"specifiesthetimetoraisealarm. eventtimeofalarm

NA

event-time

130

Issue:03B

MulticontrollerRNCSCLICommands

Table33

SCLICommands

alarmraise(Cont.)
Note:Alarmtimeshouldnotbegivenforflexiplatform
internalalarms.
Theacceptabledateformatis"DD-MM-YYYY.HH:MM:SS",
where:DD:dayofthemonth,
MM:monthoftheyear,
YYYY:year,
HH:hour,
MM:minute,
SS:second
Theparameter"identifying-application-additional-info"
identifyingapplication
specifiestheadditionalinformationofthealarmtoberaised. additionalinformation
Theacceptedvalueisstringofcharacters.

NA

Theparameter"managed-object"specifiesmanagedobject
identifierofthealarmtoberaised.

managedobjectname

NA

managed-object

Theparameter"managed-object-full-name"specifiesthe
managedobjectdistinguishedname(DN)patternofthe
alarmtoberaised.

managedobject
patterninDNformat

NA

managed-objectfull-name

Theparameter"severity"specifiesseverityofthealarmto
beraised.

severity

NA

severity

Theparameter"specific-problem"specifiesthespecific
problemofthealarmtoberaised.

specificproblem

NA

specific-problem

identifyingapplicationadditional-info

Command

Dependency
None

set alarm raise {specific-problem <SPECIFIC-PROBLEM>


application-id <APPLICATION-ID> {managed-object <MANAGEDOBJECT> managed-object-full-name <MANAGED-OBJECT-FULL-NAME>}+
[identifying-application-additional-info <IDENTIFYINGAPPLICATION-ADDITIONAL-INFO>]? [event-time <EVENT-TIME>]?
[severity <SEVERITY>]? [application-additional-info
<APPLICATION-ADDITIONAL-INFO>]?}

2.1.15 alarm recovery-history


Table34

alarmrecovery-history

Description
Thiscommandshowsallrecoveryhistoryeventsstoredinthealarmsystem.
Parameter

Issue:03B

Hint

Range

Default

131

SCLICommands

Table34

MulticontrollerRNCSCLICommands

alarmrecovery-history(Cont.)

Command

Dependency
None

show alarm recovery-history


None
show alarm recovery-history filter-by {[action-type <ACTIONTYPE>]* [managed-object <MANAGED-OBJECT>]? [managed-objectfull-name <MANAGED-OBJECT-FULL-NAME>]? [mo-type <MO-TYPE>]?
[from-event-time <FROM-EVENT-TIME>]? [to-event-time <TO-EVENTTIME>]?}

2.1.15.1
Table35

alarm recovery-history filter-by

alarmrecovery-historyfilter-by

Description
Thiscommandshowsthealarmrecoveryhistorydatabasedonthefilteringoptions.
Parameter

Hint

Range

Default

Theparameter"action-type"specifiestheactiontypeofthe
recoveryhistoryeventstobefetched.ActiontypesareHAS
actionslikeshutdown,restart,andsoon.

actiontypesuchas
lock,unlockor
switchover

NA

action-type

from-event-time

Theparameter"from-event-time"specifiesthestartingtime
fromwhichtherecoveryhistoryeventsaretobefetched.
ThedateformatisDD-MM-YYYY.HH:MM:SS.

starttimetofetch
NA
alarmrecoveryhistory;
DateformatisDD-MMYYYY.HH:MM:SS

Theparameter"managed-object"specifiesthemanaged
objectnameoftherecoveryhistoryeventstobefetched.

managedobjectname

NA

managed-object

Theparameter"managed-object-full-name"specifiesthe
managedobjectoftherecoveryhistoryevents,in
distinguishedname(DN)format,tobefetched.

managedobjectname
inDNformat

NA

managed-objectfull-name

Theparameter"mo-type"specifiesthemanagedobjecttype
oftherecoveryhistoryeventstobefetched.

managedobjectof
typeHAS

NA

mo-type

Theparameter"to-event-time"specifiestheendtimeto
whichtherecoveryhistoryeventsaretobefetched.The
dateformatisDD-MM-YYYY.HH:MM:SS.

endtimetofetchalarm NA
recoveryhistory;Date
formatisDD-MMYYYY.HH:MM:SS

to-event-time

Command

Dependency
None

show alarm recovery-history filter-by {[action-type <ACTIONTYPE>]* [managed-object <MANAGED-OBJECT>]? [managed-objectfull-name <MANAGED-OBJECT-FULL-NAME>]? [mo-type <MO-TYPE>]?

132

Issue:03B

MulticontrollerRNCSCLICommands

Table35

SCLICommands

alarmrecovery-historyfilter-by(Cont.)

[from-event-time <FROM-EVENT-TIME>]? [to-event-time <TO-EVENTTIME>]?}

2.1.16 alarm specific-problems


Table36

alarmspecific-problems

Description
Thiscommandshowsallthespecificproblemsinthealarmsystem.
Parameter

from-index

how-many

Hint

Range

Default

Theparameter"from-index"specifiesthestartingindex
numberforretrievingthealarmrecords.Alarmrecordsare
displayedfromtheparticularrownumberasspecifiedinthis
parameter.

startindexnumberfor
retrievingthealarm
records

NA

Theparameter"how-many"specifiesthecountofalarmsto
befetched.

numberofrecordsto
beshown

NA

Command

Dependency
None

show alarm specific-problems {[from-index <STARTING-INDEX-FORFETCHING-RECORDS>]? [how-many <HOW-MANY-RECORDS-SHOULD-BEFETCHED>]?}

2.1.17 alarm test-instructions


Table37

alarmtest-instructions

Description
Thiscommandshowsthealarmtestinstructions.
Parameter

Hint

Range

Default

Theparameter"specific-problem"specifiesthespecific
problemforwhichthealarmtestinstructionsinformationto
befetched.

specificproblem

NA

specific-problem

Command

Dependency
None

show alarm test-instructions {specific-problem <SPECIFICPROBLEM>}

Issue:03B

133

SCLICommands

MulticontrollerRNCSCLICommands

2.1.18 alarm type


Table38

alarmtype

Description
add
Thiscommandaddsnewalarmtype(s).
set
Thiscommandupdatestheinformationofexistingalarmtypedefinitionparameterswiththespecifiedvalues.Thealarm
typedefinitionisupdatedforagivenspecificproblem.
show
Thiscommandshowsthealarmtypeinformationinthealarmsystem.
Parameter

Hint

Theparameter"auto-acknowledged"allowstwostates,on
auto-acknowledged andoff.Ifonthenalarmisacknowledgedautomatically
whencleared.Ifoffthenalarmwillnotbeacknowledged
whencleared.

Range

Default

autoacknowledged
state

NA

Theparameter"clearing-delay"updatestheclearingdelayof clearingdelay
thealarminmilliseconds.

NA

clearing-delay

Theparameter"default-severity"updatestheseverityofthe
alarm.Theacceptedrangeforthisparameteris[2..5].

defaultseverity

NA

default-severity

Theparameter"informing-delay"updatestheinforming
delayperiodofthealarms.

informingdelay

NA

informing-delay

set

specificproblem

NA

Theparameter"switch-over-update"specifiesiftheactive
alarmistobeupdatedintothenewactiveunitbythealarm
systemwhenaunitswitchovertakesplace.Alarmswith
emptyswitchoverupdatevaluearecleared.

switchoverupdate

NA

Theparameter"time-to-live"updatesthelifetimeofthe
alarmsinmilliseconds.Ifthetimetolivevalueisnot
specified,thealarmstaysactiveuntilitisexplicitlycleared
eitherbytheapplicationthatraiseditorbytheuser.

timetolive

NA

specific-problem

Theparameter"specific-problem"specifiesthespecific
problemofthealarmtobeupdated.
show
Theparameter"specific-problem"specifiesthespecific
problemforwhichthealarmtypeinformationistobe
fetched.

switch-overupdate

time-to-live

Command

Dependency
None

set alarm type {specific-problem <SPECIFIC-PROBLEM> {default-

134

Issue:03B

MulticontrollerRNCSCLICommands

Table38

SCLICommands

alarmtype(Cont.)

severity <SEVERITY> auto-acknowledged <AUTO-ACKNOWLEDGED>


switch-over-update <SWITCH-OVER-UPDATE> clearing-delay
<CLEARING-DELAY> informing-delay <INFORMING-DELAY> time-to-live
<TIME-TO-LIVE>}+}
None
show alarm type {specific-problem <SPECIFIC-PROBLEM>}
None
add alarm type from-directory {dir-path <DIR-PATH>}
None
add alarm type from-file {file-path <FILE-PATH>}

2.1.18.1
Table39

alarm type from-directory

alarmtypefrom-directory

Description
Thiscommandaddsanewalarmtype(s)fromthespecifieddirectorypath.
Parameter

Hint

Range

Default

Theparameter"dir-path"specifiestheabsolutedirectory
pathofthealarmtypefilesonthegivendirectory.

absolutedirectorypath NA

dir-path

Iftheuserisroot,thenplacethefile(s)underthe"/home"
directory.
Command

Dependency
None

add alarm type from-directory {dir-path <DIR-PATH>}

2.1.18.2
Table40

alarm type from-file

alarmtypefrom-file

Description
Thiscommandaddsanewalarmtypefromthespecifiedfile(s)underhomedirectory.
Parameter

Hint

Range

Default

Theparameter"file-path"specifiestheabsolutepathofthe
alarmtypefile(s)underthehomedirectory.

absolutefilepath
underhomedirectory

NA

file-path

Ifuserisroot,thenplacethefile(s)underthe"/home"
directory.

Issue:03B

135

SCLICommands

Table40

MulticontrollerRNCSCLICommands

alarmtypefrom-file(Cont.)

Command

Dependency
None

add alarm type from-file {file-path <FILE-PATH>}

2.1.19 alarm type-all


Table41

alarmtype-all

Description
Thiscommandshowsallthealarmtypesinthealarmsystem.
Parameter

Hint

Range

Default

Theparameter"from-index"specifiesthestartingalarm
indexfromwhichthealarmtypesaretobefetched.

startindexofalarm
types

NA

from-index

Theparameter"how-many"specifiesthenumberofalarms
typestobefetched.

numberofalarmtypes
tobeshown

NA

how-many
Command

Dependency
None

show alarm type-all {[from-index <STARTING-INDEX-FOR-FETCHINGRECORDS>]? [how-many <HOW-MANY-RECORDS-SHOULD-BE-FETCHED>]?}

2.1.20 alarm type-restore-defaults


Table42

alarmtype-restore-defaults

Description
Thiscommandrestoresthedefaultalarmtypedefinitionforspecificproblem.
Parameter

Hint

Range

Default

Theparameter"specific-problem"specifiesthespecific
problemnumberofthealarmtoberestored.

specificproblemfor
whichthedefault
parametersare
restored

NA

specific-problem

Command

Dependency
None

set alarm type-restore-defaults {specific-problem <SPECIFICPROBLEM>}

136

Issue:03B

MulticontrollerRNCSCLICommands

SCLICommands

2.1.21 alarm unacknowledge


Table43

alarmunacknowledge

Description
Thiscommandunacknowledgesthealarmthatwasalreadyacknowledged.
Parameter

Hint

Range

Default

Theparameter"alarm-id"specifiesthealarmIDtobe
unacknowledged.

alarmidentifier

NA

alarm-id

Note:Comma-separatedvaluesareallowedforthevalueof
theparameter"alarm-id".Forexample:5,6,7,andsoon.
Command

Dependency
None

set alarm unacknowledge {alarm-id <ALARM-ID>}

2.2 app-parameter
Table44

app-parameter

Description
set
Thiscommandisusedforchangingthevalueofaconfigurationparameter,
andforactivatingordeactivatinganoptionalfeature.
show
Thiscommandisusedforshowingthevalueofaconfigurationparameter,
ortheactivationstatusofanoptionalfeature.
Parameter

Hint

Command

Range

Default

Dependency
None

set app-parameter configuration-parameter {class <class_id>


number <parameter_number> value <parameter_value>}
None
set app-parameter feature-optionality {class <class_id> number
<parameter_number> activation-status <parameter_status>}
None
show appparameter

Issue:03B

137

SCLICommands

Table44

MulticontrollerRNCSCLICommands

app-parameter(Cont.)

configurationparameter {[class
<class_id>]?
[number
<parameter_number
>]?}
None
show appparameter
featureoptionality
{[class
<class_id>]?
[number
<parameter_number
>]?}

2.2.1 app-parameter configuration-parameter


Table45

app-parameterconfiguration-parameter

Description
set
Thiscommandisusedforchangingthevalueofaconfigurationparameter.
show
Thiscommandisusedforshowingthevalueofaconfigurationparameter.
Parameter

class

Hint

Range

Default

set

0..254

NA

0..9999

NA

Theparameterspecifiestheclassvalueoftheconfigurable
parameter.
Thevalueisgivenindecimalformat.
show
Theparameterspecifiestheclassvalueoftheconfiguration
parameter.
Thevalueisgivenindecimalformat.
set

number

Theparameterspecifiesthenumbervalueofthe
configurableparameter.
Thevalueisgivenindecimalformat.
show

138

Issue:03B

MulticontrollerRNCSCLICommands

Table45

SCLICommands

app-parameterconfiguration-parameter(Cont.)
Theparameterspecifiesthenumbervalueofthe
configurationparameter.
Thevalueisgivenindecimalformat.

value

Theparameteristhenewvalueoftheconfiguration
parameter.

0..FF00

NA

Thegivenvalueisinterpretedasahexadecimalnumber.
Theoreticallyallowedvaluerangeis0..FF00.
Pleasechecktheallowedvaluesforthisparameterfromthe
documentationofthePRFILEparameters.
Command

Dependency
None

set app-parameter configuration-parameter {class <class_id>


number <parameter_number> value <parameter_value>}
None
show app-parameter configuration-parameter {[class <class_id>]?
[number <parameter_number>]?}

2.2.2 app-parameter feature-optionality


Table46

app-parameterfeature-optionality

Description
set
Thiscommandisusedforactivatingordeactivatinganoptionalfeature.
show
Thiscommandisusedforshowingtheactivationstatusofanoptionalfeature,whichiscontrolledbyaconfiguration
parameter.hevalueofaconfigurationparameter.
Parameter

Hint

Theparameteristhenewdesiredactivationstatusofthe
activation-status optionalfeature.

Range

Default

featureactivation
status

NA

0..254

NA

Itcanbeeither"deactivated"or"activated".

class

Theparameterspecifiestheclassvalue,whichisusedfor
controllinganoptionalfeature.
Thevalueisgivenindecimalformat.

number

Theparameterspecifiesthenumbervalue,whichisusedfor 0..9999
controllinganoptionalfeature.

NA

Thevalueisgivenindecimalformat.

Issue:03B

139

SCLICommands

Table46

MulticontrollerRNCSCLICommands

app-parameterfeature-optionality(Cont.)

Command

Dependency
None

set app-parameter feature-optionality {class <class_id> number


<parameter_number> activation-status <parameter_status>}
None
show app-parameter feature-optionality {[class <class_id>]?
[number <parameter_number>]?}

2.3 backup
Table47

backup

Description
add
Thiscommandallowstheuserstoselectthebackupentities.
Note:
1)Thiscommandshouldonlybeusedwithselectivebackupsession.
2)Duplicateentitiesshouldnotbeselected.
Forexample,
Configvolumeisduplicatedinthefollowingcommandsresultinginanappropriateerrormessage:
>startbackupselective
>addbackupconfigall
>addbackupconfigall
Configvolumeisalreadyselected
Thebelowcommandsresultinsuccessfulbackup.
>startbackupselective
>addbackupconfigall
>commitbackup
commit
Thiscommandbacksupthespecifiedcontents(softwaredeliveries,configurationdata,statevolumes,databases,
applicationfilesystems)fromthesystem.TheresultofthebackupprocessisanISOimage,whichwillbelocatedinthe
directory/backup.Backuplogfilesareavailableat"/share"directory.
delete
Thiscommanddeletesthebackupobjectspresentinthebackupdirectory.
rollback
Thiscommandterminatestheactivebackupsession.
start

140

Issue:03B

MulticontrollerRNCSCLICommands

Table47

SCLICommands

backup(Cont.)

Thiscommandstartsanewbackupsession.Thefollowingtypesofbackupsaresupported.
1.full:Fullbackupprovidesacopyofsoftwaredeliveries,configurationdata,themasterstatevolume,databases,
applicationfilesystemsandadditionalentitiesthroughplug-ins.
2.selective:Selectivebackupprovidesanoptiontocopyoneormoreofthefollowingentities:Softwaredeliveries,configurationdata,themasterstatevolume,databases,applicationfilesystemsandadditionalentities
throughplug-ins.
3.partial:Partialbackupresemblesfullbackup,butitdoesnotincludesoftwaredeliveries.
4.active:Activebackupresemblesfullbackup,butitdoesnotincludenon-activedeliveriesandtheactive-delivery'snonactiveconfigurations.
Note1:
1.1)Plug-insarecustomscripts,thatimplementsthebackupandrestorelogicforadditionalentitieslikehomedirectory
contents,useraccountinformation,etc.
ForExample:
Homedirectoriesarebackedupusingtheplug-inbu_home.sh.Similarlyuseraccountinformationarebackedupusingthe
plug-inbu_ldapuser.sh.
1.2)Thiscommanddoesnotactuallycreatethebackup,itonlycreatesasession.Tocreatethebackup,execute"commit
backup"commandinthesubsequentsteps.
Forexample:
a)Tocreateafullbackup,executethefollowingcommands:
>startbackupfull
>commitbackup
b)Tocreateaselectivebackupofallthedatabasesandapplicationfilesystems,executethefollowingcommands:
>startbackupselective
>addbackupdatabase
>addbackupfilesystem
>commitbackup
c)Tocreateapartialbackup,executethefollowingcommands:
>startbackuppartial
>commitbackup
d)Tocreateanactivebackup,executethefollowingcommands:
>startbackupactive
>commitbackup
Note2:
Backupandrestorationlogfilesareavailablein"/share"directory.
Parameter

Issue:03B

Hint

Range

Default

141

SCLICommands

Table47

MulticontrollerRNCSCLICommands

backup(Cont.)
Thiscommandallowsoperatortospecifytheloglevel
displayedontheconsoleduringbackup.

Logsthemessages
withthespecificlog
leveltotheconsole.

NA

log-level

Thiscommanddisplaystheexecutiondetailsofthecommit
backupsessionwithoutperformingtheactualbackup.

Printstheexecution
detailstotheconsole
withoutactual
execution.

NA

no-exec

Command

Dependency
None

commit backup {[no-exec]? [log-level <select mode>]?}


None
rollback backup
None
add backup config {[startup]?} all
None
add backup config {[startup]?} current
None
add backup config {[startup]?} label [<label>]+
None
add backup database
None
add backup database db-name [<db-name>]+
None
add backup delivery {[no-config]?} all
None
add backup delivery {[no-config]?} current
None
add backup delivery {[no-config]?} label [<label-name>]+

2.3.1 backup active


Table48

backupactive

Description

142

Issue:03B

MulticontrollerRNCSCLICommands

Table48

SCLICommands

backupactive(Cont.)

Thiscommandstartsanactivebackupsession.Activebackupcreatesacopyoftheactivesoftwaredelivery,itsactive
configurationdata,themasterstatevolume,databases,applicationfilesystemsandcontentsbackedupthroughplugins.
Anactivebackuparchiveissimilartoafullbackuparchiveexcludingthenon-activedeliveries,theircorresponding
configurationsnapshots,andtheactiveSWdelivery'snon-activeconfigurationsnapshots.
An"activebackuparchive"highlydiffersfroma"partialbackuparchive"sincetheformeradditionallyincludestheactivedeliveryandincludesonlytheactiveconfigurationsnapshot.
Theactivebackuparchivecanbeusedwithfull/partial/selectiverestore.
Forexample:
Tocreateanactivebackup,executethefollowingcommandsinorder:
1.startbackupactive
2.commitbackup
Parameter

Hint

Command

Range

Default

Dependency
None

start backup active

2.3.2 backup backup-iso


Table49

backupbackup-iso

Description
Deletesthebackupimages(ISO).
Parameter

Hint

Command

Range

Default

Dependency
None

delete backup backup-iso all


None
delete backup backup-iso image [<backup-iso-name>]+

2.3.2.1
Table50

backup backup-iso all

backupbackup-isoall

Description
Deletesallthebackupimages(ISOs)presentinthebackupdirectory.
Parameter

Issue:03B

Hint

Range

Default

143

SCLICommands

Table50

MulticontrollerRNCSCLICommands

backupbackup-isoall(Cont.)

Command

Dependency
None

delete backup backup-iso all

2.3.2.2
Table51

backup backup-iso image

backupbackup-isoimage

Description
Deletesthebackupimage(ISO)provided.
Parameter

Hint

Command

Range

Default

Dependency
None

delete backup backup-iso image [<backup-iso-name>]+

2.3.2.2.1
Table52

backup backup-iso image <backup-iso-name>

backupbackup-isoimage<backup-iso-name>

Description
selectthebackupimage(ISO)name/s.
Parameter

Hint

Command

Range

Default

Dependency
None

delete backup backup-iso image [<backup-iso-name>]+

2.3.3 backup config


Table53

backupconfig

Description
Thiscommandbacksupconfigurationdata.Theoperatorcanselectivelybackuptheconfigurationdataassociatedwith
thesoftwaredeliveriesusingthefollowingoptions:
1.startup:Backsupthestartupconfigurationdata.
2.all:Backsupalltheconfigurationdata.
3.current:Backsuptheconfigurationdataassociatedwiththeactivesoftwaredelivery.
4.label:Backsuptheconfigurationdataassociatedwiththespecificsoftwaredeliverylabel.

144

Issue:03B

MulticontrollerRNCSCLICommands

Table53

SCLICommands

backupconfig(Cont.)

Parameter

Hint

Range

Default

Thiscommandallowstheselectivebackupofthestartup
configurationdataassociatedwiththeinstalledsoftware
deliveries.

Addsthestartup
configurationdatato
thebackupsession.

NA

startup

Command

Dependency
None

add backup config {[startup]?} all


None
add backup config {[startup]?} current
None
add backup config {[startup]?} label [<label>]+

2.3.3.1
Table54

backup config all

backupconfigall

Description
Thiscommandallowsthebackupofallconfigurationdataassociatedwiththeinstalledsoftwaredeliveries.Ifusedwiththe
optionalparameterstartup,thiscommandallowsthebackupofallthestartupconfigurationdataassociatedwiththe
installedsoftwaredeliveries.
Parameter

Hint

Command

Range

Default

Dependency
None

add backup config {[startup]?} all

2.3.3.2
Table55

backup config current

backupconfigcurrent

Description
Thiscommandallowsthebackupofconfigurationdataassociatedwiththeactivesoftwaredelivery.Ifusedwiththe
optionalparameterstartup,thiscommandallowsthebackupofthestartupconfigurationdataassociatedwiththeactive
softwaredelivery.
Parameter

Issue:03B

Hint

Range

Default

145

SCLICommands

Table55

MulticontrollerRNCSCLICommands

backupconfigcurrent(Cont.)

Command

Dependency
None

add backup config {[startup]?} current

2.3.3.3
Table56

backup config label

backupconfiglabel

Description
Thiscommandallowsthebackupofconfigurationdataassociatedwiththespecificsoftwaredeliverylabel.Ifusedwiththe
optionalparameterstartup,thiscommandallowsthebackupofthestartupconfigurationdataassociatedwiththespecific
softwaredeliverylabel.
Parameter

Hint

Command

Range

Default

Dependency
None

add backup config {[startup]?} label [<label>]+

2.3.3.3.1
Table57

backup config label <label>

backupconfiglabel<label>

Description
Thiscommandallowsthebackupofalltheconfigurationdataassociatedwiththespecificsoftwaredeliverylabel.Ifused
withtheoptionalparameterstartup,thiscommandallowsthebackupofthestartupconfigurationdataassociatedwiththe
specificsoftwaredeliverylabel.
Parameter

Hint

Command

Range

Default

Dependency
None

add backup config {[startup]?} label [<label>]+

2.3.4 backup database


Table58

backupdatabase

Description
Thiscommandallowsthebackupofdatabases.Bydefaultallthedatabasesarebackedup.Operatorcanalsospecify
namesofdatabasestobebackedupbyprovidingthedatabasenameasaparameterinthecommand.
Note:

146

Issue:03B

MulticontrollerRNCSCLICommands

Table58

SCLICommands

backupdatabase(Cont.)

EachdatabaseisassociatedwithaRecoveryGroup,whichmustbeinunlockedstateforthesuccessfulcompletionof
databasebackup.
Parameter

Hint

Command

Range

Default

Dependency
None

add backup database


None
add backup database db-name [<db-name>]+

2.3.4.1
Table59

backup database db-name

backupdatabasedb-name

Description
Specifythenameofthedatabasetobebackedup.
Note:
1)DatabaseRecoveryGroupnamecouldbedifferentfromthedatabasename.
2)Operatorcanspecifymultipledatabasenamesinasingleadd-command.
Forexample,
>addbackupdatabasedb-nameDB_AlarmDB_TestMySQL
Parameter

Hint

Command

Range

Default

Dependency
None

add backup database db-name [<db-name>]+

2.3.4.1.1
Table60

backup database db-name <db-name>

backupdatabasedb-name<db-name>

Description
Specifythenameofthedatabasetobebackedup.
Note:
1)DatabaseRecoveryGroupnamecouldbedifferentfromthedatabasename.
2)Operatorcanspecifymultipledatabasenamesinasingleadd-command.
Forexample,
>addbackupdatabasedb-nameDB_AlarmDB_TestMySQL

Issue:03B

147

SCLICommands

Table60

MulticontrollerRNCSCLICommands

backupdatabasedb-name<db-name>(Cont.)

Parameter

Hint

Command

Range

Default

Dependency
None

add backup database db-name [<db-name>]+

2.3.5 backup delivery


Table61

backupdelivery

Description
Thiscommandallowstheselectivebackupofsoftwaredeliveriesandtheirassociatedconfigurationdatausingthe
followingoptions:
1)no-config:Backsupthesoftwaredeliveriesexcludingtheconfigurationdata.
2)all:Backsupallthesoftwaredeliveriesandtheirconfigurationdata.
3)current:Backsupactivesoftwaredeliveryanditsconfigurationdata.
4)label:Backsupsoftwaredeliveryanditsconfigurationdataassociatedwiththespecificdeliverylabel.
Parameter

Hint

Range

no-config

Thiscommandallowstheselectivebackupofsoftware
deliveries,excludingtheconfigurationdata.

Excludesconfiguration NA
datafromthebackup
session.

Command

Default

Dependency
None

add backup delivery {[no-config]?} all


None
add backup delivery {[no-config]?} current
None
add backup delivery {[no-config]?} label [<label-name>]+

2.3.5.1
Table62

backup delivery all

backupdeliveryall

Description
Thiscommandallowsthebackupofallthesoftwaredeliveriesandtheirconfigurationdata.Ifusedwiththeoptional
parameterno-config,theconfigurationdataisexcludedfromthebackupsession.
ForExample:
Thefollowingcommandsbackupallthesoftwaredeliveriesandtheirconfigurationdata.

148

Issue:03B

MulticontrollerRNCSCLICommands

Table62

SCLICommands

backupdeliveryall(Cont.)

>startbackupselective
>addbackupdeliveryall
>commitbackup
Thefollowingcommandsexcludeconfigurationdatafromthebackup.
>startbackupselective
>addbackupdeliveryno-configall
>commitbackup
Parameter

Hint

Command

Range

Default

Dependency
None

add backup delivery {[no-config]?} all

2.3.5.2
Table63

backup delivery current

backupdeliverycurrent

Description
Thiscommandallowsthebackupofcurrentsoftwaredeliveryanditsconfigurationdata.Ifusedwiththeoptionalparameter
no-config,theconfigurationdataisexcludedfromthebackupsession.
Parameter

Hint

Command

Range

Default

Dependency
None

add backup delivery {[no-config]?} current

2.3.5.3
Table64

backup delivery label

backupdeliverylabel

Description
Thiscommandallowsthebackupofthesoftwaredeliveryanditsconfigurationdata,associatedwiththespecificsoftware
deliverylabel.Ifusedwiththeoptionalparameterno-config,configurationdataassociatedwiththespecificsoftwarelabel
isexcludedfromthebackupsession.
ForExample,
TocreatebackupofsoftwaredeliveryR_FSPR5LYNX_1.21.1.52.atca64.r.1108161711.233886,executefollowing
commands:
>startbackupselective
>addbackupdeliverylabelR_FSPR5LYNX_1.21.1.52.atca64.r.1108161711.233886
>commitbackup

Issue:03B

149

SCLICommands

Table64

MulticontrollerRNCSCLICommands

backupdeliverylabel(Cont.)

Parameter

Hint

Command

Range

Default

Dependency
None

add backup delivery {[no-config]?} label [<label-name>]+

2.3.5.3.1
Table65

backup delivery label <label-name>

backupdeliverylabel<label-name>

Description
Thiscommandallowsthebackupofthesoftwaredeliveryandconfigurationdataassociatedwiththespecificsoftware
deliverylabel.Ifusedwiththeoptionalparameterno-config,configurationdataassociatedwiththespecificsoftwarelabel
isexcludedfromthebackupsession.
Parameter

Hint

Command

Range

Default

Dependency
None

add backup delivery {[no-config]?} label [<label-name>]+

2.3.6 backup filesystem


Table66

backupfilesystem

Description
Thiscommandallowsthebackupoffilesystems.Bydefaultallthefilesystemsarebackedup.Operatorcanalsospecify
thefilesystemstobebackedupbyprovidingtheassociatedRecoveryGroup(RG)nameasaparameterinthiscommand.
ForExample,
Tocreatebackupofallfilesystems,executefollowingcommands:
>startbackupselective
>addbackupfilesystem
>commitbackup
Parameter

Hint

Command

Range

Default

Dependency
None

add backup filesystem


None
add backup filesystem rg-name [<rg-name>]+

150

Issue:03B

MulticontrollerRNCSCLICommands

2.3.6.1
Table67

SCLICommands

backup filesystem rg-name

backupfilesystemrg-name

Description
Thiscommandallowsthebackupofspecificfilesystems,bygivingtheappropriateRecoverygroup(RG)names.
Note:
OperatorcanspecifymultipleRGnamesinasingleadd-command.>addbackupfilesystemrg-nameCLMPM9
Parameter

Hint

Command

Range

Default

Dependency
None

add backup filesystem rg-name [<rg-name>]+

2.3.6.1.1
Table68

backup filesystem rg-name <rg-name>

backupfilesystemrg-name<rg-name>

Description
Thiscommandallowsthebackupofspecificfilesystems,bygivingtheappropriateRecoverygroup(RG)name.
Note:
OperatorcanspecifymultipleRGnamesinasingleadd-command.>addbackupfilesystemrg-nameCLMPM9
Parameter

Hint

Command

Range

Default

Dependency
None

add backup filesystem rg-name [<rg-name>]+

2.3.7 backup full


Table69

backupfull

Description
Thiscommandstartsafullbackupsession.Fullbackupcreatesacopyofsoftwaredeliveries,configurationdata,the
masterstatevolume,databases,applicationfilesystemsandadditionalentitiesthroughplug-ins.
Forexample:
Tocreateafullbackup,executethefollowingcommandsinorder:
1.startbackupfull
2.commitbackup
Parameter

Issue:03B

Hint

Range

Default

151

SCLICommands

Table69

MulticontrollerRNCSCLICommands

backupfull(Cont.)

Command

Dependency
None

start backup full

2.3.8 backup partial


Table70

backuppartial

Description
Thiscommandstartsapartialbackupsession.
Partialbackupresemblesfullbackup,buttheformerdoesnotincludesoftwaredeliveries.
Forexample:
Tocreateapartialbackup,executethefollowingcommandsinorder:
1.startbackuppartial
2.commitbackup
Parameter

Hint

Command

Range

Default

Dependency
None

start backup partial

2.3.9 backup plugin


Table71

backupplugin

Description
Thiscommandallowsthebackupofadditionalentitiesthroughplug-ins.
Note:
Plug-insarecustomscripts,thatimplementsthebackupandrestorelogicforadditionalentitieslikehomedirectory
contents,useraccountinformation,etc.
ForExample:
Homedirectoriesarebackedupusingtheplug-inbu_home.sh.Similarlyuseraccountinformationarebackedupusingthe
plug-inbu_ldapuser.sh.
Parameter
Command

152

Hint

Range

Default

Dependency

Issue:03B

MulticontrollerRNCSCLICommands

Table71

SCLICommands

backupplugin(Cont.)
None

add backup plugin


None
add backup plugin plugin-name [<plugin-name>]+

2.3.9.1
Table72

backup plugin plugin-name

backuppluginplugin-name

Description
Thiscommandallowstheexecutionofthespecificplug-in.Operatorcanalsospecifymultipleplug-insinasingleadd
command.
ForExample:
Belowcommandsbackupthehomedirectoriesandflexiuserinformation.
>startbackupselective
>addbackuppluginplugin-namebu_home.shbu_ldapuser.sh
>commitbackup
Parameter

Hint

Command

Range

Default

Dependency
None

add backup plugin plugin-name [<plugin-name>]+

2.3.9.1.1
Table73

backup plugin plugin-name <plugin-name>

backuppluginplugin-name<plugin-name>

Description
Thiscommandallowstheexecutionofthespecificplug-in.Operatorcanalsospecifymultipleplug-insinasingleadd
command.
ForExample:
Belowcommandsbackupthehomedirectoriesandflexiuserinformation.
>startbackupselective
>addbackuppluginplugin-namebu_home.shbu_ldapuser.sh
>commitbackup
Parameter

Issue:03B

Hint

Range

Default

153

SCLICommands

Table73

MulticontrollerRNCSCLICommands

backuppluginplugin-name<plugin-name>(Cont.)

Command

Dependency
None

add backup plugin plugin-name [<plugin-name>]+

2.3.10 backup selective


Table74

backupselective

Description
Thiscommandstartsaselectivebackupsession.Selectivebackupprovidesanoptiontocopyoneormoreofthefollowing
entities:
Softwaredeliveries,configurationdata,themasterstatevolume,databases,applicationfilesystemsandadditionalentities
throughplug-ins.
Forexample:
Tocreateaselectivebackupofmasterstatevolumeexecutethefollowingcommandsinorder:
1.startbackupselective
2.addbackupstate
3.commitbackup
Parameter

Hint

Command

Range

Default

Dependency
None

start backup selective

2.3.11 backup state


Table75

backupstate

Description
Masterstatevolume(/mnt/mstate)isusedtostorepersistentdata.Thestatevolumebackupfeaturewillbackupthe
contentsofthisdirectory.Theoperatorcanselectivelybackupthecontentsofmasterstatevolumeusingincludefile/exclude-fileoptions.Toestablishthelistoffilestobebackedup,thefollowingalgorithmisapplied.
(1)Iftheinclude-fileoptionisspecified(withorwithoutexclude-fileoption),startwithanemptylistoffiles.Otherwise(i.eno
optionisspecifiedoronlytheexcludefileoptionisspecified)startwiththelistoffilesinthemasterstatevolume.
(2)Tothelistobtainedfromstep(1)applytheinclude-filelist,i.e.explicitlyincludethefilesanddirectorieslistedinthe
include-file.Duplicateentrieswhichcanappearbecauseofthefilebeingalreadyincludedinstep(1)arenotlistedtwice.
(3)Tothelistobtainedfromstep(2)applytheexclude-filelist,i.e.explicitlyremoveallfilesanddirectorieslistedinthe
exclude-filelistobtainedinstep(2).
#Exampleofanincludeorexcludefile
$catinclude.txt

154

Issue:03B

MulticontrollerRNCSCLICommands

Table75

SCLICommands

backupstate(Cont.)

/mnt/mstate/TCU-0
/mnt/mstate/TDMSNIU-3/etc/timestamp
Note:
Pleasemakesurethattherearenotrailing/leadingspacesandblanklineswhileaddingentriesintoinclude-file/exclude-file.
Theinclude-file/exclude-fileoptionisavailableonlyforfiles/directoriesinside/mnt/mstate.
Parameter

exclude-file

include-file

Hint

Range

Default

Thiscommandacceptsatextfileasanargument.Thetext
filecontainsalistofdirectories/filesinsidethemasterstate
volumethatneedstobeexcludedfromthestatevolume
backup.

filenamethatcontains
alistofdirectoriesand
filestobeexcluded
fromthebackup

NA

Thiscommandacceptsatextfileasargument,which
containsalistofdirectories/filesinsidemasterstatevolume
whichneedstobeincludedinthestatevolumebackup.

filenamethatcontains
alistofdirectoriesand
filestobeincludedin
thebackup

NA

Command

Dependency
None

add backup state {[include-file <file-name>]? [exclude-file


<file-name>]?}

2.4 built-in
Table76

built-in

Description
SCLIbuilt-incommandsareusedformanagingtheSCLIsessionenvironment.Theyhavenoeffectonthefunctionalityof
thenetworkelement.Withbuilt-incommandsyoucanmanageSCLIusers,modifythesettingsandvariablesoftheSCLI
environment,controltheoutputofSCLIcommands,managethehistoryofexecutedcommands,andswitchbetweenthe
bashshellandthefsclishshell.

2.4.1 built-in cli


Table77

built-incli

Description
refresh
RefreshesSCLIcommanddefinitions.
reset
ResetstheSCLIenvironmentvariables.
save

Issue:03B

155

SCLICommands

Table77

MulticontrollerRNCSCLICommands

built-incli(Cont.)

Thiscommandsaveseitherallenvironmentvariablesorallsessionvariables
intoafile.
set
ThiscommandsetsthepropertiesofthestructuredCLIshell.
Example:
1.Built-inpropertiesofashell.
2.Thenameandvalueofenvironmentandsessionvariables.
3.Destinationfordisplayingerror,output,anddebuginformation
show
ThiscommandshowsthepropertiesofthisstructuredCLIshellsession,
suchasbuilt-in,environment,andsessionvariables.
start
Thiscommandstartscliactions.
Parameter

Hint

Command

Range

Default

Dependency
None

refresh cli cache


None
reset cli env
None
save cli env
None
save cli env file <filename>
None
save cli env file <filename> <save_mode>
None
save cli env <save_mode>
None
save cli session file <filename>

156

Issue:03B

MulticontrollerRNCSCLICommands

Table77

SCLICommands

built-incli(Cont.)
None

save cli session file <filename> <save_mode>


None
set cli built-in confirmation-prompt <on_off>
None
set cli built-in constraint-hint <on_off>

2.4.1.1
Table78

built-in cli batch-file

built-inclibatch-file

Description
Thiscommandrunsothercommandsfromagiveninputfileinbatchmode.
Thebehavior,incaseoffailingcommands,iscontrolledbytheon-failure
built-incliproperty(seehelpfromthe"setclibuilt-in"command).
NotethatthebatchcommandscannotincludethefollowingSCLIcommands
-startclibatch-file
-quit
-exit
-shell
Parameter

Hint

Command

Range

Default

Dependency
None

start cli batch-file <file>

2.4.1.1.1
Table79

built-in cli batch-file <file>

built-inclibatch-file<file>

Description
Theparameterfilespecifiesthepathtothebatchcommandfile.
Parameter

Hint

Command

Range

Default

Dependency
None

start cli batch-file <file>

Issue:03B

157

SCLICommands

2.4.1.2
Table80

MulticontrollerRNCSCLICommands

built-in cli built-in

built-inclibuilt-in

Description
set
Thiscommandsetstheread/writebuilt-inproperties,suchastheprint-header
configuration.Thechangesdoneusingthiscommandareappliedonlytothe
user'scurrentsession.Othersessionsofthesameuserremainunaffected.
Userscanpreservethemodifiedpropertiesinthecurrentsessionbysaving
theCLIenvironmentparametersusingthecommand"saveclienv".Thisway,
anynewly-createdsessionbythesameuserwillautomaticallyhavethese
modifications.
show
Thiscommandshowsthevaluesofthebuilt-inpropertiesforthecurrentsession.
Parameter

Hint

Command

Range

Default

Dependency
None

set cli built-in confirmation-prompt <on_off>


None
set cli built-in constraint-hint <on_off>
None
set cli built-in debug <debug_level>
None
set cli built-in echo-cmd <on_off>
None
set cli built-in on-failure <stop_continue>
None
set cli built-in output <output_format>
None
set cli built-in print-footer <on_off>

158

Issue:03B

MulticontrollerRNCSCLICommands

Table80

SCLICommands

built-inclibuilt-in(Cont.)
None

set cli built-in print-header <on_off>


None
set cli built-in relative-mode <on_off>
None
set cli built-in rows <number_of_rows>

2.4.1.2.1
Table81

built-in cli built-in <properties>

built-inclibuilt-in<properties>

Description
Thisparameterspecifiesthebuilt-inpropertytobedisplayed.
Thepropertiescurrentlysupportedare:
confirmation-prompt:Thisparameterspecifiesthevalueofthe
"confirmation-prompt"built-inproperty.Thispropertycontrolsthebehaviorof
askingforuserconfirmationfortheexecutedcommand.
Seealso"setclibuilt-inconfirmation-prompt"command.
constraint-hint:Thisparameterspecifiesthevalueofthe"constraint-hint"
built-inproperty.Thispropertycontrolsthedisplayofadditionalinformation
intheparameterhintabouttheexpectedvaluerangeofaparameter.
Seealso"setclibuilt-inconstraint-hint"command.
debug:Thisparameterspecifiesthevalueofthe"debug"built-inproperty.
ThispropertycontrolsthelevelofthedebugtracingdonebytheSCLIcommands.
Seealso"setclibuilt-indebug"command.
echo-cmd:Thisparameterspecifiesthevalueofthe"echo-cmd"
built-inproperty.Thispropertycontrolstheechoingofthecommandtothe
outputstreaminnon-interactivemode.
Seealso"setclibuilt-inecho-cmd"command.
on-failure:Thisparameterspecifiesthevalueofthe"on-failure"
built-inproperty.Thispropertycontrolswhethertostoporcontinuecommand
executionifanerroroccursduringbatchexecution.
Seealso"setclibuilt-inon-failure"command.
print-header:Thisparameterspecifiesthevalueofthe"print-header"
built-inproperty.Thispropertycontrolstheinclusionofacommandheaderto
theoutputstream.Seealso"setclibuilt-inprint-header"command.
print-footer:Thisparameterspecifiesthevalueofthe"print-footer"

Issue:03B

159

SCLICommands

Table81

MulticontrollerRNCSCLICommands

built-inclibuilt-in<properties>(Cont.)

built-inproperty.Thispropertycontrolstheinclusionofacommandstatus
aftereveryexecutedcommand.
Seealso"setclibuilt-inprint-footer"command.
relative-mode:Thisparameterspecifiesthevalueofthe"relative-mode"
built-inproperty.Thispropertycontrolswhethertheusercanenterthecommand
sublevelornot.Seealso"setclibuilt-inrelative-mode"command.
rows:Thisparameterspecifiesthevalueofthe"rows"built-inproperty.
Thispropertycontrolsthenumberofrowstobedisplayedinapageusing
more-likepaging.Seealso"setclibuilt-inrows"command.
syntax-check:Thisparameterspecifiesthevalueofthe"syntax-check"
built-inproperty.Thispropertycontrolswhetherrealexecutionofthecommand
takesplaceoronlythesyntaxofcommandischecked.
Seealso"setclibuilt-insyntax-check"command.
USER:Thisparametershowsthenameofthelogged-inuser.
validation-trace:Thisparameterspecifiesthevalueofthe"validation-trace"
built-inproperty.Thispropertycontrolsthevalidationtracingdonebythe
interpreterincaseofanerror.Pleasenotethatthisparameterisread-only,
soyoucannotsetorunsetitsvalue.
Seealso"setclibuilt-invalidation-trace"command
NODE-NAME:Theparameter"NODE-NAME"showsthenodenameonwhichthe
currentSCLIsessionislaunched.Pleasenotethatthisparameterisread-only,
soyoucannotsetorunsetitsvalue.
SESSION-ID:Theparameter"SESSION-ID"showstheIDofthecurrentSCLIsession.
Pleasenotethatthisparameterisread-only,soyoucannotsetorunsetitsvalue.
Notethatsessionidentifiersareuniqueonlyinthescopeofa
particularmanagementnode.Insystemswithmultiplemanagementnodes
(typicallytwo)eachmanagementnodewillonlyguaranteeuniquenessofthe
sessionIDwithinitsownscope.Sessionidentifiersarerestartedwhenthe
managementnodeisrestarted.
Parameter

Hint

Command

Range

Default

Dependency
None

show cli built-in <properties>

160

Issue:03B

MulticontrollerRNCSCLICommands

2.4.1.2.2
Table82

SCLICommands

built-in cli built-in confirmation-prompt

built-inclibuilt-inconfirmation-prompt

Description
Thisparameterallowstosetthenewvalueofthe"confirmation-prompt"
built-inproperty.Whensetto"off",anSCLIcommanddefinedtopromptfor
confirmationfromtheuserwillnotprompt.Whensetto"on",thatcommandwill
promptforconfirmationfromtheuser.Thedefaultvalueofthisparameter
is"on".
Allowedvalues:
1.on(youareaskedforconfirmation).
2.off(confirmationisnotasked).
Parameter

Hint

Command

Range

Default

Dependency
None

set cli built-in confirmation-prompt <on_off>

2.4.1.2.2.1
Table83

built-in cli built-in confirmation-prompt <on_off>

built-inclibuilt-inconfirmation-prompt<on_off>

Description
valueforsetting'confirmation-prompt'
Parameter

Hint

Command

Range

Default

Dependency
None

set cli built-in confirmation-prompt <on_off>

2.4.1.2.3
Table84

built-in cli built-in constraint-hint

built-inclibuilt-inconstraint-hint

Description
Thisparameterallowstosetthenewvalueofthe"constraint-hint"
built-inproperty.Whensetto"on",additionalinformationaboutthe
expectedvaluerangeofaparameterisincludedintheparameterhintdisplayed.
Theadditionalinformationcontainsthetype(s)oftheconstraint(s)andthe
expectedvalue(s).Thedefaultvalueofthisparameteris"off".

Issue:03B

161

SCLICommands

Table84

MulticontrollerRNCSCLICommands

built-inclibuilt-inconstraint-hint(Cont.)

Allowedvalues:
1.on(displaysadditionalinformationabouttheconstraint).
2.off(donotdisplayadditionalinformationabouttheconstraint).
Note:Additionalrestrictions,inadditiontothosevisibleviathisparameter,
maybeapplicabletoaparameter.
Parameter

Hint

Command

Range

Default

Dependency
None

set cli built-in constraint-hint <on_off>

2.4.1.2.3.1
Table85

built-in cli built-in constraint-hint <on_off>

built-inclibuilt-inconstraint-hint<on_off>

Description
valueforsetting'constraint-hint'
Parameter

Hint

Command

Range

Default

Dependency
None

set cli built-in constraint-hint <on_off>

2.4.1.2.4
Table86

built-in cli built-in debug

built-inclibuilt-indebug

Description
Thisparameterallowstosetthenewvalueofthe"debug"built-inproperty.
ThispropertycontrolsthelevelofthedebugtracingdonebytheSCLIcommands.
Thedefaultvalueofthisparameteris"1".Pleasenotethatthedestinationof
thedebugtracingiscontrolledby"setclitracestream"command.
Allowedvalues:
1.0(FATAL)
2.1(ERROR)
3.2(WARNING)
4.3(INFO)
5.4(DEBUG)

162

Issue:03B

MulticontrollerRNCSCLICommands

Table86

SCLICommands

built-inclibuilt-indebug(Cont.)

Seealso:setclitracestream
Parameter

Hint

Command

Range

Default

Dependency
None

set cli built-in debug <debug_level>

2.4.1.2.4.1
Table87

built-in cli built-in debug <debug_level>

built-inclibuilt-indebug<debug_level>

Description
integervalueforsetting'debug-level'
Parameter

Hint

Command

Range

Default

Dependency
None

set cli built-in debug <debug_level>

2.4.1.2.5
Table88

built-in cli built-in echo-cmd

built-inclibuilt-inecho-cmd

Description
Thisparameterallowstosetthenewvalueofthe"echo-cmd"built-inproperty.
Thispropertycontrolstheechoingofthecommandtotheoutputstreamin
non-interactivemode.Withthispropertyturnedon,everyexecutedcommandline
innon-interactivemodeisdisplayedtotheoutputstream.Pleasenotethatthe
outputstreamdestinationdependsonthecurrentsettings
("setclioutstream"command).
Thedefaultvalueofthisparameteris"off"
Allowedvalues:
1.on(displaystheexecutedcommandontheoutputstream).
2.off(doesnotdisplaytheexecutedcommandontheoutputstream).
Seealso:setclioutstream
Parameter

Issue:03B

Hint

Range

Default

163

SCLICommands

Table88

MulticontrollerRNCSCLICommands

built-inclibuilt-inecho-cmd(Cont.)

Command

Dependency
None

set cli built-in echo-cmd <on_off>

2.4.1.2.5.1
Table89

built-in cli built-in echo-cmd <on_off>

built-inclibuilt-inecho-cmd<on_off>

Description
valueforsetting'echo-cmd'
Parameter

Hint

Command

Range

Default

Dependency
None

set cli built-in echo-cmd <on_off>

2.4.1.2.6
Table90

built-in cli built-in on-failure

built-inclibuilt-inon-failure

Description
Thisparameterallowstosetthenewvalueofthe"on-failure"
built-inproperty.Thispropertycontrolswhethertostoporcontinuecommand
executionifanerroroccursduringexecutioninbatchmode.Thedefaultvalue
ofthisparameteris"stop".Thispropertyisapplicableduringbatchexecution
inbothinteractiveandnon-interactivemode.
Allowedvalues:
1.continue(continuesbatchexecutionafteranerror).
2.stop(stopsbatchexecutionafterthefirsterror).
Parameter

Hint

Command

Range

Default

Dependency
None

set cli built-in on-failure <stop_continue>

2.4.1.2.6.1
Table91

built-in cli built-in on-failure <stop_continue>

built-inclibuilt-inon-failure<stop_continue>

Description

164

Issue:03B

MulticontrollerRNCSCLICommands

Table91

SCLICommands

built-inclibuilt-inon-failure<stop_continue>(Cont.)

Allowedvaluesinbatchmodeexecutionfor'on-failure'arestoporcontinue.
Parameter

Hint

Command

Range

Default

Dependency
None

set cli built-in on-failure <stop_continue>

2.4.1.2.7
Table92

built-in cli built-in output

built-inclibuilt-inoutput

Description
Thisparameterallowstosetthenewvalueofthe"output"built-inproperty.
Thispropertycontrolstheformatusedtodisplaytheoutput.Notethat
onlyveryfewcommandssupportstructuredorXMLoutputformat.Onlytheoutput
ofthesecommandswillbeaffectedwhenthisparameterischanged.
Forexample,showalarmmanualspecific-problem"(specificproblemnumber)"
supportsbothprettyandstructuredmodeanditsoutputwillbeaffected
uponchangingthisparameter.
Allowedvalues:
1.pretty(Thisistheoutputformatintendedforhumanusers).
2.structured(Theoutputisexpectedtohaveastructureeasytoparsebyprograms.
Example:outputascomma-separatedvalues).
3.xml(Theoutputisexpectedtobeinxmlformat).
Parameter

Hint

Command

Range

Default

Dependency
None

set cli built-in output <output_format>

2.4.1.2.7.1
Table93

built-in cli built-in output <output_format>

built-inclibuilt-inoutput<output_format>

Description
valueforsetting'output'
Parameter

Issue:03B

Hint

Range

Default

165

SCLICommands

Table93

MulticontrollerRNCSCLICommands

built-inclibuilt-inoutput<output_format>(Cont.)

Command

Dependency
None

set cli built-in output <output_format>

2.4.1.2.8
Table94

built-in cli built-in print-footer

built-inclibuilt-inprint-footer

Description
Thisparameterallowstosetthenewvalueofthe"print-footer"
built-inproperty.Thispropertycontrolsthedisplayofthecommandexecution
statusWiththispropertyturnedon,everyexecutedcommandlineisdisplayed
withafootertotheoutputstream.Thefooterdisplaysastatusmessageabout
thesuccessorfailureofthecommandexecuted.Pleasenotethatthe
outputstreamdestinationdependsonthecurrentsettings
("setclioutstream"command).
Thedefaultvalueofthisparameteris"off".
Seealso:setclioutstream
Parameter

Hint

Command

Range

Default

Dependency
None

set cli built-in print-footer <on_off>

2.4.1.2.8.1
Table95

built-in cli built-in print-footer <on_off>

built-inclibuilt-inprint-footer<on_off>

Description
valueforsetting'print-footer'
Parameter

Hint

Command

Range

Default

Dependency
None

set cli built-in print-footer <on_off>

166

Issue:03B

MulticontrollerRNCSCLICommands

2.4.1.2.9
Table96

SCLICommands

built-in cli built-in print-header

built-inclibuilt-inprint-header

Description
Thisparameterallowstosetthenewvalueofthe"print-header"
built-inproperty.Thispropertycontrolstheinclusionofacommandheaderto
theoutputstream.Withthispropertyturnedon,everyexecutedcommandline
isdisplayedwithaheadertotheoutputstream.Thedefaultheaderformat
isdate,hostname,andplatform.Pleasenotethattheoutputstream
destinationdependsonthecurrentsettings("setclioutstream"command).
Thedefaultvalueofthisparameteris"off".
Allowedvalues:
1.on(displaystheheaderontheoutputstream).
2.off(doesnotdisplaytheheaderontheoutputstream).
Seealso:setclioutstream
Parameter

Hint

Command

Range

Default

Dependency
None

set cli built-in print-header <on_off>

2.4.1.2.9.1
Table97

built-in cli built-in print-header <on_off>

built-inclibuilt-inprint-header<on_off>

Description
valueforsetting'print-header'
Parameter

Hint

Command

Range

Default

Dependency
None

set cli built-in print-header <on_off>

2.4.1.2.10
Table98

built-in cli built-in relative-mode

built-inclibuilt-inrelative-mode

Description
Thisparameterallowstosetthenewvalueofthe"relative-mode"
built-inproperty.Whentherelativemodeissettoon,itis

Issue:03B

167

SCLICommands

Table98

MulticontrollerRNCSCLICommands

built-inclibuilt-inrelative-mode(Cont.)

possibletoenteracommandsub-level.
Forexample:
user@CLA-0>set[Enter]
user@CLA-0set>
Thesymbolsunderthatlevelthenbecomesaccessibledirectlywithoutthe
needtotypethefullpath.
Forexample:
user@CLA-0set>[Tab]
[X]alarm-ManagementOperationsonAlarmsusingthe"LightAlarmSystem"
[X]cli-structuredCLIbuilt-insetcommands
...
[X]user-startanewfsclishshellasuser
[X]user-management-setuser-managementdata
user@CLA-0set>user-management[Enter]
user@CLA-0user-management>
"exit"movesonelevelupfromthecurrentsublevel.
user@CLA-0user-management>exit[Enter]
user@CLA-0set>
Therelativemodeis,bydefault,turnedoff.Itcanbeenabled/disabled
withthecommand"setclibuilt-inrelative-mode[on/off]".
Parameter

Hint

Command

Range

Default

Dependency
None

set cli built-in relative-mode <on_off>

2.4.1.2.10.1
Table99

built-in cli built-in relative-mode <on_off>

built-inclibuilt-inrelative-mode<on_off>

Description
Allowedvaluesforsetting'relative-mode'areeitheronoroff.
Parameter

Hint

Command

Range

Default

Dependency
None

set cli built-in relative-mode <on_off>

168

Issue:03B

MulticontrollerRNCSCLICommands

2.4.1.2.11
Table100

SCLICommands

built-in cli built-in rows

built-inclibuilt-inrows

Description
Thisparameterallowstosetthenewvalueofthe"rows"built-inproperty.
Thispropertyspecifiesthenumberofrowstobedisplayedinapage
usingmore-likepaging.Thedefaultvalueofthisparameteris"0".
If"rows"issetto"-1",then"more"isdisabled,thatis,theoutput
scrollsuntillastpage.If"rows"issetto"0",thenthenumberof
rowsisthenumberoftheterminalrows.
Parameter

Hint

Command

Range

Default

Dependency
None

set cli built-in rows <number_of_rows>

2.4.1.2.11.1
Table101

built-in cli built-in rows <number_of_rows>

built-inclibuilt-inrows<number_of_rows>

Description
integervaluefrom-1to99
Parameter

Hint

Command

Range

Default

Dependency
None

set cli built-in rows <number_of_rows>

2.4.1.2.12
Table102

built-in cli built-in syntax-check

built-inclibuilt-insyntax-check

Description
Thisparameterallowstosetthenewvalueofthe"syntax-check"
built-inproperty.Withthispropertyturnedon,thereisnoexecutionofthe
finalactionsassignedtothenodesinthecommandtree,thatis,noexecution
ofrealcommands.Itisintendedtobeusedindebuggingphasetotest
thatthegivencommandsaresyntacticallycorrect.Thedefaultvalueofthis
parameteris"off".Pleasenotethatintermediatedynamicactions,suchas
evaluationoflists-of-valuesorexecutionofvalidation,isperformedwhen

Issue:03B

169

SCLICommands

Table102

MulticontrollerRNCSCLICommands

built-inclibuilt-insyntax-check(Cont.)

syntax-checkmodeisenabled.
Allowedvalues:
1.on(doesnotexecutethecommandandonlyrunsvalidation).
2.off(executesthecommand).
Parameter

Hint

Command

Range

Default

Dependency
None

set cli built-in syntax-check <on_off>

2.4.1.2.12.1
Table103

built-in cli built-in syntax-check <on_off>

built-inclibuilt-insyntax-check<on_off>

Description
valueforsetting'syntax-check'
Parameter

Hint

Command

Range

Default

Dependency
None

set cli built-in syntax-check <on_off>

2.4.1.2.13
Table104

built-in cli built-in validation-trace

built-inclibuilt-invalidation-trace

Description
Thisparametersetsthenewvalueforthe"validation-trace"built-inproperty.
Thispropertycontrolsthevalidationtracingdonebytheinterpreteronly
incaseofanerror.Thedefaultvalueofthisparameteris"1".
Allowedvalues:
1.0(doesnotshowthevalidationtrace).
2.1(showsallthevalidationtraceexceptstaticvalidationtrace).
3.2(showsallthevalidationtrace)
Forvalue"2",tokenmatchingagainstpossiblecombinationsiscarriedout,
andifthereisanerror,thenitisdisplayedasbelow:
user@CLA-0>showclienv7
Foundtoken"env7"

170

Issue:03B

MulticontrollerRNCSCLICommands

Table104

SCLICommands

built-inclibuilt-invalidation-trace(Cont.)

expected:built-in:nomatch
expected:env:nomatch
expected:file:nomatch
expected:session:nomatch
expected:views:nomatch
Parameternotfound
showclienv7
---------^
user@CLA-0>
Parameter

Hint

Command

Range

Default

Dependency
None

set cli built-in validation-trace <validation-trace-level>

2.4.1.2.13.1
Table105

built-in cli built-in validation-trace <validation-trace-level>

built-inclibuilt-invalidation-trace<validation-trace-level>

Description
integervaluefrom0to2
Parameter

Hint

Command

Range

Default

Dependency
None

set cli built-in validation-trace <validation-trace-level>

2.4.1.3
Table106

built-in cli cache

built-inclicache

Description
Thiscommandisusedtorefreshtherecentchangesmadeinthecommandcacheof
theuser.Thisincludesrebuildingandvalidatingthecommandtree.Thisdoes
notincludearefreshoftheauthorizationdata.Theauthorizationdatais
periodicallyrefreshedevery600seconds.RestartingtheSCLIrecoverygroupis
aworkaroundiftheauthorizationdataneedstobeimmediatelyupdated.
Pleasenotethatifthereisanerrorinthecommandtree,thentheSCLIdaemon

Issue:03B

171

SCLICommands

Table106

MulticontrollerRNCSCLICommands

built-inclicache(Cont.)

willnotcomeup.Thiscommandisnormallynotneeded,ascommandchangesare
broughtinviasoftwareupgradethatrequiresarestartoftheSCLIrecovery
group.
Parameter

Hint

Command

Range

Default

Dependency
None

refresh cli cache

2.4.1.4
Table107

built-in cli env

built-inclienv

Description
reset
Thiscommandresetsalltheread/writebuilt-inenvironmentvariablestotheir
defaultvaluesandunsetsalltheuser-definedenvironmentvariables.The
changetotheenvironmentisapplicableonlyforthecurrentSCLIsession
wherethecommandisexecuted.
Notethattheread-onlybuilt-invariables,orthereservedhiddenenvironment
variables,willnotberesetuponexecutingthiscommand.Alsothecommandwill
notresetanysessionvariable.
Seealso:setclienv,showclienv,loadclienv,saveclienv,unsetclienv,
setclibuilt-in.
save
Thiscommandsavesthecurrentstateoftheenvironmentintotheuser-specific
".cshrc"file(thisisdonebydefaultifnofilenameisgiven)ortoafile
specifiedbytheuser.
Theread/writebuilt-inenvironmentvariablesanduser-definedenvironment
variablesaresavedwhenthiscommandisexecuted.Pleasenotethatthesession
variables(manipulatedby"setclisession","loadclisession"etc.)arenot
saved.Thosesessionvariablesaresavedbyissuingthe"saveclisession"
command.Thiscommandwillnotsavetheread-onlybuilt-invariablesorthe
reservedhiddenenvironmentvariables.
Thedefaultsavingmodeis"update",unlessanalternatemodeisexplicitly
given.Ifthe"saveclienv"commandisinvokedwithoutspecifyinganexplicit
filename,thenthecommandwillstoretheenvironmentvariablesinthe

172

Issue:03B

MulticontrollerRNCSCLICommands

Table107

SCLICommands

built-inclienv(Cont.)

".cshrc"file.
IftheuserdoesnothaveahomedirectorythatisaccessiblefromtheSCLI
shell,thenthesavecommandwillfail.Forsuchusers,thecommandhastobe
executedbyexplicitlyspecifyingafilename.Alsonotethatforusersthat
donothaveahomedirectory,theenvironmentwillnotbeautomaticallyloaded
atsessioncreationtimeeither.Instead,suchsessionswillstartwiththe
defaultenvironmentandoperatorsneedtoexplicitlyloadanenvironmentusing
the"loadclienvfile[filename]"command.
Seealso:loadclienv,setclienv,showclienv.
set
Thiscommandallowsdefiningnewenvironmentvariablesormodifyinguser-defined
environmentvariables.Thechangetotheenvironmentisapplicableonlyforthe
currentSCLIsessionwherethecommandisexecuted.
Built-inenvironmentvariablescanbesetonlyviathe"setclibuilt-in"command.
Theuserwillnotbeabletoset/modifybuilt-inenvironmentvariablesviathe
"setclienv"command.Built-inenvironmentvariablesareasetofdefault
environmentvariables,providedbySCLIframework,toexposesettingsspecificto
thecurrentfsclishsessionorcurrentnode.Mostofthebuilt-inenvironment
variablesareread-writevariablesandallowtheusertocustomizetheSCLIbehavior.
Someofthebuilt-invariablesareread-onlyandcannotbemodifiedatall.
Reservedhiddenenvironmentvariablescannotbemodifiedusingthiscommand.Infact,
theycannotbemodifiedatallbyanySCLIcommand.Thesevariablesareintendedto
exposecertainsystem-definedsettingswhichareglobaltoallsessions,andare
neededbySCLIcommandimplementation.ThesevariablesareinitializedbytheSCLI
framework.NotethatthesevariablesarenotvisibletotheusersofSCLI,butare
accessibletoSCLImodules.
Thiscommanddoesnotallowsettinganyvariablewiththesamenameasareserved
hiddensessionvariableoraread-onlysessionvariable."Sessionvariable"isa
conceptdifferentfromenvironmentvariablesuchthatitisnormallyintendedto
besetordefinedonlybyanSCLImoduleandnotbytheuser.Reservedhidden
sessionvariablesandread-onlysessionvariablesaresessionvariableswhichare
alreadyreservedforcertainspecificpurposes,butdifferinthesensethat
reservedhiddensessionvariablesarenotvisibletotheuserviaanyshowcommand,
whereasread-onlysessionvariableswillbevisibletotheuserasoutputofthe
command"showclisession".
Notethatthechangesmadetotheenvironmentwillnotbesavedonthediskautomatically.

Issue:03B

173

SCLICommands

Table107

MulticontrollerRNCSCLICommands

built-inclienv(Cont.)

Tosavetheenvironmentonthedisk,usethe"saveclienv"command.Theenvironmentcan
berestoredlaterintoanewsessionusingthe"loadclienv"command.Theseparationof
settingandsavingofvariablesisdonetoallowtheusertofirstverifythechangesdone
totheenvironment(see"showclienv"and"showclisession"commands).Then,thechanges
canbesaved(see"save..."commands)ordiscarded.
Seealso:showclienv,loadclienv,saveclienv,unsetclienv,resetclienv,
setclibuilt-in,showclibuilt-in,showclisession.
show
Thiscommanddisplaysalltheuser-definedenvironmentvariablesandbuilt-in
environmentvariablesintheusedsession.
Thebuilt-inenvironmentvariablesareasetofdefaultenvironmentvariables
providedbySCLIframeworktoexposesettingsspecifictothecurrentfsclish
sessionorcurrentnode.Forexample:session-id,node-name,debug-level,
print-header,print-footer,etc.
Thiscommanddoesnotshowreservedhiddenenvironmentvariables.Reserved
hiddenenvironmentvariablesareintendedtoexposecertainsystemdefined
settingswhichareglobaltoallsessions.Thesevariablesareinitialized
bytheSCLIframeworkandarereadbySCLImodulesimplementingtheSCLI
commands.
Thiscommanddoesnotshow"sessionvariables"."Sessionvariable"isaconcept
differentfromenvironmentvariablesuchthatitisnormallyintendedtobeset
ordefinedonlybyanSCLImoduleandnotbytheuser.
Seealso:setclienv,loadclienv,saveclienv,unsetclienv,resetclienv,
showclisession.
Parameter

Hint

Command

Range

Default

Dependency
None

reset cli env


None
save cli env
None
show cli env
None
save cli env file <filename>

174

Issue:03B

MulticontrollerRNCSCLICommands

Table107

SCLICommands

built-inclienv(Cont.)
None

save cli env file <filename> <save_mode>


None
save cli env <save_mode>
None
set cli env [<NAME> <VALUE>]+
None
show cli env [<variable_name>]+

2.4.1.4.1
Table108

built-in cli env <NAME>

built-inclienv<NAME>

Description
environmentvariablename
Parameter

Hint

Command

Range

Default

Dependency
None

set cli env [<NAME> <VALUE>]+

2.4.1.4.1.1
Table109

built-in cli env <NAME> <VALUE>

built-inclienv<NAME><VALUE>

Description
environmentvariablevalue.
Parameter

Hint

Command

Range

Default

Dependency
None

set cli env [<NAME> <VALUE>]+

2.4.1.4.2
Table110

built-in cli env <save_mode>

built-inclienv<save_mode>

Description

Issue:03B

175

SCLICommands

Table110

MulticontrollerRNCSCLICommands

built-inclienv<save_mode>(Cont.)

savemode
Parameter

Hint

Command

Range

Default

Dependency
None

save cli env <save_mode>

2.4.1.4.3
Table111

built-in cli env <variable_name>

built-inclienv<variable_name>

Description
thenameofthestructuredCLIenvironmentvariable(s)
Parameter

Hint

Command

Range

Default

Dependency
None

show cli env [<variable_name>]+

2.4.1.4.4
Table112

built-in cli env file

built-inclienvfile

Description
Theparameter'file'savestheenvironmentvariablesintothespecifiedfile.
Parameter

Hint

Command

Range

Default

Dependency
None

save cli env file <filename>


None
save cli env file <filename> <save_mode>

2.4.1.4.4.1
Table113

built-in cli env file <filename>

built-inclienvfile<filename>

Description
Thiscommandreplacestheexistingfilebydefault,

176

Issue:03B

MulticontrollerRNCSCLICommands

Table113

SCLICommands

built-inclienvfile<filename>(Cont.)

ifsavemodeisnotgivenexplicitly.
Parameter

Hint

Command

Range

Default

Dependency
None

save cli env file <filename>


None
save cli env file <filename> <save_mode>

2.4.1.4.4.1.1
Table114

built-inclienvfile<filename><save_mode>

built-inclienvfile<filename><save_mode>

Description
Theparameter'create'specifiesthatanewfilewith
filenamewillbecreatedifitdoesnotexist.
Ifthefileexists,thecommandwillfail.
Theparameter'replace'specifiesthatthefilewillbeoverwritten
withthecurrentshell'ssessionvariables.
Theparameter'update'specifiesthatexistingvariablesinthefile
willbeupdatedandanynewvariableswillbeadded.
Parameter

Hint

Command

Range

Default

Dependency
None

save cli env file <filename> <save_mode>

2.4.1.5
Table115

built-in cli errorstream

built-inclierrorstream

Description
Thiscommandsetsthedestinationfortheerrorstreamreceiver.
Allowedvalues:
1.file(redirectserrorstreamreceivertoafile)
2.null(redirectserrorstreamreceivertoanulldevicewhichisaspecialfile
thatdiscardsallthedatawrittentoit)
3.std(redirectserrorstreamreceivertoSTDOUT)

Issue:03B

177

SCLICommands

Table115

MulticontrollerRNCSCLICommands

built-inclierrorstream(Cont.)

Parameter

Hint

Command

Range

Default

Dependency
None

set cli errorstream <destination>


None
set cli errorstream file <filename>
None
set cli errorstream file <filename> <write_mode>

2.4.1.5.1
Table116

built-in cli errorstream <destination>

built-inclierrorstream<destination>

Description
destinationfortheerrorstream
Parameter

Hint

Command

Range

Default

Dependency
None

set cli errorstream <destination>

2.4.1.5.2
Table117

built-in cli errorstream file

built-inclierrorstreamfile

Description
fileastheerrorstream
Parameter

Hint

Command

Range

Default

Dependency
None

set cli errorstream file <filename>


None
set cli errorstream file <filename> <write_mode>

178

Issue:03B

MulticontrollerRNCSCLICommands

2.4.1.5.2.1
Table118

SCLICommands

built-in cli errorstream file <filename>

built-inclierrorstreamfile<filename>

Description
Thiscommandappendstothefilebydefault,
unlessthemodeisexplicitlygiven.
Parameter

Hint

Command

Range

Default

Dependency
None

set cli errorstream file <filename>


None
set cli errorstream file <filename> <write_mode>

2.4.1.5.2.1.1
Table119

built-inclierrorstreamfile<filename><write_mode>

built-inclierrorstreamfile<filename><write_mode>

Description
filewritemodefortheerrorstream
Parameter

Hint

Command

Range

Default

Dependency
None

set cli errorstream file <filename> <write_mode>

2.4.1.6
Table120

built-in cli outstream

built-inclioutstream

Description
Thiscommandsetsthedestinationfortheoutputstreamreceiver.
Allowedvalues:
1.file(redirectsoutputstreamreceivertoafile)
2.null(redirectsoutputstreamreceiverto/dev/null)
3.std(redirectsoutputstreamreceivertoSTDOUT)
Parameter

Issue:03B

Hint

Range

Default

179

SCLICommands

Table120

MulticontrollerRNCSCLICommands

built-inclioutstream(Cont.)

Command

Dependency
None

set cli outstream <destination>


None
set cli outstream file <filename>
None
set cli outstream file <filename> <write_mode>

2.4.1.6.1
Table121

built-in cli outstream <destination>

built-inclioutstream<destination>

Description
destinationfortheoutputstream
Parameter

Hint

Command

Range

Default

Dependency
None

set cli outstream <destination>

2.4.1.6.2
Table122

built-in cli outstream file

built-inclioutstreamfile

Description
fileastheoutputstream
Parameter

Hint

Command

Range

Default

Dependency
None

set cli outstream file <filename>


None
set cli outstream file <filename> <write_mode>

180

Issue:03B

MulticontrollerRNCSCLICommands

2.4.1.6.2.1
Table123

SCLICommands

built-in cli outstream file <filename>

built-inclioutstreamfile<filename>

Description
Thiscommandappendstothefilebydefault,
unlessthemodeisexplicitlygiven.
Parameter

Hint

Command

Range

Default

Dependency
None

set cli outstream file <filename>


None
set cli outstream file <filename> <write_mode>

2.4.1.6.2.1.1
Table124

built-inclioutstreamfile<filename><write_mode>

built-inclioutstreamfile<filename><write_mode>

Description
filewritemodefortheoutputstream
Parameter

Hint

Command

Range

Default

Dependency
None

set cli outstream file <filename> <write_mode>

2.4.1.7
Table125

built-in cli session

built-inclisession

Description
save
Thiscommandsavesthesessionvariablesintoauser-specifiedfile.Notethat
thecommandwillnotsavereservedhiddensessionvariables,read-onlysession
variablesorreservedhiddenenvironmentvariables.
Seealso:loadclisession,setclisession,showclisession,saveclienv.
set
Thiscommandsetsasessionvariable.Sessionvariablesenableexchangeof
information(forexample,state)betweencommandsexecutedinthesamesession.
Typically,sessionvariablesaresetbyoneSCLImoduleandreadbythesame

Issue:03B

181

SCLICommands

Table125

MulticontrollerRNCSCLICommands

built-inclisession(Cont.)

orotherSCLImodules.Butinsomecases,theuserwouldwanttomodifythese
variables,whichcanbedonebyusingthiscommand.Notethatthecommandwill
notmodifyreservedhiddensessionvariablesandread-onlysessionvariables.
Reservedhiddensessionvariablesandread-onlysessionvariablesaresession
variableswhichcanonlybemodifiedbytheSCLImoduleandnotbytheuser.
Modificationofthosevariablesbyausercanresultinunexpectedbehavior,thus,
itisprohibited.Thedifferencebetweenthesetwotypesofsessionvariablesis
thatreservedhiddensessionvariablesarenotvisibletotheuserviaanyshow
command,whereasread-onlysessionvariableswillbevisibletotheuserviathe
command"showclisession".
Anychangemadetothesessionvariablesarenotsavedbydefault,unless
"saveclisession"commandhasbeenexecuted.Sessionvariablesexistuntilthe
fsclishsessionisterminated.
Seealso:showclisession,saveclisession,loadclisession,
unsetclisession,setclienv.
show
Thiscommandshowsthecurrentlysetsessionvariables.
"Sessionvariable"isaconceptdifferentfromenvironmentvariablesuchthat
itisnormallyintendedtobesetordefinedonlybyanSCLImoduleandnot
bytheuser.Sessionvariablesaremainlyusedtomaintainsessionstate
betweentheinvocationofmultipleSCLIcommands.
Thiscommanddoesnotshowthevaluesofreservedhiddensessionvariables.
Reservedhiddensessionvariablesaresessionvariableswhichwerealready
reservedforcertainspecificpurposes.Thesevariablesareonlyforinternal
usebySCLImodulesandthus,arehiddenfromtheuser.
Thiscommanddoesnotshowenvironmentvariables.Usethe"showclienv"
commandtoseetheenvironmentvariables.
Sessionvariablesnormallyoverrideenvironmentvariables.However,theycannot
beusedtooverridethevalueofbuilt-invariables.Inbothcases,evenif
definedasasessionvariable,thevaluereadbytheSCLImodulesimplementing
SCLIcommandscomesfromtheenvironmentvariable.
Sessionvariablescanbeexplicitlysavedtoandloadedfromafilebyinvoking
the"saveclisession"and"loadclisession"commands.Sessionvariablesare
unaffectedbythesaveandloadcommandfortheenvironmentvariables,
thatis,loadingenvironmentvariablesusingthe"loadclienv"commandwillnot
overwritethevalueofanysessionvariable.Sessionvariable(s)existsuntil

182

Issue:03B

MulticontrollerRNCSCLICommands

Table125

SCLICommands

built-inclisession(Cont.)

thefsclishsessionisterminated.
Seealso:setclisession,loadclisession,saveclisession,unsetclisession,
showclienv.
Parameter

Hint

Command

Range

Default

Dependency
None

show cli session


None
save cli session file <filename>
None
save cli session file <filename> <save_mode>
None
set cli session [<NAME> <VALUE>]+
None
show cli session [<variable_name>]+

2.4.1.7.1
Table126

built-in cli session <NAME>

built-inclisession<NAME>

Description
sessionvariablename
Parameter

Hint

Command

Range

Default

Dependency
None

set cli session [<NAME> <VALUE>]+

2.4.1.7.1.1
Table127

built-in cli session <NAME> <VALUE>

built-inclisession<NAME><VALUE>

Description
sessionvariablevalue.
Parameter

Issue:03B

Hint

Range

Default

183

SCLICommands

Table127

MulticontrollerRNCSCLICommands

built-inclisession<NAME><VALUE>(Cont.)

Command

Dependency
None

set cli session [<NAME> <VALUE>]+

2.4.1.7.2
Table128

built-in cli session <variable_name>

built-inclisession<variable_name>

Description
thenameofthestructuredCLIsessionvariable(s)
Parameter

Hint

Command

Range

Default

Dependency
None

show cli session [<variable_name>]+

2.4.1.7.3
Table129

built-in cli session file

built-inclisessionfile

Description
Theparameter'file'savesthesessionvariable(s)intothespecifiedfile.
Parameter

Hint

Command

Range

Default

Dependency
None

save cli session file <filename>


None
save cli session file <filename> <save_mode>

2.4.1.7.3.1
Table130

built-in cli session file <filename>

built-inclisessionfile<filename>

Description
Theparameter'file'specifiesthefilenametosavethesessionenvironment.
Parameter
Command

184

Hint

Range

Default

Dependency

Issue:03B

MulticontrollerRNCSCLICommands

Table130

SCLICommands

built-inclisessionfile<filename>(Cont.)
None

save cli session file <filename>


None
save cli session file <filename> <save_mode>

2.4.1.7.3.1.1
Table131

built-inclisessionfile<filename><save_mode>

built-inclisessionfile<filename><save_mode>

Description
Theparameter'create'specifiesthatanewfilewith
filenamewillbecreatedifitdoesnotexist.
Ifthefileexists,thecommandwillfail.
Theparameter'replace'specifiesthatthefilewillbeoverwritten
withthecurrentshell'senvironmentvariables.
Theparameter'update'specifiesthatexistingvariablesinthefile
willbeupdatedandanynewvariableswillbeadded.
Parameter

Hint

Command

Range

Default

Dependency
None

save cli session file <filename> <save_mode>

2.4.1.8
Table132

built-in cli tracestream

built-inclitracestream

Description
Thiscommandsetsthedestinationforthetracelogs.
Bydefault,itissetasstd.
Allowedvalues:
1.file(redirectstracestreamreceivertoafile)
2.null(redirectstracestreamreceivertonulldevice)
3.std(redirectstracestreamreceivertostandardoutput)
4.syslog(redirectstracestreamreceivertothesystemlog)
Parameter

Issue:03B

Hint

Range

Default

185

SCLICommands

Table132

MulticontrollerRNCSCLICommands

built-inclitracestream(Cont.)

Command

Dependency
None

set cli tracestream <destination>


None
set cli tracestream file <filename>
None
set cli tracestream file <filename> <write_mode>

2.4.1.8.1
Table133

built-in cli tracestream <destination>

built-inclitracestream<destination>

Description
destinationforthetrace(debug)stream
Parameter

Hint

Command

Range

Default

Dependency
None

set cli tracestream <destination>

2.4.1.8.2
Table134

built-in cli tracestream file

built-inclitracestreamfile

Description
fileasthetrace(debug)stream
Parameter

Hint

Command

Range

Default

Dependency
None

set cli tracestream file <filename>


None
set cli tracestream file <filename> <write_mode>

186

Issue:03B

MulticontrollerRNCSCLICommands

2.4.1.8.2.1
Table135

SCLICommands

built-in cli tracestream file <filename>

built-inclitracestreamfile<filename>

Description
Thiscommandappendstothefilebydefault,
unlessthemodeisexplicitlygiven.
Parameter

Hint

Command

Range

Default

Dependency
None

set cli tracestream file <filename>


None
set cli tracestream file <filename> <write_mode>

2.4.1.8.2.1.1
Table136

built-inclitracestreamfile<filename><write_mode>

built-inclitracestreamfile<filename><write_mode>

Description
filewritemodeforthetrace(debug)stream
Parameter

Hint

Command

Range

Default

Dependency
None

set cli tracestream file <filename> <write_mode>

2.4.1.9
Table137

built-in cli views

built-incliviews

Description
ThiscommanddisplaysthelistofavailableCLIviews.
EnablingaparticularviewleadstogroupingoftheSCLI-commandsintoviews.
Whenaparticularviewisset,thenthecommandsthatareclassifiedas
belongingtothisviewbecomevisibleforauto-completionandexecution.
Parameter
Command

Hint

Range

Default

Dependency
None

show cli views

Issue:03B

187

SCLICommands

MulticontrollerRNCSCLICommands

2.4.2 built-in cmdtree


Table138

built-incmdtree

Description
Thiscommandhasbeendeprecated.Usethe"helpcmd-tree"commandinstead.
Parameter

Hint

Command

Range

Default

Dependency
None

cmdtree
None
cmdtree [<command>]+

2.4.2.1
Table139

built-in cmdtree <command>

built-incmdtree<command>

Description
Thiscommandhasbeendeprecated.Usethe"helpcmd-tree"commandinstead.
Parameter

Hint

Command

Range

Default

Dependency
None

cmdtree [<command>]+

2.4.3 built-in exit


Table140

built-inexit

Description
ThiscommandterminatesthecurrentSCLIsessionifyouareattheabsolute
rootpath.Anychangesmadetotheenvironmentarenotsavedbydefault,unless
thesavecommandhasbeenexecuted.Thecommandexecutionhistoryis
automaticallysavedbeforethesessionisterminated.
Normally,theexitcommanddoesthesameasthequitcommand.But,ifrelative
rootpath(thecurrentuserprompt)isnotthesameastheabsolutecommandtree
root(thefsclishprompt),thenthecommandmovestherelativerootonelevelup
inthecommandtree.
Example:

188

Issue:03B

MulticontrollerRNCSCLICommands

Table140

SCLICommands

built-inexit(Cont.)

user@cla-0>setuser-management
user@cla-0user-management>exit
user@cla-0set>exit
user@cla-0>exit
user@cla-0#
Seealso:quit
Parameter

Hint

Command

Range

Default

Dependency
None

exit

2.4.4 built-in help


Table141

built-inhelp

Description
ThiscommandshowsthehelpforthestructuredCLI(SCLI)shell.
Parameter

Hint

Command

Range

Default

Dependency
None

help
None
help cmd-tree
None
help cmd-tree cmd-set <cmd-set>
None
help cmd-tree command [<command>]+

2.4.4.1
Table142

built-in help cmd-tree

built-inhelpcmd-tree

Description
ThiscommandshowstheinformationabouttheavailablestructuredCLI(SCLI)
commands.Ifthiscommandisexecutedwithoutanyarguments,thenitdisplays

Issue:03B

189

SCLICommands

Table142

MulticontrollerRNCSCLICommands

built-inhelpcmd-tree(Cont.)

thecommandsyntaxtreeforallthecommands.
Parameter

Hint

Command

Range

Default

Dependency
None

help cmd-tree
None
help cmd-tree cmd-set <cmd-set>
None
help cmd-tree command [<command>]+

2.4.4.1.1
Table143

built-in help cmd-tree cmd-set

built-inhelpcmd-treecmd-set

Description
Thisparameterspecifiesthecommandsetforwhichthecommandsyntaxtree
needstobedisplayed.Executingthecommand"helpcmd-treecmd-set/xyz"
willbeequivalenttodisplayingthecommand"helpcmd-treecommand*xyz".
Itwilldisplayallthebranchesofthecommandtreewhere"xyz"isoccurring
asthesecondword.Thecommandsetcanbespecifiedtouptotwolevels.
Forexample,"helpcmd-treecmd-set/xyz/abc"willdisplayallthebranchesof
thecommandtreewhere"xyz"isoccurringasthesecondword,and"abc"is
occurringasthethirdword.
Thefollowingaresomeexamples:
1)helpcmd-treecmd-set/alarm-todisplayallthebranchesofthecommand
treefor"alarm"namely"showalarm","setalarm","addalarm"andsoon.
2)helpcmd-treecmd-set/networking/vlan-todisplaythebranchesofthe
commandtreefor"networkingvlan"namely"addnetworkingvlan",
"shownetworkingvlan"andsoon.
Parameter

Hint

Command

Range

Default

Dependency
None

help cmd-tree cmd-set <cmd-set>

190

Issue:03B

MulticontrollerRNCSCLICommands

2.4.4.1.1.1
Table144

SCLICommands

built-in help cmd-tree cmd-set <cmd-set>

built-inhelpcmd-treecmd-set<cmd-set>

Description
Thisparameterspecifiesthecommandsetforwhichthecommandsyntaxtree
needstobedisplayed.Executingthecommand"helpcmd-treecmd-set/xyz"
willbeequivalenttodisplayingthecommand"helpcmd-treecommand*xyz".
Itwilldisplayallthebranchesofthecommandtreewhere"xyz"isoccurring
asthesecondword.Thecommandsetcanbespecifiedtouptotwolevels.
Forexample,"helpcmd-treecmd-set/xyz/abc"willdisplayallthebranchesof
thecommandtreewhere"xyz"isoccurringasthesecondword,and"abc"is
occurringasthethirdword.
Thefollowingaresomeexamples:
1)helpcmd-treecmd-set/alarm-todisplayallthebranchesofthecommand
treefor"alarm"namely"showalarm","setalarm","addalarm"andsoon.
2)helpcmd-treecmd-set/networking/vlan-todisplaythebranchesofthe
commandtreefor"networkingvlan"namely"addnetworkingvlan",
"shownetworkingvlan"andsoon.
Parameter

Hint

Command

Range

Default

Dependency
None

help cmd-tree cmd-set <cmd-set>

2.4.4.1.2
Table145

built-in help cmd-tree command

built-inhelpcmd-treecommand

Description
ThisparameterspecifiesthestructuredCLI(SCLI)commandorsubcommandfor
whichthesyntaxtreehastobedisplayed.
Thefollowingaresomeexamples:
1)helpcmd-treeshow-todisplaythecommandtreeforall"show"commands.
2)helpcmd-treeaddnetworking-todisplaythecommandtreeforall"add
networking"commands.
3)helpcmd-treeshowalarmtype-todisplaythecommandtreeforthe
"showalarmtype"command.
Parameter

Issue:03B

Hint

Range

Default

191

SCLICommands

Table145

MulticontrollerRNCSCLICommands

built-inhelpcmd-treecommand(Cont.)

Command

Dependency
None

help cmd-tree command [<command>]+

2.4.4.1.2.1
Table146

built-in help cmd-tree command <command>

built-inhelpcmd-treecommand<command>

Description
ThisparameterspecifiesthestructuredCLI(SCLI)commandorsubcommandfor
whichthesyntaxtreehastobedisplayed.
Thefollowingaresomeexamples:
1)helpcmd-treeshow-todisplaythecommandtreeforall"show"commands.
2)helpcmd-treeaddnetworking-todisplaythecommandtreeforall"add
networking"commands.
3)helpcmd-treeshowalarmtype-todisplaythecommandtreeforthe
"showalarmtype"command.
Parameter

Hint

Command

Range

Default

Dependency
None

help cmd-tree command [<command>]+

2.4.5 built-in history


Table147

built-inhistory

Description
ThiscommanddisplayspreviouslyexecutedCLIsessioncommands.Thecommand
historycanbenavigatedinaninteractivemodebyusingtheUpandDownarrow
keys.Specifichistorycommandscanbeinvokedwith
!nn-invokesthecommandstoredwithindexnninthecommandhistory
!-nn-invokenn-thtolastcommandfromthecommandhistory
Invoking!!(typetheexclamationmarktwice)repeatsthelastcommand.
Note:Atanypointoftime,onlythelast200executedcommandsareavailable
inCLIhistorybydefault.Atexit,thelast200historycommands(executedin
thepresentshell)willbewrittentothehistoryfileintheuser'shomedirectory
however,thatforthoseuserswhodonothaveahomedirectoryorwhosehomedirectory

192

Issue:03B

MulticontrollerRNCSCLICommands

Table147

SCLICommands

built-inhistory(Cont.)

isnotavailableinthesecure"chroot"filesystemavailablefromSCLIsessionsthe
historywillnotbesaved.Thisisparticularlythecasewheninvokedastheuser
"root"orwheninvokedonthemanagementnodewherethehomedirectoriesarenot
available(typicallythenodewherestandbyrecoveryunitofthe/SSHrecoverygroup
isrunning).Insuchcasesthehistoryisnotmaintainedovermultiplesessions.
Parameter

Hint

Command

Range

Default

Dependency
None

history

2.4.6 built-in quit


Table148

built-inquit

Description
ThiscommandterminatesthecurrentSCLIsession.
Anychangesmadetotheenvironmentarenotsavedbydefault,unlessthesave
commandhasbeenexecuted.Thecommandexecutionhistoryisautomaticallysaved
beforethesessionisterminated.
Parameter

Hint

Command

Range

Default

Dependency
None

quit

2.4.7 built-in shell


Table149

built-inshell

Description
Thiscommandlaunchesanexternalrestrictedbashshell(limited-bash).The
controlispassedtotheshellwhichhasstarted.Aftertheshellisexited,
thecontrolispassedbacktotheSCLIshell.Thishasthesameeffectas
executingthe"shellbashlimited"command.
Parameter

Issue:03B

Hint

Range

Default

193

SCLICommands

Table149

MulticontrollerRNCSCLICommands

built-inshell(Cont.)

Command

Dependency
None

shell
None
shell bash full
None
shell bash limited
None
shell scli node <node_name>
None
shell scli peer

2.4.7.1
Table150

built-in shell bash

built-inshellbash

Description
Thiscommandstartsanewbashshell.
Parameter

Hint

Command

Range

Default

Dependency
None

shell bash full


None
shell bash limited

2.4.7.1.1
Table151

built-in shell bash full

built-inshellbashfull

Description
Thiscommandstartsanewbashshellthathasfulloperationalcapabilities.
Parameter

194

Hint

Range

Default

Issue:03B

MulticontrollerRNCSCLICommands

Table151

SCLICommands

built-inshellbashfull(Cont.)

Command

Dependency
None

shell bash full

2.4.7.1.2
Table152

built-in shell bash limited

built-inshellbashlimited

Description
Thiscommandstartsanewbashshellthathaslimitedandsecureoperational
capabilities.
Parameter

Hint

Command

Range

Default

Dependency
None

shell bash limited

2.4.7.2
Table153

built-in shell scli

built-inshellscli

Description
ThiscommandstartsanewSCLIshell.
Parameter

Hint

Command

Range

Default

Dependency
None

shell scli peer


None
shell scli node <node_name>

2.4.7.2.1
Table154

built-in shell scli node

built-inshellsclinode

Description
ThiscommandallowsyoutostartaninteractiveSCLIsessiononaspecific
managementnodewithoutleavingtheexistingSCLIsession.
IfthesamenodeisspecifiedasinthecurrentSCLIsession,thiswillstart

Issue:03B

195

SCLICommands

Table154

MulticontrollerRNCSCLICommands

built-inshellsclinode(Cont.)

asecondSCLIsessiononthesamenode.TheexistingSCLIsessionwillnotbe
terminated.
ExitingfromthenewlyestablishedSCLIsessionwillbringyoubacktothe
originalSCLIsession.
Parameter

Hint

Command

Range

Default

Dependency
None

shell scli node <node_name>

2.4.7.2.1.1
Table155

built-in shell scli node <node_name>

built-inshellsclinode<node_name>

Description

Parameter

Hint

Command

Range

Default

Dependency
None

shell scli node <node_name>

2.4.7.2.2
Table156

built-in shell scli peer

built-inshellsclipeer

Description
ThiscommandallowsyoutostartaninteractiveSCLIsessiononthepeer
managementnodewithoutleavingtheexistingSCLIsession.Networkelements
typicallyhaveapairofmanagementnodes,typicallywithnamessuchasCLA-0
andCLA-1.Fromthispairthepeermanagementnodeisalwaystheonewhichis
notrunningthecurrentSCLIsession.
Forexample,runningthecommandfirstonthemanagementnodeCLA-0willcreate
aSCLIsessiononCLA-1.
RunningthecommandagainwithinthatCLA-1sessionwillcreateanewsession
onCLA-0.
Thisultimatelyconsumesresourcesfor3SCLIsessions(theoriginaloneplus
thetwonewones).
NotethatthenumberofSCLIsessionsarelimitedpernode,andfollowingthe

196

Issue:03B

MulticontrollerRNCSCLICommands

Table156

SCLICommands

built-inshellsclipeer(Cont.)

aboveexamplerepeatedlywillultimatelyexhaustthenumberofSCLIsessions.
TheexistingSCLIsessionwillnotbeterminated.Exitingfromthenewly
establishedSCLIsessionwillbringyoubacktotheoriginalSCLIsession.
Ifthenetworkelementhasonlyonemanagementnode,thiscommandwilldo
nothing.
Note:TheactualnamesoftheCLAnodescanvaryindifferentproduct
applications.Theterm"CLAnode"referstoanodethatcontainstheO&M
functionalitiesaswellasthecentralizedclustermanagementfunctions.Users
loginintoaCLAnodewhenstartinganSCLIsession.Inexamples,nameslike
"CLA-0"and"CLA-1"areusedfortheCLAnodes.
Parameter

Hint

Command

Range

Default

Dependency
None

shell scli peer

2.4.8 built-in user


Table157

built-inuser

Description
Thiscommandstartsanewloginshell(typically,theSCLI)withthespecifiedusernameastheuseraccount.
Thepasswordfortheuseraccounthastobespecified.Onlyusersthatbelongtothegroup_nokfsuiwheelor
wheelcanswitchtotherootaccount.Iftheusernameparameterisnotexplicitlygiven,thentherootaccount
isusedasthedefaultaccounttoswitchto.
Parameter

Hint

Range

Default

Theparameter"username"specifiestheusernameforthe
newshell.

usernameforthenew
shell(default:root)

root

username
Command

Dependency
None

set user {[username <username>]?}

Issue:03B

197

SCLICommands

MulticontrollerRNCSCLICommands

2.5 cluster
Table158

cluster

Description
Thiscommandresetstheclusterinspecifieddelay.
Parameter

Hint

Range

Default

Theparameteristhedelaytimefortheclusterreset.

1..20

delay-time
Command

Dependency
None

reset cluster {[delay-time <delay-time>]?}

2.6 cmf
Table159

cmf

Description
set
SetCMF(ClusterManagementFunctionality)stateofnodesandadministerDRBDresources.
show
QueryCMFstatusofthenodesandadministratingDRBDresources.
Parameter

Hint

Command

Range

Default

Dependency
None

set cmf disable {node-name <node-name> [non-permanent]?}


None
set cmf enable {node-name <node-name>}
None
set cmf restart {node-name <node-name>}
None
set cmf yield {node-name <node-name>}
None
show cmf status {node-name <node-name> [check-enabled]?

198

Issue:03B

MulticontrollerRNCSCLICommands

Table159

SCLICommands

cmf(Cont.)

[recovery-unit]? [verbose]?}

2.6.1 cmf disable


Table160

cmfdisable

Description
ThecommandpreventsthenodefromrunningtheHAScentralizedpart.Thecommandcanbeissuedonlytoanodethat
isconfiguredtorunHAScentralizedpart.
Forexample:
setcmfdisablenode-name/CLA-0
Parameter

node-name

non-permanent

Hint

Range

Default

Nameofthenode.Thenodecanbee.g./CLA-0or/CLA-1.
Note:TheactualnamesoftheCLA(ClusterAdministrator)
nodescanvaryindifferentproductapplications.Theterm
"CLAnode"referstoanodethatcontainsthecentralized
clustermanagementandOAMfunctionalitiesinthesystem.

Nameofthenode

NA

DonotstoreCMFdisableinformationtodisk.CMFis
enabledagainafternodereboot.Forexample:

DonotstoreCMF
disable

NA

setcmfdisablenon-permanentnode-name/CLA-0
Command

Dependency
None

set cmf disable {node-name <node-name> [non-permanent]?}

2.6.2 cmf enable


Table161

cmfenable

Description
ThiscommandreactivatesdisabledCMFinanode.Thismeansthatthenodeisallowedtotaketheactiveroleandstart
HAScentralizedpartinthenode.ThecommandcanbespecifiedonlyforanoperationalCMFnode.Forexample:
setcmfenablenode-name/CLA-0
Parameter

node-name

Command

Issue:03B

Hint

Range

Default

Nameofthenode.Thenodecanbee.g./CLA-0or/CLA-1.
Note:TheactualnamesoftheCLA(ClusterAdministrator)
nodescanvaryindifferentproductapplications.Theterm
"CLAnode"referstoanodethatcontainsthecentralized
clustermanagementandOAMfunctionalitiesinthesystem.

Nameofthenode

NA

Dependency

199

SCLICommands

Table161

MulticontrollerRNCSCLICommands

cmfenable(Cont.)
None

set cmf enable {node-name <node-name>}

2.6.3 cmf restart


Table162

cmfrestart

Description
ThiscommandrestartsCMFinthesamenode.ThecommandcanbespecifiedonlyforanoperationalCMFnodeandthe
nodeshouldhaveCMFstatusasCMF-SERVING.Forexample:
sethasrestartnode-name/CLA-0
Parameter

node-name

Hint

Range

Default

Nameofthenode.Thenodecanbee.g./CLA-0or/CLA-1.
Note:TheactualnamesoftheCLA(ClusterAdministrator)
nodescanvaryindifferentproductapplications.Theterm
"CLAnode"referstoanodethatcontainsthecentralized
clustermanagementandOAMfunctionalitiesinthesystem.

Nameofthenode

NA

Command

Dependency
None

set cmf restart {node-name <node-name>}

2.6.4 cmf status


Table163

cmfstatus

Description
GetstatusesofCMFnodes.ThestatusofaCMFnodecanbe
CMF-SERVING(thenodeisactive,i.e.itiscurrentlyrunningHAScentralizedpart),
CMF-BACKUP(thenodeisnotcurrentlyrunningHAScentralizedpartbutitcantaketheactiveroleifthecurrentactive
nodefails),
CMF-DISABLED(thenodeisnotallowedtotaketheactiverole),
CMF-NOTCONFIGURED(thenodeisnotconfiguredtorunHAScentralizedpart),
CMF-INITIALIZING(thenodeisstartingHAScentralizedpart)or
CMF-TERMINATING(thenodeisstoppingHAScentralizedpart).
ThecommandcanbespecifiedonlyforanoperationalCMFnode.Forexample:
showcmfstatusnode-name/CLA-0
Parameter

200

Hint

Range

Default

Issue:03B

MulticontrollerRNCSCLICommands

Table163

SCLICommands

cmfstatus(Cont.)

check-enabled

CheckifthegivennodecantakeCMFresponsibility.For
example:

CheckCMF
NA
responsibilitycapability

showcmfstatuscheck-enablednode-name/CLA-0

node-name

recovery-unit

Nameofthenode.Thenodecanbee.g./CLA-0or/CLA-1.
Note:TheactualnamesoftheCLA(ClusterAdministrator)
nodescanvaryindifferentproductapplications.Theterm
"CLAnode"referstoanodethatcontainsthecentralized
clustermanagementandOAMfunctionalitiesinthesystem.

Nameofthenode

NA

InDRBDconfigurationshowDRBDstatusesofnode's
recoveryunitsthathaveDRBDresources.Forexample:

Statusesofrecovery
units

NA

Showadditional
information

NA

showcmfstatusrecovery-unitnode-name/CLA-0
InDRBDconfigurationshowDRBDstatusinadditionto
basicCMFstatusinformation.Iftheoptionisassociatedto
thevalidatecommandthenadditionalvalidationinformation
isprinted.Forexample:

verbose

showcmfstatusverbosenode-name/CLA-0
Command

Dependency
None

show cmf status {node-name <node-name> [check-enabled]?


[recovery-unit]? [verbose]?}

2.6.5 cmf yield


Table164

cmfyield

Description
YieldHAScentralizedparttoanothernode.ThecommandcanbespecifiedonlyforanoperationalCMFnodeandthe
CMFstatusofthenodemustbeCMF-SERVING.Forexample:
setcmfyieldnode-name/CLA-0
Parameter

node-name

Hint

Range

Default

Nameofthenode.Thenodecanbee.g./CLA-0or/CLA-1.
Note:TheactualnamesoftheCLA(ClusterAdministrator)
nodescanvaryindifferentproductapplications.Theterm
"CLAnode"referstoanodethatcontainsthecentralized
clustermanagementandOAMfunctionalitiesinthesystem.

Nameofthenode

NA

Command

Dependency
None

set cmf yield {node-name <node-name>}

Issue:03B

201

SCLICommands

MulticontrollerRNCSCLICommands

2.7 config
Table165

config

Description
********************************WARNING**********************************
Theshow|add|delete|setconfig*commandsdirectlyaccess
theunderlyingconfigurationdirectory.Dataintheconfigurationdirectory
isstructuredinmannerthattheservicesusingitcaneasilyaccessit.
Thedataentriesand,especially,thedependenciesbetweenthemarenot
clearlyvisiblebyjustviewingthehierarchyofentries.
Thedataneednotbeaccessedintheconfigurationdirectorydirectly.
Forexample:
Insteadofusing"addconfigobject",usethespecificSCLIcommandslike
"addnetworkingaddress"toaddanIPaddresstoaninterface,or
"addstatsm-job"toaddastatisticsmeasurementjob.
Theshow|add|delete|setconfig*commandsmustonlybeusedonexplicit
requestbyaNokiaSolutionsandNetworksSupportEngineerorifinstructedin
theCustomerDocumentation.Donotusethecommandstodoarbitrarychanges
totheconfigurationdirectoryasthattypicallyleadstounintended
consequences.
AlsonotethatallSCLIcommands,includingtheadd|delete|set
configfamilyofcommands,generateanauditlog.Auditlogscanbeusedto
seeifthecommandwasmisused.
********************************WARNING**********************************
add
Forexample,addinganewobject"fsFragmentId=foobar"underexistingobject"fsClusterId=ClusterRoot":
addconfigobjectfsClusterId=ClusterRootattribute-listobject-namefsFragmentId=foobarobject-classFSFragment
fsFragmentIdfoobar
Forexample,addinganattribute(oftype"foo"andvalue"bar")toanexistingobject"fsClusterId=ClusterRoot
fsFragmentId=foobarfsFooName=foo":
addconfigattributefsClusterId=ClusterRootfsFragmentId=foobarfsFooName=fooattribute-listfoobar
delete
Thiscommanddeletesattributesandobjectsfromtheconfigurationdirectory.Forexample,theexistingleafobject
"fsFoo=bar"containsattribute"foo",whichshallbedeleted:
deleteconfigattributefsClusterId=ClusterRootfsFragmentId=foobarfsFoo=barattribute-listfoo
or
Forexample,theexistingleafobject"fsFoo=bar"shallbedeleted:

202

Issue:03B

MulticontrollerRNCSCLICommands

Table165

SCLICommands

config(Cont.)

deleteconfigobjectfsClusterId=ClusterRootfsFragmentId=foobarfsFoo=bar
set
Thiscommandmodifiesattributesofexistingobjectsintheconfigurationdirectory.Forexample,theexistingleafobject
"fsFoo=bar"containsattribute"foo",whichvalueissetto"bar":
setconfigattributefsClusterId=ClusterRootfsFragmentId=foobarfsFoo=barattribute-listfoobar
show
Thiscommanddisplaysconfigurationdirectorydata.Forexample,showingcontentof"fsFragmentId=foobar"anditschild
objects:
showconfigfsClusterId=ClusterRootfsFragmentId=foobar
or
Forexample,showingcontentof"ou=Group"anditschildobjects,whichmatchtothefilter(memberUid=_nokfssysldap*):
showconfigfilter(memberUid=_nokfssysldap*)fsClusterId=ClusterRootfsFragmentId=SystemSecurityou=Group
Parameter

filter

Hint

Range

Thefiltershouldconformtothestringrepresentationfor
filtervalue
searchfiltersasdefinedinRFC2254.Ifnotprovided,the
defaultfilter,(object-Class=*),isused.Forexample,thefilter
whichselectstheobjectswhosememberUidstartswith
_nokfssysldapisasfollows:

Default
NA

(memberUid=_nokfssysldap*)
YoucandisplayallthegroupsintheSystemSecurity
fragmentmatchingthisfilterbyexecutingthefollowing
command:
showconfigfilter(memberUid=_nokfssysldap*)
fsClusterId=ClusterRootfsFragmentId=SystemSecurity
ou=Group

host

scope

Thenameofthenodethatrunsaread-onlyreplicaofthe
ConfigurationDirectory.Thisparametercanbeusedfor
checkingifthedatachangedinthemasterConfiguration
DirectoryServerwascorrectlyreplicated.Thenameofthe
nodecanbe,forexample,CLA-1,CLA-0orAS-0.

Hostname

NA

Specifiesthescopeofthesearchwithinthedirectory
hierarchy.Thescopecanbeoneofthefollowing:

{base,one,sub}

sub

Timeoutforexecuting
theoperationin
milliseconds.Default
value:20000ms

20000

base:onlythebaseobjectisshown,
one:onelevelbelowthebaseisshown,
sub:thewholesubtreefromthebaseisshown(default).
add
timeout

Timeoutforexecutingtheoperationinmilliseconds(ms).
Thedefaulttimeoutvalueis20000ms.
delete

Issue:03B

203

SCLICommands

Table165

MulticontrollerRNCSCLICommands

config(Cont.)
Timeoutforexecutingtheoperationinmilliseconds(ms).
Thedefaulttimeoutvalueis20000ms.
set
Timeoutforexecutingtheoperationinmilliseconds(ms).
Thedefaulttimeoutvalueis20000ms.
show
Timeoutforexecutingtheoperationinmilliseconds(ms).
Thedefaulttimeoutvalueis5000ms.

Command

Dependency
None

show config {[timeout <timeout>]? [host <host>]? [filter


<filter>]? [scope <scope value>]?}
None
add config {[timeout <timeout>]?} attribute [<full-objectname>]+ attribute-list [<attribute-name> <attribute-value>]+
None
add config {[timeout <timeout>]?} object [<parent-object>]+
attribute-list {object-class <ObjectClass> object-name <objectname>} [<attribute-name> <attribute-value>]+
None
delete config {[timeout <timeout>]?} attribute [<full-objectname>]+ attribute-list [<attribute-name>]+
None
delete config {[timeout <timeout>]?} object [<full-objectname>]+
None
set config {[timeout <timeout>]?} attribute [<full-objectname>]+ attribute-list [<attribute-name> <attribute-value>]+
None
show config {[timeout <timeout>]? [host <host>]? [filter
<filter>]? [scope <scope value>]?} [<full-object-name>]+

2.7.1 config <full-object-name>


Table166

config<full-object-name>

Description

204

Issue:03B

MulticontrollerRNCSCLICommands

Table166

SCLICommands

config<full-object-name>(Cont.)

Definethesearchbasebygivingthefull-object-namevalue.Ifnofull-object-nameisgiven,emptyfull-object-nameisused.
Notethatindividualpartsofthefull-object-nameareseparatedbyspaces.Alsonotethattheobjectnamemustbegiven
startingfromthehighestlevelinthedirectorytree..Forexample:
fsClusterId=ClusterRootfsFragmentId=foobar
or
fsClusterId=ClusterRootfsFragmentId=SystemSecurityou=Group
Parameter

Hint

Command

Range

Default

Dependency
None

show config {[timeout <timeout>]? [host <host>]? [filter


<filter>]? [scope <scope value>]?} [<full-object-name>]+

2.7.2 config attribute


Table167

configattribute

Description
add
Thiscommandaddsattributestoanexistingobjectintheconfigurationdirectory.
Forexample,addinganattribute(oftype"foo"andvalue"bar")toanexistingobject"fsClusterId=ClusterRoot
fsFragmentId=foobarfsFooName=foo":
addconfigattributefsClusterId=ClusterRootfsFragmentId=foobarfsFooName=fooattribute-listfoobar
delete
Thiscommanddeletesattributesfromtheconfigurationdirectory.Forexample,theexistingleafobject"fsFoo=bar"
containsattribute"foo",whichshallbedeleted:
deleteconfigattributefsClusterId=ClusterRootfsFragmentId=foobarfsFoo=barattribute-listfoo
set
Thiscommandmodifiesattributesofexistingobjectsintheconfigurationdirectory.Forexample,theexistingleafobject
"fsFoo=bar"containsattribute"foo",whichvalueissetto"bar":
setconfigattributefsClusterId=ClusterRootfsFragmentId=foobarfsFoo=barattribute-listfoobar
Parameter

Hint

Command

Range

Default

Dependency
None

add config {[timeout <timeout>]?} attribute [<full-objectname>]+ attribute-list [<attribute-name> <attribute-value>]+


None
delete config {[timeout <timeout>]?} attribute [<full-object-

Issue:03B

205

SCLICommands

Table167

MulticontrollerRNCSCLICommands

configattribute(Cont.)

name>]+ attribute-list [<attribute-name>]+


None
set config {[timeout <timeout>]?} attribute [<full-objectname>]+ attribute-list [<attribute-name> <attribute-value>]+

2.7.2.1
Table168

config attribute <full-object-name>

configattribute<full-object-name>

Description
Objectnameconsistingofspace-separatedpartsintheformat<attributename>=<attributevalue>
Parameter

Hint

Command

Range

Default

Dependency
None

add config {[timeout <timeout>]?} attribute [<full-objectname>]+ attribute-list [<attribute-name> <attribute-value>]+


None
delete config {[timeout <timeout>]?} attribute [<full-objectname>]+ attribute-list [<attribute-name>]+
None
set config {[timeout <timeout>]?} attribute [<full-objectname>]+ attribute-list [<attribute-name> <attribute-value>]+

2.7.2.1.1
Table169

config attribute <full-object-name> attribute-list

configattribute<full-object-name>attribute-list

Description
add
alistofattributestobeaddedintheformat<attributename><attributevalue>
delete
aspaceseparatedlistofattributestobedeleted
set
alistofattributestobesetintheformat<attributename><attributevalue>
Parameter

206

Hint

Range

Default

Issue:03B

MulticontrollerRNCSCLICommands

Table169

SCLICommands

configattribute<full-object-name>attribute-list(Cont.)

Command

Dependency
None

add config {[timeout <timeout>]?} attribute [<full-objectname>]+ attribute-list [<attribute-name> <attribute-value>]+


None
delete config {[timeout <timeout>]?} attribute [<full-objectname>]+ attribute-list [<attribute-name>]+
None
set config {[timeout <timeout>]?} attribute [<full-objectname>]+ attribute-list [<attribute-name> <attribute-value>]+

2.7.2.1.1.1
Table170

config attribute <full-object-name> attribute-list <attribute-name>

configattribute<full-object-name>attribute-list<attribute-name>

Description
attributename
Parameter

Hint

Command

Range

Default

Dependency
None

delete config {[timeout <timeout>]?} attribute [<full-objectname>]+ attribute-list [<attribute-name>]+


None
add config {[timeout <timeout>]?} attribute [<full-objectname>]+ attribute-list [<attribute-name> <attribute-value>]+
None
set config {[timeout <timeout>]?} attribute [<full-objectname>]+ attribute-list [<attribute-name> <attribute-value>]+

2.7.2.1.1.1.1
Table171

configattribute<full-object-name>attribute-list<attribute-name><attribute-value>

configattribute<full-object-name>attribute-list<attribute-name><attributevalue>

Description
attributevalue
Parameter
Command

Issue:03B

Hint

Range

Default

Dependency

207

SCLICommands

Table171

MulticontrollerRNCSCLICommands

configattribute<full-object-name>attribute-list<attribute-name><attributevalue>(Cont.)
None

add config {[timeout <timeout>]?} attribute [<full-objectname>]+ attribute-list [<attribute-name> <attribute-value>]+


None
set config {[timeout <timeout>]?} attribute [<full-objectname>]+ attribute-list [<attribute-name> <attribute-value>]+

2.7.3 config object


Table172

configobject

Description
add
Thiscommandaddsobjectstotheconfigurationdirectory.
Forexample,addinganewobject"fsFragmentId=foobar"underexistingobject"fsClusterId=ClusterRoot":
addconfigobjectfsClusterId=ClusterRootattribute-listobject-namefsFragmentId=foobarobject-classFSFragment
fsFragmentIdfoobar
delete
Thiscommanddeletesanobjectfromtheconfigurationdirectory.Forexample,deletingaleafobject"fsFoo=bar":
deleteconfigobjectfsClusterId=ClusterRootfsFragmentId=foobarfsFoo=bar
Parameter

Hint

Command

Range

Default

Dependency
None

add config {[timeout <timeout>]?} object [<parent-object>]+


attribute-list {object-class <ObjectClass> object-name <objectname>} [<attribute-name> <attribute-value>]+
None
delete config {[timeout <timeout>]?} object [<full-objectname>]+

2.7.3.1
Table173

config object <full-object-name>

configobject<full-object-name>

Description
Objectnameconsistingofspace-separatedpartsintheformat<attributename>=<attributevalue>
Parameter

208

Hint

Range

Default

Issue:03B

MulticontrollerRNCSCLICommands

Table173

SCLICommands

configobject<full-object-name>(Cont.)

Command

Dependency
None

delete config {[timeout <timeout>]?} object [<full-objectname>]+

2.7.3.2
Table174

config object <parent-object>

configobject<parent-object>

Description
Newobjectnameintheformat<attributetype>=<attributevalue>
Parameter

Hint

Command

Range

Default

Dependency
None

add config {[timeout <timeout>]?} object [<parent-object>]+


attribute-list {object-class <ObjectClass> object-name <objectname>} [<attribute-name> <attribute-value>]+

2.7.3.2.1
Table175

config object <parent-object> attribute-list

configobject<parent-object>attribute-list

Description
ThiscommandaddsanobjecttotheConfigurationDirectorybygivinganobjectClassvalue(forexample,FSFragment),
theobjectname(forexample,fsFragmentId=foobar)andalistofattributenamesandvaluesintheformat<attribute
name>=<attributevalue>(forexample,fsFoo=bar).Notethattypicallyyouwillneedtorepeattheobjectnameinthe
attributelist,forexample,add"fsFragmentIdfoobar"(noquotes)totheattributelistifthetheobjectnameis
fsFragmentId=foobar.
Parameter

Hint

Range

Default

AvaluefortheObjectClassattribute

Avalueforthe
ObjectClassattribute

NA

Thenameofthenewobject.

{<objectname>=<objectvalue>}

NA

object-name

Command

Dependency

object-class

None
add config {[timeout <timeout>]?} object [<parent-object>]+
attribute-list {object-class <ObjectClass> object-name <objectname>} [<attribute-name> <attribute-value>]+

Issue:03B

209

SCLICommands

2.7.3.2.1.1
Table176

MulticontrollerRNCSCLICommands

config object <parent-object> attribute-list <attribute-name>

configobject<parent-object>attribute-list<attribute-name>

Description
ThiscommandaddsanobjecttotheConfigurationDirectorybygivinganobjectClassvalue(forexample,FSFragment),
theobjectname(forexample,fsFragmentId=foobar)andalistofattributenamesandvaluesintheformat<attribute
name>=<attributevalue>(forexample,fsFoo=bar).Notethattypicallyyouwillneedtorepeattheobjectnameinthe
attributelist,forexample,add"fsFragmentIdfoobar"(noquotes)totheattributelistifthetheobjectnameis
fsFragmentId=foobar.
Parameter

Hint

Command

Range

Default

Dependency
None

add config {[timeout <timeout>]?} object [<parent-object>]+


attribute-list {object-class <ObjectClass> object-name <objectname>} [<attribute-name> <attribute-value>]+

2.7.3.2.1.1.1
Table177

configobject<parent-object>attribute-list<attribute-name><attribute-value>

configobject<parent-object>attribute-list<attribute-name><attributevalue>

Description
ThiscommandaddsanobjecttotheConfigurationDirectorybygivinganobjectClassvalue(forexample,FSFragment),
theobjectname(forexample,fsFragmentId=foobar)andalistofattributenamesandvaluesintheformat<attribute
name>=<attributevalue>(forexample,fsFoo=bar).Notethattypicallyyouwillneedtorepeattheobjectnameinthe
attributelist,forexample,add"fsFragmentIdfoobar"(noquotes)totheattributelistifthetheobjectnameis
fsFragmentId=foobar.
Parameter

Hint

Command

Range

Default

Dependency
None

add config {[timeout <timeout>]?} object [<parent-object>]+


attribute-list {object-class <ObjectClass> object-name <objectname>} [<attribute-name> <attribute-value>]+

2.8 config-mode
Table178

config-mode

Description
set

210

Issue:03B

MulticontrollerRNCSCLICommands

Table178

SCLICommands

config-mode(Cont.)

Thiscommandallowstheuserstoperformconfigurationlockoperations.Theconfigurationlockcanbeusedtoprevent
othermanagementusersofthenetworkelementfromchangingtheconfiguration.Dependingonthesituation,youmightor
mightnotwanttodothis.Forexample,ifyoucoordinateyourchangeswithothersusers,forexample,oneuseronly
touchingonepartoftheconfigurationandanotherusertouchinganotherpart,andthere'snoriskofoverlapbetweenthe
twochangesets,thenitisperfectlyfinetodothechangeswithoutacquiringtheconfigurationlock.Allmanagement
interfaces,includingtheonesfacingthenetworkmanagementsystem,obeytheconfigurationlock.Thismeansthat,for
example,byacquiringtheconfigurationlocklocally,youcanblockchangestotheconfigurationcominginfromthenetwork
managementsystem.Youcanacquiretheconfigurationlockinnormal(non-exclusive)mode("on")orinexclusivemode
("exclusive"),orreleaseit("off")orresetitsidletimeout("touch").
show
Thiscommandallowstheusertoquerytheconfigurationlockstatus.
Parameter

Hint

Command

Range

Default

Dependency
None

set config-mode <config-mode-exclusive> {[wait-timeout <waittimeout>]? [lock-timeout <lock-timeout>]?}


None
set config-mode <config-mode-off>
None
set config-mode <config-mode-on> {[wait-timeout <waittimeout>]? [lock-timeout <lock-timeout>]?}
None
set config-mode <config-mode-touch>
None
set config-mode <mass-config> off
None
set config-mode <mass-config> on
None
show config-mode status

2.8.1 config-mode <config-mode-exclusive>


Table179

config-mode<config-mode-exclusive>

Description
Thiscommandacquirestheconfigurationlockforexclusiveuse.Ifalltheconditionsaremetasspecifiedbelow:-

Issue:03B

211

SCLICommands

Table179

MulticontrollerRNCSCLICommands

config-mode<config-mode-exclusive>(Cont.)

a)Theexclusivelockcanbeacquiredonlyifneithertheexclusivenornon-exclusivelockisheldbyanyuserinany
session;
b)Therearenoongoingcommands.
Theexclusivelockpreventsacquiringtheconfigurationlock.Italsopreventsstartingconfiguration-changingcommandsin
anothersession,beitoneofyoursoroneofanotheruser.
Parameter

lock-timeout

wait-timeout

Hint

Range

Theparameter"lock-timeout"isthemaximumtime,in
minutes,afterwhichtheconfigurationlockwillbereleased.
Tofullypreventanyidletimeout,specify0.Notethat"noidle
timeout"(0)mightresultinasituationthatrequiresarestart
oftheconfigurationlockrecoverygroup("/ConfLockServer")
toreleasetheconfigurationlockinsomefailurescenarios.
Thedefaultidle-timeoutis10minutes.

idle-timeoutvaluein
NA
minutesafterwhichthe
lockisautomatically
released(default10
minutes)

Theparameter"wait-timeout"isthemaximumtimeoutvalue,
inseconds,towaitforanyongoingconfigurationcommands
thatpreventtheconfigurationlocktobeacquiredto
complete.Thedefaultvalueofthisparameteris60seconds.

maximumtimeout
valueinsecondsto
waitforthelockto
becomeavailable
(default60seconds)

Command

Default

NA

Dependency
None

set config-mode <config-mode-exclusive> {[wait-timeout <waittimeout>]? [lock-timeout <lock-timeout>]?}

2.8.2 config-mode <config-mode-off>


Table180

config-mode<config-mode-off>

Description
Thiscommandreleasestheconfigurationlock.Thenormal,non-exclusiveconfigurationlockisonlyreleasedonceyou
releaseitinallsessionswhereyouacquiredit.Forexample,ifthenormal,non-exclusiveconfigurationlockwasacquired
fromSCLIsession1and2withthecommand"setconfig-modeon"runineachofthem,thentheconfigurationlockwill
onlybereleasedonceyourun"setconfig-modeoff"inbothsessions.
Parameter

Hint

Command

Range

Default

Dependency
None

set config-mode <config-mode-off>

212

Issue:03B

MulticontrollerRNCSCLICommands

SCLICommands

2.8.3 config-mode <config-mode-on>


Table181

config-mode<config-mode-on>

Description
Thiscommandacquirestheconfigurationlockifalltheconditionsaremetasspecifiedbelow:a)Nootheruserholdstheconfigurationlock(eitherexclusiveornormal);
b)Therearenoongoingconfiguration-changingcommands;
c)Thesameuserdoesnotholdtheexclusiveconfigurationlock.
Acquiringthenormal,non-exclusivelockpreventsotherusersfromacquiringtheconfigurationlock.Italsoprevents
startingconfiguration-changingcommandsbeingrunbyotherusers.Itdoesnotpreventrunningconfiguration-changing
commandsinanotherofyoursessions.Whileholdingtheconfigurationlock,thesameusercanacquiretheconfiguration
lockinanothersessioninnon-exclusivemodeorstartconfiguration-changingcommandsinanotherparallelsessioneven
withoutexplicitlyacquiringthenon-exclusiveconfigurationlock.Ifgenerallyusingtheconfigurationlock,itis
recommended,though,toacquireitineachsessiontoavoidnotnoticingthetimingoutoftheconfigurationlockdueto
inactivity.
Parameter

lock-timeout

wait-timeout

Hint

Range

Theparameter"lock-timeout"isthemaximumtime,in
minutes,afterwhichtheconfigurationlockwillbereleased.
Tofullypreventanyidletimeout,specify0.Notethat"noidle
timeout"(0)mightresultinasituationthatrequiresarestart
oftheconfigurationlockrecoverygroup("/ConfLockServer")
toreleasetheconfigurationlockinsomefailurescenarios.
Thedefaultidle-timeoutis10minutes.

idle-timeoutvaluein
NA
minutesafterwhichthe
lockisautomatically
released(default10
minutes)

Theparameter"wait-timeout"isthemaximumtimeoutvalue,
inseconds,towaitforanyongoingconfigurationcommands
thatpreventtheconfigurationlocktobeacquiredto
complete.Thedefaultvalueofthisparameteris60seconds.

maximumtimeout
valueinsecondsto
waitforthelockto
becomeavailable
(default60sec)

Command

Default

NA

Dependency
None

set config-mode <config-mode-on> {[wait-timeout <waittimeout>]? [lock-timeout <lock-timeout>]?}

2.8.4 config-mode <config-mode-touch>


Table182

config-mode<config-mode-touch>

Description
Thiscommandresetstheidle-timeoutoftheconfigurationlock.Usethiscommandtoavoidtheconfigurationlock
automaticallytimingoutduetoinactivity.
Parameter

Issue:03B

Hint

Range

Default

213

SCLICommands

Table182

MulticontrollerRNCSCLICommands

config-mode<config-mode-touch>(Cont.)

Command

Dependency
None

set config-mode <config-mode-touch>

2.8.5 config-mode <mass-config>


Table183

config-mode<mass-config>

Description
Thiscommandentersorexitsthespecialmass-configmode.Themass-configmodeimplicitlyacquirestheexclusive
configurationlock.Inthismode,thevalidationsintheconfigurationdirectoryarenotexecutedforindividualcommandsand
validationhappensonlyifandwhensavesnapshotisexecuted.
Parameter

Hint

Command

Range

Default

Dependency
None

set config-mode <mass-config> off


None
set config-mode <mass-config> on

2.8.5.1
Table184

config-mode <mass-config> off

config-mode<mass-config>off

Description
Thiscommandexitsthespecialmass-configmode.
Allchangesdoneduringmass-configmodearelostunlesssavesnapshotcommandhasbeenexecutedbefore.
Parameter

Hint

Command

Range

Default

Dependency
None

set config-mode <mass-config> off

2.8.5.2
Table185

config-mode <mass-config> on

config-mode<mass-config>on

Description

214

Issue:03B

MulticontrollerRNCSCLICommands

Table185

SCLICommands

config-mode<mass-config>on(Cont.)

Thiscommandentersthespecialmass-configmode.Thiscommandisratherheavyoperation.Themass-configmode
implicitlyacquirestheexclusiveconfigurationlock.Inthismode,validationintheconfigurationdirectoryisnotdonefor
individualcommandsandvalidationhappensonlyifandwhensavesnapshotisexecuted.
Ifasessionisterminatedoraclusterisrestartedduringmassconfigurationmode,thenchangesmadeduringthemode
arelost.
Parameter

Hint

Command

Range

Default

Dependency
None

set config-mode <mass-config> on

2.8.6 config-mode status


Table186

config-modestatus

Description
Thiscommandshowstheconfigurationlockstatus,includingtheinformationabouttheholderofthelock,thetypeoflock
(non-exclusiveorexclusivelock),andthenumberofsessionsinwhichthenormalnon-exclusivelockiscurrentlyacquired
for.Additionally,itshowsthenumberofongoingconfiguration-changingcommands.
Parameter

Hint

Command

Range

Default

Dependency
None

show config-mode status

2.9 directory
Table187

directory

Description
add
Thiscommandisusedtoaddanewdirectory.
delete
Thiscommanddeletesthegivendirectoryprovidedthedirectorytobedeletedisempty.Anydirectorydirectlyunder'/'(eg:
/bin,/backup)cannotbedeletedeveniftheyareempty.Tryingtodosowillresultinanerroroftheform"Failedtoremove
directory,goterror:Deviceorresourcebusy".
Parameter

Issue:03B

Hint

Range

Default

215

SCLICommands

Table187

MulticontrollerRNCSCLICommands

directory(Cont.)

Command

Dependency
None

add directory <directory>


None
delete directory <directory>

2.9.1 directory <directory>


Table188

directory<directory>

Description
add
Theparameter"directory"specifiesthenameofthedirectorytobeadded.
delete
Theparameter"directory"specifiesthenameofthedirectorytobedeleted.
Parameter

Hint

Command

Range

Default

Dependency
None

add directory <directory>


None
delete directory <directory>

2.10 file
Table189

file

Description
copy
Thiscommandallowstheusertocopyagivenfiletogivenalocation.Theownershipofthecopiedfilewillreflecttheuser
executingthecommand.Thepermissionsofthefilewillberetainedasinthesourcelocationunlessthedestinationfile
existsandisgettingoverwritten,inwhichcase,itsoldpermissionsareretained.Fileaccesscontrollistsofthesourcefile
arenevercopied.Thedefaultumaskforinteractiveandnon-interactivesessionsissetto002.UserswithuserIDsless
than100(thisincludes,ifactuallyavailable,therootuseraccount),willhavetheirdefaultumasksetto022.Aumaskof
002willautomaticallymaskoutthewritepermissionfor"others"andaumaskof022willmaskoutthewritepermissionfor
thegroupownerofthefileandfor"others".
delete
Thiscommanddeletesthegivenfile.

216

Issue:03B

MulticontrollerRNCSCLICommands

Table189

SCLICommands

file(Cont.)

set
Thiscommandisusedtocomputesha1sum.
show
Thiscommandshowsfilerelatedinformation.
Parameter

Hint

Range

Default

Theparameter"destination"specifiesthedestinationfileor
destinationdirectorywherethegivenfileistobecopied.

destinationfileor
directory

NA

destination

Theparameter"source"specifiesthefilewhichistobe
copied.

sourcefile

NA

source
Command

Dependency
None

copy file {source <source> destination <destination>}


None
delete file <file>
None
set file sha1sum <checksum-file> <directory>
None
show file content <file>
None
show file disk-usage <directory>
None
show file list <directory>
None
show file sha1sum <checksum-file>

2.10.1 file <file>


Table190

file<file>

Description
Theparameter"file"specifiesnameofthefiletobedeleted.
Parameter
Command

Issue:03B

Hint

Range

Default

Dependency

217

SCLICommands

Table190

MulticontrollerRNCSCLICommands

file<file>(Cont.)
None

delete file <file>

2.10.2 file content


Table191

filecontent

Description
Thiscommandwilldisplaythecontentsofthefilegivenasaparameter.
Parameter

Hint

Command

Range

Default

Dependency
None

show file content <file>

2.10.2.1
Table192

file content <file>

filecontent<file>

Description
Theparameter"file"specifiesthefilewhosecontentsaretobedisplayed.
Parameter

Hint

Command

Range

Default

Dependency
None

show file content <file>

2.10.3 file disk-usage


Table193

filedisk-usage

Description
Thiscommandisusedtoshowthediskusageofthefilesystemonwhichthegivendirectoryismounted.
Parameter

Hint

Command

Range

Default

Dependency
None

show file disk-usage <directory>

218

Issue:03B

MulticontrollerRNCSCLICommands

2.10.3.1
Table194

SCLICommands

file disk-usage <directory>

filedisk-usage<directory>

Description
Theparameter"directory"specifiesthedirectorywhosefilesystemdiskusageistobeshown.
Parameter

Hint

Command

Range

Default

Dependency
None

show file disk-usage <directory>

2.10.4 file list


Table195

filelist

Description
Thiscommandlistsfilesunderagivendirectory
Parameter

Hint

Command

Range

Default

Dependency
None

show file list <directory>

2.10.4.1
Table196

file list <directory>

filelist<directory>

Description
Theparameter"directory"specifiesthedirectorytobelisted.
Parameter

Hint

Command

Range

Default

Dependency
None

show file list <directory>

2.10.5 file sha1sum


Table197

filesha1sum

Description

Issue:03B

219

SCLICommands

Table197

MulticontrollerRNCSCLICommands

filesha1sum(Cont.)

set
Thiscommandisusedtocomputethesha1checksumforagivenfile.Thefilecontainingthechecksumwillbenamedas
'bu.sha1'andwillbestoredunderthedirectorygivenasaparameter.Givingthesamedirectorymultipletimeswillkeep
appendingthesha1sumstothesamefile.
show
ThiscommandisusedtoreadtheSHA1sumsfromagivenfileandcheckthem.
Parameter

Hint

Command

Range

Default

Dependency
None

set file sha1sum <checksum-file> <directory>


None
show file sha1sum <checksum-file>

2.10.5.1
Table198

file sha1sum <checksum-file>

filesha1sum<checksum-file>

Description
set
Theparameter"checksum-file"specifiesthefileforwhichthechecksumistobecomputed.
show
Theparameter"checksum-file"specifiesthefilewhichhasthechecksumtobechecked.
Parameter

Hint

Command

Range

Default

Dependency
None

show file sha1sum <checksum-file>


None
set file sha1sum <checksum-file> <directory>

2.10.5.1.1
Table199

file sha1sum <checksum-file> <directory>

filesha1sum<checksum-file><directory>

Description
Theparameter"directory"specifiesthedirectorypathwherethefilewiththecomputedchecksumistobestored.
Parameter

220

Hint

Range

Default

Issue:03B

MulticontrollerRNCSCLICommands

Table199

SCLICommands

filesha1sum<checksum-file><directory>(Cont.)

Command

Dependency
None

set file sha1sum <checksum-file> <directory>

2.11 hardware
Table200

hardware

Description
add
Adddifferenthwmodules
delete
Removedifferenthwmodules
set
hardwarerelatedsettings
show
showshardwareinformation
start
Performahardwarestartrelatedoperation.
stop
Performahardwarestoprelatedoperation.
Parameter

Hint

Command

Range

Default

Dependency
None

add hardware config component <component-name> {type <type>}


None
add hardware config component <new-component-name> {type <type>
[location-name <location-name>]?}
None
delete hardware config component <component-name> {[deletelinked-has-nodes <delete-linked-has-nodes>]? [power-off-first
<power-off-first>]?}
None
delete hardware config disk-storage {storage-name <name of disk
storage>}

Issue:03B

221

SCLICommands

Table200

MulticontrollerRNCSCLICommands

hardware(Cont.)
None

delete hardware diagnostics report all


None
delete hardware diagnostics report fru-location <frulocation>
all
None
delete hardware diagnostics report fru-location <frulocation>
report-name <r-name>
None
set hardware admin-ignore sync
None
set hardware admin-ignore <yes-no> fru-location <fru-locationname>
None
set hardware config physical-location <physical-location>
cabinet-id <cabinet_id> {[chassis-id <chassis_id>]?}

2.11.1 hardware admin-ignore


Table201

hardwareadmin-ignore

Description
admin-ignorestateforahardwareunit.
Parameter

Hint

Command

Range

Default

Dependency
None

set hardware admin-ignore sync


None
set hardware admin-ignore <yes-no> fru-location <fru-locationname>

2.11.1.1
Table202

hardware admin-ignore <yes-no>

hardwareadmin-ignore<yes-no>

Description

222

Issue:03B

MulticontrollerRNCSCLICommands

Table202

SCLICommands

hardwareadmin-ignore<yes-no>(Cont.)

Parameter

Hint

Command

Range

Default

Dependency
None

set hardware admin-ignore <yes-no> fru-location <fru-locationname>

2.11.1.1.1
Table203

hardware admin-ignore <yes-no> fru-location

hardwareadmin-ignore<yes-no>fru-location

Description
fieldreplaceableunit(FRU)locationofthehardwareunits
Parameter

Hint

Command

Range

Default

Dependency
None

set hardware admin-ignore <yes-no> fru-location <fru-locationname>

2.11.1.1.1.1
Table204

hardware admin-ignore <yes-no> fru-location <fru-location-name>

hardwareadmin-ignore<yes-no>fru-location<fru-location-name>

Description
Thiscommandprovidesamethodtosettheadministrativestatusofhardwareunitforconsidering/ignoringtheinstalled
hardwarebasedoninputfromuser/operator.
Parameter

Hint

Command

Range

Default

Dependency
None

set hardware admin-ignore <yes-no> fru-location <fru-locationname>

2.11.1.2
Table205

hardware admin-ignore sync

hardwareadmin-ignoresync

Description
Thiscommandisusedtosynchronizetheclusterconfigurationdatawiththerealhardwareunitspresentinthenetwork
element.

Issue:03B

223

SCLICommands

Table205
Parameter

MulticontrollerRNCSCLICommands

hardwareadmin-ignoresync(Cont.)
Hint

Command

Range

Default

Dependency
None

set hardware admin-ignore sync

2.11.2 hardware config


Table206

hardwareconfig

Description
add
Adddifferenthwmoduleinconfiguration
delete
Removedifferenthwmodulefromcurrentconfiguration
set
Modifyhardwarelocationinconfiguration
show
showshardwareconfiguration
Parameter

Hint

Command

Range

Default

Dependency
None

add hardware config component <component-name> {type <type>}


None
add hardware config component <new-component-name> {type <type>
[location-name <location-name>]?}
None
delete hardware config component <component-name> {[deletelinked-has-nodes <delete-linked-has-nodes>]? [power-off-first
<power-off-first>]?}
None
delete hardware config disk-storage {storage-name <name of disk
storage>}

224

Issue:03B

MulticontrollerRNCSCLICommands

Table206

SCLICommands

hardwareconfig(Cont.)
None

set hardware config physical-location <physical-location>


cabinet-id <cabinet_id> {[chassis-id <chassis_id>]?}
None
show hardware config disk-storage {[unused]?}
None
show hardware config physical-location cabinet-id <cabinet-id>
{[chassis-id <chassis_id>]?}

2.11.2.1
Table207

hardware config component

hardwareconfigcomponent

Description
add
Acomponentisahardwareentitywhichholdsahardwaremoduleormodules.Itcanbeconfiguredwiththetype,which
indicatesthatatypeofhardwarecanbeinsertedintoitsphysicallocation.Thecomponenttokenisauto-completed.
Forexample,inaddinganewchassis,theusercanpresstheTABkey,thenalistofcurrentchassisandanewchassiswill
beshown.Alongwithaddinganewchassis,theswitches,shelfmanagementcontrollers,fanmodulesandpowermodules
areautomaticallyadded.Notethatauto-completionfornewchassisalwayslistsnewchassisIDascurrentchassis-id+1.
Forexample,ifthereiscurrentlyonlyonechassisinconfiguration,thenthenewchassisIDwillbechassis-2.
Inaaddinganewblade,theusercanpresstheTABkeyaftercompletingthechassis.Forexample,/chassis-1/or
/chassis-1,thenpresstheTABkey.Itwillgivealistof"/chassis-1/slot-#".
Addinganewmodule,usercanpressaTABkeyaftercompletingtheslotsunderchassis,e.g./chassis-1/slot-11or
/chassis-1/slot-11/andpressaTABkey.Itwillgivealistof"/chassis-1/slot-11/sub-slot-#".
delete
Thiscommanddeletesahardwarecomponent.Acomponentisahardwareentitywhichholdsthehardwaremodules.
Deletingthishardwareconfigurationisremovingtheexpectedhardwaretypeforthathardwarecomponent.The
componenttokenisauto-completed.
Forexample,indeletinganewchassis,theusercanpresstheTABkey,thenalistofthecurrentchassiswillbeshown.
Indeletinganewblade,theusercanpresstheTABkeyaftercompletingthechassis.Forexample./chassis-1/or/chassis1andthenpresstheTABkey.Itwillgivealistof"/chassis-1/slot-#".
Indeletingamodule,theusercanpresstheTABkeyaftercompletingtheslotsunderchassis.Forexample,/chassis1/slot-11or/chassis-1/slot-11/andthenpresstheTABkey.Itwillgivealistof"/chassis-1/slot-11/sub-slot-#".
Parameter

Hint

Command

Range

Default

Dependency
None

add hardware config component <component-name> {type <type>}


None
add hardware config component <new-component-name> {type <type>

Issue:03B

225

SCLICommands

Table207

MulticontrollerRNCSCLICommands

hardwareconfigcomponent(Cont.)

[location-name <location-name>]?}
None
delete hardware config component <component-name> {[deletelinked-has-nodes <delete-linked-has-nodes>]? [power-off-first
<power-off-first>]?}

2.11.2.1.1
Table208

hardware config component <component-name>

hardwareconfigcomponent<component-name>

Description
add
Acomponentisahardwareentitywhichholdsahardwaremoduleormodules.Itcanbeconfiguredwiththetype,which
indicatesatypeofhardwarecanbeinsertedintoitsphysicallocation.
delete
Acomponentisahardwareentitywhichholdsthehardwaremodules.Deletingthishardwareconfigurationisremovingthe
expectedhardwaretypeforthathardwarecomponent.
Parameter

delete-linkedhas-nodes

power-off-first

type

Hint

Range

Default

Theparameter"delete-linked-has-nodes"specifiestheHAS {yes|no}
node(s)linkedtoaparticularcomponent.Ifthevalue"yes"is
given,thentheHASnode(s)linkedtoaparticular
componentwillbedeleted.Ifthevalue"no"isgiven,then
theHASnode/slinkedtoaparticularcomponentwillnotbe
deleted.

no

Theparameter"power-off-first"specifiesthattheHASnodes {yes|no}
linkedtoaparticularcomponentwillbeautomatically
poweredoff.Ifthevalue"yes"isgiven,thenthelinkedHAS
nodewillbeautomaticallypoweredoff.Ifthevalue"no"is
given,thenthelinkedHASnodesarerequiredtobe
manuallypoweredoff.

no

Acomponentisahardwareentitywhichholdsthehardware
modules,anditsconfiguredtypedefineswhichkindof
hardwarecouldbeinsertedintothatphysicallocationgiven
fromacomponentoption.

NA

Command

Addsanewhardware
componenttype.

Dependency
None

add hardware config component <component-name> {type <type>}


None
delete hardware config component <component-name> {[deletelinked-has-nodes <delete-linked-has-nodes>]? [power-off-first
<power-off-first>]?}

226

Issue:03B

MulticontrollerRNCSCLICommands

2.11.2.1.2
Table209

SCLICommands

hardware config component <new-component-name>

hardwareconfigcomponent<new-component-name>

Description
Thiscommandaddsanewchassistothecurrentconfiguration.Switches,shelfmanagementcontrollers,fanmodules,and
powermodulesareautomaticallyaddedalongwiththeadditionofanewchassis.Thechassis-name,thelocationof
chassisandcabinet,andthechassistypeareneededfortheaddition.Notethatauto-completionfornewchassisalways
listsnewchassisIDascurrentchassis-id+1.Forexample,ifthereiscurrentlyonlyonechassisinconfiguration,thenthe
newchassisIDwillbechassis-2.
Parameter

Hint

Range

Default

Theparameter"location-name"specifiesthelocationofthe
chassisandthecabinet.Thisinformationisusedtohelp
locatethechassisandcabinetinthelab.Thesyntaxforthis
is"chassis-id:cabinet-id".

Addsthelocationof
thechassisandthe
cabinet.

NA

Typeofthenewchassis.

Addsanewchassis
type.

NA

type
Command

Dependency

location-name

None
add hardware config component <new-component-name> {type <type>
[location-name <location-name>]?}

2.11.2.2
Table210

hardware config disk-storage

hardwareconfigdisk-storage

Description
delete
Thiscommanddeletesdiskstorages.
show
Thiscommanddisplaysthediskstorages.
Parameter

Hint

Theparameter"storage-name"specifiesthediskstoragesto nameofdiskstorage
beremoved,thatarenotconfiguredinthesystembutare
physicallypresentinit.

NA

storage-name

Theparameter"unused"specifiesthediskstorageswhich
arenotconfiguredinthesystembutarephysicallypresent
init.

NA

unused

Command

Range

unuseddiskstorages

Default

Dependency
None

delete hardware config disk-storage {storage-name <name of disk

Issue:03B

227

SCLICommands

Table210

MulticontrollerRNCSCLICommands

hardwareconfigdisk-storage(Cont.)

storage>}
None
show hardware config disk-storage {[unused]?}

2.11.2.3
Table211

hardware config physical-location

hardwareconfigphysical-location

Description
set
Provideanewphysical-locationnametobeset
show
Thiscommandshowsthephysicallocationoftheselectedcabinetorchassis.
Case1:Ifthecabinetisselectedbytheuser,thenthephysicallocationoftherespectivecabinetwillbedisplayedtothe
user.
Case2:Iftheuserselectsthecabinetandthechassis,thenonlythephysicallocationoftherespectivechassiswillbe
displayedtotheuser.
Parameter

Hint

Command

Range

Default

Dependency
None

set hardware config physical-location <physical-location>


cabinet-id <cabinet_id> {[chassis-id <chassis_id>]?}
None
show hardware config physical-location cabinet-id <cabinet-id>
{[chassis-id <chassis_id>]?}

2.11.2.3.1
Table212

hardware config physical-location <physical-location>

hardwareconfigphysical-location<physical-location>

Description
Provideanewphysical-locationnametobeset
Parameter

Hint

Command

Range

Default

Dependency
None

set hardware config physical-location <physical-location>


cabinet-id <cabinet_id> {[chassis-id <chassis_id>]?}

228

Issue:03B

MulticontrollerRNCSCLICommands

2.11.2.3.1.1
Table213

SCLICommands

hardware config physical-location <physical-location> cabinet-id

hardwareconfigphysical-location<physical-location>cabinet-id

Description
Identificationnumberofcabinete.g.1ton.
Parameter

Hint

Command

Range

Default

Dependency
None

set hardware config physical-location <physical-location>


cabinet-id <cabinet_id> {[chassis-id <chassis_id>]?}

2.11.2.3.1.1.1
Table214

hardwareconfigphysical-location<physical-location>cabinet-id<cabinet_id>

hardwareconfigphysical-location<physical-location>cabinet-id
<cabinet_id>

Description
Identificationnumberofchassise.g.1ton.
Parameter

Hint

Range

Default

Chassisidentificationnumber

Chassisidentification
number

NA

chassis-id
Command

Dependency
None

set hardware config physical-location <physical-location>


cabinet-id <cabinet_id> {[chassis-id <chassis_id>]?}

2.11.2.3.2
Table215

hardware config physical-location cabinet-id

hardwareconfigphysical-locationcabinet-id

Description
Theparameter"cabinet-id"specifiesthecabinetidentificationname.Forexample,cabinet-1tocabinet-n.
Parameter

Hint

Command

Range

Default

Dependency
None

show hardware config physical-location cabinet-id <cabinet-id>


{[chassis-id <chassis_id>]?}

Issue:03B

229

SCLICommands

2.11.2.3.2.1
Table216

MulticontrollerRNCSCLICommands

hardware config physical-location cabinet-id <cabinet-id>

hardwareconfigphysical-locationcabinet-id<cabinet-id>

Description
Thiscommandshowsthephysicallocationoftheselectedcabinetorchassis.
Case1:Ifthecabinetisselectedbytheuser,thenthephysicallocationoftherespectivecabinetwillbedisplayedtothe
user.
Case2:Iftheuserselectsthecabinetandthechassis,thenonlythephysicallocationoftherespectivechassiswillbe
displayedtotheuser.
Parameter

Hint

Range

Default

Theparameter"chassis-id"specifiesthechassis
identificationname.Forexample,chassis-1tochassis-n.

chassisidentification
name

NA

chassis-id
Command

Dependency
None

show hardware config physical-location cabinet-id <cabinet-id>


{[chassis-id <chassis_id>]?}

2.11.3 hardware diagnostics


Table217

hardwarediagnostics

Description
delete
Deletehardwarediagnosticstestreport(s).
show
Showstheavailablehardwarediagnostictests,reports,testreadinessandreportstatus.
Supportedfunctionsare:
1.test-list:Showsthelistofhardwarediagnostictestssupported.
2.test-details:Showsthedetailsofhardwarediagnostictest.
3.test-readiness:Showsthehardwarereadinessforadiagnostictest.
4.report-status:Showsthestatusofanongoingtestreport.
5.report-list:Showsthelistofallavailablehardwarediagnosticreports.
6.report-details:Showsthedetailedreportofahardwarediagnostictest.
start
Startsahardwarediagnosticstest.
stop
Stopsarunningdiagnosticstest.
Parameter

230

Hint

Range

Default

Issue:03B

MulticontrollerRNCSCLICommands

Table217

SCLICommands

hardwarediagnostics(Cont.)

Command

Dependency
None

delete hardware diagnostics report all


None
delete hardware diagnostics report fru-location <frulocation>
all
None
delete hardware diagnostics report fru-location <frulocation>
report-name <r-name>
None
show hardware diagnostics report-details {report-name <report
name>}
None
show hardware diagnostics report-list
None
show hardware diagnostics report-list fru-location <frulocation> {[test <test-name>]?}
None
show hardware diagnostics report-status fru-location <frulocation> {test <test-name>}
None
show hardware diagnostics report-status report-name <reportname>
None
show hardware diagnostics test-details fru-location
<frulocation> {test <test-name>}
None
show hardware diagnostics test-list {fru-location <FRU
Location>}

2.11.3.1
Table218

hardware diagnostics fru-location

hardwarediagnosticsfru-location

Description
frulocation

Issue:03B

231

SCLICommands

Table218

MulticontrollerRNCSCLICommands

hardwarediagnosticsfru-location(Cont.)

Parameter

Hint

Command

Range

Default

Dependency
None

start hardware diagnostics fru-location <frulocation> {reportname <report name> test <test-name> [blocking <test type>]?}
None
stop hardware diagnostics fru-location <fru-location> {test
<test-name>}

2.11.3.1.1
Table219

hardware diagnostics fru-location <fru-location>

hardwarediagnosticsfru-location<fru-location>

Description
Stopsadiagnosticstestfortheselectedfruandtestid.
Parameter

Hint

Range

Default

Displayslistoftestsupportedbytheselectedfru.

nameofthetest

NA

test
Command

Dependency
None

stop hardware diagnostics fru-location <fru-location> {test


<test-name>}

2.11.3.1.2
Table220

hardware diagnostics fru-location <frulocation>

hardwarediagnosticsfru-location<frulocation>

Description
Startsthespecifiedhardwarediagnosticstestonthespecifiedfru-location.
Parameter

blocking

Hint

Range

Default

Typeoftest.

test-type

false

Supportedvalues:
blocking:true-fsclishshellisblockeduntiltestcompletes.
blocking:false(default)-testisqueuedandfsclishshellisnot
blocked.

232

Issue:03B

MulticontrollerRNCSCLICommands

Table220

SCLICommands

hardwarediagnosticsfru-location<frulocation>(Cont.)
Diagnosticstestreportname.Reportnamehastobe
unique.

report-name

NA

report-name

Theparameter"test"specifiesthenameofthetestwhich
hastoberunon

nameofthetest

NA

test

aselectedFRUlocation.
Command

Dependency
None

start hardware diagnostics fru-location <frulocation> {reportname <report name> test <test-name> [blocking <test type>]?}

2.11.3.2
Table221

hardware diagnostics report

hardwarediagnosticsreport

Description
delete
Deletehardwarediagnosticstestreport(s).
stop
Stopstheactivediagnosticstestidentifiedbythereportname.
Parameter

Hint

Range

Default

reportname.

report-name

NA

report-name
Command

Dependency
None

stop hardware diagnostics report {report-name <report name>}


None
delete hardware diagnostics report all
None
delete hardware diagnostics report fru-location <frulocation>
all
None
delete hardware diagnostics report fru-location <frulocation>
report-name <r-name>

Issue:03B

233

SCLICommands

2.11.3.2.1
Table222

MulticontrollerRNCSCLICommands

hardware diagnostics report all

hardwarediagnosticsreportall

Description
Deletesallthetestreports.
Parameter

Hint

Command

Range

Default

Dependency
None

delete hardware diagnostics report all

2.11.3.2.2
Table223

hardware diagnostics report fru-location

hardwarediagnosticsreportfru-location

Description
frulocation
Parameter

Hint

Command

Range

Default

Dependency
None

delete hardware diagnostics report fru-location <frulocation>


all
None
delete hardware diagnostics report fru-location <frulocation>
report-name <r-name>

2.11.3.2.2.1
Table224

hardware diagnostics report fru-location <frulocation>

hardwarediagnosticsreportfru-location<frulocation>

Description
Deletesallthediagnosticsreportforthespecifiedfru.
Parameter
Command

234

Hint

Range

Default

Dependency

Issue:03B

MulticontrollerRNCSCLICommands

Table224

SCLICommands

hardwarediagnosticsreportfru-location<frulocation>(Cont.)
None

delete hardware diagnostics report fru-location <frulocation>


all
None
delete hardware diagnostics report fru-location <frulocation>
report-name <r-name>

2.11.3.2.2.1.1
Table225

hardwarediagnosticsreportfru-location<frulocation>all

hardwarediagnosticsreportfru-location<frulocation>all

Description
Deletesalldiagnosticsreportfortheselectedfru.
Parameter

Hint

Command

Range

Default

Dependency
None

delete hardware diagnostics report fru-location <frulocation>


all

2.11.3.2.2.1.2
Table226

hardwarediagnosticsreportfru-location<frulocation>report-name

hardwarediagnosticsreportfru-location<frulocation>report-name

Description
Deletesthespecifieddiagnosticstestreportidentifiedbyreportname.
Parameter

Hint

Command

Range

Default

Dependency
None

delete hardware diagnostics report fru-location <frulocation>


report-name <r-name>

2.11.3.2.2.1.2.1

Table227

hardwarediagnosticsreportfru-location<frulocation>report-name<r-name>

hardwarediagnosticsreportfru-location<frulocation>report-name<rname>

Description
Displaysreportsavailablefordeletion.
Parameter

Issue:03B

Hint

Range

Default

235

SCLICommands

Table227

MulticontrollerRNCSCLICommands

hardwarediagnosticsreportfru-location<frulocation>report-name<rname>(Cont.)

Command

Dependency
None

delete hardware diagnostics report fru-location <frulocation>


report-name <r-name>

2.11.3.3
Table228

hardware diagnostics report-details

hardwarediagnosticsreport-details

Description
Displaysthetestreportspecifiedbyreport-name.
Parameter

Hint

Range

Default

Hardwarediagnostictestreportname.

report-name

NA

report-name
Command

Dependency
None

show hardware diagnostics report-details {report-name <report


name>}

2.11.3.4
Table229

hardware diagnostics report-list

hardwarediagnosticsreport-list

Description
Showsthelistofavailablediagnosticstestreports.
Parameter

Hint

Command

Range

Default

Dependency
None

show hardware diagnostics report-list


None
show hardware diagnostics report-list fru-location <frulocation> {[test <test-name>]?}

2.11.3.4.1
Table230

hardware diagnostics report-list fru-location

hardwarediagnosticsreport-listfru-location

Description

236

Issue:03B

MulticontrollerRNCSCLICommands

Table230

SCLICommands

hardwarediagnosticsreport-listfru-location(Cont.)

Displaysallthediagnosticstestreportsfortestsconductedonfru-location.
Parameter

Hint

Command

Range

Default

Dependency
None

show hardware diagnostics report-list fru-location <frulocation> {[test <test-name>]?}

2.11.3.4.1.1
Table231

hardware diagnostics report-list fru-location <fru-location>

hardwarediagnosticsreport-listfru-location<fru-location>

Description
Displayslistofhardwarediagnosticsreportsavailablefortheselectedfrulocation
and/orthetestid.
Parameter

Hint

Range

Default

Displayslistoftestsupportedbytheselectedfru.

nameofthetest

NA

test
Command

Dependency
None

show hardware diagnostics report-list fru-location <frulocation> {[test <test-name>]?}

2.11.3.5
Table232

hardware diagnostics report-status

hardwarediagnosticsreport-status

Description
Displaysstatusofongoinghardwarediagnostictests.
Parameter

Hint

Command

Range

Default

Dependency
None

show hardware diagnostics report-status fru-location <frulocation> {test <test-name>}


None
show hardware diagnostics report-status report-name <reportname>

Issue:03B

237

SCLICommands

2.11.3.5.1
Table233

MulticontrollerRNCSCLICommands

hardware diagnostics report-status fru-location

hardwarediagnosticsreport-statusfru-location

Description
frulocation
Parameter

Hint

Command

Range

Default

Dependency
None

show hardware diagnostics report-status fru-location <frulocation> {test <test-name>}

2.11.3.5.1.1
Table234

hardware diagnostics report-status fru-location <fru-location>

hardwarediagnosticsreport-statusfru-location<fru-location>

Description
Displaysstatusofthespecifiedtestrunningonfrulocation.
Parameter

Hint

Range

Default

Displayslistoftestsavailablefortheselectedfru.

nameofthetest

NA

test
Command

Dependency
None

show hardware diagnostics report-status fru-location <frulocation> {test <test-name>}

2.11.3.5.2
Table235

hardware diagnostics report-status report-name

hardwarediagnosticsreport-statusreport-name

Description
Displaysthestatusofongoingtestspecifiedbyreport-name.
Parameter

Hint

Command

Range

Default

Dependency
None

show hardware diagnostics report-status report-name <reportname>

238

Issue:03B

MulticontrollerRNCSCLICommands

2.11.3.5.2.1
Table236

SCLICommands

hardware diagnostics report-status report-name <report-name>

hardwarediagnosticsreport-statusreport-name<report-name>

Description
Displaysstatusofongoingtestspecifiedbyreport-name.
Parameter

Hint

Command

Range

Default

Dependency
None

show hardware diagnostics report-status report-name <reportname>

2.11.3.6
Table237

hardware diagnostics test-details

hardwarediagnosticstest-details

Description
Showsthedetailsofthespecifiedhardwarediagnosticstest.
Parameter

Hint

Command

Range

Default

Dependency
None

show hardware diagnostics test-details fru-location


<frulocation> {test <test-name>}

2.11.3.6.1
Table238

hardware diagnostics test-details fru-location

hardwarediagnosticstest-detailsfru-location

Description
frulocation
Parameter

Hint

Command

Range

Default

Dependency
None

show hardware diagnostics test-details fru-location


<frulocation> {test <test-name>}

Issue:03B

239

SCLICommands

2.11.3.6.1.1
Table239

MulticontrollerRNCSCLICommands

hardware diagnostics test-details fru-location <frulocation>

hardwarediagnosticstest-detailsfru-location<frulocation>

Description
Showsthedetailedinformationaboutthespecifiedhardwarediagnosticstest.
Parameter

Hint

Range

Default

Listoftestsavailableforthespecifiedfru-location.

nameofthetest

NA

test
Command

Dependency
None

show hardware diagnostics test-details fru-location


<frulocation> {test <test-name>}

2.11.3.7
Table240

hardware diagnostics test-list

hardwarediagnosticstest-list

Description
Showsthelistofavailablehardwarediagnosticsteststhatcanbeconductedonthefru.
Parameter

Hint

Range

Default

frulocation

frulocationname.

NA

fru-location
Command

Dependency
None

show hardware diagnostics test-list {fru-location <FRU


Location>}

2.11.3.8
Table241

hardware diagnostics test-readiness

hardwarediagnosticstest-readiness

Description
Displaysifaspecifiedfru-locationisreadyforthespecifiedtest.
Parameter

Hint

Command

Range

Default

Dependency
None

show hardware diagnostics test-readiness fru-location


<frulocation> {test <test-name>}

240

Issue:03B

MulticontrollerRNCSCLICommands

2.11.3.8.1
Table242

SCLICommands

hardware diagnostics test-readiness fru-location

hardwarediagnosticstest-readinessfru-location

Description
frulocation
Parameter

Hint

Command

Range

Default

Dependency
None

show hardware diagnostics test-readiness fru-location


<frulocation> {test <test-name>}

2.11.3.8.1.1
Table243

hardware diagnostics test-readiness fru-location <frulocation>

hardwarediagnosticstest-readinessfru-location<frulocation>

Description
Displaysifspecifiedfru-locationisreadyforthespecifiedtest.
Parameter

Hint

Range

Default

Displayslistofdiagnostictestsavailableforspecifiedfrulocation.

nameofthetest

NA

test
Command

Dependency
None

show hardware diagnostics test-readiness fru-location


<frulocation> {test <test-name>}

2.11.4 hardware inventory


Table244

hardwareinventory

Description
showshardwareinventoryinformation
Parameter
Command

Issue:03B

Hint

Range

Default

Dependency

241

SCLICommands

Table244

MulticontrollerRNCSCLICommands

hardwareinventory(Cont.)
None

show hardware inventory component <component>


None
show hardware inventory list brief {[include-empty]?}
None
show hardware inventory list detailed {[include-empty]?}

2.11.4.1
Table245

hardware inventory component

hardwareinventorycomponent

Description
showsdetailedhardwareinventoryinformationofcomponent
Parameter

Hint

Command

Range

Default

Dependency
None

show hardware inventory component <component>

2.11.4.1.1
Table246

hardware inventory component <component>

hardwareinventorycomponent<component>

Description
showsdetailedhardwareinventoryinformationofselectedcomponent.
Parameter

Hint

Command

Range

Default

Dependency
None

show hardware inventory component <component>

2.11.4.2
Table247

hardware inventory list

hardwareinventorylist

Description
showshardwareinventoryforentirecluster
Parameter

242

Hint

Range

Default

Issue:03B

MulticontrollerRNCSCLICommands

Table247

SCLICommands

hardwareinventorylist(Cont.)

Command

Dependency
None

show hardware inventory list brief {[include-empty]?}


None
show hardware inventory list detailed {[include-empty]?}

2.11.4.2.1
Table248

hardware inventory list brief

hardwareinventorylistbrief

Description
showsclusterhardwareinventorydetailsinbriefformat.Bydefaultonlycomponentswhicharepresentinthesystemare
shown
Parameter

Hint

Range

Default

showspresentbladesandemptyslots.

includeemptyslotsin
output

NA

include-empty
Command

Dependency
None

show hardware inventory list brief {[include-empty]?}

2.11.4.2.2
Table249

hardware inventory list detailed

hardwareinventorylistdetailed

Description
showshardwareinventoryindetailedformat.
Parameter

Hint

Range

Default

showshardwareunitdetailsonpresentunitsandempty
slots.

includeemptyslotsin
output

NA

include-empty
Command

Dependency
None

show hardware inventory list detailed {[include-empty]?}

Issue:03B

243

SCLICommands

MulticontrollerRNCSCLICommands

2.11.5 hardware power


Table250

hardwarepower

Description
setsnodepowerstatus
Parameter

Hint

Command

Range

Default

Dependency
None

set hardware power off node <nodename>


None
set hardware power on node <nodename>

2.11.5.1
Table251

hardware power off

hardwarepoweroff

Description
poweroffanode
Parameter

Hint

Command

Range

Default

Dependency
None

set hardware power off node <nodename>

2.11.5.1.1
Table252

hardware power off node

hardwarepoweroffnode

Description
poweroffamanagednode
Parameter

Hint

Command

Range

Default

Dependency
None

set hardware power off node <nodename>

244

Issue:03B

MulticontrollerRNCSCLICommands

2.11.5.1.1.1
Table253

SCLICommands

hardware power off node <nodename>

hardwarepoweroffnode<nodename>

Description
Thiscommandallowstopoweroffanodeorahardwareunit(suchasaswitch).
Parameter

Hint

Command

Range

Default

Dependency
None

set hardware power off node <nodename>

2.11.5.2
Table254

hardware power on

hardwarepoweron

Description
poweronanode
Parameter

Hint

Command

Range

Default

Dependency
None

set hardware power on node <nodename>

2.11.5.2.1
Table255

hardware power on node

hardwarepoweronnode

Description
poweronamanagednode
Parameter

Hint

Command

Range

Default

Dependency
None

set hardware power on node <nodename>

2.11.5.2.1.1
Table256

hardware power on node <nodename>

hardwarepoweronnode<nodename>

Description
Thiscommandallowstopoweronanodeorahardwareunit(suchasaswitch).

Issue:03B

245

SCLICommands

Table256

MulticontrollerRNCSCLICommands

hardwarepoweronnode<nodename>(Cont.)

Parameter

Hint

Command

Range

Default

Dependency
None

set hardware power on node <nodename>

2.11.6 hardware restart


Table257

hardwarerestart

Description
coldresetanode
Parameter

Hint

Command

Range

Default

Dependency
None

set hardware restart node <nodename>

2.11.6.1
Table258

hardware restart node

hardwarerestartnode

Description
restartnode
Parameter

Hint

Command

Range

Default

Dependency
None

set hardware restart node <nodename>

2.11.6.1.1
Table259

hardware restart node <nodename>

hardwarerestartnode<nodename>

Description
Thiscommandallowstorestartanodeorahardwareunit(suchasaswitch).
Parameter

246

Hint

Range

Default

Issue:03B

MulticontrollerRNCSCLICommands

Table259

SCLICommands

hardwarerestartnode<nodename>(Cont.)

Command

Dependency
None

set hardware restart node <nodename>

2.11.7 hardware state


Table260

hardwarestate

Description
showsnodestate
Parameter

Hint

Command

Range

Default

Dependency
None

show hardware state list


None
show hardware state node <nodename>

2.11.7.1
Table261

hardware state list

hardwarestatelist

Description
showsstateofavailablenodesunderhardwaremanagement.
Parameter

Hint

Command

Range

Default

Dependency
None

show hardware state list

2.11.7.2
Table262

hardware state node

hardwarestatenode

Description
showsmanagednodestate
Parameter
Command

Issue:03B

Hint

Range

Default

Dependency

247

SCLICommands

Table262

MulticontrollerRNCSCLICommands

hardwarestatenode(Cont.)
None

show hardware state node <nodename>

2.11.7.2.1
Table263

hardware state node <nodename>

hardwarestatenode<nodename>

Description
showsselectednodestate.
Parameter

Hint

Command

Range

Default

Dependency
None

show hardware state node <nodename>

2.12 has
Table264

has

Description
add
Adddifferentmanagedobject
delete
Removedifferentmanagedobjects
set
HighAvailabilityServicecommandsforadministrativeoperationsofMOs.
show
HighAvailabilityServicecommandsforshowingstateandstatusattributesofMOsorlogicalgroups.
start
ThiscommandstartsaMOrelatedoperation.
stop
ThiscommandstopsaMOrelatedoperation.
Parameter

Hint

Range

Default

FilterinputMOnamesbasedontheirtype.Thisisusedin
othercommandstofilterMOnames.Exampleisdetailed
here:

FilterinputMOnames
basedontheirtype

NA

filter

sethasfilterru,rgunlockmanaged-object"/HAS*""/*/HAS*"

248

Issue:03B

MulticontrollerRNCSCLICommands

Table264

SCLICommands

has(Cont.)
Thepossibletypesarelistedbelow:
-cluster:Cluster
-node:Allnodes
-rg:AllRGs
-ru:AllRUs
-process:Allprocesses
-proxy:Allproxyprocesses
-proxied:Allproxiedcomponents
-logical:Alllogicalgroups

logerrors

Writeserrormessagestosyslog.ThisisusefulifHASSCLI
isrunfromscripts.

Writeerrormessages
alsotosyslog

NA

Forexample:
sethaslogerrorslockmanaged-object/Directory

noerror

ContinueexecutingtheMOnamelistalthoughthecommand Ignoreerrorsduring
failswithsomeMOname(s)inthelist.Withoutthisoption
theexecutionofan
executionstopstothefirstfailingMOnameinthelist.
MOnamelist

NA

Forexample:
sethasnoerrorunlockmanaged-object/TA-?

regex

MOnamelistisconsideredtobealistofregular
expressions.Forexample:
sethasregexunlockmanaged-object"^/TA-[A-Z]$"

Command

MOnamelistis
consideredtobealist
ofregularexpressions

NA

Dependency
None

add has config node component <component> {name <name> type


<type> [cpu <cpu>]? [core <core>]? [num-of-cores <num-ofcores>]?}
None
delete has config node {name <name>}
None
delete has process-family warming statistics unit-type <unittype-name> {unit-index <unit-index>}

Issue:03B

249

SCLICommands

Table264

MulticontrollerRNCSCLICommands

has(Cont.)
None

set has {[regex]? [filter <filter-value>]? [noerror]?


[logerrors]?} attribute <name> <value> managed-object [<moname>]+
None
set has {[regex]? [filter <filter-value>]? [noerror]?
[logerrors]?} attribute <name> <value> managed-object-full-name
[<mo-fullname>]+
None
set has {[regex]? [filter <filter-value>]? [noerror]?
[logerrors]?} config link node-to-core <component-name> {name
<name> num-of-cores <num-of-cores> cpu <cpu> core <core>
[force]?}
None
set has {[regex]? [filter <filter-value>]? [noerror]?
[logerrors]?} config node-type name <name> {type <type>}
None
set has {[regex]? [filter <filter-value>]? [noerror]?
[logerrors]?} force-active managed-object [<mo-name>]+
None
set has {[regex]? [filter <filter-value>]? [noerror]?
[logerrors]?} force-active managed-object-full-name [<mofullname>]+
None
set has {[regex]? [filter <filter-value>]? [noerror]?
[logerrors]?} forcedswitchover {[noblock]? [force]?} logicalgroup [<logical-group-name>]+

2.12.1 has attribute


Table265

hasattribute

Description
SetdynamicattributesforanMO.TheMOcanbeanytypeofanMO.Adynamicattributeisaname-valuepair.An
attributeisdeletedbysettinganemptystringasthevalueoftheattribute.Forexample:
sethasattributeAPPLICATION_IDExampleIdmanaged-object/ExampleHARG
sethasattributeAPPLICATION_ID""managed-object/ExampleHARG
Parameter
Command

250

Hint

Range

Default

Dependency

Issue:03B

MulticontrollerRNCSCLICommands

Table265

SCLICommands

hasattribute(Cont.)
None

set has {[regex]? [filter <filter-value>]? [noerror]?


[logerrors]?} attribute <name> <value> managed-object [<moname>]+
None
set has {[regex]? [filter <filter-value>]? [noerror]?
[logerrors]?} attribute <name> <value> managed-object-full-name
[<mo-fullname>]+

2.12.1.1
Table266

has attribute <name>

hasattribute<name>

Description
Adynamicattributename.
Parameter

Hint

Command

Range

Default

Dependency
None

set has {[regex]? [filter <filter-value>]? [noerror]?


[logerrors]?} attribute <name> <value> managed-object [<moname>]+
None
set has {[regex]? [filter <filter-value>]? [noerror]?
[logerrors]?} attribute <name> <value> managed-object-full-name
[<mo-fullname>]+

2.12.1.1.1
Table267

has attribute <name> <value>

hasattribute<name><value>

Description
Adynamicattributevalue.
Parameter
Command

Issue:03B

Hint

Range

Default

Dependency

251

SCLICommands

Table267

MulticontrollerRNCSCLICommands

hasattribute<name><value>(Cont.)
None

set has {[regex]? [filter <filter-value>]? [noerror]?


[logerrors]?} attribute <name> <value> managed-object [<moname>]+
None
set has {[regex]? [filter <filter-value>]? [noerror]?
[logerrors]?} attribute <name> <value> managed-object-full-name
[<mo-fullname>]+

2.12.1.1.1.1
Table268

has attribute <name> <value> managed-object

hasattribute<name><value>managed-object

Description
ThenameoftheMO.AnyoptioncanbeappliedtooneormoreMOs.Patternmatching'*'and'?'canbeusedinMO
namesandregularexpressionscanbeusedwithregexparametertomatchMOnames.NOTE!'?'mustbeusedwithin
quotationmarks(""),seeexamplebelow.
NotethatasubtypeofMOs-proxiedcomponent-isnotaddressablebythenormal"managed-object"syntax.Please
selectmanaged-object-full-namewhenreferringtothem.
TouseDNasapartofMOname,pleaseusetheoptionmanaged-object-full-name.
MOnameisaHASMOname.Forexample:
/ExampleHARG
"/?xampleHARG"
Parameter

Hint

Command

Range

Default

Dependency
None

set has {[regex]? [filter <filter-value>]? [noerror]?


[logerrors]?} attribute <name> <value> managed-object [<moname>]+

2.12.1.1.1.1.1
Table269

hasattribute<name><value>managed-object<mo-name>

hasattribute<name><value>managed-object<mo-name>

Description
ThenameoftheMO.AnyoptioncanbeappliedtooneormoreMOs.Patternmatching'*'and'?'canbeusedinMO
namesandregularexpressionscanbeusedwithregexparametertomatchMOnames.NOTE!'?'mustbeusedwithin
quotationmarks(""),seeexamplebelow.
NotethatasubtypeofMOs-proxiedcomponent-isnotaddressablebythenormal"managed-object"syntax.Please
selectmanaged-object-full-namewhenreferringtothem.
TouseDNasapartofMOname,pleaseusetheoptionmanaged-object-full-name.
MOnameisaHASMOname.Forexample:

252

Issue:03B

MulticontrollerRNCSCLICommands

Table269

SCLICommands

hasattribute<name><value>managed-object<mo-name>(Cont.)

/ExampleHARG
"/?xampleHARG"
Parameter

Hint

Command

Range

Default

Dependency
None

set has {[regex]? [filter <filter-value>]? [noerror]?


[logerrors]?} attribute <name> <value> managed-object [<moname>]+

2.12.1.1.1.2
Table270

has attribute <name> <value> managed-object-full-name

hasattribute<name><value>managed-object-full-name

Description
ThenameoftheMOindistinguishedname(DN)format.TouseslashseparatedMOname,pleaseusetheoption
managed-object.
Forexample:
fshaRecoveryGroupName=ExampleHARG,fsFragmentId=RecoveryGroups,fsFragmentId=HA,fsClusterId=ClusterRoot
Orinareverseorder:
fsClusterId=ClusterRoot,fsFragmentId=HA,fsFragmentId=RecoveryGroups,fshaRecoveryGroupName=ExampleHARG
Onlythelatternameformatsupportsautocompletionwith[TAB]key.
Parameter

Hint

Command

Range

Default

Dependency
None

set has {[regex]? [filter <filter-value>]? [noerror]?


[logerrors]?} attribute <name> <value> managed-object-full-name
[<mo-fullname>]+

2.12.1.1.1.2.1
Table271

hasattribute<name><value>managed-object-full-name<mo-fullname>

hasattribute<name><value>managed-object-full-name<mo-fullname>

Description
ThenameoftheMOindistinguishedname(DN)format.TouseslashseparatedMOname,pleaseusetheoption
managed-object.
Forexample:
fshaRecoveryGroupName=ExampleHARG,fsFragmentId=RecoveryGroups,fsFragmentId=HA,fsClusterId=ClusterRoot
Orinareverseorder:
fsClusterId=ClusterRoot,fsFragmentId=HA,fsFragmentId=RecoveryGroups,fshaRecoveryGroupName=ExampleHARG

Issue:03B

253

SCLICommands

Table271

MulticontrollerRNCSCLICommands

hasattribute<name><value>managed-object-full-name<mo-fullname>
(Cont.)

Onlythelatternameformatsupportsautocompletionwith[TAB]key.
Parameter

Hint

Command

Range

Default

Dependency
None

set has {[regex]? [filter <filter-value>]? [noerror]?


[logerrors]?} attribute <name> <value> managed-object-full-name
[<mo-fullname>]+

2.12.2 has bare


Table272

hasbare

Description
ViewMOnamesbyMOtype.AnMOnameisnotacceptedasaparameter.
ViewingtheDNofthelogicalgroupisnotsupported.Nameofthelogicalgroupisshowninstead.
Forexample:
showhasbarerg
ViewtheMOnamesofRGs.
Parameter

Hint

Range

Default

PrintalistofMOnamesanddistinguishednames.For
example:

PrintalistofMO
namesand
distinguishednames

NA

dn

showhasviewdnmanaged-object/ExampleHARG
showhasbarednrgru
Command

Dependency
None

show has {[regex]? [filter <filter-value>]? [noerror]?} bare


{[dn]?} [<mo-type>]+

2.12.2.1
Table273

has bare <mo-type>

hasbare<mo-type>

Description
ViewMOnamesbyMOtype.AnMOnameisnotacceptedasaparameter.
ViewingtheDNofthelogicalgroupisnotsupported.Nameofthelogicalgroupisshowninstead.
Forexample:

254

Issue:03B

MulticontrollerRNCSCLICommands

Table273

SCLICommands

hasbare<mo-type>(Cont.)

showhasbarerg
ViewtheMOnamesofRGs.
Parameter

Hint

Command

Range

Default

Dependency
None

show has {[regex]? [filter <filter-value>]? [noerror]?} bare


{[dn]?} [<mo-type>]+

2.12.3 has children


Table274

haschildren

Description
PrintMOnamesofchildren.Forexample:
showhaschildrenmanaged-object/ExampleHARG
Parameter

Hint

Command

Range

Default

Dependency
None

show has {[regex]? [filter <filter-value>]? [noerror]?}


children managed-object [<mo-name>]+
None
show has {[regex]? [filter <filter-value>]? [noerror]?}
children managed-object-full-name [<mo-fullname>]+

2.12.3.1
Table275

has children managed-object

haschildrenmanaged-object

Description
ThenameoftheMO.AnyoptioncanbeappliedtooneormoreMOs.Patternmatching'*'and'?'canbeusedinMO
namesandregularexpressionscanbeusedwithregexparametertomatchMOnames.NOTE!'?'mustbeusedwithin
quotationmarks(""),seeexamplebelow.
NotethatasubtypeofMOs-proxiedcomponent-isnotaddressablebythenormal"managed-object"syntax.Please
selectmanaged-object-full-namewhenreferringtothem.
TouseDNasapartofMOname,pleaseusetheoptionmanaged-object-full-name.
MOnameisaHASMOname.Forexample:
/ExampleHARG
"/?xampleHARG"

Issue:03B

255

SCLICommands

Table275

MulticontrollerRNCSCLICommands

haschildrenmanaged-object(Cont.)

Parameter

Hint

Command

Range

Default

Dependency
None

show has {[regex]? [filter <filter-value>]? [noerror]?}


children managed-object [<mo-name>]+

2.12.3.1.1
Table276

has children managed-object <mo-name>

haschildrenmanaged-object<mo-name>

Description
ThenameoftheMO.AnyoptioncanbeappliedtooneormoreMOs.Patternmatching'*'and'?'canbeusedinMO
namesandregularexpressionscanbeusedwithregexparametertomatchMOnames.NOTE!'?'mustbeusedwithin
quotationmarks(""),seeexamplebelow.
NotethatasubtypeofMOs-proxiedcomponent-isnotaddressablebythenormal"managed-object"syntax.Please
selectmanaged-object-full-namewhenreferringtothem.
TouseDNasapartofMOname,pleaseusetheoptionmanaged-object-full-name.
MOnameisaHASMOname.Forexample:
/ExampleHARG
"/?xampleHARG"
Parameter

Hint

Command

Range

Default

Dependency
None

show has {[regex]? [filter <filter-value>]? [noerror]?}


children managed-object [<mo-name>]+

2.12.3.2
Table277

has children managed-object-full-name

haschildrenmanaged-object-full-name

Description
ThenameoftheMOindistinguishedname(DN)format.TouseslashseparatedMOname,pleaseusetheoption
managed-object.
Forexample:
fshaRecoveryGroupName=ExampleHARG,fsFragmentId=RecoveryGroups,fsFragmentId=HA,fsClusterId=ClusterRoot
Orinareverseorder:
fsClusterId=ClusterRoot,fsFragmentId=HA,fsFragmentId=RecoveryGroups,fshaRecoveryGroupName=ExampleHARG
Onlythelatternameformatsupportsautocompletionwith[TAB]key.

256

Issue:03B

MulticontrollerRNCSCLICommands

Table277

SCLICommands

haschildrenmanaged-object-full-name(Cont.)

Parameter

Hint

Command

Range

Default

Dependency
None

show has {[regex]? [filter <filter-value>]? [noerror]?}


children managed-object-full-name [<mo-fullname>]+

2.12.3.2.1
Table278

has children managed-object-full-name <mo-fullname>

haschildrenmanaged-object-full-name<mo-fullname>

Description
ThenameoftheMOindistinguishedname(DN)format.TouseslashseparatedMOname,pleaseusetheoption
managed-object.
Forexample:
fshaRecoveryGroupName=ExampleHARG,fsFragmentId=RecoveryGroups,fsFragmentId=HA,fsClusterId=ClusterRoot
Orinareverseorder:
fsClusterId=ClusterRoot,fsFragmentId=HA,fsFragmentId=RecoveryGroups,fshaRecoveryGroupName=ExampleHARG
Onlythelatternameformatsupportsautocompletionwith[TAB]key.
Parameter

Hint

Command

Range

Default

Dependency
None

show has {[regex]? [filter <filter-value>]? [noerror]?}


children managed-object-full-name [<mo-fullname>]+

2.12.4 has config


Table279

hasconfig

Description
add
Adddifferentmanagedobjectinconfiguration
delete
Removedifferentmanagedobjectsfromcurrentconfiguration
set
Setconfiguration
Parameter
Command

Issue:03B

Hint

Range

Default

Dependency

257

SCLICommands

Table279

MulticontrollerRNCSCLICommands

hasconfig(Cont.)
None

add has config node component <component> {name <name> type


<type> [cpu <cpu>]? [core <core>]? [num-of-cores <num-ofcores>]?}
None
delete has config node {name <name>}
None
set has {[regex]? [filter <filter-value>]? [noerror]?
[logerrors]?} config link node-to-core <component-name> {name
<name> num-of-cores <num-of-cores> cpu <cpu> core <core>
[force]?}
None
set has {[regex]? [filter <filter-value>]? [noerror]?
[logerrors]?} config node-type name <name> {type <type>}

2.12.4.1
Table280

has config link

hasconfiglink

Description
Thiscommandsetsalinkincurrentconfiguration
Parameter

Hint

Command

Range

Default

Dependency
None

set has {[regex]? [filter <filter-value>]? [noerror]?


[logerrors]?} config link node-to-core <component-name> {name
<name> num-of-cores <num-of-cores> cpu <cpu> core <core>
[force]?}

2.12.4.1.1
Table281

has config link node-to-core

hasconfiglinknode-to-core

Description
ThiscommandreassignsalinkedHASnodetoCPUcores.
Parameter

Hint

Command

Range

Default

Dependency
None

set has {[regex]? [filter <filter-value>]? [noerror]?

258

Issue:03B

MulticontrollerRNCSCLICommands

Table281

SCLICommands

hasconfiglinknode-to-core(Cont.)

[logerrors]?} config link node-to-core <component-name> {name


<name> num-of-cores <num-of-cores> cpu <cpu> core <core>
[force]?}

2.12.4.1.1.1
Table282

has config link node-to-core <component-name>

hasconfiglinknode-to-core<component-name>

Description
reassignsaHASlinkednodetoCPUcores
Parameter

Hint

Range

Default

Theparameter"core"specifiestheidentificationnumberof
thecore.

coreidentification
number

NA

core

Theparameter"cpu"specifiestheidentificationnumberof
thecpu.Forexample,0,1etc.

cpuidentification
number

NA

cpu

Theparameter"force"specifiesthatthecoresthattheHAS
nodeslinkedtoareusedbytheotherHASnode,itwillbe
automaticallyreleasedandattachedtothenewnode.

overridethecoresif
usedbyothernode

NA

Thisparameterspecifiesanameofalinked-hasnode,e.g.
CLA-0,AS-0.

nameofthenode

NA

force

name

num-of-cores

Theparameter"num-of-cores"specifiesthenumberofcores numberofcoresto
(quantity)tobeattachedordetached.Therangeforthis
attachordetach
valueis[1..32].e.g.Iftheparameter"core"numberisgiven
as2andtheparameter"num-of-cores"isgivenas3,the
numberofcores(2,3,4)willbelinked.

Command

NA

Dependency
None

set has {[regex]? [filter <filter-value>]? [noerror]?


[logerrors]?} config link node-to-core <component-name> {name
<name> num-of-cores <num-of-cores> cpu <cpu> core <core>
[force]?}

2.12.4.2
Table283

has config node

hasconfignode

Description
add
Adddifferentmanagedobject
delete

Issue:03B

259

SCLICommands

Table283

MulticontrollerRNCSCLICommands

hasconfignode(Cont.)

Deletenodefromcurrentconfiguration
NOTE:
1.Takeaconfigurationsnapshotandsetitasanewstart-upconfigurationtomakeyourconfigurationchangespersistent.
Otherwisethechangesmadetotheconfigurationarelostifthenetworkelementisrestarted.Fordetailedinformation,refer
totheConfigurationmanagementdocumentation.
2.Multiplechangescanbebundledintoonebiggertransaction.Notealsothatyoucanpreventotherusersfrominterfering
withyourconfigurationchangesbyusingtheconfigurationlockingfeature.
3.Alarmsarenotautomaticallyclearedfortheremovednodes.Operatorcanviewtheactivealarmsrelatedtotheremoved
nodewithbelowcommandusingSCLI."showalarmactivefilter-bymanaged-objectremoved-NodeName"
4.OperatorcancleartheactivealarmsrelatedtotheremovednodewiththebelowcommandusingSCLI."setalarmclearmatching-alarmsfilter-bymanaged-objectremoved-NodeName"
Parameter

Hint

Range

Default

Thisparameterspecifiesanameofalinked-hasnode,e.g.
CLA-0,AS-0.

nameofthenode

NA

name
Command

Dependency
None

delete has config node {name <name>}


None
add has config node component <component> {name <name> type
<type> [cpu <cpu>]? [core <core>]? [num-of-cores <num-ofcores>]?}

2.12.4.2.1
Table284

has config node component

hasconfignodecomponent

Description
ThiscommandaddsaHASnodeinthecurrentconfiguration.AddingaHAS-managednodeinthecurrentconfigurationwill
createalinkbetweenhighavailabilityservicesandhardwarecomponent.Ausermustprovideanameforthenodetype
definitionthatdefineswhatsoftwareisbeingruninthenode.AusermustalsoprovidetheidentificationoftheHW
component(s)wherethenodeisbeingdeployed(cabinet,chassis,slot,possiblemodule,possibleCPU(s)andcore(s)).
The"component"tokenisauto-completed.
Forexample,forauto-completingthechassis,theusercanpresstheTABkey,thenalistofthenewandcurrentchassis
willbeshown.
Forauto-completingablade,theusercanpresstheTABkeyaftercompletingthechassis.Forexample,/chassis-1/or
/chassis-1thenpresstheTABkey.Itwillgivealistof"/chassis-1/slot-#".
Forauto-completingamodule,theusercanpresstheTABkeyaftercompletingtheslotsunderchassis.Forexample,
/chassis-1/slot-11or/chassis-1/slot-11/thenpresstheTABkey.Itwillgivealistof"/chassis-1/slot-11/sub-slot-#".
Parameter

260

Hint

Range

Default

Issue:03B

MulticontrollerRNCSCLICommands

Table284

SCLICommands

hasconfignodecomponent(Cont.)

Command

Dependency
None

add has config node component <component> {name <name> type


<type> [cpu <cpu>]? [core <core>]? [num-of-cores <num-ofcores>]?}

2.12.4.2.1.1
Table285

has config node component <component>

hasconfignodecomponent<component>

Description
AddingaHAS-managednodeinthecurrentconfigurationwillcreatealinkbetweenHighavailabilityservicesandhardware
component.Ausermustprovideanameofthenodetypedefinition.AusermustprovidealsotheidentificationoftheHW
component(s)onwhichthenodeisbeingdeployed(cabinet,chassis,slot,possiblemodule,possibleCPU(s)andcore(s)).
The"component"tokenisautocompleted.
Forexample,forauto-completingthechassis,usercanpressaTABkey,alistofthenewandcurrentchassiswillbe
shown.
Forauto-completingablade,usercanpressaTABkeyaftercompletingthechassis,e.g./chassis-1/or/chassis-1pressa
TABkey.Itwillgivealistof"/chassis-1/slot-#".
Forauto-completingamodule,usercanpressaTABaftercompletingtheslotsunderchassis,e.g./chassis-1/slot-11or
/chassis-1/slot-11/pressaTABkey.Itwillgivealistof"/chassis-1/slot-11/sub-slot-#".
Parameter

Hint

Range

Default

Theparameter"core"specifiestheidentificationnumberof
thecore.

coreidentification
number

NA

core

Theparameter"cpu"specifiestheidentificationnumberof
thecpu.Forexample,0,1etc.

cpuidentification
number

NA

cpu

Nameofthenodee.g.CLA-0,AS-0

nameofthenode

NA

name

num-of-cores

Theparameter"num-of-cores"specifiesthenumberofcores numberofcoresto
(quantity)tobeattachedordetached.Therangeforthis
attachordetach
valueis[1..32].e.g.Iftheparameter"core"numberisgiven
as2andtheparameter"num-of-cores"isgivenas3,the
numberofcores(2,3,4)willbelinked.

NA

Theparameter"type"specifiesthetypeofthenode.

NA

typeofthenode

type
Command

Dependency
None

add has config node component <component> {name <name> type


<type> [cpu <cpu>]? [core <core>]? [num-of-cores <num-ofcores>]?}

Issue:03B

261

SCLICommands

2.12.4.3
Table286

MulticontrollerRNCSCLICommands

has config node-type

hasconfignode-type

Description
Thiscommandchangenodetypeincurrentconfiguration.
Parameter

Hint

Command

Range

Default

Dependency
None

set has {[regex]? [filter <filter-value>]? [noerror]?


[logerrors]?} config node-type name <name> {type <type>}

2.12.4.3.1
Table287

has config node-type name

hasconfignode-typename

Description
Nameofthenode.
Parameter

Hint

Command

Range

Default

Dependency
None

set has {[regex]? [filter <filter-value>]? [noerror]?


[logerrors]?} config node-type name <name> {type <type>}

2.12.4.3.1.1
Table288

has config node-type name <name>

hasconfignode-typename<name>

Description
Changenodetypeincurrentconfiguration
NOTE:
1.Takeaconfigurationsnapshotandsetitasanewstart-upconfigurationtomakeyourconfigurationchangespersistent.
Otherwisethechangesmadetotheconfigurationarelostifthenetworkelementisrestarted.Fordetailedinformation,refer
totheConfigurationmanagementdocumentation.
2.Multiplechangescanbebundledintoonebiggertransaction.Notealsothatyoucanpreventotherusersfrominterfering
withyourconfigurationchangesbyusingtheconfigurationlockingfeature.
Parameter

Hint

Range

Default

Theparameter"type"specifiesthetypeofthenode.

typeofthenode

NA

type
Command

262

Dependency

Issue:03B

MulticontrollerRNCSCLICommands

Table288

SCLICommands

hasconfignode-typename<name>(Cont.)
None

set has {[regex]? [filter <filter-value>]? [noerror]?


[logerrors]?} config node-type name <name> {type <type>}

2.12.5 has dependencies


Table289

hasdependencies

Description
CommandshowstheRGdependencies.Thisincludesthestartupdependenciesalongwiththeparasite,stalkerand
symbiotdependencies.
Example:
showhasdependencies
Parameter

Hint

Command

Range

Default

Dependency
None

show has {[regex]? [filter <filter-value>]? [noerror]?}


dependencies

2.12.6 has force-active


Table290

hasforce-active

Description
Thiscommandrequestsaresourcecontrollertosetitsresource'sstatefromTRASHEDorDEGRADEDtoFUNCTIONAL.
ThisallowsanRUtotaketheACTIVErole.ThiscommandappliesonlytoRUswitharesourcecontrollerprocess.
Notethatthisoperationmightcauselossofdata.Therefore,thecommandshouldbegivenonlytoout-of-syncRUsand
onlyifthecorrespondingactiveRUisknowntobepermanentlydown.Anout-of-syncRUcanbeidentifiedbyitsresource
statebeingTRASHEDorDEGRADED.Inothercases,itisbettertowaitforthepeerRUtocomeupandlettheservices
re-synchronize.
Forexample:
sethasforce-activemanaged-object/TA-A/ExampleHARU-A
Parameter

Hint

Command

Range

Default

Dependency
None

set has {[regex]? [filter <filter-value>]? [noerror]?


[logerrors]?} force-active managed-object [<mo-name>]+
None
set has {[regex]? [filter <filter-value>]? [noerror]?

Issue:03B

263

SCLICommands

Table290

MulticontrollerRNCSCLICommands

hasforce-active(Cont.)

[logerrors]?} force-active managed-object-full-name [<mofullname>]+

2.12.6.1
Table291

has force-active managed-object

hasforce-activemanaged-object

Description
ThenameoftheMO.AnyoptioncanbeappliedtooneormoreMOs.Patternmatching'*'and'?'canbeusedinMO
namesandregularexpressionscanbeusedwithregexparametertomatchMOnames.NOTE!'?'mustbeusedwithin
quotationmarks(""),seeexamplebelow.
NotethatasubtypeofMOs-proxiedcomponent-isnotaddressablebythenormal"managed-object"syntax.Please
selectmanaged-object-full-namewhenreferringtothem.
TouseDNasapartofMOname,pleaseusetheoptionmanaged-object-full-name.
MOnameisaHASMOname.Forexample:
/ExampleHARG
"/?xampleHARG"
Parameter

Hint

Command

Range

Default

Dependency
None

set has {[regex]? [filter <filter-value>]? [noerror]?


[logerrors]?} force-active managed-object [<mo-name>]+

2.12.6.1.1
Table292

has force-active managed-object <mo-name>

hasforce-activemanaged-object<mo-name>

Description
ThenameoftheMO.AnyoptioncanbeappliedtooneormoreMOs.Patternmatching'*'and'?'canbeusedinMO
namesandregularexpressionscanbeusedwithregexparametertomatchMOnames.NOTE!'?'mustbeusedwithin
quotationmarks(""),seeexamplebelow.
NotethatasubtypeofMOs-proxiedcomponent-isnotaddressablebythenormal"managed-object"syntax.Please
selectmanaged-object-full-namewhenreferringtothem.
TouseDNasapartofMOname,pleaseusetheoptionmanaged-object-full-name.
MOnameisaHASMOname.Forexample:
/ExampleHARG
"/?xampleHARG"
Parameter

264

Hint

Range

Default

Issue:03B

MulticontrollerRNCSCLICommands

Table292

SCLICommands

hasforce-activemanaged-object<mo-name>(Cont.)

Command

Dependency
None

set has {[regex]? [filter <filter-value>]? [noerror]?


[logerrors]?} force-active managed-object [<mo-name>]+

2.12.6.2
Table293

has force-active managed-object-full-name

hasforce-activemanaged-object-full-name

Description
ThenameoftheMOindistinguishedname(DN)format.TouseslashseparatedMOname,pleaseusetheoption
managed-object.
Forexample:
fshaRecoveryGroupName=ExampleHARG,fsFragmentId=RecoveryGroups,fsFragmentId=HA,fsClusterId=ClusterRoot
Orinareverseorder:
fsClusterId=ClusterRoot,fsFragmentId=HA,fsFragmentId=RecoveryGroups,fshaRecoveryGroupName=ExampleHARG
Onlythelatternameformatsupportsautocompletionwith[TAB]key.
Parameter

Hint

Command

Range

Default

Dependency
None

set has {[regex]? [filter <filter-value>]? [noerror]?


[logerrors]?} force-active managed-object-full-name [<mofullname>]+

2.12.6.2.1
Table294

has force-active managed-object-full-name <mo-fullname>

hasforce-activemanaged-object-full-name<mo-fullname>

Description
ThenameoftheMOindistinguishedname(DN)format.TouseslashseparatedMOname,pleaseusetheoption
managed-object.
Forexample:
fshaRecoveryGroupName=ExampleHARG,fsFragmentId=RecoveryGroups,fsFragmentId=HA,fsClusterId=ClusterRoot
Orinareverseorder:
fsClusterId=ClusterRoot,fsFragmentId=HA,fsFragmentId=RecoveryGroups,fshaRecoveryGroupName=ExampleHARG
Onlythelatternameformatsupportsautocompletionwith[TAB]key.
Parameter
Command

Issue:03B

Hint

Range

Default

Dependency

265

SCLICommands

Table294

MulticontrollerRNCSCLICommands

hasforce-activemanaged-object-full-name<mo-fullname>(Cont.)
None

set has {[regex]? [filter <filter-value>]? [noerror]?


[logerrors]?} force-active managed-object-full-name [<mofullname>]+

2.12.7 has forcedswitchover


Table295

hasforcedswitchover

Description
ExecuteaforcedswitchoverforthegivenRG,RUorlogicalgroup.ThiscommandappliesonlyforRGswithactive/standby
recoverypolicy.Note:ThiscommandcannotbeissuedtoanRGthatisaSTALKERoraPARASITEofanotherRG.
Forexample:
sethasforcedswitchovermanaged-object/ExampleHARG
Parameter

Hint

Range

Default

ForceacriticalMOtoperformtheoperation.

ForceacriticalMOto
performtheoperation

NA

Thecommandwillreturnimmediatelyafterinitiationwithout
checkingtheoperationresult.

Don'twaitforan
operationtobe
completed

NA

force

noblock

Command

Dependency
None

set has {[regex]? [filter <filter-value>]? [noerror]?


[logerrors]?} forcedswitchover {[noblock]? [force]?} logicalgroup [<logical-group-name>]+
None
set has {[regex]? [filter <filter-value>]? [noerror]?
[logerrors]?} forcedswitchover {[noblock]? [force]?} managedobject [<mo-name>]+
None
set has {[regex]? [filter <filter-value>]? [noerror]?
[logerrors]?} forcedswitchover {[noblock]? [force]?} managedobject-full-name [<mo-fullname>]+
None
set has {[regex]? [filter <filter-value>]? [noerror]?
[logerrors]?} forcedswitchover {[noblock]? [force]?} newactive-recovery-unit [<new-active-recovery-unit>]+

266

Issue:03B

MulticontrollerRNCSCLICommands

2.12.7.1
Table296

SCLICommands

has forcedswitchover logical-group

hasforcedswitchoverlogical-group

Description
Thenameofthelogicalgroup.
Patternmatching'*'and'?'canbeusedinlogicalgroupnames.NOTE!'?'mustbeusedwithinquotationmarks(""),see
examplebelow.
Forexample:
ExampleLogicalGroup
"LogicalGroup??"
Parameter

Hint

Command

Range

Default

Dependency
None

set has {[regex]? [filter <filter-value>]? [noerror]?


[logerrors]?} forcedswitchover {[noblock]? [force]?} logicalgroup [<logical-group-name>]+

2.12.7.1.1
Table297

has forcedswitchover logical-group <logical-group-name>

hasforcedswitchoverlogical-group<logical-group-name>

Description
Thenameofthelogicalgroup.
Patternmatching'*'and'?'canbeusedinlogicalgroupnames.NOTE!'?'mustbeusedwithinquotationmarks(""),see
examplebelow.
Forexample:
ExampleLogicalGroup
"LogicalGroup??"
Parameter

Hint

Command

Range

Default

Dependency
None

set has {[regex]? [filter <filter-value>]? [noerror]?


[logerrors]?} forcedswitchover {[noblock]? [force]?} logicalgroup [<logical-group-name>]+

2.12.7.2
Table298

has forcedswitchover managed-object

hasforcedswitchovermanaged-object

Description

Issue:03B

267

SCLICommands

Table298

MulticontrollerRNCSCLICommands

hasforcedswitchovermanaged-object(Cont.)

ThenameoftheMO.AnyoptioncanbeappliedtooneormoreMOs.Patternmatching'*'and'?'canbeusedinMO
namesandregularexpressionscanbeusedwithregexparametertomatchMOnames.NOTE!'?'mustbeusedwithin
quotationmarks(""),seeexamplebelow.
NotethatasubtypeofMOs-proxiedcomponent-isnotaddressablebythenormal"managed-object"syntax.Please
selectmanaged-object-full-namewhenreferringtothem.
TouseDNasapartofMOname,pleaseusetheoptionmanaged-object-full-name.
MOnameisaHASMOname.Forexample:
/ExampleHARG
"/?xampleHARG"
Parameter

Hint

Command

Range

Default

Dependency
None

set has {[regex]? [filter <filter-value>]? [noerror]?


[logerrors]?} forcedswitchover {[noblock]? [force]?} managedobject [<mo-name>]+

2.12.7.2.1
Table299

has forcedswitchover managed-object <mo-name>

hasforcedswitchovermanaged-object<mo-name>

Description
ThenameoftheMO.AnyoptioncanbeappliedtooneormoreMOs.Patternmatching'*'and'?'canbeusedinMO
namesandregularexpressionscanbeusedwithregexparametertomatchMOnames.NOTE!'?'mustbeusedwithin
quotationmarks(""),seeexamplebelow.
NotethatasubtypeofMOs-proxiedcomponent-isnotaddressablebythenormal"managed-object"syntax.Please
selectmanaged-object-full-namewhenreferringtothem.
TouseDNasapartofMOname,pleaseusetheoptionmanaged-object-full-name.
MOnameisaHASMOname.Forexample:
/ExampleHARG
"/?xampleHARG"
Parameter

Hint

Command

Range

Default

Dependency
None

set has {[regex]? [filter <filter-value>]? [noerror]?


[logerrors]?} forcedswitchover {[noblock]? [force]?} managedobject [<mo-name>]+

268

Issue:03B

MulticontrollerRNCSCLICommands

2.12.7.3
Table300

SCLICommands

has forcedswitchover managed-object-full-name

hasforcedswitchovermanaged-object-full-name

Description
ThenameoftheMOindistinguishedname(DN)format.TouseslashseparatedMOname,pleaseusetheoption
managed-object.
Forexample:
fshaRecoveryGroupName=ExampleHARG,fsFragmentId=RecoveryGroups,fsFragmentId=HA,fsClusterId=ClusterRoot
Orinareverseorder:
fsClusterId=ClusterRoot,fsFragmentId=HA,fsFragmentId=RecoveryGroups,fshaRecoveryGroupName=ExampleHARG
Onlythelatternameformatsupportsautocompletionwith[TAB]key.
Parameter

Hint

Command

Range

Default

Dependency
None

set has {[regex]? [filter <filter-value>]? [noerror]?


[logerrors]?} forcedswitchover {[noblock]? [force]?} managedobject-full-name [<mo-fullname>]+

2.12.7.3.1
Table301

has forcedswitchover managed-object-full-name <mo-fullname>

hasforcedswitchovermanaged-object-full-name<mo-fullname>

Description
ThenameoftheMOindistinguishedname(DN)format.TouseslashseparatedMOname,pleaseusetheoption
managed-object.
Forexample:
fshaRecoveryGroupName=ExampleHARG,fsFragmentId=RecoveryGroups,fsFragmentId=HA,fsClusterId=ClusterRoot
Orinareverseorder:
fsClusterId=ClusterRoot,fsFragmentId=HA,fsFragmentId=RecoveryGroups,fshaRecoveryGroupName=ExampleHARG
Onlythelatternameformatsupportsautocompletionwith[TAB]key.
Parameter

Hint

Command

Range

Default

Dependency
None

set has {[regex]? [filter <filter-value>]? [noerror]?


[logerrors]?} forcedswitchover {[noblock]? [force]?} managedobject-full-name [<mo-fullname>]+

Issue:03B

269

SCLICommands

2.12.7.4
Table302

MulticontrollerRNCSCLICommands

has forcedswitchover new-active-recovery-unit

hasforcedswitchovernew-active-recovery-unit

Description
Parameterdefinesthenewactiverecoveryunit(s).
Parameter

Hint

Command

Range

Default

Dependency
None

set has {[regex]? [filter <filter-value>]? [noerror]?


[logerrors]?} forcedswitchover {[noblock]? [force]?} newactive-recovery-unit [<new-active-recovery-unit>]+

2.12.7.4.1
Table303

has forcedswitchover new-active-recovery-unit <new-active-recovery-unit>

hasforcedswitchovernew-active-recovery-unit<new-active-recovery-unit>

Description
Parameterdefinesthenewactiverecoveryunit(s).
Parameter

Hint

Command

Range

Default

Dependency
None

set has {[regex]? [filter <filter-value>]? [noerror]?


[logerrors]?} forcedswitchover {[noblock]? [force]?} newactive-recovery-unit [<new-active-recovery-unit>]+

2.12.8 has functional-unit


Table304

hasfunctional-unit

Description
Thiscommandshowsfunctionalunitrelatedinformation.
Parameter

Hint

Command

Range

Default

Dependency
None

show has {[regex]? [filter <filter-value>]? [noerror]?}


functional-unit comp-addr-info {[unit-type <unit-type>]?}
None
show has {[regex]? [filter <filter-value>]? [noerror]?}

270

Issue:03B

MulticontrollerRNCSCLICommands

Table304

SCLICommands

hasfunctional-unit(Cont.)

functional-unit group-addr-info
None
show has {[regex]? [filter <filter-value>]? [noerror]?}
functional-unit startup-info parameter {unit-type <unit-typevalue> unit-index <unit-index-value>}
None
show has {[regex]? [filter <filter-value>]? [noerror]?}
functional-unit startup-info phase-output {unit-type <unittype-value> unit-index <unit-index-value> data-type <data-typevalue>}
None
show has {[regex]? [filter <filter-value>]? [noerror]?}
functional-unit startup-info statistics {unit-type <unit-typevalue> unit-index <unit-index-value>}
None
show has {[regex]? [filter <filter-value>]? [noerror]?}
functional-unit unit-info {[unit-index <unit-index>]? [unittype <unit-type>]? [show-mode <show-mode>]?}
None
show has {[regex]? [filter <filter-value>]? [noerror]?}
functional-unit unit-type-info {[unit-type <unit-type>]?}

2.12.8.1
Table305

has functional-unit comp-addr-info

hasfunctional-unitcomp-addr-info

Description
Thiscommandshowsthecontentofcomputeraddresstable.
LOG_ADDRinthetableheaderisthelogicaladdress.
WOinthetableheaderisthephyscialaddressfortheWOstateunit(s).
SPinthetableheaderisthephyscialaddressfortheSPstateunit(s).
WOSPinthetableheaderisthephyscialaddressfortheWOandSPunit(s).
Parameter

Hint

Range

Default

Theparameterspecifiesthefunctionalunittype,for
example,OMU.

unittype,forexample,
OMU

NA

unit-type
Command

Dependency
None

show has {[regex]? [filter <filter-value>]? [noerror]?}

Issue:03B

271

SCLICommands

Table305

MulticontrollerRNCSCLICommands

hasfunctional-unitcomp-addr-info(Cont.)

functional-unit comp-addr-info {[unit-type <unit-type>]?}

2.12.8.2
Table306

has functional-unit group-addr-info

hasfunctional-unitgroup-addr-info

Description
Thiscommandshowsthecontentofgroupaddresstable.
GROUP_PHYS_ADDRinthetableheaderisthegroupphysicaladdress.
Physicaladdresslistincludesphysicaladdress(es)mappingtoGROUP_PHYS_ADDR.
Parameter

Hint

Command

Range

Default

Dependency
None

show has {[regex]? [filter <filter-value>]? [noerror]?}


functional-unit group-addr-info

2.12.8.3
Table307

has functional-unit startup-info

hasfunctional-unitstartup-info

Description
Thiscommandshowsunitstartuprelatedinformation.
Parameter

Hint

Command

Range

Default

Dependency
None

show has {[regex]? [filter <filter-value>]? [noerror]?}


functional-unit startup-info parameter {unit-type <unit-typevalue> unit-index <unit-index-value>}
None
show has {[regex]? [filter <filter-value>]? [noerror]?}
functional-unit startup-info phase-output {unit-type <unittype-value> unit-index <unit-index-value> data-type <data-typevalue>}
None
show has {[regex]? [filter <filter-value>]? [noerror]?}
functional-unit startup-info statistics {unit-type <unit-typevalue> unit-index <unit-index-value>}

272

Issue:03B

MulticontrollerRNCSCLICommands

2.12.8.3.1
Table308

SCLICommands

has functional-unit startup-info parameter

hasfunctional-unitstartup-infoparameter

Description
Thiscommandshowsthestartupparametersofspecifiedunit.
Parameter

Hint

Range

Default

Theparameterspecifiesthefunctionalunitindex,for
example,0.

unitindex,for
example,0

NA

unit-index

Theparameterspecifiesthefunctionalunittype,for
example,OMU.

unittype,forexample,
OMU

NA

unit-type
Command

Dependency
None

show has {[regex]? [filter <filter-value>]? [noerror]?}


functional-unit startup-info parameter {unit-type <unit-typevalue> unit-index <unit-index-value>}

2.12.8.3.2
Table309

has functional-unit startup-info phase-output

hasfunctional-unitstartup-infophase-output

Description
Theparameterindicatestwotypesphase-outputtobedisplayed:
historyorlatest.Andlatestmeanslastfewtimes.
Parameter

Hint

Range

Default

Theparameteristhedatatype

Theparameteristhe
datatype

NA

Theparameterspecifiesthefunctionalunitindex,for
example,0.

unitindex,for
example,0

NA

unit-index

Theparameterspecifiesthefunctionalunittype,for
example,OMU.

unittype,forexample,
OMU

NA

unit-type

data-type

Command

Dependency
None

show has {[regex]? [filter <filter-value>]? [noerror]?}


functional-unit startup-info phase-output {unit-type <unittype-value> unit-index <unit-index-value> data-type <data-typevalue>}

Issue:03B

273

SCLICommands

2.12.8.3.3
Table310

MulticontrollerRNCSCLICommands

has functional-unit startup-info statistics

hasfunctional-unitstartup-infostatistics

Description
Thiscommandshowsthestartupstatisticsdataofspecifiedunit.
Parameter

Hint

Range

Default

Theparameterspecifiesthefunctionalunitindex,for
example,0.

unitindex,for
example,0

NA

unit-index

Theparameterspecifiesthefunctionalunittype,for
example,OMU.

unittype,forexample,
OMU

NA

unit-type
Command

Dependency
None

show has {[regex]? [filter <filter-value>]? [noerror]?}


functional-unit startup-info statistics {unit-type <unit-typevalue> unit-index <unit-index-value>}

2.12.8.4
Table311

has functional-unit unit-info

hasfunctional-unitunit-info

Description
Thiscommmandshowsthefuctionalunitinformation.
LOG_ADDRinthetableheaderisthelogicaladdress.
PHYS_ADDRinthetableheaderisthephysicaladdress.
RU_MONAMEinthetableheaderistherecoveryunitMOname.
RG_MONAMEinthetableheaderistherecoverygroupMOname.
Parameter

Hint

Range

Default

Theparameteristhetabledisplaymode.Thedisplayof
somecolumnsaredecidedbythisparameter.

displaymode,for
example,normal

NA

show-mode

Theparameterspecifiesthefunctionalunitindex,for
example,0.

unitindex,for
example,0

NA

unit-index

Theparameterspecifiesthefunctionalunittype,for
example,OMU.

unittype,forexample,
OMU

NA

unit-type
Command

Dependency
None

show has {[regex]? [filter <filter-value>]? [noerror]?}


functional-unit unit-info {[unit-index <unit-index>]? [unit-

274

Issue:03B

MulticontrollerRNCSCLICommands

Table311

SCLICommands

hasfunctional-unitunit-info(Cont.)

type <unit-type>]? [show-mode <show-mode>]?}

2.12.8.5
Table312

has functional-unit unit-type-info

hasfunctional-unitunit-type-info

Description
Thiscommmandshowsthefuctionalunittypeinformation.
LOG_ADDRinthetableheaderisthelogicaladdress.
PRIM_ADDRinthetalbeheaderistheprimarylogicaladdress.
PHYS_ADDRinthetableheaderisthephysicaladdress.
Parameter

Hint

Range

Default

Theparameterspecifiesthefunctionalunittype,for
example,OMU.

unittype,forexample,
OMU

NA

unit-type
Command

Dependency
None

show has {[regex]? [filter <filter-value>]? [noerror]?}


functional-unit unit-type-info {[unit-type <unit-type>]?}

2.12.9 has inert


Table313

hasinert

Description
SetinertmodefortheMO.TheMOcanbetheclusteroroneormorenodes.Theinertmodewillpreventtherecovery
actionswithinthenodesorthecluster.Thiscommandshouldbeusedonlyfordebuggingpurposes.Forexample:
sethasinertonmanaged-object/
sethasinertoffmanaged-object/CLA-0/CLA-1
Note:TheactualnamesoftheCLA(ClusterAdministrator)nodescanvaryindifferentproductapplications.Theterm"CLA
node"referstoanodethatcontainsthecentralizedclustermanagementandOAMfunctionalitiesinthesystem.
Parameter

Hint

Command

Range

Default

Dependency
None

set has {[regex]? [filter <filter-value>]? [noerror]?


[logerrors]?} inert <inert-mode> managed-object [<mo-name>]+
None
set has {[regex]? [filter <filter-value>]? [noerror]?
[logerrors]?} inert <inert-mode> managed-object-full-name [<mo-

Issue:03B

275

SCLICommands

Table313

MulticontrollerRNCSCLICommands

hasinert(Cont.)

fullname>]+

2.12.9.1
Table314

has inert <inert-mode>

hasinert<inert-mode>

Description
Inertmodecaneitherbeonoroff.
Parameter

Hint

Command

Range

Default

Dependency
None

set has {[regex]? [filter <filter-value>]? [noerror]?


[logerrors]?} inert <inert-mode> managed-object [<mo-name>]+
None
set has {[regex]? [filter <filter-value>]? [noerror]?
[logerrors]?} inert <inert-mode> managed-object-full-name [<mofullname>]+

2.12.9.1.1
Table315

has inert <inert-mode> managed-object

hasinert<inert-mode>managed-object

Description
ThenameoftheMO.AnyoptioncanbeappliedtooneormoreMOs.Patternmatching'*'and'?'canbeusedinMO
namesandregularexpressionscanbeusedwithregexparametertomatchMOnames.NOTE!'?'mustbeusedwithin
quotationmarks(""),seeexamplebelow.
NotethatasubtypeofMOs-proxiedcomponent-isnotaddressablebythenormal"managed-object"syntax.Please
selectmanaged-object-full-namewhenreferringtothem.
TouseDNasapartofMOname,pleaseusetheoptionmanaged-object-full-name.
MOnameisaHASMOname.Forexample:
/ExampleHARG
"/?xampleHARG"
Parameter

Hint

Command

Range

Default

Dependency
None

set has {[regex]? [filter <filter-value>]? [noerror]?


[logerrors]?} inert <inert-mode> managed-object [<mo-name>]+

276

Issue:03B

MulticontrollerRNCSCLICommands

2.12.9.1.1.1
Table316

SCLICommands

has inert <inert-mode> managed-object <mo-name>

hasinert<inert-mode>managed-object<mo-name>

Description
ThenameoftheMO.AnyoptioncanbeappliedtooneormoreMOs.Patternmatching'*'and'?'canbeusedinMO
namesandregularexpressionscanbeusedwithregexparametertomatchMOnames.NOTE!'?'mustbeusedwithin
quotationmarks(""),seeexamplebelow.
NotethatasubtypeofMOs-proxiedcomponent-isnotaddressablebythenormal"managed-object"syntax.Please
selectmanaged-object-full-namewhenreferringtothem.
TouseDNasapartofMOname,pleaseusetheoptionmanaged-object-full-name.
MOnameisaHASMOname.Forexample:
/ExampleHARG
"/?xampleHARG"
Parameter

Hint

Command

Range

Default

Dependency
None

set has {[regex]? [filter <filter-value>]? [noerror]?


[logerrors]?} inert <inert-mode> managed-object [<mo-name>]+

2.12.9.1.2
Table317

has inert <inert-mode> managed-object-full-name

hasinert<inert-mode>managed-object-full-name

Description
ThenameoftheMOindistinguishedname(DN)format.TouseslashseparatedMOname,pleaseusetheoption
managed-object.
Forexample:
fshaRecoveryGroupName=ExampleHARG,fsFragmentId=RecoveryGroups,fsFragmentId=HA,fsClusterId=ClusterRoot
Orinareverseorder:
fsClusterId=ClusterRoot,fsFragmentId=HA,fsFragmentId=RecoveryGroups,fshaRecoveryGroupName=ExampleHARG
Onlythelatternameformatsupportsautocompletionwith[TAB]key.
Parameter

Hint

Command

Range

Default

Dependency
None

set has {[regex]? [filter <filter-value>]? [noerror]?


[logerrors]?} inert <inert-mode> managed-object-full-name [<mofullname>]+

Issue:03B

277

SCLICommands

2.12.9.1.2.1
Table318

MulticontrollerRNCSCLICommands

has inert <inert-mode> managed-object-full-name <mo-fullname>

hasinert<inert-mode>managed-object-full-name<mo-fullname>

Description
ThenameoftheMOindistinguishedname(DN)format.TouseslashseparatedMOname,pleaseusetheoption
managed-object.
Forexample:
fshaRecoveryGroupName=ExampleHARG,fsFragmentId=RecoveryGroups,fsFragmentId=HA,fsClusterId=ClusterRoot
Orinareverseorder:
fsClusterId=ClusterRoot,fsFragmentId=HA,fsFragmentId=RecoveryGroups,fshaRecoveryGroupName=ExampleHARG
Onlythelatternameformatsupportsautocompletionwith[TAB]key.
Parameter

Hint

Command

Range

Default

Dependency
None

set has {[regex]? [filter <filter-value>]? [noerror]?


[logerrors]?} inert <inert-mode> managed-object-full-name [<mofullname>]+

2.12.10 has isolate


Table319

hasisolate

Description
SetafaultynodethatHAScannotresetasisolated.Operatorisrequiredtoensurethatthenodeisofflinebeforesetting
thenodeasisolated.
Forexample:
sethasisolatemanaged-object/AS-0
Parameter

Hint

Command

Range

Default

Dependency
None

set has {[regex]? [filter <filter-value>]? [noerror]?


[logerrors]?} isolate managed-object [<mo-name>]+
None
set has {[regex]? [filter <filter-value>]? [noerror]?
[logerrors]?} isolate managed-object-full-name [<mo-fullname>]+

278

Issue:03B

MulticontrollerRNCSCLICommands

2.12.10.1
Table320

SCLICommands

has isolate managed-object

hasisolatemanaged-object

Description
ThenameoftheMO.AnyoptioncanbeappliedtooneormoreMOs.Patternmatching'*'and'?'canbeusedinMO
namesandregularexpressionscanbeusedwithregexparametertomatchMOnames.NOTE!'?'mustbeusedwithin
quotationmarks(""),seeexamplebelow.
NotethatasubtypeofMOs-proxiedcomponent-isnotaddressablebythenormal"managed-object"syntax.Please
selectmanaged-object-full-namewhenreferringtothem.
TouseDNasapartofMOname,pleaseusetheoptionmanaged-object-full-name.
MOnameisaHASMOname.Forexample:
/ExampleHARG
"/?xampleHARG"
Parameter

Hint

Command

Range

Default

Dependency
None

set has {[regex]? [filter <filter-value>]? [noerror]?


[logerrors]?} isolate managed-object [<mo-name>]+

2.12.10.1.1
Table321

has isolate managed-object <mo-name>

hasisolatemanaged-object<mo-name>

Description
ThenameoftheMO.AnyoptioncanbeappliedtooneormoreMOs.Patternmatching'*'and'?'canbeusedinMO
namesandregularexpressionscanbeusedwithregexparametertomatchMOnames.NOTE!'?'mustbeusedwithin
quotationmarks(""),seeexamplebelow.
NotethatasubtypeofMOs-proxiedcomponent-isnotaddressablebythenormal"managed-object"syntax.Please
selectmanaged-object-full-namewhenreferringtothem.
TouseDNasapartofMOname,pleaseusetheoptionmanaged-object-full-name.
MOnameisaHASMOname.Forexample:
/ExampleHARG
"/?xampleHARG"
Parameter

Hint

Command

Range

Default

Dependency
None

set has {[regex]? [filter <filter-value>]? [noerror]?


[logerrors]?} isolate managed-object [<mo-name>]+

Issue:03B

279

SCLICommands

2.12.10.2
Table322

MulticontrollerRNCSCLICommands

has isolate managed-object-full-name

hasisolatemanaged-object-full-name

Description
ThenameoftheMOindistinguishedname(DN)format.TouseslashseparatedMOname,pleaseusetheoption
managed-object.
Forexample:
fshaRecoveryGroupName=ExampleHARG,fsFragmentId=RecoveryGroups,fsFragmentId=HA,fsClusterId=ClusterRoot
Orinareverseorder:
fsClusterId=ClusterRoot,fsFragmentId=HA,fsFragmentId=RecoveryGroups,fshaRecoveryGroupName=ExampleHARG
Onlythelatternameformatsupportsautocompletionwith[TAB]key.
Parameter

Hint

Command

Range

Default

Dependency
None

set has {[regex]? [filter <filter-value>]? [noerror]?


[logerrors]?} isolate managed-object-full-name [<mo-fullname>]+

2.12.10.2.1
Table323

has isolate managed-object-full-name <mo-fullname>

hasisolatemanaged-object-full-name<mo-fullname>

Description
ThenameoftheMOindistinguishedname(DN)format.TouseslashseparatedMOname,pleaseusetheoption
managed-object.
Forexample:
fshaRecoveryGroupName=ExampleHARG,fsFragmentId=RecoveryGroups,fsFragmentId=HA,fsClusterId=ClusterRoot
Orinareverseorder:
fsClusterId=ClusterRoot,fsFragmentId=HA,fsFragmentId=RecoveryGroups,fshaRecoveryGroupName=ExampleHARG
Onlythelatternameformatsupportsautocompletionwith[TAB]key.
Parameter

Hint

Command

Range

Default

Dependency
None

set has {[regex]? [filter <filter-value>]? [noerror]?


[logerrors]?} isolate managed-object-full-name [<mo-fullname>]+

280

Issue:03B

MulticontrollerRNCSCLICommands

SCLICommands

2.12.11 has lock


Table324

haslock

Description
ThiscommandwilllockanMOoralogicalgroup.TheMOcanbethecluster,anode,anRGoranRU.Forexample:
sethaslockmanaged-object/TA-A/ExampleHARU-A
ThelockoptionbrutallyterminatestheMOanditschildMOs.TheMOcanbeshutdowngracefullybythecommandshown
below:
sethasshutdown
Parameter

Hint

Range

Default

ForceacriticalMOtoperformtheoperation.

ForceacriticalMOto
performtheoperation

NA

Thecommandwillreturnimmediatelyafterinitiationwithout
checkingtheoperationresult.

Don'twaitforan
operationtobe
completed

NA

force

noblock

Command

Dependency
None

set has {[regex]? [filter <filter-value>]? [noerror]?


[logerrors]?} lock {[noblock]? [force]?} logical-group
[<logical-group-name>]+
None
set has {[regex]? [filter <filter-value>]? [noerror]?
[logerrors]?} lock {[noblock]? [force]?} managed-object [<moname>]+
None
set has {[regex]? [filter <filter-value>]? [noerror]?
[logerrors]?} lock {[noblock]? [force]?} managed-object-fullname [<mo-fullname>]+

2.12.11.1
Table325

has lock logical-group

haslocklogical-group

Description
Thenameofthelogicalgroup.
Patternmatching'*'and'?'canbeusedinlogicalgroupnames.NOTE!'?'mustbeusedwithinquotationmarks(""),see
examplebelow.
Forexample:
ExampleLogicalGroup

Issue:03B

281

SCLICommands

Table325

MulticontrollerRNCSCLICommands

haslocklogical-group(Cont.)

"LogicalGroup??"
Parameter

Hint

Command

Range

Default

Dependency
None

set has {[regex]? [filter <filter-value>]? [noerror]?


[logerrors]?} lock {[noblock]? [force]?} logical-group
[<logical-group-name>]+

2.12.11.1.1
Table326

has lock logical-group <logical-group-name>

haslocklogical-group<logical-group-name>

Description
Thenameofthelogicalgroup.
Patternmatching'*'and'?'canbeusedinlogicalgroupnames.NOTE!'?'mustbeusedwithinquotationmarks(""),see
examplebelow.
Forexample:
ExampleLogicalGroup
"LogicalGroup??"
Parameter

Hint

Command

Range

Default

Dependency
None

set has {[regex]? [filter <filter-value>]? [noerror]?


[logerrors]?} lock {[noblock]? [force]?} logical-group
[<logical-group-name>]+

2.12.11.2
Table327

has lock managed-object

haslockmanaged-object

Description
ThenameoftheMO.AnyoptioncanbeappliedtooneormoreMOs.Patternmatching'*'and'?'canbeusedinMO
namesandregularexpressionscanbeusedwithregexparametertomatchMOnames.NOTE!'?'mustbeusedwithin
quotationmarks(""),seeexamplebelow.
NotethatasubtypeofMOs-proxiedcomponent-isnotaddressablebythenormal"managed-object"syntax.Please
selectmanaged-object-full-namewhenreferringtothem.
TouseDNasapartofMOname,pleaseusetheoptionmanaged-object-full-name.
MOnameisaHASMOname.Forexample:
/ExampleHARG

282

Issue:03B

MulticontrollerRNCSCLICommands

Table327

SCLICommands

haslockmanaged-object(Cont.)

"/?xampleHARG"
Parameter

Hint

Command

Range

Default

Dependency
None

set has {[regex]? [filter <filter-value>]? [noerror]?


[logerrors]?} lock {[noblock]? [force]?} managed-object [<moname>]+

2.12.11.2.1
Table328

has lock managed-object <mo-name>

haslockmanaged-object<mo-name>

Description
ThenameoftheMO.AnyoptioncanbeappliedtooneormoreMOs.Patternmatching'*'and'?'canbeusedinMO
namesandregularexpressionscanbeusedwithregexparametertomatchMOnames.NOTE!'?'mustbeusedwithin
quotationmarks(""),seeexamplebelow.
NotethatasubtypeofMOs-proxiedcomponent-isnotaddressablebythenormal"managed-object"syntax.Please
selectmanaged-object-full-namewhenreferringtothem.
TouseDNasapartofMOname,pleaseusetheoptionmanaged-object-full-name.
MOnameisaHASMOname.Forexample:
/ExampleHARG
"/?xampleHARG"
Parameter

Hint

Command

Range

Default

Dependency
None

set has {[regex]? [filter <filter-value>]? [noerror]?


[logerrors]?} lock {[noblock]? [force]?} managed-object [<moname>]+

2.12.11.3
Table329

has lock managed-object-full-name

haslockmanaged-object-full-name

Description
ThenameoftheMOindistinguishedname(DN)format.TouseslashseparatedMOname,pleaseusetheoption
managed-object.
Forexample:
fshaRecoveryGroupName=ExampleHARG,fsFragmentId=RecoveryGroups,fsFragmentId=HA,fsClusterId=ClusterRoot
Orinareverseorder:

Issue:03B

283

SCLICommands

Table329

MulticontrollerRNCSCLICommands

haslockmanaged-object-full-name(Cont.)

fsClusterId=ClusterRoot,fsFragmentId=HA,fsFragmentId=RecoveryGroups,fshaRecoveryGroupName=ExampleHARG
Onlythelatternameformatsupportsautocompletionwith[TAB]key.
Parameter

Hint

Command

Range

Default

Dependency
None

set has {[regex]? [filter <filter-value>]? [noerror]?


[logerrors]?} lock {[noblock]? [force]?} managed-object-fullname [<mo-fullname>]+

2.12.11.3.1
Table330

has lock managed-object-full-name <mo-fullname>

haslockmanaged-object-full-name<mo-fullname>

Description
ThenameoftheMOindistinguishedname(DN)format.TouseslashseparatedMOname,pleaseusetheoption
managed-object.
Forexample:
fshaRecoveryGroupName=ExampleHARG,fsFragmentId=RecoveryGroups,fsFragmentId=HA,fsClusterId=ClusterRoot
Orinareverseorder:
fsClusterId=ClusterRoot,fsFragmentId=HA,fsFragmentId=RecoveryGroups,fshaRecoveryGroupName=ExampleHARG
Onlythelatternameformatsupportsautocompletionwith[TAB]key.
Parameter

Hint

Command

Range

Default

Dependency
None

set has {[regex]? [filter <filter-value>]? [noerror]?


[logerrors]?} lock {[noblock]? [force]?} managed-object-fullname [<mo-fullname>]+

2.12.12 has logical-group-state


Table331

haslogical-group-state

Description
ViewthestatesofRUsoftheLGineachnode.
Forexample:
showhaslogical-group-statelogical-groupSingleIP
Parameter

284

Hint

Range

Default

Issue:03B

MulticontrollerRNCSCLICommands

Table331

SCLICommands

haslogical-group-state(Cont.)

Command

Dependency
None

show has {[regex]? [filter <filter-value>]? [noerror]?}


logical-group-state logical-group [<logical-group-name>]+

2.12.12.1
Table332

has logical-group-state logical-group

haslogical-group-statelogical-group

Description
Thenameofthelogicalgroup.
Patternmatching'*'and'?'canbeusedinlogicalgroupnames.NOTE!'?'mustbeusedwithinquotationmarks(""),see
examplebelow.
Forexample:
ExampleLogicalGroup
"LogicalGroup??"
Parameter

Hint

Command

Range

Default

Dependency
None

show has {[regex]? [filter <filter-value>]? [noerror]?}


logical-group-state logical-group [<logical-group-name>]+

2.12.12.1.1
Table333

has logical-group-state logical-group <logical-group-name>

haslogical-group-statelogical-group<logical-group-name>

Description
Thenameofthelogicalgroup.
Patternmatching'*'and'?'canbeusedinlogicalgroupnames.NOTE!'?'mustbeusedwithinquotationmarks(""),see
examplebelow.
Forexample:
ExampleLogicalGroup
"LogicalGroup??"
Parameter

Hint

Command

Range

Default

Dependency
None

show has {[regex]? [filter <filter-value>]? [noerror]?}

Issue:03B

285

SCLICommands

Table333

MulticontrollerRNCSCLICommands

haslogical-group-statelogical-group<logical-group-name>(Cont.)

logical-group-state logical-group [<logical-group-name>]+

2.12.13 has parent


Table334

hasparent

Description
PrinttheMOnameoftheparent.InacaseofRU,theparentRGnameisprinted.Forexample:
showhasparentmanaged-object/TA-A/ExampleHARU-A
Parameter

Hint

Command

Range

Default

Dependency
None

show has {[regex]? [filter <filter-value>]? [noerror]?} parent


managed-object [<mo-name>]+
None
show has {[regex]? [filter <filter-value>]? [noerror]?} parent
managed-object-full-name [<mo-fullname>]+

2.12.13.1
Table335

has parent managed-object

hasparentmanaged-object

Description
ThenameoftheMO.AnyoptioncanbeappliedtooneormoreMOs.Patternmatching'*'and'?'canbeusedinMO
namesandregularexpressionscanbeusedwithregexparametertomatchMOnames.NOTE!'?'mustbeusedwithin
quotationmarks(""),seeexamplebelow.
NotethatasubtypeofMOs-proxiedcomponent-isnotaddressablebythenormal"managed-object"syntax.Please
selectmanaged-object-full-namewhenreferringtothem.
TouseDNasapartofMOname,pleaseusetheoptionmanaged-object-full-name.
MOnameisaHASMOname.Forexample:
/ExampleHARG
"/?xampleHARG"
Parameter

Hint

Command

Range

Default

Dependency
None

show has {[regex]? [filter <filter-value>]? [noerror]?} parent


managed-object [<mo-name>]+

286

Issue:03B

MulticontrollerRNCSCLICommands

2.12.13.1.1
Table336

SCLICommands

has parent managed-object <mo-name>

hasparentmanaged-object<mo-name>

Description
ThenameoftheMO.AnyoptioncanbeappliedtooneormoreMOs.Patternmatching'*'and'?'canbeusedinMO
namesandregularexpressionscanbeusedwithregexparametertomatchMOnames.NOTE!'?'mustbeusedwithin
quotationmarks(""),seeexamplebelow.
NotethatasubtypeofMOs-proxiedcomponent-isnotaddressablebythenormal"managed-object"syntax.Please
selectmanaged-object-full-namewhenreferringtothem.
TouseDNasapartofMOname,pleaseusetheoptionmanaged-object-full-name.
MOnameisaHASMOname.Forexample:
/ExampleHARG
"/?xampleHARG"
Parameter

Hint

Command

Range

Default

Dependency
None

show has {[regex]? [filter <filter-value>]? [noerror]?} parent


managed-object [<mo-name>]+

2.12.13.2
Table337

has parent managed-object-full-name

hasparentmanaged-object-full-name

Description
ThenameoftheMOindistinguishedname(DN)format.TouseslashseparatedMOname,pleaseusetheoption
managed-object.
Forexample:
fshaRecoveryGroupName=ExampleHARG,fsFragmentId=RecoveryGroups,fsFragmentId=HA,fsClusterId=ClusterRoot
Orinareverseorder:
fsClusterId=ClusterRoot,fsFragmentId=HA,fsFragmentId=RecoveryGroups,fshaRecoveryGroupName=ExampleHARG
Onlythelatternameformatsupportsautocompletionwith[TAB]key.
Parameter

Hint

Command

Range

Default

Dependency
None

show has {[regex]? [filter <filter-value>]? [noerror]?} parent


managed-object-full-name [<mo-fullname>]+

Issue:03B

287

SCLICommands

2.12.13.2.1
Table338

MulticontrollerRNCSCLICommands

has parent managed-object-full-name <mo-fullname>

hasparentmanaged-object-full-name<mo-fullname>

Description
ThenameoftheMOindistinguishedname(DN)format.TouseslashseparatedMOname,pleaseusetheoption
managed-object.
Forexample:
fshaRecoveryGroupName=ExampleHARG,fsFragmentId=RecoveryGroups,fsFragmentId=HA,fsClusterId=ClusterRoot
Orinareverseorder:
fsClusterId=ClusterRoot,fsFragmentId=HA,fsFragmentId=RecoveryGroups,fshaRecoveryGroupName=ExampleHARG
Onlythelatternameformatsupportsautocompletionwith[TAB]key.
Parameter

Hint

Command

Range

Default

Dependency
None

show has {[regex]? [filter <filter-value>]? [noerror]?} parent


managed-object-full-name [<mo-fullname>]+

2.12.14 has power


Table339

haspower

Description
Setpoweron|offforanodeorthecluster.Forexample:
sethaspoweroffmanaged-object/TA-A
Parameter

Hint

Command

Range

Default

Dependency
None

set has {[regex]? [filter <filter-value>]? [noerror]?


[logerrors]?} power off {[power-off-cause <power-off-cause>]?
[config-check <config-check>]?} managed-object [<mo-name>]+
None
set has {[regex]? [filter <filter-value>]? [noerror]?
[logerrors]?} power off {[power-off-cause <power-off-cause>]?
[config-check <config-check>]?} managed-object-full-name [<mofullname>]+
None
set has {[regex]? [filter <filter-value>]? [noerror]?
[logerrors]?} power on managed-object [<mo-name>]+

288

Issue:03B

MulticontrollerRNCSCLICommands

Table339

SCLICommands

haspower(Cont.)
None

set has {[regex]? [filter <filter-value>]? [noerror]?


[logerrors]?} power on managed-object-full-name [<mofullname>]+

2.12.14.1
Table340

has power off

haspoweroff

Description
PowertheMOoff.
Parameter

config-check

Hint

Range

Theparameter"config-check"definesthebehaviorwhenthe unsavedconfiguration
targetobjectiscluster(/)oraclustermanagementnode,
check(default:checkandtheclustercurrentconfigurationisnotsavedasthe
and-stop)
startupconfiguration.Thefollowingvaluescanbegivento
theparameter:

Default
checkand-stop

no-check:Commanddoesn'tchecktheconfiguration.Any
unsavedconfigurationchangesarediscarded.
check-and-stop:Commandcheckstheconfiguration.Ifthe
currentconfigurationisnotsavedasthestartup
configuration,thenthecommandrejectstherequested
operationandinformstheuser.

power-off-cause

ChoosethereasonwhytheMOispoweredoff.Thevalueof
thisparameterdoesnotaffectthepoweringoffoftheMO,it
onlyprovidesextrainformationindicatingwhytheMOis
poweredoff,thisinformationwillbeavailableasadynamic
attributewhichcanbeobtainedviathenormalHAS
commands.Thenameofthedynamicattributeis
POWERING_OFF_REASON.Thevalueofthedynamic
attributecanbeobtainedviathe"showhasstate..."
command.

Command

Thereasonwhythe
MOispoweredoff

NA

Dependency
None

set has {[regex]? [filter <filter-value>]? [noerror]?


[logerrors]?} power off {[power-off-cause <power-off-cause>]?
[config-check <config-check>]?} managed-object [<mo-name>]+
None
set has {[regex]? [filter <filter-value>]? [noerror]?
[logerrors]?} power off {[power-off-cause <power-off-cause>]?
[config-check <config-check>]?} managed-object-full-name [<mofullname>]+

Issue:03B

289

SCLICommands

2.12.14.1.1
Table341

MulticontrollerRNCSCLICommands

has power off managed-object

haspoweroffmanaged-object

Description
ThenameoftheMO.AnyoptioncanbeappliedtooneormoreMOs.Patternmatching'*'and'?'canbeusedinMO
namesandregularexpressionscanbeusedwithregexparametertomatchMOnames.NOTE!'?'mustbeusedwithin
quotationmarks(""),seeexamplebelow.
NotethatasubtypeofMOs-proxiedcomponent-isnotaddressablebythenormal"managed-object"syntax.Please
selectmanaged-object-full-namewhenreferringtothem.
TouseDNasapartofMOname,pleaseusetheoptionmanaged-object-full-name.
MOnameisaHASMOname.Forexample:
/ExampleHARG
"/?xampleHARG"
Parameter

Hint

Command

Range

Default

Dependency
None

set has {[regex]? [filter <filter-value>]? [noerror]?


[logerrors]?} power off {[power-off-cause <power-off-cause>]?
[config-check <config-check>]?} managed-object [<mo-name>]+

2.12.14.1.1.1
Table342

has power off managed-object <mo-name>

haspoweroffmanaged-object<mo-name>

Description
ThenameoftheMO.AnyoptioncanbeappliedtooneormoreMOs.Patternmatching'*'and'?'canbeusedinMO
namesandregularexpressionscanbeusedwithregexparametertomatchMOnames.NOTE!'?'mustbeusedwithin
quotationmarks(""),seeexamplebelow.
NotethatasubtypeofMOs-proxiedcomponent-isnotaddressablebythenormal"managed-object"syntax.Please
selectmanaged-object-full-namewhenreferringtothem.
TouseDNasapartofMOname,pleaseusetheoptionmanaged-object-full-name.
MOnameisaHASMOname.Forexample:
/ExampleHARG
"/?xampleHARG"
Parameter

Hint

Command

Range

Default

Dependency
None

set has {[regex]? [filter <filter-value>]? [noerror]?


[logerrors]?} power off {[power-off-cause <power-off-cause>]?
[config-check <config-check>]?} managed-object [<mo-name>]+

290

Issue:03B

MulticontrollerRNCSCLICommands

2.12.14.1.2
Table343

SCLICommands

has power off managed-object-full-name

haspoweroffmanaged-object-full-name

Description
ThenameoftheMOindistinguishedname(DN)format.TouseslashseparatedMOname,pleaseusetheoption
managed-object.
Forexample:
fshaRecoveryGroupName=ExampleHARG,fsFragmentId=RecoveryGroups,fsFragmentId=HA,fsClusterId=ClusterRoot
Orinareverseorder:
fsClusterId=ClusterRoot,fsFragmentId=HA,fsFragmentId=RecoveryGroups,fshaRecoveryGroupName=ExampleHARG
Onlythelatternameformatsupportsautocompletionwith[TAB]key.
Parameter

Hint

Command

Range

Default

Dependency
None

set has {[regex]? [filter <filter-value>]? [noerror]?


[logerrors]?} power off {[power-off-cause <power-off-cause>]?
[config-check <config-check>]?} managed-object-full-name [<mofullname>]+

2.12.14.1.2.1
Table344

has power off managed-object-full-name <mo-fullname>

haspoweroffmanaged-object-full-name<mo-fullname>

Description
ThenameoftheMOindistinguishedname(DN)format.TouseslashseparatedMOname,pleaseusetheoption
managed-object.
Forexample:
fshaRecoveryGroupName=ExampleHARG,fsFragmentId=RecoveryGroups,fsFragmentId=HA,fsClusterId=ClusterRoot
Orinareverseorder:
fsClusterId=ClusterRoot,fsFragmentId=HA,fsFragmentId=RecoveryGroups,fshaRecoveryGroupName=ExampleHARG
Onlythelatternameformatsupportsautocompletionwith[TAB]key.
Parameter

Hint

Command

Range

Default

Dependency
None

set has {[regex]? [filter <filter-value>]? [noerror]?


[logerrors]?} power off {[power-off-cause <power-off-cause>]?
[config-check <config-check>]?} managed-object-full-name [<mofullname>]+

Issue:03B

291

SCLICommands

2.12.14.2
Table345

MulticontrollerRNCSCLICommands

has power on

haspoweron

Description
PowertheMOon.
Parameter

Hint

Command

Range

Default

Dependency
None

set has {[regex]? [filter <filter-value>]? [noerror]?


[logerrors]?} power on managed-object [<mo-name>]+
None
set has {[regex]? [filter <filter-value>]? [noerror]?
[logerrors]?} power on managed-object-full-name [<mofullname>]+

2.12.14.2.1
Table346

has power on managed-object

haspoweronmanaged-object

Description
ThenameoftheMO.AnyoptioncanbeappliedtooneormoreMOs.Patternmatching'*'and'?'canbeusedinMO
namesandregularexpressionscanbeusedwithregexparametertomatchMOnames.NOTE!'?'mustbeusedwithin
quotationmarks(""),seeexamplebelow.
NotethatasubtypeofMOs-proxiedcomponent-isnotaddressablebythenormal"managed-object"syntax.Please
selectmanaged-object-full-namewhenreferringtothem.
TouseDNasapartofMOname,pleaseusetheoptionmanaged-object-full-name.
MOnameisaHASMOname.Forexample:
/ExampleHARG
"/?xampleHARG"
Parameter

Hint

Command

Range

Default

Dependency
None

set has {[regex]? [filter <filter-value>]? [noerror]?


[logerrors]?} power on managed-object [<mo-name>]+

2.12.14.2.1.1
Table347

has power on managed-object <mo-name>

haspoweronmanaged-object<mo-name>

Description

292

Issue:03B

MulticontrollerRNCSCLICommands

Table347

SCLICommands

haspoweronmanaged-object<mo-name>(Cont.)

ThenameoftheMO.AnyoptioncanbeappliedtooneormoreMOs.Patternmatching'*'and'?'canbeusedinMO
namesandregularexpressionscanbeusedwithregexparametertomatchMOnames.NOTE!'?'mustbeusedwithin
quotationmarks(""),seeexamplebelow.
NotethatasubtypeofMOs-proxiedcomponent-isnotaddressablebythenormal"managed-object"syntax.Please
selectmanaged-object-full-namewhenreferringtothem.
TouseDNasapartofMOname,pleaseusetheoptionmanaged-object-full-name.
MOnameisaHASMOname.Forexample:
/ExampleHARG
"/?xampleHARG"
Parameter

Hint

Command

Range

Default

Dependency
None

set has {[regex]? [filter <filter-value>]? [noerror]?


[logerrors]?} power on managed-object [<mo-name>]+

2.12.14.2.2
Table348

has power on managed-object-full-name

haspoweronmanaged-object-full-name

Description
ThenameoftheMOindistinguishedname(DN)format.TouseslashseparatedMOname,pleaseusetheoption
managed-object.
Forexample:
fshaRecoveryGroupName=ExampleHARG,fsFragmentId=RecoveryGroups,fsFragmentId=HA,fsClusterId=ClusterRoot
Orinareverseorder:
fsClusterId=ClusterRoot,fsFragmentId=HA,fsFragmentId=RecoveryGroups,fshaRecoveryGroupName=ExampleHARG
Onlythelatternameformatsupportsautocompletionwith[TAB]key.
Parameter

Hint

Command

Range

Default

Dependency
None

set has {[regex]? [filter <filter-value>]? [noerror]?


[logerrors]?} power on managed-object-full-name [<mofullname>]+

2.12.14.2.2.1
Table349

has power on managed-object-full-name <mo-fullname>

haspoweronmanaged-object-full-name<mo-fullname>

Description

Issue:03B

293

SCLICommands

Table349

MulticontrollerRNCSCLICommands

haspoweronmanaged-object-full-name<mo-fullname>(Cont.)

ThenameoftheMOindistinguishedname(DN)format.TouseslashseparatedMOname,pleaseusetheoption
managed-object.
Forexample:
fshaRecoveryGroupName=ExampleHARG,fsFragmentId=RecoveryGroups,fsFragmentId=HA,fsClusterId=ClusterRoot
Orinareverseorder:
fsClusterId=ClusterRoot,fsFragmentId=HA,fsFragmentId=RecoveryGroups,fshaRecoveryGroupName=ExampleHARG
Onlythelatternameformatsupportsautocompletionwith[TAB]key.
Parameter

Hint

Command

Range

Default

Dependency
None

set has {[regex]? [filter <filter-value>]? [noerror]?


[logerrors]?} power on managed-object-full-name [<mofullname>]+

2.12.15 has process-family


Table350

hasprocess-family

Description
delete
Thiscommanddeletesprocessfamilyrelatedinformation.
set
Thiscommandsetsprocessfamilyrelatedparameters.
show
Thiscommandshowsprocessfamilyrelatedinformation.
start
Thiscommandstartsprocessfamilyrelatedfunction.
stop
Thiscommandstopsprocessfamilyrelatedfunction.
Parameter

Hint

Command

Range

Default

Dependency
None

delete has process-family warming statistics unit-type <unittype-name> {unit-index <unit-index>}


None
set has {[regex]? [filter <filter-value>]? [noerror]?
[logerrors]?} process-family supervision {unit-type <unit-type-

294

Issue:03B

MulticontrollerRNCSCLICommands

Table350

SCLICommands

hasprocess-family(Cont.)

value> unit-index <unit-index-value> family-id <family-idvalue> target <target-value> interval <interval-value>}


None
show has {[regex]? [filter <filter-value>]? [noerror]?}
process-family attribute all
None
show has {[regex]? [filter <filter-value>]? [noerror]?}
process-family attribute family-id <family-id>
None
show has {[regex]? [filter <filter-value>]? [noerror]?}
process-family attribute master-name <master-name>
None
show has {[regex]? [filter <filter-value>]? [noerror]?}
process-family attribute process-name <process-name>
None
show has {[regex]? [filter <filter-value>]? [noerror]?}
process-family supervision {unit-type <unit-type-value> unitindex <unit-index-value> family-id <family-id-value>}
None
show has {[regex]? [filter <filter-value>]? [noerror]?}
process-family sync-monitoring errors unit-type <unit-typename> {unit-index <unit-index> family-id <family-id>}
None
show has {[regex]? [filter <filter-value>]? [noerror]?}
process-family sync-monitoring list unit-type <unit-type-name>
{unit-index <unit-index>}
None
show has {[regex]? [filter <filter-value>]? [noerror]?}
process-family warming compare-all unit-type <unit-type-name>
{unit-index <unit-index> family-id <family-id> process-id
<process-id>}

2.12.15.1
Table351

has process-family attribute

hasprocess-familyattribute

Description
Thiscommandshowstheprocessattributes.

Issue:03B

295

SCLICommands

Table351

MulticontrollerRNCSCLICommands

hasprocess-familyattribute(Cont.)

TheattributesincludethefamilyID,masternameandprocessname.
Parameter

Hint

Command

Range

Default

Dependency
None

show has {[regex]? [filter <filter-value>]? [noerror]?}


process-family attribute all
None
show has {[regex]? [filter <filter-value>]? [noerror]?}
process-family attribute family-id <family-id>
None
show has {[regex]? [filter <filter-value>]? [noerror]?}
process-family attribute master-name <master-name>
None
show has {[regex]? [filter <filter-value>]? [noerror]?}
process-family attribute process-name <process-name>

2.12.15.1.1
Table352

has process-family attribute all

hasprocess-familyattributeall

Description
Thiscommandshowstheattributesofallprocesses.
Parameter

Hint

Command

Range

Default

Dependency
None

show has {[regex]? [filter <filter-value>]? [noerror]?}


process-family attribute all

2.12.15.1.2
Table353

has process-family attribute family-id

hasprocess-familyattributefamily-id

Description
ThiscommandshowstheprocessattributesfilteredbythefamilyID.
Parameter
Command

296

Hint

Range

Default

Dependency

Issue:03B

MulticontrollerRNCSCLICommands

Table353

SCLICommands

hasprocess-familyattributefamily-id(Cont.)
None

show has {[regex]? [filter <filter-value>]? [noerror]?}


process-family attribute family-id <family-id>

2.12.15.1.2.1
Table354

has process-family attribute family-id <family-id>

hasprocess-familyattributefamily-id<family-id>

Description
Theparameteristhefamilyid,forexample,0x3DA.
Parameter

Hint

Command

Range

Default

Dependency
None

show has {[regex]? [filter <filter-value>]? [noerror]?}


process-family attribute family-id <family-id>

2.12.15.1.3
Table355

has process-family attribute master-name

hasprocess-familyattributemaster-name

Description
Thiscommandshowstheprocessattributesfilteredbythemastername.
Parameter

Hint

Command

Range

Default

Dependency
None

show has {[regex]? [filter <filter-value>]? [noerror]?}


process-family attribute master-name <master-name>

2.12.15.1.3.1
Table356

has process-family attribute master-name <master-name>

hasprocess-familyattributemaster-name<master-name>

Description
Theparameteristhemastername,forexample,unit_agent_mas.
Parameter

Hint

Command

Range

Default

Dependency
None

show has {[regex]? [filter <filter-value>]? [noerror]?}

Issue:03B

297

SCLICommands

Table356

MulticontrollerRNCSCLICommands

hasprocess-familyattributemaster-name<master-name>(Cont.)

process-family attribute master-name <master-name>

2.12.15.1.4
Table357

has process-family attribute process-name

hasprocess-familyattributeprocess-name

Description
Thiscommandshowstheprocessattributesfilteredbytheprocessname.
Parameter

Hint

Command

Range

Default

Dependency
None

show has {[regex]? [filter <filter-value>]? [noerror]?}


process-family attribute process-name <process-name>

2.12.15.1.4.1
Table358

has process-family attribute process-name <process-name>

hasprocess-familyattributeprocess-name<process-name>

Description
Theparameteristheprocessname,forexample,IL_UnitStateAgent.
Parameter

Hint

Command

Range

Default

Dependency
None

show has {[regex]? [filter <filter-value>]? [noerror]?}


process-family attribute process-name <process-name>

2.12.15.2
Table359

has process-family supervision

hasprocess-familysupervision

Description
set
Thiscommandsetsthesupervisionparametersofaspecifiedfamily.
show
Thiscommandshowssupervisionparametersofaspecifiedfamily.
start
Thiscommandstartsthesupervisionbystarterofaspecifiedfamily.
stop

298

Issue:03B

MulticontrollerRNCSCLICommands

Table359

SCLICommands

hasprocess-familysupervision(Cont.)

Thiscommandstopsthespecifiedfamily'ssupervisionbystarter.
Parameter

Hint

Range

Default

TheparameterspecifiesthefamilyIDindecimalorhex
format.

1..65534

NA

family-id

Theparameterspecifiessupervisionintervalindecimalor
hexformat.

0..65535

NA

interval

Theparameterspecifieswheretosettheparameters.

themodetosetthe
supervision
parameters

NA

Theparameterspecifiesthefunctionalunitindex,for
example,0.

unitindex,for
example,0

NA

unit-index

Theparameterspecifiesthefunctionalunittype,for
example,OMU.

unittype,forexample,
OMU

NA

unit-type

Valueisinseconds[0..65535].0meansthatthesupervision
willbestopped.

target

Command

Dependency
None

set has {[regex]? [filter <filter-value>]? [noerror]?


[logerrors]?} process-family supervision {unit-type <unit-typevalue> unit-index <unit-index-value> family-id <family-idvalue> target <target-value> interval <interval-value>}
None
show has {[regex]? [filter <filter-value>]? [noerror]?}
process-family supervision {unit-type <unit-type-value> unitindex <unit-index-value> family-id <family-id-value>}
None
start has process-family supervision {unit-type <unit-typevalue> unit-index <unit-index-value> family-id <family-idvalue>}
None
stop has process-family supervision {unit-type <unit-typevalue> unit-index <unit-index-value> family-id <family-idvalue>}

2.12.15.3
Table360

has process-family sync-monitoring

hasprocess-familysync-monitoring

Description

Issue:03B

299

SCLICommands

Table360

MulticontrollerRNCSCLICommands

hasprocess-familysync-monitoring(Cont.)

show
Thiscommandshowssynchronizationmonitoringinformation.
stop
Thiscommandstopsmonitoringofsynchronizationerrors.
Parameter

Hint

Command

Range

Default

Dependency
None

show has {[regex]? [filter <filter-value>]? [noerror]?}


process-family sync-monitoring errors unit-type <unit-typename> {unit-index <unit-index> family-id <family-id>}
None
show has {[regex]? [filter <filter-value>]? [noerror]?}
process-family sync-monitoring list unit-type <unit-type-name>
{unit-index <unit-index>}
None
stop has process-family sync-monitoring unit-type <unit-typename> {unit-index <unit-index> family-id <family-id>}

2.12.15.3.1
Table361

has process-family sync-monitoring errors

hasprocess-familysync-monitoringerrors

Description
Thiscommandshowssynchronizationerrors.
Parameter

Hint

Command

Range

Default

Dependency
None

show has {[regex]? [filter <filter-value>]? [noerror]?}


process-family sync-monitoring errors unit-type <unit-typename> {unit-index <unit-index> family-id <family-id>}

2.12.15.3.1.1
Table362

has process-family sync-monitoring errors unit-type

hasprocess-familysync-monitoringerrorsunit-type

Description
Thiscommandshowssynchronizationerrorsforthespecifiedunittype.

300

Issue:03B

MulticontrollerRNCSCLICommands

Table362

SCLICommands

hasprocess-familysync-monitoringerrorsunit-type(Cont.)

Parameter

Hint

Command

Range

Default

Dependency
None

show has {[regex]? [filter <filter-value>]? [noerror]?}


process-family sync-monitoring errors unit-type <unit-typename> {unit-index <unit-index> family-id <family-id>}

2.12.15.3.1.1.1
Table363

hasprocess-familysync-monitoringerrorsunit-type<unit-type-name>

hasprocess-familysync-monitoringerrorsunit-type<unit-type-name>

Description
Thiscommandshowssynchronizationerrorsoftheprocessfamilyintheunit.
Parameter

Hint

Range

Default

TheparameterspecifiesthefamilyIDindecimalorhex
format.

0x1..0xFFFE

NA

family-id

Theparameterspecifiesthefunctionalunitindex,for
example,0.

unitindex,for
example,0

NA

unit-index
Command

Dependency
None

show has {[regex]? [filter <filter-value>]? [noerror]?}


process-family sync-monitoring errors unit-type <unit-typename> {unit-index <unit-index> family-id <family-id>}

2.12.15.3.2
Table364

has process-family sync-monitoring list

hasprocess-familysync-monitoringlist

Description
Thiscommandshowscurrentmonitoredprocessfamiliesintheunit.
Parameter

Hint

Command

Range

Default

Dependency
None

show has {[regex]? [filter <filter-value>]? [noerror]?}


process-family sync-monitoring list unit-type <unit-type-name>
{unit-index <unit-index>}

Issue:03B

301

SCLICommands

2.12.15.3.2.1
Table365

MulticontrollerRNCSCLICommands

has process-family sync-monitoring list unit-type

hasprocess-familysync-monitoringlistunit-type

Description
Thiscommandshowscurrentmonitoredprocessfamiliesforthespecifiedunittype.
Parameter

Hint

Command

Range

Default

Dependency
None

show has {[regex]? [filter <filter-value>]? [noerror]?}


process-family sync-monitoring list unit-type <unit-type-name>
{unit-index <unit-index>}

2.12.15.3.2.1.1
Table366

hasprocess-familysync-monitoringlistunit-type<unit-type-name>

hasprocess-familysync-monitoringlistunit-type<unit-type-name>

Description
Thiscommandshowscurrentmonitoredprocessfamiliestheunit.
Parameter

Hint

Range

Default

Theparameterspecifiesthefunctionalunitindex,for
example,0.

unitindex,for
example,0

NA

unit-index
Command

Dependency
None

show has {[regex]? [filter <filter-value>]? [noerror]?}


process-family sync-monitoring list unit-type <unit-type-name>
{unit-index <unit-index>}

2.12.15.3.3
Table367

has process-family sync-monitoring unit-type

hasprocess-familysync-monitoringunit-type

Description
Thiscommandstopsmonitoringofsynchronizationerrorsforthespecifiedunittype.
Parameter

Hint

Command

Range

Default

Dependency
None

stop has process-family sync-monitoring unit-type <unit-typename> {unit-index <unit-index> family-id <family-id>}

302

Issue:03B

MulticontrollerRNCSCLICommands

2.12.15.3.3.1
Table368

SCLICommands

has process-family sync-monitoring unit-type <unit-type-name>

hasprocess-familysync-monitoringunit-type<unit-type-name>

Description
Thiscommandstopssynchronizationerrorsmonitoringoftheprocessfamily.
Parameter

Hint

Range

Default

TheparameterspecifiesthefamilyIDindecimalorhex
format.

0x1..0xFFFE

NA

family-id

Theparameterspecifiesthefunctionalunitindex,for
example,0.

unitindex,for
example,0

NA

unit-index
Command

Dependency
None

stop has process-family sync-monitoring unit-type <unit-typename> {unit-index <unit-index> family-id <family-id>}

2.12.15.4
Table369

has process-family warming

hasprocess-familywarming

Description
delete
Thiscommanddeleteswarmingrelatedinformation.
show
Thiscommandshowswarmingrelatedinformation.
start
Thiscommandstartstowarmaprocessfamily.
Parameter

Hint

Command

Range

Default

Dependency
None

delete has process-family warming statistics unit-type <unittype-name> {unit-index <unit-index>}


None
show has {[regex]? [filter <filter-value>]? [noerror]?}
process-family warming compare-all unit-type <unit-type-name>
{unit-index <unit-index> family-id <family-id> process-id
<process-id>}
None
show has {[regex]? [filter <filter-value>]? [noerror]?}

Issue:03B

303

SCLICommands

Table369

MulticontrollerRNCSCLICommands

hasprocess-familywarming(Cont.)

process-family warming compare-buffer unit-type <unit-typename> {unit-index <unit-index> family-id <family-id> process-id
<process-id>}
None
show has {[regex]? [filter <filter-value>]? [noerror]?}
process-family warming compare-state-data unit-type <unit-typename> {unit-index <unit-index> family-id <family-id> process-id
<process-id>}
None
show has {[regex]? [filter <filter-value>]? [noerror]?}
process-family warming compare-timer unit-type <unit-type-name>
{unit-index <unit-index> family-id <family-id> process-id
<process-id>}
None
show has {[regex]? [filter <filter-value>]? [noerror]?}
process-family warming compare-variables unit-type <unit-typename> {unit-index <unit-index> family-id <family-id> process-id
<process-id>}
None
show has {[regex]? [filter <filter-value>]? [noerror]?}
process-family warming configuration unit-type <unit-type-name>
{unit-index <unit-index>}
None
show has {[regex]? [filter <filter-value>]? [noerror]?}
process-family warming information unit-type <unit-type-name>
{unit-index <unit-index> [family-id <family-id>]?}
None
show has {[regex]? [filter <filter-value>]? [noerror]?}
process-family warming statistics unit-type <unit-type-name>
{unit-index <unit-index>}
None
show has {[regex]? [filter <filter-value>]? [noerror]?}
process-family warming subscriptions unit-type <unit-type-name>
{unit-index <unit-index>}

2.12.15.4.1
Table370

has process-family warming compare-all

hasprocess-familywarmingcompare-all

Description

304

Issue:03B

MulticontrollerRNCSCLICommands

Table370

SCLICommands

hasprocess-familywarmingcompare-all(Cont.)

Thiscommandcomparesallthewarmingdataexceptmemoryfilesbetweenactiveandstandbyunits.
Parameter

Hint

Command

Range

Default

Dependency
None

show has {[regex]? [filter <filter-value>]? [noerror]?}


process-family warming compare-all unit-type <unit-type-name>
{unit-index <unit-index> family-id <family-id> process-id
<process-id>}

2.12.15.4.1.1
Table371

has process-family warming compare-all unit-type

hasprocess-familywarmingcompare-allunit-type

Description
Thiscommandcomparesallthewarmingdataexceptmemoryfilesforthespecifiedunittype.
Parameter

Hint

Command

Range

Default

Dependency
None

show has {[regex]? [filter <filter-value>]? [noerror]?}


process-family warming compare-all unit-type <unit-type-name>
{unit-index <unit-index> family-id <family-id> process-id
<process-id>}

2.12.15.4.1.1.1
Table372

hasprocess-familywarmingcompare-allunit-type<unit-type-name>

hasprocess-familywarmingcompare-allunit-type<unit-type-name>

Description
Thiscommandcomparesallthewarmingdataexceptmemoryfilesoftheprocessbetweenactiveandstandbyunits,
including:
warmedvariables,warmedhandstatedata,warmedtimersandwarmedbuffers.
Parameter

Hint

Range

Default

TheparameterspecifiesthefamilyIDindecimalorhex
format.

0x1..0xFFFE

NA

family-id

TheparameterspecifiestheprocessIDindecimalorhex
format.

0x0..0xFFFE

NA

process-id

Theparameterspecifiesthefunctionalunitindex,for
example,0.

unitindex,for
example,0

NA

unit-index

Issue:03B

305

SCLICommands

Table372

MulticontrollerRNCSCLICommands

hasprocess-familywarmingcompare-allunit-type<unit-type-name>
(Cont.)

Command

Dependency
None

show has {[regex]? [filter <filter-value>]? [noerror]?}


process-family warming compare-all unit-type <unit-type-name>
{unit-index <unit-index> family-id <family-id> process-id
<process-id>}

2.12.15.4.2
Table373

has process-family warming compare-buffer

hasprocess-familywarmingcompare-buffer

Description
Thiscommandcompareswarmedbuffersbetweenactiveandstandbyunits.
Parameter

Hint

Command

Range

Default

Dependency
None

show has {[regex]? [filter <filter-value>]? [noerror]?}


process-family warming compare-buffer unit-type <unit-typename> {unit-index <unit-index> family-id <family-id> process-id
<process-id>}

2.12.15.4.2.1
Table374

has process-family warming compare-buffer unit-type

hasprocess-familywarmingcompare-bufferunit-type

Description
Thiscommandcompareswarmedbuffersforthespecifiedunittype.
Parameter

Hint

Command

Range

Default

Dependency
None

show has {[regex]? [filter <filter-value>]? [noerror]?}


process-family warming compare-buffer unit-type <unit-typename> {unit-index <unit-index> family-id <family-id> process-id
<process-id>}

2.12.15.4.2.1.1
Table375

hasprocess-familywarmingcompare-bufferunit-type<unit-type-name>

hasprocess-familywarmingcompare-bufferunit-type<unit-type-name>

Description

306

Issue:03B

MulticontrollerRNCSCLICommands

Table375

SCLICommands

hasprocess-familywarmingcompare-bufferunit-type<unit-type-name>
(Cont.)

Thiscommandcompareswarmedbuffersoftheprocessbetweenactiveandstandbyunits.
Parameter

Hint

Range

Default

TheparameterspecifiesthefamilyIDindecimalorhex
format.

0x1..0xFFFE

NA

family-id

TheparameterspecifiestheprocessIDindecimalorhex
format.

0x0..0xFFFE

NA

process-id

Theparameterspecifiesthefunctionalunitindex,for
example,0.

unitindex,for
example,0

NA

unit-index
Command

Dependency
None

show has {[regex]? [filter <filter-value>]? [noerror]?}


process-family warming compare-buffer unit-type <unit-typename> {unit-index <unit-index> family-id <family-id> process-id
<process-id>}

2.12.15.4.3
Table376

has process-family warming compare-state-data

hasprocess-familywarmingcompare-state-data

Description
Thiscommandcompareswarmedstatedataoftheprocessbetweenactiveandstandbyunits.
Parameter

Hint

Command

Range

Default

Dependency
None

show has {[regex]? [filter <filter-value>]? [noerror]?}


process-family warming compare-state-data unit-type <unit-typename> {unit-index <unit-index> family-id <family-id> process-id
<process-id>}

2.12.15.4.3.1
Table377

has process-family warming compare-state-data unit-type

hasprocess-familywarmingcompare-state-dataunit-type

Description
Thiscommandcompareswarmedstatedataforthespecifiedunittype.
Parameter
Command

Issue:03B

Hint

Range

Default

Dependency

307

SCLICommands

Table377

MulticontrollerRNCSCLICommands

hasprocess-familywarmingcompare-state-dataunit-type(Cont.)
None

show has {[regex]? [filter <filter-value>]? [noerror]?}


process-family warming compare-state-data unit-type <unit-typename> {unit-index <unit-index> family-id <family-id> process-id
<process-id>}

2.12.15.4.3.1.1
Table378

hasprocess-familywarmingcompare-state-dataunit-type<unit-type-name>

hasprocess-familywarmingcompare-state-dataunit-type<unit-typename>

Description
Thiscommandcompareswarmedstatedataoftheprocessbetweenactiveandstandbyunits.
Parameter

Hint

Range

Default

TheparameterspecifiesthefamilyIDindecimalorhex
format.

0x1..0xFFFE

NA

family-id

TheparameterspecifiestheprocessIDindecimalorhex
format.

0x0..0xFFFE

NA

process-id

Theparameterspecifiesthefunctionalunitindex,for
example,0.

unitindex,for
example,0

NA

unit-index
Command

Dependency
None

show has {[regex]? [filter <filter-value>]? [noerror]?}


process-family warming compare-state-data unit-type <unit-typename> {unit-index <unit-index> family-id <family-id> process-id
<process-id>}

2.12.15.4.4
Table379

has process-family warming compare-timer

hasprocess-familywarmingcompare-timer

Description
Thiscommandcompareswarmedtimersbetweenactiveandstandbyunits.
Parameter

Hint

Command

Range

Default

Dependency
None

show has {[regex]? [filter <filter-value>]? [noerror]?}


process-family warming compare-timer unit-type <unit-type-name>
{unit-index <unit-index> family-id <family-id> process-id
<process-id>}

308

Issue:03B

MulticontrollerRNCSCLICommands

2.12.15.4.4.1
Table380

SCLICommands

has process-family warming compare-timer unit-type

hasprocess-familywarmingcompare-timerunit-type

Description
Thiscommandcompareswarmedtimersforthespecifiedunittype.
Parameter

Hint

Command

Range

Default

Dependency
None

show has {[regex]? [filter <filter-value>]? [noerror]?}


process-family warming compare-timer unit-type <unit-type-name>
{unit-index <unit-index> family-id <family-id> process-id
<process-id>}

2.12.15.4.4.1.1
Table381

hasprocess-familywarmingcompare-timerunit-type<unit-type-name>

hasprocess-familywarmingcompare-timerunit-type<unit-type-name>

Description
Thiscommandcompareswarmedtimersoftheprocessbetweenactiveandstandbyunits.
Parameter

Hint

Range

Default

TheparameterspecifiesthefamilyIDindecimalorhex
format.

0x1..0xFFFE

NA

family-id

TheparameterspecifiestheprocessIDindecimalorhex
format.

0x0..0xFFFE

NA

process-id

Theparameterspecifiesthefunctionalunitindex,for
example,0.

unitindex,for
example,0

NA

unit-index
Command

Dependency
None

show has {[regex]? [filter <filter-value>]? [noerror]?}


process-family warming compare-timer unit-type <unit-type-name>
{unit-index <unit-index> family-id <family-id> process-id
<process-id>}

2.12.15.4.5
Table382

has process-family warming compare-variables

hasprocess-familywarmingcompare-variables

Description
Thiscommandcompareswarmedvariablesbetweenactiveandstandbyunits.
Parameter

Issue:03B

Hint

Range

Default

309

SCLICommands

Table382

MulticontrollerRNCSCLICommands

hasprocess-familywarmingcompare-variables(Cont.)

Command

Dependency
None

show has {[regex]? [filter <filter-value>]? [noerror]?}


process-family warming compare-variables unit-type <unit-typename> {unit-index <unit-index> family-id <family-id> process-id
<process-id>}

2.12.15.4.5.1
Table383

has process-family warming compare-variables unit-type

hasprocess-familywarmingcompare-variablesunit-type

Description
Thiscommandcompareswarmedvariablesforthespecifiedunittype.
Parameter

Hint

Command

Range

Default

Dependency
None

show has {[regex]? [filter <filter-value>]? [noerror]?}


process-family warming compare-variables unit-type <unit-typename> {unit-index <unit-index> family-id <family-id> process-id
<process-id>}

2.12.15.4.5.1.1
Table384

hasprocess-familywarmingcompare-variablesunit-type<unit-type-name>

hasprocess-familywarmingcompare-variablesunit-type<unit-type-name>

Description
Thiscommandcompareswarmedvariablesoftheprocessbetweenactiveandstandbyunits.
Parameter

Hint

Range

Default

TheparameterspecifiesthefamilyIDindecimalorhex
format.

0x1..0xFFFE

NA

family-id

TheparameterspecifiestheprocessIDindecimalorhex
format.

0x0..0xFFFE

NA

process-id

Theparameterspecifiesthefunctionalunitindex,for
example,0.

unitindex,for
example,0

NA

unit-index
Command

Dependency
None

show has {[regex]? [filter <filter-value>]? [noerror]?}


process-family warming compare-variables unit-type <unit-typename> {unit-index <unit-index> family-id <family-id> process-id

310

Issue:03B

MulticontrollerRNCSCLICommands

Table384

SCLICommands

hasprocess-familywarmingcompare-variablesunit-type<unit-type-name>
(Cont.)

<process-id>}

2.12.15.4.6
Table385

has process-family warming configuration

hasprocess-familywarmingconfiguration

Description
Thiscommandshowsthewarmingconfigurationofallwarmedprocessfamiliesinaunit.
Parameter

Hint

Command

Range

Default

Dependency
None

show has {[regex]? [filter <filter-value>]? [noerror]?}


process-family warming configuration unit-type <unit-type-name>
{unit-index <unit-index>}

2.12.15.4.6.1
Table386

has process-family warming configuration unit-type

hasprocess-familywarmingconfigurationunit-type

Description
Thiscommandshowsthewarmingconfigurationforthespecifiedunittype.
Parameter

Hint

Command

Range

Default

Dependency
None

show has {[regex]? [filter <filter-value>]? [noerror]?}


process-family warming configuration unit-type <unit-type-name>
{unit-index <unit-index>}

2.12.15.4.6.1.1
Table387

hasprocess-familywarmingconfigurationunit-type<unit-type-name>

hasprocess-familywarmingconfigurationunit-type<unit-type-name>

Description
Thiscommandshowsthewarmingconfigurationofallwarmedprocessfamiliesintheunit,including:
processfamilyID,warmingorder,maximumretrycount,waitingforwarmingsleep
requesttimeout(in10milliseconds)andwarmingtransfertimeout(in10milliseconds).

Issue:03B

311

SCLICommands

Table387

MulticontrollerRNCSCLICommands

hasprocess-familywarmingconfigurationunit-type<unit-type-name>
(Cont.)

Parameter

Hint

Range

Default

Theparameterspecifiesthefunctionalunitindex,for
example,0.

unitindex,for
example,0

NA

unit-index
Command

Dependency
None

show has {[regex]? [filter <filter-value>]? [noerror]?}


process-family warming configuration unit-type <unit-type-name>
{unit-index <unit-index>}

2.12.15.4.7
Table388

has process-family warming family

hasprocess-familywarmingfamily

Description
Thiscommandstartstowarmaprocessfamily.
PleaseuseSCLIcommand"showhasprocess-familywarmingstatistics"tocheckthedetailederrorswhenwarmingaunit
failed.
Parameter

Hint

Command

Range

Default

Dependency
None

start has process-family warming family unit-type <unit-typename> {unit-index <unit-index> family-id <family-id>}

2.12.15.4.7.1
Table389

has process-family warming family unit-type

hasprocess-familywarmingfamilyunit-type

Description
Thiscommandstartstowarmaprocessfamilyforthespecifiedunittype.
Parameter

Hint

Command

Range

Default

Dependency
None

start has process-family warming family unit-type <unit-typename> {unit-index <unit-index> family-id <family-id>}

312

Issue:03B

MulticontrollerRNCSCLICommands

2.12.15.4.7.1.1
Table390

SCLICommands

hasprocess-familywarmingfamilyunit-type<unit-type-name>

hasprocess-familywarmingfamilyunit-type<unit-type-name>

Description
Thiscommandstartstowarmaprocessfamilyorallwarmingenabledprocessfamiliesintheunit.
PleaseuseSCLIcommand"showhasprocess-familywarmingstatistics"tocheckthedetailederrorswhenwarmingaunit
failed.
Parameter

Hint

Range

Default

TheparameterspecifiesthefamilyIDindecimalorhex
format.

0x1..0xFFFF

NA

family-id

unitindex,for
example,0

NA

0xFFFFmeansallwarmingenabledfamiliesintheunit.
Theparameterspecifiesthefunctionalunitindex,for
example,0.

unit-index
Command

Dependency
None

start has process-family warming family unit-type <unit-typename> {unit-index <unit-index> family-id <family-id>}

2.12.15.4.8
Table391

has process-family warming information

hasprocess-familywarminginformation

Description
Thiscommandshowswarmeddatainformationofaunitoraprocessfamily.
Parameter

Hint

Command

Range

Default

Dependency
None

show has {[regex]? [filter <filter-value>]? [noerror]?}


process-family warming information unit-type <unit-type-name>
{unit-index <unit-index> [family-id <family-id>]?}

2.12.15.4.8.1
Table392

has process-family warming information unit-type

hasprocess-familywarminginformationunit-type

Description
Thiscommandshowswarmeddatainformationforthespecifiedunittype.
Parameter
Command

Issue:03B

Hint

Range

Default

Dependency

313

SCLICommands

Table392

MulticontrollerRNCSCLICommands

hasprocess-familywarminginformationunit-type(Cont.)
None

show has {[regex]? [filter <filter-value>]? [noerror]?}


process-family warming information unit-type <unit-type-name>
{unit-index <unit-index> [family-id <family-id>]?}

2.12.15.4.8.1.1
Table393

hasprocess-familywarminginformationunit-type<unit-type-name>

hasprocess-familywarminginformationunit-type<unit-type-name>

Description
Thiscommandshowsthewarmeddatainformationofallwarmedprocessfamiliesoraprocessfamilyintheunit,including:
warmedvariables,warmedbuffers,warmedmemoryfilesofthemasterprocessandeachhandgroupoftheprocess
family.
Parameter

Hint

Range

Default

TheparameterspecifiesthefamilyIDindecimalorhex
format.

0x1..0xFFFE

NA

family-id

unitindex,for
example,0

NA

Allwarmingenabledfamiliesintheunitwillbeshownifnot
given.
Theparameterspecifiesthefunctionalunitindex,for
example,0.

unit-index
Command

Dependency
None

show has {[regex]? [filter <filter-value>]? [noerror]?}


process-family warming information unit-type <unit-type-name>
{unit-index <unit-index> [family-id <family-id>]?}

2.12.15.4.9
Table394

has process-family warming process

hasprocess-familywarmingprocess

Description
Thiscommandstartstowarmasingleprocessofaprocessfamily.
Parameter

Hint

Command

Range

Default

Dependency
None

start has process-family warming process unit-type <unit-typename> {unit-index <unit-index> family-id <family-id> process-id
<process-id>}

314

Issue:03B

MulticontrollerRNCSCLICommands

2.12.15.4.9.1
Table395

SCLICommands

has process-family warming process unit-type

hasprocess-familywarmingprocessunit-type

Description
Thiscommandstartstowarmasingleprocessofaprocessfamilyforthespecifiedunittype.
Parameter

Hint

Command

Range

Default

Dependency
None

start has process-family warming process unit-type <unit-typename> {unit-index <unit-index> family-id <family-id> process-id
<process-id>}

2.12.15.4.9.1.1
Table396

hasprocess-familywarmingprocessunit-type<unit-type-name>

hasprocess-familywarmingprocessunit-type<unit-type-name>

Description
Thiscommandstartstowarmasingleprocessoftheprocessfamily.
Parameter

Hint

Range

Default

TheparameterspecifiesthefamilyIDindecimalorhex
format.

0x1..0xFFFE

NA

family-id

TheparameterspecifiestheprocessIDindecimalorhex
format.

0x0..0xFFFE

NA

process-id

Theparameterspecifiesthefunctionalunitindex,for
example,0.

unitindex,for
example,0

NA

unit-index
Command

Dependency
None

start has process-family warming process unit-type <unit-typename> {unit-index <unit-index> family-id <family-id> process-id
<process-id>}

2.12.15.4.10
Table397

has process-family warming statistics

hasprocess-familywarmingstatistics

Description
delete
Thiscommanddeletesallwarmingstatistics.
show

Issue:03B

315

SCLICommands

Table397

MulticontrollerRNCSCLICommands

hasprocess-familywarmingstatistics(Cont.)

Thiscommandshowswarmingstatisticsofaunit.
Parameter

Hint

Command

Range

Default

Dependency
None

delete has process-family warming statistics unit-type <unittype-name> {unit-index <unit-index>}


None
show has {[regex]? [filter <filter-value>]? [noerror]?}
process-family warming statistics unit-type <unit-type-name>
{unit-index <unit-index>}

2.12.15.4.10.1
Table398

has process-family warming statistics unit-type

hasprocess-familywarmingstatisticsunit-type

Description
delete
Thiscommanddeleteswarmingstatisticsforthespecifiedunittype.
show
Thiscommandshowswarmingstatisticsforthespecifiedunittype.
Parameter

Hint

Command

Range

Default

Dependency
None

delete has process-family warming statistics unit-type <unittype-name> {unit-index <unit-index>}


None
show has {[regex]? [filter <filter-value>]? [noerror]?}
process-family warming statistics unit-type <unit-type-name>
{unit-index <unit-index>}

2.12.15.4.10.1.
1
Table399

hasprocess-familywarmingstatisticsunit-type<unit-type-name>

hasprocess-familywarmingstatisticsunit-type<unit-type-name>

Description
delete
Thiscommanddeletesallwarmingstatisticsintheunit.

316

Issue:03B

MulticontrollerRNCSCLICommands

Table399

SCLICommands

hasprocess-familywarmingstatisticsunit-type<unit-type-name>(Cont.)

show
Thiscommandshowswarmingstatisticsoftheunit,including:
warmingstarttime,warmingtype,warmingprocessfamilyID,
warmingresult(errorcodeincaseofwarmingfailure),
warmingduration(inmicroseconds)andwarmingretrycount.
Parameter

Hint

Range

Default

Theparameterspecifiesthefunctionalunitindex,for
example,0.

unitindex,for
example,0

NA

unit-index
Command

Dependency
None

delete has process-family warming statistics unit-type <unittype-name> {unit-index <unit-index>}


None
show has {[regex]? [filter <filter-value>]? [noerror]?}
process-family warming statistics unit-type <unit-type-name>
{unit-index <unit-index>}

2.12.15.4.11
Table400

has process-family warming subscriptions

hasprocess-familywarmingsubscriptions

Description
Thiscommandshowsallwarmingsubscriptionsintheunit.
Parameter

Hint

Command

Range

Default

Dependency
None

show has {[regex]? [filter <filter-value>]? [noerror]?}


process-family warming subscriptions unit-type <unit-type-name>
{unit-index <unit-index>}

2.12.15.4.11.1
Table401

has process-family warming subscriptions unit-type

hasprocess-familywarmingsubscriptionsunit-type

Description
Thiscommandshowswarmingsubscriptionsforthespecifiedunittype.
Parameter

Issue:03B

Hint

Range

Default

317

SCLICommands

Table401

MulticontrollerRNCSCLICommands

hasprocess-familywarmingsubscriptionsunit-type(Cont.)

Command

Dependency
None

show has {[regex]? [filter <filter-value>]? [noerror]?}


process-family warming subscriptions unit-type <unit-type-name>
{unit-index <unit-index>}

2.12.15.4.11.1.
1
Table402

hasprocess-familywarmingsubscriptionsunit-type<unit-type-name>

hasprocess-familywarmingsubscriptionsunit-type<unit-type-name>

Description
Thiscommandshowsallsubscribedwarmingnotificationsintheunit,including
processfamilyIDandsubscribednotificationmessages.
Parameter

Hint

Range

Default

Theparameterspecifiesthefunctionalunitindex,for
example,0.

unitindex,for
example,0

NA

unit-index
Command

Dependency
None

show has {[regex]? [filter <filter-value>]? [noerror]?}


process-family warming subscriptions unit-type <unit-type-name>
{unit-index <unit-index>}

2.12.16 has reset-block


Table403

hasreset-block

Description
CommandsHAStopreventtheresettingofanodeinitiatedbyeitherHASitselforthewatchdogfortheprovidedtimeout
value.ThevalueOFFortimeoutvalue0willremovetheresetblock.TheSUFFIXmaybe's'forseconds,'m'forminutes,
'h'forhoursor'd'fordays.Capitalletterscanalsobeused.IfnoSUFFIXisgiven,thetimeoutvalueistreatedasseconds.
Theminimumvalueis1secondandthemaximumvalueis24hours.
Forexample:
sethasreset-blockoffmanaged-object/CLA-0
sethasreset-block300managed-object/CLA-0
Note:TheactualnamesoftheCLA(ClusterAdministrator)nodescanvaryindifferentproductapplications.Theterm"CLA
node"referstoanodethatcontainsthecentralizedclustermanagementandOAMfunctionalitiesinthesystem.
Parameter

318

Hint

Range

Default

Issue:03B

MulticontrollerRNCSCLICommands

Table403

SCLICommands

hasreset-block(Cont.)

Command

Dependency
None

set has {[regex]? [filter <filter-value>]? [noerror]?


[logerrors]?} reset-block <resetblock-value> managed-object
[<mo-name>]+
None
set has {[regex]? [filter <filter-value>]? [noerror]?
[logerrors]?} reset-block <resetblock-value> managed-objectfull-name [<mo-fullname>]+

2.12.16.1
Table404

has reset-block <resetblock-value>

hasreset-block<resetblock-value>

Description
Resetblockvaluecanbeeitherofforatimeoutvalueinfollowingformat:timeout-value[`s'|`m'|`h'|`d'|`S'|`M'|`H'|`D']
ValueOFFortimeout-value0willremovethereset-block.sforseconds,mforminutes,hforhoursanddfordays.Capital
letterscanalsobeused.Defaultisseconds.
Parameter

Hint

Command

Range

Default

Dependency
None

set has {[regex]? [filter <filter-value>]? [noerror]?


[logerrors]?} reset-block <resetblock-value> managed-object
[<mo-name>]+
None
set has {[regex]? [filter <filter-value>]? [noerror]?
[logerrors]?} reset-block <resetblock-value> managed-objectfull-name [<mo-fullname>]+

2.12.16.1.1
Table405

has reset-block <resetblock-value> managed-object

hasreset-block<resetblock-value>managed-object

Description
ThenameoftheMO.AnyoptioncanbeappliedtooneormoreMOs.Patternmatching'*'and'?'canbeusedinMO
namesandregularexpressionscanbeusedwithregexparametertomatchMOnames.NOTE!'?'mustbeusedwithin
quotationmarks(""),seeexamplebelow.
NotethatasubtypeofMOs-proxiedcomponent-isnotaddressablebythenormal"managed-object"syntax.Please
selectmanaged-object-full-namewhenreferringtothem.
TouseDNasapartofMOname,pleaseusetheoptionmanaged-object-full-name.

Issue:03B

319

SCLICommands

Table405

MulticontrollerRNCSCLICommands

hasreset-block<resetblock-value>managed-object(Cont.)

MOnameisaHASMOname.Forexample:
/ExampleHARG
"/?xampleHARG"
Parameter

Hint

Command

Range

Default

Dependency
None

set has {[regex]? [filter <filter-value>]? [noerror]?


[logerrors]?} reset-block <resetblock-value> managed-object
[<mo-name>]+

2.12.16.1.1.1
Table406

has reset-block <resetblock-value> managed-object <mo-name>

hasreset-block<resetblock-value>managed-object<mo-name>

Description
ThenameoftheMO.AnyoptioncanbeappliedtooneormoreMOs.Patternmatching'*'and'?'canbeusedinMO
namesandregularexpressionscanbeusedwithregexparametertomatchMOnames.NOTE!'?'mustbeusedwithin
quotationmarks(""),seeexamplebelow.
NotethatasubtypeofMOs-proxiedcomponent-isnotaddressablebythenormal"managed-object"syntax.Please
selectmanaged-object-full-namewhenreferringtothem.
TouseDNasapartofMOname,pleaseusetheoptionmanaged-object-full-name.
MOnameisaHASMOname.Forexample:
/ExampleHARG
"/?xampleHARG"
Parameter

Hint

Command

Range

Default

Dependency
None

set has {[regex]? [filter <filter-value>]? [noerror]?


[logerrors]?} reset-block <resetblock-value> managed-object
[<mo-name>]+

2.12.16.1.2
Table407

has reset-block <resetblock-value> managed-object-full-name

hasreset-block<resetblock-value>managed-object-full-name

Description
ThenameoftheMOindistinguishedname(DN)format.TouseslashseparatedMOname,pleaseusetheoption
managed-object.
Forexample:

320

Issue:03B

MulticontrollerRNCSCLICommands

Table407

SCLICommands

hasreset-block<resetblock-value>managed-object-full-name(Cont.)

fshaRecoveryGroupName=ExampleHARG,fsFragmentId=RecoveryGroups,fsFragmentId=HA,fsClusterId=ClusterRoot
Orinareverseorder:
fsClusterId=ClusterRoot,fsFragmentId=HA,fsFragmentId=RecoveryGroups,fshaRecoveryGroupName=ExampleHARG
Onlythelatternameformatsupportsautocompletionwith[TAB]key.
Parameter

Hint

Command

Range

Default

Dependency
None

set has {[regex]? [filter <filter-value>]? [noerror]?


[logerrors]?} reset-block <resetblock-value> managed-objectfull-name [<mo-fullname>]+

2.12.16.1.2.1
Table408

has reset-block <resetblock-value> managed-object-full-name <mo-fullname>

hasreset-block<resetblock-value>managed-object-full-name<mofullname>

Description
ThenameoftheMOindistinguishedname(DN)format.TouseslashseparatedMOname,pleaseusetheoption
managed-object.
Forexample:
fshaRecoveryGroupName=ExampleHARG,fsFragmentId=RecoveryGroups,fsFragmentId=HA,fsClusterId=ClusterRoot
Orinareverseorder:
fsClusterId=ClusterRoot,fsFragmentId=HA,fsFragmentId=RecoveryGroups,fshaRecoveryGroupName=ExampleHARG
Onlythelatternameformatsupportsautocompletionwith[TAB]key.
Parameter

Hint

Command

Range

Default

Dependency
None

set has {[regex]? [filter <filter-value>]? [noerror]?


[logerrors]?} reset-block <resetblock-value> managed-objectfull-name [<mo-fullname>]+

2.12.17 has restart


Table409

hasrestart

Description
RestartanMOoralogicalgroup.IftheMOiscurrentlyoperationalitisterminatedandthenrestarted.IfanRUora
processtypeofMOisdisabled,therestartoperationenablesitandtheMOisstartedifitsroleisACTIVE.Forexample:

Issue:03B

321

SCLICommands

Table409

MulticontrollerRNCSCLICommands

hasrestart(Cont.)

sethasrestartmanaged-object/TA-A/ExampleHARU-A
Parameter

config-check

Hint

Range

Theparameter"config-check"definesthebehaviorwhenthe unsavedconfiguration
targetobjectiscluster(/)oraclustermanagementnode,
check(default:checkandtheclustercurrentconfigurationisnotsavedasthe
and-stop)
startupconfiguration.Thefollowingvaluescanbegivento
theparameter:

Default
checkand-stop

no-check:Commanddoesn'tchecktheconfiguration.Any
unsavedconfigurationchangesarediscarded.
check-and-stop:Commandcheckstheconfiguration.Ifthe
currentconfigurationisnotsavedasthestartup
configuration,thenthecommandrejectstherequested
operationandinformstheuser.
ForceacriticalMOtoperformtheoperation.
force

raise-alarm

ForceacriticalMOto
performtheoperation

Raisealarmyes|nowhenintentionallyrestartinganMOora Raisealarmyes|no.
logicalgroup.NOTE!Thisoptionhasnoeffectwhen
restartingcluster.Thealarmisneededtocancelotheractive
alarmswhentheclusterrestarts.

NA

yes

Followingexampledoesnotwritealarmtoalarmslogabout
therestartoftheMO:
sethasrestartraise-alarmnomanaged-object/TAA/ExampleHARU-A
Command

Dependency
None

set has {[regex]? [filter <filter-value>]? [noerror]?


[logerrors]?} restart {[raise-alarm <raise-alarm-value>]?
[force]? [config-check <config-check>]?} logical-group
[<logical-group-name>]+
None
set has {[regex]? [filter <filter-value>]? [noerror]?
[logerrors]?} restart {[raise-alarm <raise-alarm-value>]?
[force]? [config-check <config-check>]?} managed-object [<moname>]+
None
set has {[regex]? [filter <filter-value>]? [noerror]?
[logerrors]?} restart {[raise-alarm <raise-alarm-value>]?
[force]? [config-check <config-check>]?} managed-object-fullname [<mo-fullname>]+

322

Issue:03B

MulticontrollerRNCSCLICommands

2.12.17.1
Table410

SCLICommands

has restart logical-group

hasrestartlogical-group

Description
Thenameofthelogicalgroup.
Patternmatching'*'and'?'canbeusedinlogicalgroupnames.NOTE!'?'mustbeusedwithinquotationmarks(""),see
examplebelow.
Forexample:
ExampleLogicalGroup
"LogicalGroup??"
Parameter

Hint

Command

Range

Default

Dependency
None

set has {[regex]? [filter <filter-value>]? [noerror]?


[logerrors]?} restart {[raise-alarm <raise-alarm-value>]?
[force]? [config-check <config-check>]?} logical-group
[<logical-group-name>]+

2.12.17.1.1
Table411

has restart logical-group <logical-group-name>

hasrestartlogical-group<logical-group-name>

Description
Thenameofthelogicalgroup.
Patternmatching'*'and'?'canbeusedinlogicalgroupnames.NOTE!'?'mustbeusedwithinquotationmarks(""),see
examplebelow.
Forexample:
ExampleLogicalGroup
"LogicalGroup??"
Parameter

Hint

Command

Range

Default

Dependency
None

set has {[regex]? [filter <filter-value>]? [noerror]?


[logerrors]?} restart {[raise-alarm <raise-alarm-value>]?
[force]? [config-check <config-check>]?} logical-group
[<logical-group-name>]+

Issue:03B

323

SCLICommands

2.12.17.2
Table412

MulticontrollerRNCSCLICommands

has restart managed-object

hasrestartmanaged-object

Description
ThenameoftheMO.AnyoptioncanbeappliedtooneormoreMOs.Patternmatching'*'and'?'canbeusedinMO
namesandregularexpressionscanbeusedwithregexparametertomatchMOnames.NOTE!'?'mustbeusedwithin
quotationmarks(""),seeexamplebelow.
NotethatasubtypeofMOs-proxiedcomponent-isnotaddressablebythenormal"managed-object"syntax.Please
selectmanaged-object-full-namewhenreferringtothem.
TouseDNasapartofMOname,pleaseusetheoptionmanaged-object-full-name.
MOnameisaHASMOname.Forexample:
/ExampleHARG
"/?xampleHARG"
Parameter

Hint

Command

Range

Default

Dependency
None

set has {[regex]? [filter <filter-value>]? [noerror]?


[logerrors]?} restart {[raise-alarm <raise-alarm-value>]?
[force]? [config-check <config-check>]?} managed-object [<moname>]+

2.12.17.2.1
Table413

has restart managed-object <mo-name>

hasrestartmanaged-object<mo-name>

Description
ThenameoftheMO.AnyoptioncanbeappliedtooneormoreMOs.Patternmatching'*'and'?'canbeusedinMO
namesandregularexpressionscanbeusedwithregexparametertomatchMOnames.NOTE!'?'mustbeusedwithin
quotationmarks(""),seeexamplebelow.
NotethatasubtypeofMOs-proxiedcomponent-isnotaddressablebythenormal"managed-object"syntax.Please
selectmanaged-object-full-namewhenreferringtothem.
TouseDNasapartofMOname,pleaseusetheoptionmanaged-object-full-name.
MOnameisaHASMOname.Forexample:
/ExampleHARG
"/?xampleHARG"
Parameter

Hint

Command

Range

Default

Dependency
None

set has {[regex]? [filter <filter-value>]? [noerror]?


[logerrors]?} restart {[raise-alarm <raise-alarm-value>]?
[force]? [config-check <config-check>]?} managed-object [<mo-

324

Issue:03B

MulticontrollerRNCSCLICommands

Table413

SCLICommands

hasrestartmanaged-object<mo-name>(Cont.)

name>]+

2.12.17.3
Table414

has restart managed-object-full-name

hasrestartmanaged-object-full-name

Description
ThenameoftheMOindistinguishedname(DN)format.TouseslashseparatedMOname,pleaseusetheoption
managed-object.
Forexample:
fshaRecoveryGroupName=ExampleHARG,fsFragmentId=RecoveryGroups,fsFragmentId=HA,fsClusterId=ClusterRoot
Orinareverseorder:
fsClusterId=ClusterRoot,fsFragmentId=HA,fsFragmentId=RecoveryGroups,fshaRecoveryGroupName=ExampleHARG
Onlythelatternameformatsupportsautocompletionwith[TAB]key.
Parameter

Hint

Command

Range

Default

Dependency
None

set has {[regex]? [filter <filter-value>]? [noerror]?


[logerrors]?} restart {[raise-alarm <raise-alarm-value>]?
[force]? [config-check <config-check>]?} managed-object-fullname [<mo-fullname>]+

2.12.17.3.1
Table415

has restart managed-object-full-name <mo-fullname>

hasrestartmanaged-object-full-name<mo-fullname>

Description
ThenameoftheMOindistinguishedname(DN)format.TouseslashseparatedMOname,pleaseusetheoption
managed-object.
Forexample:
fshaRecoveryGroupName=ExampleHARG,fsFragmentId=RecoveryGroups,fsFragmentId=HA,fsClusterId=ClusterRoot
Orinareverseorder:
fsClusterId=ClusterRoot,fsFragmentId=HA,fsFragmentId=RecoveryGroups,fshaRecoveryGroupName=ExampleHARG
Onlythelatternameformatsupportsautocompletionwith[TAB]key.
Parameter

Hint

Command

Range

Default

Dependency
None

set has {[regex]? [filter <filter-value>]? [noerror]?


[logerrors]?} restart {[raise-alarm <raise-alarm-value>]?

Issue:03B

325

SCLICommands

Table415

MulticontrollerRNCSCLICommands

hasrestartmanaged-object-full-name<mo-fullname>(Cont.)

[force]? [config-check <config-check>]?} managed-object-fullname [<mo-fullname>]+

2.12.18 has shutdown


Table416

hasshutdown

Description
ThiscommandgracefullyshutsdownanMOoralogicalgroup.TheMOcanbethecluster,anode,anRG,oranRU.The
commandwaitsuntiltheMOshutsitselfdown.Ifatimeoutvalueisgivenandtheshutdownoperationdoesnotfinish
beforethetimeoutexpires,theMOislocked.
Pleasenotethatifthetimeoutoptionisnotused,thecommandexecutionmaytakealongtime.Ifthecommandexecution
hangsfortensofseconds,pleasepress"CTRL-C"tointerruptthecommandexecution.
Forexample:
sethasshutdowntimeout10managed-object/TA-A/ExampleHARU-A
Parameter

Hint

Range

Default

ForceacriticalMOtoperformtheoperation.

ForceacriticalMOto
performtheoperation

NA

Thecommandwillreturnimmediatelyafterinitiationwithout
checkingtheoperationresult.

Don'twaitforan
operationtobe
completed

NA

Thisparameterspecifiesthetimeoutforthecommand.The
SUFFIXmaybe's'forseconds,'m'forminutes,'h'forhours
or'd'fordays.Capitalletterscanbeused.IfnoSUFFIXis
given,theTIMEOUTistreatedasseconds.Theminimum
valueis1secondandthemaximumvalueis68years
(=0x7FFFFFFE).Nowarningisdisplayedwiththis
parameter.

Timeout

NA

force

noblock

timeout

Command

Dependency
None

set has {[regex]? [filter <filter-value>]? [noerror]?


[logerrors]?} shutdown {[noblock]? [force]? [timeout <timeoutvalue>]?} logical-group [<logical-group-name>]+
None
set has {[regex]? [filter <filter-value>]? [noerror]?
[logerrors]?} shutdown {[noblock]? [force]? [timeout <timeoutvalue>]?} managed-object [<mo-name>]+
None
set has {[regex]? [filter <filter-value>]? [noerror]?
[logerrors]?} shutdown {[noblock]? [force]? [timeout <timeout-

326

Issue:03B

MulticontrollerRNCSCLICommands

Table416

SCLICommands

hasshutdown(Cont.)

value>]?} managed-object-full-name [<mo-fullname>]+

2.12.18.1
Table417

has shutdown logical-group

hasshutdownlogical-group

Description
Thenameofthelogicalgroup.
Patternmatching'*'and'?'canbeusedinlogicalgroupnames.NOTE!'?'mustbeusedwithinquotationmarks(""),see
examplebelow.
Forexample:
ExampleLogicalGroup
"LogicalGroup??"
Parameter

Hint

Command

Range

Default

Dependency
None

set has {[regex]? [filter <filter-value>]? [noerror]?


[logerrors]?} shutdown {[noblock]? [force]? [timeout <timeoutvalue>]?} logical-group [<logical-group-name>]+

2.12.18.1.1
Table418

has shutdown logical-group <logical-group-name>

hasshutdownlogical-group<logical-group-name>

Description
Thenameofthelogicalgroup.
Patternmatching'*'and'?'canbeusedinlogicalgroupnames.NOTE!'?'mustbeusedwithinquotationmarks(""),see
examplebelow.
Forexample:
ExampleLogicalGroup
"LogicalGroup??"
Parameter

Hint

Command

Range

Default

Dependency
None

set has {[regex]? [filter <filter-value>]? [noerror]?


[logerrors]?} shutdown {[noblock]? [force]? [timeout <timeoutvalue>]?} logical-group [<logical-group-name>]+

Issue:03B

327

SCLICommands

2.12.18.2
Table419

MulticontrollerRNCSCLICommands

has shutdown managed-object

hasshutdownmanaged-object

Description
ThenameoftheMO.AnyoptioncanbeappliedtooneormoreMOs.Patternmatching'*'and'?'canbeusedinMO
namesandregularexpressionscanbeusedwithregexparametertomatchMOnames.NOTE!'?'mustbeusedwithin
quotationmarks(""),seeexamplebelow.
NotethatasubtypeofMOs-proxiedcomponent-isnotaddressablebythenormal"managed-object"syntax.Please
selectmanaged-object-full-namewhenreferringtothem.
TouseDNasapartofMOname,pleaseusetheoptionmanaged-object-full-name.
MOnameisaHASMOname.Forexample:
/ExampleHARG
"/?xampleHARG"
Parameter

Hint

Command

Range

Default

Dependency
None

set has {[regex]? [filter <filter-value>]? [noerror]?


[logerrors]?} shutdown {[noblock]? [force]? [timeout <timeoutvalue>]?} managed-object [<mo-name>]+

2.12.18.2.1
Table420

has shutdown managed-object <mo-name>

hasshutdownmanaged-object<mo-name>

Description
ThenameoftheMO.AnyoptioncanbeappliedtooneormoreMOs.Patternmatching'*'and'?'canbeusedinMO
namesandregularexpressionscanbeusedwithregexparametertomatchMOnames.NOTE!'?'mustbeusedwithin
quotationmarks(""),seeexamplebelow.
NotethatasubtypeofMOs-proxiedcomponent-isnotaddressablebythenormal"managed-object"syntax.Please
selectmanaged-object-full-namewhenreferringtothem.
TouseDNasapartofMOname,pleaseusetheoptionmanaged-object-full-name.
MOnameisaHASMOname.Forexample:
/ExampleHARG
"/?xampleHARG"
Parameter

Hint

Command

Range

Default

Dependency
None

set has {[regex]? [filter <filter-value>]? [noerror]?


[logerrors]?} shutdown {[noblock]? [force]? [timeout <timeoutvalue>]?} managed-object [<mo-name>]+

328

Issue:03B

MulticontrollerRNCSCLICommands

2.12.18.3
Table421

SCLICommands

has shutdown managed-object-full-name

hasshutdownmanaged-object-full-name

Description
ThenameoftheMOindistinguishedname(DN)format.TouseslashseparatedMOname,pleaseusetheoption
managed-object.
Forexample:
fshaRecoveryGroupName=ExampleHARG,fsFragmentId=RecoveryGroups,fsFragmentId=HA,fsClusterId=ClusterRoot
Orinareverseorder:
fsClusterId=ClusterRoot,fsFragmentId=HA,fsFragmentId=RecoveryGroups,fshaRecoveryGroupName=ExampleHARG
Onlythelatternameformatsupportsautocompletionwith[TAB]key.
Parameter

Hint

Command

Range

Default

Dependency
None

set has {[regex]? [filter <filter-value>]? [noerror]?


[logerrors]?} shutdown {[noblock]? [force]? [timeout <timeoutvalue>]?} managed-object-full-name [<mo-fullname>]+

2.12.18.3.1
Table422

has shutdown managed-object-full-name <mo-fullname>

hasshutdownmanaged-object-full-name<mo-fullname>

Description
ThenameoftheMOindistinguishedname(DN)format.TouseslashseparatedMOname,pleaseusetheoption
managed-object.
Forexample:
fshaRecoveryGroupName=ExampleHARG,fsFragmentId=RecoveryGroups,fsFragmentId=HA,fsClusterId=ClusterRoot
Orinareverseorder:
fsClusterId=ClusterRoot,fsFragmentId=HA,fsFragmentId=RecoveryGroups,fshaRecoveryGroupName=ExampleHARG
Onlythelatternameformatsupportsautocompletionwith[TAB]key.
Parameter

Hint

Command

Range

Default

Dependency
None

set has {[regex]? [filter <filter-value>]? [noerror]?


[logerrors]?} shutdown {[noblock]? [force]? [timeout <timeoutvalue>]?} managed-object-full-name [<mo-fullname>]+

Issue:03B

329

SCLICommands

MulticontrollerRNCSCLICommands

2.12.19 has state


Table423

hasstate

Description
Querystate,statusanddynamicattributesofanMOoralogicalgroup.Ifalogicalgroupisgiven,stateofitsRGsandRUs
isprinted.
Forexample:
showhasstatemanaged-object/TA-A
Queryallthestatesandthestatusof/TA-A.
showhasstateadministrativemanaged-object/TA-A
Querytheadministrativestateof/TA-A.
showhasstateoperationalavailabilityproceduralmanaged-object/TA-A
Querytheoperationalstateandtheavailabilityandproceduralstatusof/TA-A.
Parameter

Hint

Range

Default

Querytheadministrativestate.Thepossiblevalueisoneof
thefollowing:LOCKED,SHUTTINGDOWNorUNLOCKED.

Querythe
administrativestate

NA

administrative

Querythealarmstatus.Thepossiblevalueiseitherempty
oroneofthefollowing:CRITICAL,MAJOR,MINORor
OUTSTANDING.Ifnoneofthevaluesabovearereturned,
theattributeisemptyand

Querythealarmstatus NA

alarm

()
willbeshowntotheuser.

availability

Querytheavailabilitystatus.Thepossiblevalueisemptyor Querytheavailability
oneormoreofthefollowing:INTEST,FAILED,POWEROFF, status
OFFLINE,OFFDUTY,DEPENDENCY,DEGRADED,
NOTINSTALLEDorLOGFULL.Ifnoneofthevaluesabove
arereturned,theattributeisemptyand

NA

()
willbeshowntotheuser.
Querydynamicattributes.

Querydynamic
attributes

NA

Querydynamicattributes.Includeshiddenattributes
beginningwith".".

Querydynamicand
hiddendynamic
attributes

NA

Thisparameterdefinesthestateoutputformat.

Formatofthestate
output

auto-wrap

dynamic

dynamic-hidden

format

330

When"auto-wrap"(default)isselected,longlineswrapand
cantakemultiplelinesonthescreen.When"fit-to-screen"is
selected,longlinesaretruncatedandsomeinformationis
lost,buttheoutputfitsonasinglelineonthescreen.Lines
thathavebeentruncatedareterminatedbyanellipsismark
(...).

Issue:03B

MulticontrollerRNCSCLICommands

Table423

SCLICommands

hasstate(Cont.)
Noticethatthesmallestsupportedscreenwidthis80
characters.

operational

procedural

Querytheoperationalstate.Thepossiblevalueisoneofthe Querytheoperational
following:DISABLEDorENABLED.
state

NA

Querytheproceduralstatus.Thepossiblevalueiseither
emptyoroneofthefollowing:INITIALIZATIONREQUIRED,
NOTINITIALIZED,INITIALIZING,REPORTINGor
TERMINATING.Ifnoneofthevaluesabovearereturned,
theattributeisEMPTYand

NA

Querytheprocedural
status

()
willbeshowntotheuser.

role

QuerytheroleofanRUorRG.Thepossiblevalueiseither Querytheroleofan
emptyoroneoffollowing:ACTIVE,HOTSTANDBY,
RUorRG
COLDSTANDBYandNONE.Ifnoneofthevaluesaboveare
returned,theattributeisemptyand

NA

()
willbeshowntotheuser.
Querytheunknownstatus.ThepossiblevalueisTRUEor
FALSE.

Querytheunknown
status

NA

unknown

Querytheusagestate.Thepossiblevalueisoneofthe
following:IDLE,ACTIVEorBUSY.

Querytheusagestate

NA

usage
Command

Dependency
None

show has {[regex]? [filter <filter-value>]? [noerror]?} state


{[administrative]? [operational]? [usage]? [procedural]?
[availability]? [unknown]? [alarm]? [role]? [dynamic]?
[dynamic-hidden]? [format <format-value>]?} logical-group
[<logical-group-name>]+
None
show has {[regex]? [filter <filter-value>]? [noerror]?} state
{[administrative]? [operational]? [usage]? [procedural]?
[availability]? [unknown]? [alarm]? [role]? [dynamic]?
[dynamic-hidden]? [format <format-value>]?} managed-object
[<mo-name>]+
None
show has {[regex]? [filter <filter-value>]? [noerror]?} state
{[administrative]? [operational]? [usage]? [procedural]?
[availability]? [unknown]? [alarm]? [role]? [dynamic]?
[dynamic-hidden]? [format <format-value>]?} managed-objectfull-name [<mo-fullname>]+

Issue:03B

331

SCLICommands

2.12.19.1
Table424

MulticontrollerRNCSCLICommands

has state logical-group

hasstatelogical-group

Description
Thenameofthelogicalgroup.
Patternmatching'*'and'?'canbeusedinlogicalgroupnames.NOTE!'?'mustbeusedwithinquotationmarks(""),see
examplebelow.
Forexample:
ExampleLogicalGroup
"LogicalGroup??"
Parameter

Hint

Command

Range

Default

Dependency
None

show has {[regex]? [filter <filter-value>]? [noerror]?} state


{[administrative]? [operational]? [usage]? [procedural]?
[availability]? [unknown]? [alarm]? [role]? [dynamic]?
[dynamic-hidden]? [format <format-value>]?} logical-group
[<logical-group-name>]+

2.12.19.1.1
Table425

has state logical-group <logical-group-name>

hasstatelogical-group<logical-group-name>

Description
Thenameofthelogicalgroup.
Patternmatching'*'and'?'canbeusedinlogicalgroupnames.NOTE!'?'mustbeusedwithinquotationmarks(""),see
examplebelow.
Forexample:
ExampleLogicalGroup
"LogicalGroup??"
Parameter

Hint

Command

Range

Default

Dependency
None

show has {[regex]? [filter <filter-value>]? [noerror]?} state


{[administrative]? [operational]? [usage]? [procedural]?
[availability]? [unknown]? [alarm]? [role]? [dynamic]?
[dynamic-hidden]? [format <format-value>]?} logical-group
[<logical-group-name>]+

332

Issue:03B

MulticontrollerRNCSCLICommands

2.12.19.2
Table426

SCLICommands

has state managed-object

hasstatemanaged-object

Description
ThenameoftheMO.AnyoptioncanbeappliedtooneormoreMOs.Patternmatching'*'and'?'canbeusedinMO
namesandregularexpressionscanbeusedwithregexparametertomatchMOnames.NOTE!'?'mustbeusedwithin
quotationmarks(""),seeexamplebelow.
NotethatasubtypeofMOs-proxiedcomponent-isnotaddressablebythenormal"managed-object"syntax.Please
selectmanaged-object-full-namewhenreferringtothem.
TouseDNasapartofMOname,pleaseusetheoptionmanaged-object-full-name.
MOnameisaHASMOname.Forexample:
/ExampleHARG
"/?xampleHARG"
Parameter

Hint

Command

Range

Default

Dependency
None

show has {[regex]? [filter <filter-value>]? [noerror]?} state


{[administrative]? [operational]? [usage]? [procedural]?
[availability]? [unknown]? [alarm]? [role]? [dynamic]?
[dynamic-hidden]? [format <format-value>]?} managed-object
[<mo-name>]+

2.12.19.2.1
Table427

has state managed-object <mo-name>

hasstatemanaged-object<mo-name>

Description
ThenameoftheMO.AnyoptioncanbeappliedtooneormoreMOs.Patternmatching'*'and'?'canbeusedinMO
namesandregularexpressionscanbeusedwithregexparametertomatchMOnames.NOTE!'?'mustbeusedwithin
quotationmarks(""),seeexamplebelow.
NotethatasubtypeofMOs-proxiedcomponent-isnotaddressablebythenormal"managed-object"syntax.Please
selectmanaged-object-full-namewhenreferringtothem.
TouseDNasapartofMOname,pleaseusetheoptionmanaged-object-full-name.
MOnameisaHASMOname.Forexample:
/ExampleHARG
"/?xampleHARG"
Parameter

Hint

Command

Range

Default

Dependency
None

show has {[regex]? [filter <filter-value>]? [noerror]?} state


{[administrative]? [operational]? [usage]? [procedural]?

Issue:03B

333

SCLICommands

Table427

MulticontrollerRNCSCLICommands

hasstatemanaged-object<mo-name>(Cont.)

[availability]? [unknown]? [alarm]? [role]? [dynamic]?


[dynamic-hidden]? [format <format-value>]?} managed-object
[<mo-name>]+

2.12.19.3
Table428

has state managed-object-full-name

hasstatemanaged-object-full-name

Description
ThenameoftheMOindistinguishedname(DN)format.TouseslashseparatedMOname,pleaseusetheoption
managed-object.
Forexample:
fshaRecoveryGroupName=ExampleHARG,fsFragmentId=RecoveryGroups,fsFragmentId=HA,fsClusterId=ClusterRoot
Orinareverseorder:
fsClusterId=ClusterRoot,fsFragmentId=HA,fsFragmentId=RecoveryGroups,fshaRecoveryGroupName=ExampleHARG
Onlythelatternameformatsupportsautocompletionwith[TAB]key.
Parameter

Hint

Command

Range

Default

Dependency
None

show has {[regex]? [filter <filter-value>]? [noerror]?} state


{[administrative]? [operational]? [usage]? [procedural]?
[availability]? [unknown]? [alarm]? [role]? [dynamic]?
[dynamic-hidden]? [format <format-value>]?} managed-objectfull-name [<mo-fullname>]+

2.12.19.3.1
Table429

has state managed-object-full-name <mo-fullname>

hasstatemanaged-object-full-name<mo-fullname>

Description
ThenameoftheMOindistinguishedname(DN)format.TouseslashseparatedMOname,pleaseusetheoption
managed-object.
Forexample:
fshaRecoveryGroupName=ExampleHARG,fsFragmentId=RecoveryGroups,fsFragmentId=HA,fsClusterId=ClusterRoot
Orinareverseorder:
fsClusterId=ClusterRoot,fsFragmentId=HA,fsFragmentId=RecoveryGroups,fshaRecoveryGroupName=ExampleHARG
Onlythelatternameformatsupportsautocompletionwith[TAB]key.
Parameter

334

Hint

Range

Default

Issue:03B

MulticontrollerRNCSCLICommands

Table429

SCLICommands

hasstatemanaged-object-full-name<mo-fullname>(Cont.)

Command

Dependency
None

show has {[regex]? [filter <filter-value>]? [noerror]?} state


{[administrative]? [operational]? [usage]? [procedural]?
[availability]? [unknown]? [alarm]? [role]? [dynamic]?
[dynamic-hidden]? [format <format-value>]?} managed-objectfull-name [<mo-fullname>]+

2.12.20 has summary


Table430

hassummary

Description
Thiscommandshowsthesummaryofamanaged-object(MO).
Theheaderlinesgrouptheoutputintonode,recoverygroup(RG),recoveryunit
(RU)andprocessstatusesifthegivenmanagedobjectisacluster.IftheMO
isanodeoranRG,thentheoutputhasonlyanRUstatusandaprocessstatus.
Innormalsteadysituation,onlyfewlinesareshowneverytime,whileother
linesareshowndynamicallywhennecessary.Thefollowingexplainsthelines
whichcanbeshown:
1.NODESTATUS
1.1Nodesinconfiguration
ThisshowsthenumberofHighAvailabilityServices(HAS)managednodesinthe
configurationdata.Thisnumberdoesnotincludetheso-calledunmanagednodes
andunsupervisednodeswhicharenotmanagedbyHighAvailability(HA)
services.Thenumbershownhereischangedonlywhentheconfigurationdatain
theconfigurationdirectorychanges.Physicalremovalofanodedoesnotchange
thenumber.
1.2Unlockednodes
Thisshowsthenumberofunlockednodes.
1.3Missingnodes
Thisshowsthenumberofmissingnodesandtheirnames.Thenodeslistedhere
haveneverstartedupsuccessfullysincethetimetheclusterwasinitially
commissioned.Thiscanbeanormalcaseiftheclusterissetuptousethe
so-calledmaximumconfiguration.Missingnodeshaveadynamicattribute
"HW_STATUS=MISSING"set.Thisnumberisstrictlybasedonthefunctional
observationmadebyHAS,anddoesnotnecessarilycorrelatewiththe
informationshownbyHardware(HW)managementsystem.Forexample,abroken

Issue:03B

335

SCLICommands

Table430

MulticontrollerRNCSCLICommands

hassummary(Cont.)

nodeiscalculatedaspresentevenifaboardhasactuallybeenremoved.This
numberismaintainedbecausesomeHWenvironmentsdonothaveautomaticHW
inventory.Also,HWinventoryoperationcanbeveryslowandthereforetheHW
inventorymightnotbeavailableimmediatelyaftertheclusterstartup.
1.4Non-operationalnodes
Thisshowsthenumberofnon-operationalnodesandtheirnames.Nodesthatare
powereddown,currentlyrebooting,orarefaultyareconsideredtobe
non-operational.
1.5Lockednodes
Thisshowsthenumberoflockednodesandtheirnames.
1.6Nodesininitializingstate
Thisshowsthenumberofnodes,andtheirnames,thatareinitializing.
Nodesherearelistedwiththeircurrentstartuplevels,configuredmaximum
startuplevels,andlastreportedreasontexts.Anodeisininitializing
stateifithasunlockedRUs,whichcanbestarted,butarenotyetrunning.
Anodeisalsoconsideredinitializingifitissynchronizingits
DistributedReplicatedBlockDevice(DRBD)disks.
Thevaluefor"lastreportedreason"canbeoneofthefollowing:
a.<RU>startupdelayed;Somerequiredserviceisnotyetup.
NORMAL:ThesystemiswaitingforsomerequireddependencyRUtostartup.
b.<RU>FAULTY(waitingrepair)
ERROR:ThenamedRUhasfailed.
c.<RU>FAULTY(blockingnodestartup)
ERROR:ThenamedRUhasfailedandispreventingstartupofRUs
onhigherstartuplevels.
d.<RU>initializing
NORMAL:ThesystemiswaitingfortheRUtostartup.
e.<RU>waitingstartuprequest
NORMAL:TheRGhasnotyetissuedastartuprequestfortheRU.
f.<RU>waitingstartupslot
NORMAL:MaximumnumberofparallelRUstartupactionsisongoing.
RUwillbestartedaftertheongoingoperationsarecompleted.
1.7Terminating/stoppingnodes
Thisshowsthenumberofnodes,andtheirnames,thatareterminatingservices.
Nodesherearelistedwiththeircurrentstartuplevelsandconfiguredmaximum
startuplevels.

336

Issue:03B

MulticontrollerRNCSCLICommands

Table430

SCLICommands

hassummary(Cont.)

1.8Nodesintestmode
Thisshowsthenumberofnodes,andtheirnames,theoperatorhassettotest
mode.
1.9Nodesininertmode
Thisshowsthenumberofnodes,andtheirnames,theoperatorhassettoinert
mode.
1.10Nodesinderivedinertmode
Thisshowsthenumberofnodes,andtheirnames,inderivedinertmode.
SettinganRUintoinertmodecausesthenodetobeinderivedinertmode.
2.RECOVERYGROUPSTATUS
2.1RGsinconfiguration
ThisshowsthenumberofRGsintheconfigurationdata.
2.2UnlockedRGs
ThisshowsthenumberofunlockedRGs.
2.3DegradedRGs
ThisshowsthenumberofdegradedRGsandtheirnames.Inthisview,theRGis
considereddegradedifallRUsoftheRG,whichcanbestarted,arenotrunning
(forexample,becauseanodeisrebootingordown).NoredundancyRGsare
consideredtoprovidenodelocalservices,andthereforearenotshownunless
theRGhasRUsthatarefaulty.
3.RECOVERYUNITSTATUS
3.1RUsinconfiguration
ThisshowsthenumberofRUsintheconfigurationdata.
3.2UnlockedRUs
ThisshowsthenumberofunlockedRUs.
3.3Non-operationalRUs
Thisshowsthenumberofnon-operational(notrunning)RUsandtheirnames.
3.4Terminating/stoppingRUs
ThisshowsthenumberofRUs,andtheirnames,thatareterminatingorbeing
terminated.
3.5RUskeepingnodesininitializingstate
ThisshowsthenumberofRUs,andtheirnames,thatarekeepingnodesin
initializingstate,thatis,preventingthenodestoproceedinstartup.
3.6RUsininertmode
ThisshowsthenumberofRUs,andtheirnames,theoperatorhassettoinert
mode.

Issue:03B

337

SCLICommands

Table430

MulticontrollerRNCSCLICommands

hassummary(Cont.)

4.PROCESSSTATUS
4.1Processesinconfiguration
Thisshowsthenumberofprocessesintheconfigurationdata.
4.2Unlockedprocesses
Thisshowsthenumberofunlockedprocesses.
4.3Non-operationalprocesses
Thisshowsthenumberofnon-operationalprocessesandtheirnames.
Parameter

Hint

Command

Range

Default

Dependency
None

show has {[regex]? [filter <filter-value>]? [noerror]?} summary


None
show has {[regex]? [filter <filter-value>]? [noerror]?} summary
managed-object [<mo-name>]+
None
show has {[regex]? [filter <filter-value>]? [noerror]?} summary
managed-object-full-name [<mo-fullname>]+

2.12.20.1
Table431

has summary managed-object

hassummarymanaged-object

Description
ThenameoftheMO.AnyoptioncanbeappliedtooneormoreMOs.Patternmatching'*'and'?'canbeusedinMO
namesandregularexpressionscanbeusedwithregexparametertomatchMOnames.NOTE!'?'mustbeusedwithin
quotationmarks(""),seeexamplebelow.
NotethatasubtypeofMOs-proxiedcomponent-isnotaddressablebythenormal"managed-object"syntax.Please
selectmanaged-object-full-namewhenreferringtothem.
TouseDNasapartofMOname,pleaseusetheoptionmanaged-object-full-name.
MOnameisaHASMOname.Forexample:
/ExampleHARG
"/?xampleHARG"
Parameter

Hint

Command

Range

Default

Dependency
None

show has {[regex]? [filter <filter-value>]? [noerror]?} summary

338

Issue:03B

MulticontrollerRNCSCLICommands

Table431

SCLICommands

hassummarymanaged-object(Cont.)

managed-object [<mo-name>]+

2.12.20.1.1
Table432

has summary managed-object <mo-name>

hassummarymanaged-object<mo-name>

Description
ThenameoftheMO.AnyoptioncanbeappliedtooneormoreMOs.Patternmatching'*'and'?'canbeusedinMO
namesandregularexpressionscanbeusedwithregexparametertomatchMOnames.NOTE!'?'mustbeusedwithin
quotationmarks(""),seeexamplebelow.
NotethatasubtypeofMOs-proxiedcomponent-isnotaddressablebythenormal"managed-object"syntax.Please
selectmanaged-object-full-namewhenreferringtothem.
TouseDNasapartofMOname,pleaseusetheoptionmanaged-object-full-name.
MOnameisaHASMOname.Forexample:
/ExampleHARG
"/?xampleHARG"
Parameter

Hint

Command

Range

Default

Dependency
None

show has {[regex]? [filter <filter-value>]? [noerror]?} summary


managed-object [<mo-name>]+

2.12.20.2
Table433

has summary managed-object-full-name

hassummarymanaged-object-full-name

Description
ThenameoftheMOindistinguishedname(DN)format.TouseslashseparatedMOname,pleaseusetheoption
managed-object.
Forexample:
fshaRecoveryGroupName=ExampleHARG,fsFragmentId=RecoveryGroups,fsFragmentId=HA,fsClusterId=ClusterRoot
Orinareverseorder:
fsClusterId=ClusterRoot,fsFragmentId=HA,fsFragmentId=RecoveryGroups,fshaRecoveryGroupName=ExampleHARG
Onlythelatternameformatsupportsautocompletionwith[TAB]key.
Parameter

Hint

Command

Range

Default

Dependency
None

show has {[regex]? [filter <filter-value>]? [noerror]?} summary

Issue:03B

339

SCLICommands

Table433

MulticontrollerRNCSCLICommands

hassummarymanaged-object-full-name(Cont.)

managed-object-full-name [<mo-fullname>]+

2.12.20.2.1
Table434

has summary managed-object-full-name <mo-fullname>

hassummarymanaged-object-full-name<mo-fullname>

Description
ThenameoftheMOindistinguishedname(DN)format.TouseslashseparatedMOname,pleaseusetheoption
managed-object.
Forexample:
fshaRecoveryGroupName=ExampleHARG,fsFragmentId=RecoveryGroups,fsFragmentId=HA,fsClusterId=ClusterRoot
Orinareverseorder:
fsClusterId=ClusterRoot,fsFragmentId=HA,fsFragmentId=RecoveryGroups,fshaRecoveryGroupName=ExampleHARG
Onlythelatternameformatsupportsautocompletionwith[TAB]key.
Parameter

Hint

Command

Range

Default

Dependency
None

show has {[regex]? [filter <filter-value>]? [noerror]?} summary


managed-object-full-name [<mo-fullname>]+

2.12.21 has switchover


Table435

hasswitchover

Description
ExecuteacontrolledorforcedswitchoverforthegivenRG,RUorLG.Acontrolledswitchoverisdoneforservicesthat
supportitandaforcedswitchoverforothers.Mostservicessupportonlyforcedswitchover,becauseusuallycontrolled
switchoverwillnotprovideanyrealbenefits.Thetimeoutoptionisignoredifaforcedswitchoverisdone.
Moreover,thiscommandallowstheswitchovertobeginonlyifthestandbyRUisingoodcondition.Thisdiffersfromthe
explicit'forced-switchover'operation,whichmayallowtheswitchoveralsoinsomeun-recommendedcases,suchas
situationswherethestandbyunitiscurrentlynotinsyncwiththeactiveunit,orthenetworkconnectivityofthestandby
nodeislimited.
ThiscommandisapplicableonlyforLGsandRGswithactive/standbyrecoverypolicy.
Note:ThiscommandcannotbeissuedtoanRGthatisaSTALKERoraPARASITEofanotherRG.
Forexample:
sethasswitchovertimeout10managed-object/ExampleHARG
Parameter

340

Hint

Range

Default

Issue:03B

MulticontrollerRNCSCLICommands

Table435

SCLICommands

hasswitchover(Cont.)
ForceacriticalMOtoperformtheoperation.

ForceacriticalMOto
performtheoperation

NA

Thecommandwillreturnimmediatelyafterinitiationwithout
checkingtheoperationresult.

Don'twaitforan
operationtobe
completed

NA

Thisparameterspecifiesthetimeoutforthecommand.The
SUFFIXmaybe's'forseconds,'m'forminutes,'h'forhours
or'd'fordays.Capitalletterscanbeused.IfnoSUFFIXis
given,theTIMEOUTistreatedasseconds.Theminimum
valueis1secondandthemaximumvalueis68years
(=0x7FFFFFFE).Nowarningisdisplayedwiththis
parameter.

Timeout

NA

force

noblock

timeout

Command

Dependency
None

set has {[regex]? [filter <filter-value>]? [noerror]?


[logerrors]?} switchover {[noblock]? [force]? [timeout
<timeout-value>]?} logical-group [<logical-group-name>]+
None
set has {[regex]? [filter <filter-value>]? [noerror]?
[logerrors]?} switchover {[noblock]? [force]? [timeout
<timeout-value>]?} managed-object [<mo-name>]+
None
set has {[regex]? [filter <filter-value>]? [noerror]?
[logerrors]?} switchover {[noblock]? [force]? [timeout
<timeout-value>]?} managed-object-full-name [<mo-fullname>]+
None
set has {[regex]? [filter <filter-value>]? [noerror]?
[logerrors]?} switchover {[noblock]? [force]? [timeout
<timeout-value>]?} new-active-recovery-unit [<new-activerecovery-unit>]+

2.12.21.1
Table436

has switchover logical-group

hasswitchoverlogical-group

Description
Thenameofthelogicalgroup.
Patternmatching'*'and'?'canbeusedinlogicalgroupnames.NOTE!'?'mustbeusedwithinquotationmarks(""),see
examplebelow.
Forexample:
ExampleLogicalGroup

Issue:03B

341

SCLICommands

Table436

MulticontrollerRNCSCLICommands

hasswitchoverlogical-group(Cont.)

"LogicalGroup??"
Parameter

Hint

Command

Range

Default

Dependency
None

set has {[regex]? [filter <filter-value>]? [noerror]?


[logerrors]?} switchover {[noblock]? [force]? [timeout
<timeout-value>]?} logical-group [<logical-group-name>]+

2.12.21.1.1
Table437

has switchover logical-group <logical-group-name>

hasswitchoverlogical-group<logical-group-name>

Description
Thenameofthelogicalgroup.
Patternmatching'*'and'?'canbeusedinlogicalgroupnames.NOTE!'?'mustbeusedwithinquotationmarks(""),see
examplebelow.
Forexample:
ExampleLogicalGroup
"LogicalGroup??"
Parameter

Hint

Command

Range

Default

Dependency
None

set has {[regex]? [filter <filter-value>]? [noerror]?


[logerrors]?} switchover {[noblock]? [force]? [timeout
<timeout-value>]?} logical-group [<logical-group-name>]+

2.12.21.2
Table438

has switchover managed-object

hasswitchovermanaged-object

Description
ThenameoftheMO.AnyoptioncanbeappliedtooneormoreMOs.Patternmatching'*'and'?'canbeusedinMO
namesandregularexpressionscanbeusedwithregexparametertomatchMOnames.NOTE!'?'mustbeusedwithin
quotationmarks(""),seeexamplebelow.
NotethatasubtypeofMOs-proxiedcomponent-isnotaddressablebythenormal"managed-object"syntax.Please
selectmanaged-object-full-namewhenreferringtothem.
TouseDNasapartofMOname,pleaseusetheoptionmanaged-object-full-name.
MOnameisaHASMOname.Forexample:
/ExampleHARG

342

Issue:03B

MulticontrollerRNCSCLICommands

Table438

SCLICommands

hasswitchovermanaged-object(Cont.)

"/?xampleHARG"
Parameter

Hint

Command

Range

Default

Dependency
None

set has {[regex]? [filter <filter-value>]? [noerror]?


[logerrors]?} switchover {[noblock]? [force]? [timeout
<timeout-value>]?} managed-object [<mo-name>]+

2.12.21.2.1
Table439

has switchover managed-object <mo-name>

hasswitchovermanaged-object<mo-name>

Description
ThenameoftheMO.AnyoptioncanbeappliedtooneormoreMOs.Patternmatching'*'and'?'canbeusedinMO
namesandregularexpressionscanbeusedwithregexparametertomatchMOnames.NOTE!'?'mustbeusedwithin
quotationmarks(""),seeexamplebelow.
NotethatasubtypeofMOs-proxiedcomponent-isnotaddressablebythenormal"managed-object"syntax.Please
selectmanaged-object-full-namewhenreferringtothem.
TouseDNasapartofMOname,pleaseusetheoptionmanaged-object-full-name.
MOnameisaHASMOname.Forexample:
/ExampleHARG
"/?xampleHARG"
Parameter

Hint

Command

Range

Default

Dependency
None

set has {[regex]? [filter <filter-value>]? [noerror]?


[logerrors]?} switchover {[noblock]? [force]? [timeout
<timeout-value>]?} managed-object [<mo-name>]+

2.12.21.3
Table440

has switchover managed-object-full-name

hasswitchovermanaged-object-full-name

Description
ThenameoftheMOindistinguishedname(DN)format.TouseslashseparatedMOname,pleaseusetheoption
managed-object.
Forexample:
fshaRecoveryGroupName=ExampleHARG,fsFragmentId=RecoveryGroups,fsFragmentId=HA,fsClusterId=ClusterRoot
Orinareverseorder:

Issue:03B

343

SCLICommands

Table440

MulticontrollerRNCSCLICommands

hasswitchovermanaged-object-full-name(Cont.)

fsClusterId=ClusterRoot,fsFragmentId=HA,fsFragmentId=RecoveryGroups,fshaRecoveryGroupName=ExampleHARG
Onlythelatternameformatsupportsautocompletionwith[TAB]key.
Parameter

Hint

Command

Range

Default

Dependency
None

set has {[regex]? [filter <filter-value>]? [noerror]?


[logerrors]?} switchover {[noblock]? [force]? [timeout
<timeout-value>]?} managed-object-full-name [<mo-fullname>]+

2.12.21.3.1
Table441

has switchover managed-object-full-name <mo-fullname>

hasswitchovermanaged-object-full-name<mo-fullname>

Description
ThenameoftheMOindistinguishedname(DN)format.TouseslashseparatedMOname,pleaseusetheoption
managed-object.
Forexample:
fshaRecoveryGroupName=ExampleHARG,fsFragmentId=RecoveryGroups,fsFragmentId=HA,fsClusterId=ClusterRoot
Orinareverseorder:
fsClusterId=ClusterRoot,fsFragmentId=HA,fsFragmentId=RecoveryGroups,fshaRecoveryGroupName=ExampleHARG
Onlythelatternameformatsupportsautocompletionwith[TAB]key.
Parameter

Hint

Command

Range

Default

Dependency
None

set has {[regex]? [filter <filter-value>]? [noerror]?


[logerrors]?} switchover {[noblock]? [force]? [timeout
<timeout-value>]?} managed-object-full-name [<mo-fullname>]+

2.12.21.4
Table442

has switchover new-active-recovery-unit

hasswitchovernew-active-recovery-unit

Description
Parameterdefinesthenewactiverecoveryunit(s).
Parameter

344

Hint

Range

Default

Issue:03B

MulticontrollerRNCSCLICommands

Table442

SCLICommands

hasswitchovernew-active-recovery-unit(Cont.)

Command

Dependency
None

set has {[regex]? [filter <filter-value>]? [noerror]?


[logerrors]?} switchover {[noblock]? [force]? [timeout
<timeout-value>]?} new-active-recovery-unit [<new-activerecovery-unit>]+

2.12.21.4.1
Table443

has switchover new-active-recovery-unit <new-active-recovery-unit>

hasswitchovernew-active-recovery-unit<new-active-recovery-unit>

Description
Parameterdefinesthenewactiverecoveryunit(s).
Parameter

Hint

Command

Range

Default

Dependency
None

set has {[regex]? [filter <filter-value>]? [noerror]?


[logerrors]?} switchover {[noblock]? [force]? [timeout
<timeout-value>]?} new-active-recovery-unit [<new-activerecovery-unit>]+

2.12.22 has test-state


Table444

hastest-state

Description
SetteststatefortheMO.TheMOcanbetheclusteroroneormorenodesoraproxiedcomponent.Theteststatewill
preventtherecoveryactionswithinthenodesorthecluster.Thiscommandcanbeusedfordebuggingpurposes.For
example:
sethastest-state[on|off]managed-object[managed_object_name]
Forexample:
sethastest-stateonmanaged-object/NODE-1/NODE-2
Parameter
Command

Issue:03B

Hint

Range

Default

Dependency

345

SCLICommands

Table444

MulticontrollerRNCSCLICommands

hastest-state(Cont.)
None

set has {[regex]? [filter <filter-value>]? [noerror]?


[logerrors]?} test-state <test-state-value> managed-object
[<mo-name>]+
None
set has {[regex]? [filter <filter-value>]? [noerror]?
[logerrors]?} test-state <test-state-value> managed-objectfull-name [<mo-fullname>]+

2.12.22.1
Table445

has test-state <test-state-value>

hastest-state<test-state-value>

Description
teststatevaluecaneitherbeonoroff.
Parameter

Hint

Command

Range

Default

Dependency
None

set has {[regex]? [filter <filter-value>]? [noerror]?


[logerrors]?} test-state <test-state-value> managed-object
[<mo-name>]+
None
set has {[regex]? [filter <filter-value>]? [noerror]?
[logerrors]?} test-state <test-state-value> managed-objectfull-name [<mo-fullname>]+

2.12.22.1.1
Table446

has test-state <test-state-value> managed-object

hastest-state<test-state-value>managed-object

Description
ThenameoftheMO.AnyoptioncanbeappliedtooneormoreMOs.Patternmatching'*'and'?'canbeusedinMO
namesandregularexpressionscanbeusedwithregexparametertomatchMOnames.NOTE!'?'mustbeusedwithin
quotationmarks(""),seeexamplebelow.
NotethatasubtypeofMOs-proxiedcomponent-isnotaddressablebythenormal"managed-object"syntax.Please
selectmanaged-object-full-namewhenreferringtothem.
TouseDNasapartofMOname,pleaseusetheoptionmanaged-object-full-name.
MOnameisaHASMOname.Forexample:
/ExampleHARG
"/?xampleHARG"

346

Issue:03B

MulticontrollerRNCSCLICommands

Table446

SCLICommands

hastest-state<test-state-value>managed-object(Cont.)

Parameter

Hint

Command

Range

Default

Dependency
None

set has {[regex]? [filter <filter-value>]? [noerror]?


[logerrors]?} test-state <test-state-value> managed-object
[<mo-name>]+

2.12.22.1.1.1
Table447

has test-state <test-state-value> managed-object <mo-name>

hastest-state<test-state-value>managed-object<mo-name>

Description
ThenameoftheMO.AnyoptioncanbeappliedtooneormoreMOs.Patternmatching'*'and'?'canbeusedinMO
namesandregularexpressionscanbeusedwithregexparametertomatchMOnames.NOTE!'?'mustbeusedwithin
quotationmarks(""),seeexamplebelow.
NotethatasubtypeofMOs-proxiedcomponent-isnotaddressablebythenormal"managed-object"syntax.Please
selectmanaged-object-full-namewhenreferringtothem.
TouseDNasapartofMOname,pleaseusetheoptionmanaged-object-full-name.
MOnameisaHASMOname.Forexample:
/ExampleHARG
"/?xampleHARG"
Parameter

Hint

Command

Range

Default

Dependency
None

set has {[regex]? [filter <filter-value>]? [noerror]?


[logerrors]?} test-state <test-state-value> managed-object
[<mo-name>]+

2.12.22.1.2
Table448

has test-state <test-state-value> managed-object-full-name

hastest-state<test-state-value>managed-object-full-name

Description
ThenameoftheMOindistinguishedname(DN)format.TouseslashseparatedMOname,pleaseusetheoption
managed-object.
Forexample:
fshaRecoveryGroupName=ExampleHARG,fsFragmentId=RecoveryGroups,fsFragmentId=HA,fsClusterId=ClusterRoot
Orinareverseorder:
fsClusterId=ClusterRoot,fsFragmentId=HA,fsFragmentId=RecoveryGroups,fshaRecoveryGroupName=ExampleHARG

Issue:03B

347

SCLICommands

Table448

MulticontrollerRNCSCLICommands

hastest-state<test-state-value>managed-object-full-name(Cont.)

Onlythelatternameformatsupportsautocompletionwith[TAB]key.
Parameter

Hint

Command

Range

Default

Dependency
None

set has {[regex]? [filter <filter-value>]? [noerror]?


[logerrors]?} test-state <test-state-value> managed-objectfull-name [<mo-fullname>]+

2.12.22.1.2.1
Table449

has test-state <test-state-value> managed-object-full-name <mo-fullname>

hastest-state<test-state-value>managed-object-full-name<mo-fullname>

Description
ThenameoftheMOindistinguishedname(DN)format.TouseslashseparatedMOname,pleaseusetheoption
managed-object.
Forexample:
fshaRecoveryGroupName=ExampleHARG,fsFragmentId=RecoveryGroups,fsFragmentId=HA,fsClusterId=ClusterRoot
Orinareverseorder:
fsClusterId=ClusterRoot,fsFragmentId=HA,fsFragmentId=RecoveryGroups,fshaRecoveryGroupName=ExampleHARG
Onlythelatternameformatsupportsautocompletionwith[TAB]key.
Parameter

Hint

Command

Range

Default

Dependency
None

set has {[regex]? [filter <filter-value>]? [noerror]?


[logerrors]?} test-state <test-state-value> managed-objectfull-name [<mo-fullname>]+

2.12.23 has unlock


Table450

hasunlock

Description
UnlockanMOoralogicalgroup.TheMOcanbethecluster,anode,anRGoranRU.Forexample:
sethasunlockmanaged-object/TA-A/ExampleHARU-A
Parameter

348

Hint

Range

Default

Issue:03B

MulticontrollerRNCSCLICommands

Table450

SCLICommands

hasunlock(Cont.)

Command

Dependency
None

set has {[regex]? [filter <filter-value>]? [noerror]?


[logerrors]?} unlock all {[include-user-locked]? [includetest]? [exclude-proxied-components]?}
None
set has {[regex]? [filter <filter-value>]? [noerror]?
[logerrors]?} unlock logical-group [<logical-group-name>]+
None
set has {[regex]? [filter <filter-value>]? [noerror]?
[logerrors]?} unlock managed-object [<mo-name>]+
None
set has {[regex]? [filter <filter-value>]? [noerror]?
[logerrors]?} unlock managed-object-full-name [<mo-fullname>]+

2.12.23.1
Table451

has unlock all

hasunlockall

Description
Theparameteraffectsallmanagedobjects(MOs)inthecluster,exceptthoseexplicitlylockedbytheuserorthose
declaredastestobjects.
Parameter

Hint

Range

Default

Theparameter'exclude-proxied-components'excludesthe
managedobjects(MOs)thatareproxiedcomponents.

excludeMOswhich
aretypeofproxied
components

NA

Theparameter'include-test'alsoaffectsthemanaged
objects(MOs)declaredastestobjects.

includeMOsdeclared
astestobjects

NA

include-test

include-userlocked

Theparameter'include-user-locked'alsoaffectsthe
managedobjects(MOs)explicitlylocked(orpowered-off)by
theuser.

includeMOslockedby NA
theuser

exclude-proxiedcomponents

Command

Dependency
None

set has {[regex]? [filter <filter-value>]? [noerror]?


[logerrors]?} unlock all {[include-user-locked]? [includetest]? [exclude-proxied-components]?}

Issue:03B

349

SCLICommands

2.12.23.2
Table452

MulticontrollerRNCSCLICommands

has unlock logical-group

hasunlocklogical-group

Description
Thenameofthelogicalgroup.
Patternmatching'*'and'?'canbeusedinlogicalgroupnames.NOTE!'?'mustbeusedwithinquotationmarks(""),see
examplebelow.
Forexample:
ExampleLogicalGroup
"LogicalGroup??"
Parameter

Hint

Command

Range

Default

Dependency
None

set has {[regex]? [filter <filter-value>]? [noerror]?


[logerrors]?} unlock logical-group [<logical-group-name>]+

2.12.23.2.1
Table453

has unlock logical-group <logical-group-name>

hasunlocklogical-group<logical-group-name>

Description
Thenameofthelogicalgroup.
Patternmatching'*'and'?'canbeusedinlogicalgroupnames.NOTE!'?'mustbeusedwithinquotationmarks(""),see
examplebelow.
Forexample:
ExampleLogicalGroup
"LogicalGroup??"
Parameter

Hint

Command

Range

Default

Dependency
None

set has {[regex]? [filter <filter-value>]? [noerror]?


[logerrors]?} unlock logical-group [<logical-group-name>]+

2.12.23.3
Table454

has unlock managed-object

hasunlockmanaged-object

Description

350

Issue:03B

MulticontrollerRNCSCLICommands

Table454

SCLICommands

hasunlockmanaged-object(Cont.)

ThenameoftheMO.AnyoptioncanbeappliedtooneormoreMOs.Patternmatching'*'and'?'canbeusedinMO
namesandregularexpressionscanbeusedwithregexparametertomatchMOnames.NOTE!'?'mustbeusedwithin
quotationmarks(""),seeexamplebelow.
NotethatasubtypeofMOs-proxiedcomponent-isnotaddressablebythenormal"managed-object"syntax.Please
selectmanaged-object-full-namewhenreferringtothem.
TouseDNasapartofMOname,pleaseusetheoptionmanaged-object-full-name.
MOnameisaHASMOname.Forexample:
/ExampleHARG
"/?xampleHARG"
Parameter

Hint

Command

Range

Default

Dependency
None

set has {[regex]? [filter <filter-value>]? [noerror]?


[logerrors]?} unlock managed-object [<mo-name>]+

2.12.23.3.1
Table455

has unlock managed-object <mo-name>

hasunlockmanaged-object<mo-name>

Description
ThenameoftheMO.AnyoptioncanbeappliedtooneormoreMOs.Patternmatching'*'and'?'canbeusedinMO
namesandregularexpressionscanbeusedwithregexparametertomatchMOnames.NOTE!'?'mustbeusedwithin
quotationmarks(""),seeexamplebelow.
NotethatasubtypeofMOs-proxiedcomponent-isnotaddressablebythenormal"managed-object"syntax.Please
selectmanaged-object-full-namewhenreferringtothem.
TouseDNasapartofMOname,pleaseusetheoptionmanaged-object-full-name.
MOnameisaHASMOname.Forexample:
/ExampleHARG
"/?xampleHARG"
Parameter

Hint

Command

Range

Default

Dependency
None

set has {[regex]? [filter <filter-value>]? [noerror]?


[logerrors]?} unlock managed-object [<mo-name>]+

Issue:03B

351

SCLICommands

2.12.23.4
Table456

MulticontrollerRNCSCLICommands

has unlock managed-object-full-name

hasunlockmanaged-object-full-name

Description
ThenameoftheMOindistinguishedname(DN)format.TouseslashseparatedMOname,pleaseusetheoption
managed-object.
Forexample:
fshaRecoveryGroupName=ExampleHARG,fsFragmentId=RecoveryGroups,fsFragmentId=HA,fsClusterId=ClusterRoot
Orinareverseorder:
fsClusterId=ClusterRoot,fsFragmentId=HA,fsFragmentId=RecoveryGroups,fshaRecoveryGroupName=ExampleHARG
Onlythelatternameformatsupportsautocompletionwith[TAB]key.
Parameter

Hint

Command

Range

Default

Dependency
None

set has {[regex]? [filter <filter-value>]? [noerror]?


[logerrors]?} unlock managed-object-full-name [<mo-fullname>]+

2.12.23.4.1
Table457

has unlock managed-object-full-name <mo-fullname>

hasunlockmanaged-object-full-name<mo-fullname>

Description
ThenameoftheMOindistinguishedname(DN)format.TouseslashseparatedMOname,pleaseusetheoption
managed-object.
Forexample:
fshaRecoveryGroupName=ExampleHARG,fsFragmentId=RecoveryGroups,fsFragmentId=HA,fsClusterId=ClusterRoot
Orinareverseorder:
fsClusterId=ClusterRoot,fsFragmentId=HA,fsFragmentId=RecoveryGroups,fshaRecoveryGroupName=ExampleHARG
Onlythelatternameformatsupportsautocompletionwith[TAB]key.
Parameter

Hint

Command

Range

Default

Dependency
None

set has {[regex]? [filter <filter-value>]? [noerror]?


[logerrors]?} unlock managed-object-full-name [<mo-fullname>]+

352

Issue:03B

MulticontrollerRNCSCLICommands

SCLICommands

2.12.24 has view


Table458

hasview

Description
ViewtheHASconfiguration.Ifrecoverygroupisgivenasaparameter,thecommandprintstheHASconfigurationfrom
RGstoprocesses.IfanMOnameisgiven,thecommandprintstheHASconfigurationstartingfromtheMO.Ifalogical
groupnameisgiven,commandprintslogicalgroup'stypeandRGsandRUswhichbelongtothelogicalgroup.For
example:
showhasview
ViewthewholeHASconfigurationfromthenodeview.
showhasviewrecoverygroup
ViewtheRGview.
showhasviewmanaged-object/TA-A/ExampleHARU-A
ViewthecontentsofRU/TA-A/ExampleHARU-Aandallitsprocesses.
showhasviewlogical-groupSingleIP
ViewRGsandRUsofthelogicalgroupSingleIP.
Parameter

Hint

Range

Default

PrintalistofMOnamesanddistinguishednames.For
example:

PrintalistofMO
namesand
distinguishednames

NA

dn

showhasviewdnmanaged-object/ExampleHARG
showhasbarednrgru
Command

Dependency
None

show has {[regex]? [filter <filter-value>]? [noerror]?} view


{[dn]?}
None
show has {[regex]? [filter <filter-value>]? [noerror]?} view
{[dn]?} logical-group [<logical-group-name>]+
None
show has {[regex]? [filter <filter-value>]? [noerror]?} view
{[dn]?} managed-object [<mo-name>]+
None
show has {[regex]? [filter <filter-value>]? [noerror]?} view
{[dn]?} managed-object-full-name [<mo-fullname>]+
None
show has {[regex]? [filter <filter-value>]? [noerror]?} view
{[dn]?} recoverygroup

Issue:03B

353

SCLICommands

2.12.24.1
Table459

MulticontrollerRNCSCLICommands

has view logical-group

hasviewlogical-group

Description
Thenameofthelogicalgroup.
Patternmatching'*'and'?'canbeusedinlogicalgroupnames.NOTE!'?'mustbeusedwithinquotationmarks(""),see
examplebelow.
Forexample:
ExampleLogicalGroup
"LogicalGroup??"
Parameter

Hint

Command

Range

Default

Dependency
None

show has {[regex]? [filter <filter-value>]? [noerror]?} view


{[dn]?} logical-group [<logical-group-name>]+

2.12.24.1.1
Table460

has view logical-group <logical-group-name>

hasviewlogical-group<logical-group-name>

Description
Thenameofthelogicalgroup.
Patternmatching'*'and'?'canbeusedinlogicalgroupnames.NOTE!'?'mustbeusedwithinquotationmarks(""),see
examplebelow.
Forexample:
ExampleLogicalGroup
"LogicalGroup??"
Parameter

Hint

Command

Range

Default

Dependency
None

show has {[regex]? [filter <filter-value>]? [noerror]?} view


{[dn]?} logical-group [<logical-group-name>]+

2.12.24.2
Table461

has view managed-object

hasviewmanaged-object

Description

354

Issue:03B

MulticontrollerRNCSCLICommands

Table461

SCLICommands

hasviewmanaged-object(Cont.)

ThenameoftheMO.AnyoptioncanbeappliedtooneormoreMOs.Patternmatching'*'and'?'canbeusedinMO
namesandregularexpressionscanbeusedwithregexparametertomatchMOnames.NOTE!'?'mustbeusedwithin
quotationmarks(""),seeexamplebelow.
NotethatasubtypeofMOs-proxiedcomponent-isnotaddressablebythenormal"managed-object"syntax.Please
selectmanaged-object-full-namewhenreferringtothem.
TouseDNasapartofMOname,pleaseusetheoptionmanaged-object-full-name.
MOnameisaHASMOname.Forexample:
/ExampleHARG
"/?xampleHARG"
Parameter

Hint

Command

Range

Default

Dependency
None

show has {[regex]? [filter <filter-value>]? [noerror]?} view


{[dn]?} managed-object [<mo-name>]+

2.12.24.2.1
Table462

has view managed-object <mo-name>

hasviewmanaged-object<mo-name>

Description
ThenameoftheMO.AnyoptioncanbeappliedtooneormoreMOs.Patternmatching'*'and'?'canbeusedinMO
namesandregularexpressionscanbeusedwithregexparametertomatchMOnames.NOTE!'?'mustbeusedwithin
quotationmarks(""),seeexamplebelow.
NotethatasubtypeofMOs-proxiedcomponent-isnotaddressablebythenormal"managed-object"syntax.Please
selectmanaged-object-full-namewhenreferringtothem.
TouseDNasapartofMOname,pleaseusetheoptionmanaged-object-full-name.
MOnameisaHASMOname.Forexample:
/ExampleHARG
"/?xampleHARG"
Parameter

Hint

Command

Range

Default

Dependency
None

show has {[regex]? [filter <filter-value>]? [noerror]?} view


{[dn]?} managed-object [<mo-name>]+

Issue:03B

355

SCLICommands

2.12.24.3
Table463

MulticontrollerRNCSCLICommands

has view managed-object-full-name

hasviewmanaged-object-full-name

Description
ThenameoftheMOindistinguishedname(DN)format.TouseslashseparatedMOname,pleaseusetheoption
managed-object.
Forexample:
fshaRecoveryGroupName=ExampleHARG,fsFragmentId=RecoveryGroups,fsFragmentId=HA,fsClusterId=ClusterRoot
Orinareverseorder:
fsClusterId=ClusterRoot,fsFragmentId=HA,fsFragmentId=RecoveryGroups,fshaRecoveryGroupName=ExampleHARG
Onlythelatternameformatsupportsautocompletionwith[TAB]key.
Parameter

Hint

Command

Range

Default

Dependency
None

show has {[regex]? [filter <filter-value>]? [noerror]?} view


{[dn]?} managed-object-full-name [<mo-fullname>]+

2.12.24.3.1
Table464

has view managed-object-full-name <mo-fullname>

hasviewmanaged-object-full-name<mo-fullname>

Description
ThenameoftheMOindistinguishedname(DN)format.TouseslashseparatedMOname,pleaseusetheoption
managed-object.
Forexample:
fshaRecoveryGroupName=ExampleHARG,fsFragmentId=RecoveryGroups,fsFragmentId=HA,fsClusterId=ClusterRoot
Orinareverseorder:
fsClusterId=ClusterRoot,fsFragmentId=HA,fsFragmentId=RecoveryGroups,fshaRecoveryGroupName=ExampleHARG
Onlythelatternameformatsupportsautocompletionwith[TAB]key.
Parameter

Hint

Command

Range

Default

Dependency
None

show has {[regex]? [filter <filter-value>]? [noerror]?} view


{[dn]?} managed-object-full-name [<mo-fullname>]+

356

Issue:03B

MulticontrollerRNCSCLICommands

2.12.24.4
Table465

SCLICommands

has view recoverygroup

hasviewrecoverygroup

Description
RGview
Parameter

Hint

Command

Range

Default

Dependency
None

show has {[regex]? [filter <filter-value>]? [noerror]?} view


{[dn]?} recoverygroup

2.13 hw
Table466

hw

Description
Initialisesthestoragesaccordingtodirectoryconfiguration.Thiscommandisusedforinitialisingaclustermanagernode
diskforexamplewhenabrokendiskhasbeenreplacedwithanewone.Thecommandreconfiguresaclustermanager
nodediskwhichhasbeenstarteduptotheinitialisationstate.Theclustermanagernodesstartautomaticallyinto
initialisationstatewhenbootedfromthenetwork.Allexistingdatawillbeerasedfromthediskofthenodeunder
initialisation.Newdisksetupwillbecreatedaccordingtotheconfigurationinthedirectoryandtheexistingvolumesonthe
otherclustermanagernode.Thenecessarydatawillbecopiedfromtheotherclustermanagernode.
Parameter

Hint

Range

Default

quiet

Suppressesnormaldebuggingmessageontheconsole
exceptforcriticalfailuremessages."quiet"optionoverrides
the"verbose"optionifbothofthemaregiven.

suppressesdebugging NA
messages

Enablestheexecutionlinetraceintracelog.Tracelogis
storedat"/tmp/SS_FConfigure/fsconfigure_trace.log".Trace
logisnotvisibleontheconsole.

enablestheexecution
trace

NA

trace

showsthedetailsof
theexecutiononthe
terminal

NA

AnyuserwithaccesstothebashshellviatheSCLI
command"shellbashfull",hasaccesstothistracelogfileof
theoperation.
Verboselevelcanbe:
verbose

1critical
2error
3warning
4info
5debug

Issue:03B

357

SCLICommands

Table466

MulticontrollerRNCSCLICommands

hw(Cont.)
Thehigherthenumber,themoreverboseisthelog."quiet"
optionoverridesthe"verbose"optionifbothofthemare
given.

Command

Dependency
None

initialise hw {[verbose <verbose level>]? [trace]? [quiet]?}

2.14 ipsec
Table467

ipsec

Description
add
ThiscommandaddsIPSecconfigurationobjects:
Internetkeyexchange(IKE)template:thetemplatesetsalltheIKEphase(Phase1)andIPSecphase(Phase2)
parametersofIKEprotocol.
Virtualprivatenetworks(VPN):theVPNconfigurationsetsthetunnelendpoints.
Rule:theruletellswhenthetrafficshouldgothroughtheVPNtunnel.
IPSecmanagementobjectsareusedtocreateIPSecconnectionsbetweenthisnetworkelementandremotepeer.The
coreattributesoftheIPSecconnectionsaredefinedinconfigurationobjects.EachIPSecconnectionneedsasetof
genericattributesthatarestoredintemplates,sharedbyoneormoreVPNobjects.EachVPNhasoneormorerules
associatedwhichdefinethetrafficselectorsforthatIPSecconnection.
Atemplatecanbeinternetkeyexchangeprotocolversion1(IKEv1)orinternetkeyexchangeprotocolversion2(IKEv2)
specific.BothtemplatescontainagroupofcommonsettingsforconnectionandIKEprotocol-specificsettingssuchas
authentication,encryptionandothers.Attributesofthetemplateareconnectionindependentandcanbethereforeshared
byseveralVPNs.
MostoftheattributesinatemplatearerelatedtoIKEprotocolnegotiationphases(1and2).Severalgenericattributes
relatedtotheconnectioncharacteristicsarealsoincludedinthetemplate.Thetemplateattributeike-auth(authentication
typeforIKEv1negotiation)requiresmatchingsettingintheVPNobject,asdescribedlaterinexamples.Atemplatecannot
beremovedfromtheconfigurationifitisreferredbyVPNobjects.
AVPNobjectisaformalIPSecVPNentrythatdefinestheindividualIPSecconnectionbetweennetworkelements.AVPN
objectdefinesmerelytheIPSectunnelendpointaddressesthatbehaveasasecuregateway.Connection-specific
authenticationinformationisalsostoredtoaVPNobject,whereasanycommonattributesaresharedintemplatesreferred
tobytheVPNobjects.TheactualtrafficselectorsforVPNconnectionaredefinedbypolicyrules.Ifanyrulereferstoan
existingVPNobject,thatVPNobjectcannotberemovedfromtheconfiguration.
AruleisatrafficselectorthatdeterminestheactualIPtrafficthatispassedthroughanIPSectunnelconnection.Eachrule
mustrefertoasingleVPNobject.SeveralpolicyrulescanrefertothesameVPN.Inthiscase,thepriorityofthepolicy
rulesdefinestheorderoftheapplication.
Changesmadetotheconfigurationsareautomaticallypropagatedtotheruntimeenvironment(RTE)viaconfigurationfiles
thatareappliedtoassociateddaemonsorkernel.ModifyingtheconfigurationwillresulteventuallyinrestartingIKE
daemon.Ifanychangeshavebeenmadeduringrun-time,acompleteconfigurationisalwayscreatedatnextstart-up,and
appliedtothewhole.

358

Issue:03B

MulticontrollerRNCSCLICommands

Table467

SCLICommands

ipsec(Cont.)

IfthenodehastheredundantIPSecconfiguration,itsharestheIPSecconfigurationwiththeothernode.Thesame
configurationisappliedtoRTEinbothredundantnodesandallIPSecmanagementobjectsinconfigurationdirectoryare
sharedforthosenodes.Forexample,removinganIPSecobjectfromoneofthenodesalsoremovesitfromthe
configurationoftheothernode.SameIPSecobjectsarealsoseenintheconfigurationofbothnodes.
delete
ThiscommanddeletestheIPSecconfiguration.
show
ThiscommandshowsIPSecconfiguration.
Parameter

Hint

Command

Range

Default

Dependency
None

add ipsec instance <instance_name> rule <rule-name> {owner


<owner-value> src-addr <src-addr-value> dst-addr <dst-addrvalue> protocol <protocol_value> action <action-value> [vpn
<vpn-value>]? [src-port <src-port-value>]? [dst-port <dst-portvalue>]? [priority <priority-value>]? [mode <mode-value>]?
[direction <dir-value>]?}
None
add ipsec instance <instance_name> vpn <vpn-name> certificate
<certificate-value> {template <template-value> owner <ownervalue> local-addr <local-addr-value> remote-addr <remote-addrvalue> ca-certificate <ca-certificate-value> private-key
<private-key-value> [local-id-type <local-id-type-value>]?
[local-id <local-id-value>]?}
None
add ipsec instance <instance_name> vpn <vpn-name> secret
<secret-value> {template <template-value> owner <owner-value>
local-addr <local-addr-value> remote-addr <remote-addr-value>}
None
add ipsec rule <rule-name> {owner <owner-value> src-addr <srcaddr-value> dst-addr <dst-addr-value> protocol <protocol_value>
action <action-value> [vpn <vpn-value>]? [src-port <src-portvalue>]? [dst-port <dst-port-value>]? [priority <priorityvalue>]? [mode <mode-value>]? [direction <dir-value>]?}
None
add ipsec template ikev1 <template-name> {owner <owner-value>
ike-enc <ike-enc-value> ike-hash <ike-hash-value> ike-auth
<ike-auth-value> ike-dh-group <ike-dh-group-value> ike-lifetime
<ike-lifetime-value> enc <enc-value> lifetime <lifetime-value>
auth <auth-value> [mode <mode-value>]? [pfs-group <pfsgroupvalue>]? [dpd-delay <dpd-delay-value>]? [dpd-max-fail <dpd-maxfail-value>]? [dpd-retry <dpd-retry-value>]?}

Issue:03B

359

SCLICommands

Table467

MulticontrollerRNCSCLICommands

ipsec(Cont.)
None

add ipsec template ikev2 <template-name> {owner <owner-value>


ike-enc <ike-enc-value> ike-hash <ike-hash-value> ike-auth
<ike-auth-value> ike-dh-group <ike-dh-group-value> ike-lifetime
<ike-lifetime-value> enc <enc-value> lifetime <lifetime-value>
auth <auth-value> [dpd-action <dpd-action-value>]? [dpd-delay
<dpd-delay-value>]?}
None
add ipsec vpn <vpn-name> certificate <certificate-value>
{template <template-value> owner <owner-value> local-addr
<local-addr-value> remote-addr <remote-addr-value> cacertificate <ca-certificate-value> private-key <private-keyvalue> [local-id-type <local-id-type-value>]? [local-id <localid-value>]?}
None
add ipsec vpn <vpn-name> secret <secret-value> {template
<template-value> owner <owner-value> local-addr <local-addrvalue> remote-addr <remote-addr-value>}
None
delete ipsec rule <name> {owner <owner-value>}
None
delete ipsec template ikev1 <name> {owner <owner-value>}

2.14.1 ipsec instance


Table468

ipsecinstance

Description
ThiscommandaddsIPSecconfigurationdatatothespecifiedvirtualroutingandforwarding(VRF)instance.IfnoVRF
instanceisspecified,defaultVRFisconsidered.
Parameter

Hint

Command

Range

Default

Dependency
None

add ipsec instance <instance_name> rule <rule-name> {owner


<owner-value> src-addr <src-addr-value> dst-addr <dst-addrvalue> protocol <protocol_value> action <action-value> [vpn
<vpn-value>]? [src-port <src-port-value>]? [dst-port <dst-portvalue>]? [priority <priority-value>]? [mode <mode-value>]?
[direction <dir-value>]?}
None
add ipsec instance <instance_name> vpn <vpn-name> certificate

360

Issue:03B

MulticontrollerRNCSCLICommands

Table468

SCLICommands

ipsecinstance(Cont.)

<certificate-value> {template <template-value> owner <ownervalue> local-addr <local-addr-value> remote-addr <remote-addrvalue> ca-certificate <ca-certificate-value> private-key
<private-key-value> [local-id-type <local-id-type-value>]?
[local-id <local-id-value>]?}
None
add ipsec instance <instance_name> vpn <vpn-name> secret
<secret-value> {template <template-value> owner <owner-value>
local-addr <local-addr-value> remote-addr <remote-addr-value>}
None
show ipsec instance <instance_name> rule all
None
show ipsec instance <instance_name> rule config {owner
<owner_value> [name <name-value>]? [vpn <vpn-value>]?}
None
show ipsec instance <instance_name> vpn all
None
show ipsec instance <instance_name> vpn config {[name <namevalue>]? [owner <owner-value>]? [local-addr <local-addrvalue>]? [remote-addr <remote-addr-value>]? [template
<template-value>]?}

2.14.1.1
Table469

ipsec instance <instance_name>

ipsecinstance<instance_name>

Description
Virtualroutingandforwardinginstancename.
Parameter

Hint

Command

Range

Default

Dependency
None

add ipsec instance <instance_name> rule <rule-name> {owner


<owner-value> src-addr <src-addr-value> dst-addr <dst-addrvalue> protocol <protocol_value> action <action-value> [vpn
<vpn-value>]? [src-port <src-port-value>]? [dst-port <dst-portvalue>]? [priority <priority-value>]? [mode <mode-value>]?
[direction <dir-value>]?}
None
add ipsec instance <instance_name> vpn <vpn-name> certificate

Issue:03B

361

SCLICommands

Table469

MulticontrollerRNCSCLICommands

ipsecinstance<instance_name>(Cont.)

<certificate-value> {template <template-value> owner <ownervalue> local-addr <local-addr-value> remote-addr <remote-addrvalue> ca-certificate <ca-certificate-value> private-key
<private-key-value> [local-id-type <local-id-type-value>]?
[local-id <local-id-value>]?}
None
add ipsec instance <instance_name> vpn <vpn-name> secret
<secret-value> {template <template-value> owner <owner-value>
local-addr <local-addr-value> remote-addr <remote-addr-value>}
None
show ipsec instance <instance_name> rule all
None
show ipsec instance <instance_name> rule config {owner
<owner_value> [name <name-value>]? [vpn <vpn-value>]?}
None
show ipsec instance <instance_name> vpn all
None
show ipsec instance <instance_name> vpn config {[name <namevalue>]? [owner <owner-value>]? [local-addr <local-addrvalue>]? [remote-addr <remote-addr-value>]? [template
<template-value>]?}

2.14.1.1.1
Table470

ipsec instance <instance_name> rule

ipsecinstance<instance_name>rule

Description
add
ThiscommandaddstheIPSecpolicyrule.Therulenameshouldbeatamaximumof80characterslongandcannot
containspecialcharactersotherthan"-","\".IPSecpolicyruleisatrafficselectorthatdetermineswhethertheactualIP
trafficshouldbepassedencryptedorwithoutencryptionordiscarded.
show
ThiscommandshowsIPSecpolicyrule(s)configurationforthegivenvirtualroutingandforwarding(VRF).
Parameter

Hint

Command

Range

Default

Dependency
None

add ipsec instance <instance_name> rule <rule-name> {owner


<owner-value> src-addr <src-addr-value> dst-addr <dst-addrvalue> protocol <protocol_value> action <action-value> [vpn

362

Issue:03B

MulticontrollerRNCSCLICommands

Table470

SCLICommands

ipsecinstance<instance_name>rule(Cont.)

<vpn-value>]? [src-port <src-port-value>]? [dst-port <dst-portvalue>]? [priority <priority-value>]? [mode <mode-value>]?


[direction <dir-value>]?}
None
show ipsec instance <instance_name> rule all
None
show ipsec instance <instance_name> rule config {owner
<owner_value> [name <name-value>]? [vpn <vpn-value>]?}

2.14.1.1.1.1
Table471

ipsec instance <instance_name> rule <rule-name>

ipsecinstance<instance_name>rule<rule-name>

Description
ThiscommandaddstheIPSecpolicyrule.IPSecpolicyruleisatrafficselectorthatdetermineswhethertheactualIPtraffic
shouldbepassedencryptedorwithoutencryptionordiscarded.
Parameter

action

direction

dst-addr

Hint

Range

Default

Theparameter"action"definestheactiontobeperformed
formatchedrules.Theactiontypes"esp","ah","pass",and
"discard"areaccepted.ItismandatorytospecifytheVPN
forESPandAHactionpolicies.

IPsecpolicyruleaction NA

Theparameter"direction"definestheruledirectiontobein
orout.Ifthisoptionisnotgiven,thenthedefaultis
assumed,whichisbothdirections.Directionisonlypossible
tobesetfordiscardorpassactions.

IPsecpolicyrule
direction

NA

Theparameter"dst-addr"referstotheip-addressoripsubnet/maskwhere

IPv4/IPv6addressor
subnet/mask

NA

ip-address:IPv4orIPv6addresswithoutamask.
ip-subnet/mask:IPv4orIPv6networkaddresswithamask.
Themaskcanvaryfrom1to32foranIPv4addressand1
to128foranIPv6address,exceptforsubnets0.0.0.0,::,or
0:0:0:0:0:0:0:0itmustbe0.
Ifip-addresswithoutmaskisused,theIDtypeusedinIKE
negotiationIPSecphasewillbeanIPaddressinsteadof
subnettype.

Issue:03B

363

SCLICommands

Table471
dst-port

mode

owner

priority

MulticontrollerRNCSCLICommands

ipsecinstance<instance_name>rule<rule-name>(Cont.)
Theparameter"dst-port"allowsyoutoconfigurethe
0..65535
destinationportforpolicyorruleselector.Portnumbermay
onlybegivenforprotocolsforwhichitisrelevant.The
defaultis"0"andthismeansthatanydestinationportis
appliediftheprotocolsupportsports.Italsomeansnoportif
theprotocoldoesnotsupportports.

NA

Theparameter"mode"definesthepolicymodeforthe
IPsecpolicyrulemode NA
encryptedpackets.Validonlyiftheselectedpolicyactionis
"esp"or"ah".Intheruleobject'mode'meanstheIPSec
policymode.Currently,onlytunnelmodeissupported.In
tunnelmode,theentireIPpacketisencryptedand/or
authenticatedthenencapsulatedintoanewIPpacketwitha
newIPheader.
Theparameter"owner"definestheowneroftheIPSec
tunnel.Itmustbeeitherthenameofanodethathas
standaloneIPSecdeployment,orthenameofarecovery
groupthatisofactive-standbyredundancytype.

{NODE|RG}

Theparameter"priority"definesthepolicyrulepriorityvalue. 1..500
Itistheorderinwhichtherulesareapplied.Ahighervalue
meanslowerpriority.Prioritycanonlybeusedwithpassor
discardrules.

NA

NA

Thevaluerangeis[1..500]andthedefaultis10.

protocol

src-addr

Theparameter"protocol"definesprotocolforthepolicyrule
selector.Aninteger[0..255]or"any","udp","tcp","icmp",or
"icmp6".Thevalue'0'or'any'meansthatanyprotocolis
applied.

0..255

NA

Theparameter"src-addr"definestheip-addressoripsubnet/maskwhere

IPv4/IPv6addressor
subnet/mask

NA

ip-address:IPv4orIPv6addresswithoutamask.
ip-subnet/mask:IPv6orIPv6networkaddresswithamask.
Themaskcanvaryfrom1to32foranIPv4addressand1
to128foranIPv6address,exceptforsubnets0.0.0.0,::,or
0:0:0:0:0:0:0:0itmustbe0.
Ifip-addresswithoutmaskisused,theIDtypeusedinIKE
negotiationIPSecphasewillbeaddressinsteadofsubnet
type.

src-port

vpn

364

Theparameter"src-port"allowsyoutoconfigurethesource 0..65535
portforpolicyorruleselector.Portnumbermayonlybe
givenforprotocolsforwhichitisrelevant.Thedefaultis"0"
andthismeansthatanysourceportisappliediftheprotocol
supportsports.Italsomeansnoportiftheprotocoldoesnot
supportports.

NA

Theparameter"vpn"definesthenameofthevirtualprivate
network(VPN)objectreferredbythepolicyrule.

NA

thenameoftheVPN
objectthatthepolicy
ruleobjectrefersto

Issue:03B

MulticontrollerRNCSCLICommands

Table471

SCLICommands

ipsecinstance<instance_name>rule<rule-name>(Cont.)

Command

Dependency
None

add ipsec instance <instance_name> rule <rule-name> {owner


<owner-value> src-addr <src-addr-value> dst-addr <dst-addrvalue> protocol <protocol_value> action <action-value> [vpn
<vpn-value>]? [src-port <src-port-value>]? [dst-port <dst-portvalue>]? [priority <priority-value>]? [mode <mode-value>]?
[direction <dir-value>]?}

2.14.1.1.1.2
Table472

ipsec instance <instance_name> rule all

ipsecinstance<instance_name>ruleall

Description
ThiscommandshowsalltheIPSecpolicyruleconfiguration.
Parameter

Hint

Command

Range

Default

Dependency
None

show ipsec instance <instance_name> rule all

2.14.1.1.1.3
Table473

ipsec instance <instance_name> rule config

ipsecinstance<instance_name>ruleconfig

Description
ThiscommandshowstheIPSecpolicyrule(s)configurationbasedonagivenfilter.Itispossibletospecifywhichruleto
showbyspecifyingitsname(name),virtualprivatenetwork(vpn)ortheowneroftheIPSectunnel(owner).
Parameter

Hint

Range

Default

Theparameter"name"definesthenameoftheexisting
IPSecpolicyrule.

thenameoftheIPsec
policyrule

NA

name

Theparameter"owner"definestheowneroftheIPSec
tunnel.Itmustbeeitherthenameofanodethathas
standaloneIPSecdeployment,orthenameofarecovery
groupthatisofactive-standbyredundancytype.

{NODE|RG}

NA

Theparameter"vpn"definesthenameofthevirtualprivate
network(VPN)objectreferredbythepolicyrule.

thenameoftheVPN
objectthatthepolicy
ruleobjectrefersto

NA

owner

vpn

Command

Dependency
None

show ipsec instance <instance_name> rule config {owner

Issue:03B

365

SCLICommands

Table473

MulticontrollerRNCSCLICommands

ipsecinstance<instance_name>ruleconfig(Cont.)

<owner_value> [name <name-value>]? [vpn <vpn-value>]?}

2.14.1.1.2
Table474

ipsec instance <instance_name> vpn

ipsecinstance<instance_name>vpn

Description
add
ThiscommandaddstheIPSecvirtualprivatenetwork(VPN)objecttogiveninstance.AVPNobjectisaformalIPSecVPN
entrythatdefinestheindividualIPSecconnectionbetweennetworkelements.AVPNobjectdefinestheIPSectunnel
endpointaddressesthatbehaveasasecuregateway.Connection-specificauthenticationinformationisalsostoredina
VPNobject,whereasanycommonattributesaresharedintemplatesreferredtobytheVPNobjects.Theactualtraffic
selectorsforVPNconnectionaredefinedbypolicyrules.IfanyrulereferstoanexistingVPNobject,thatVPNobject
cannotberemovedfromtheconfiguration.
show
Thiscommandshowsthevirtualprivatenetwork(VPN)configurationcorrespondingtothegivenvirtualroutingand
forwarding(VRF).
Parameter

Hint

Command

Range

Default

Dependency
None

add ipsec instance <instance_name> vpn <vpn-name> certificate


<certificate-value> {template <template-value> owner <ownervalue> local-addr <local-addr-value> remote-addr <remote-addrvalue> ca-certificate <ca-certificate-value> private-key
<private-key-value> [local-id-type <local-id-type-value>]?
[local-id <local-id-value>]?}
None
add ipsec instance <instance_name> vpn <vpn-name> secret
<secret-value> {template <template-value> owner <owner-value>
local-addr <local-addr-value> remote-addr <remote-addr-value>}
None
show ipsec instance <instance_name> vpn all
None
show ipsec instance <instance_name> vpn config {[name <namevalue>]? [owner <owner-value>]? [local-addr <local-addrvalue>]? [remote-addr <remote-addr-value>]? [template
<template-value>]?}

366

Issue:03B

MulticontrollerRNCSCLICommands

2.14.1.1.2.1
Table475

SCLICommands

ipsec instance <instance_name> vpn <vpn-name>

ipsecinstance<instance_name>vpn<vpn-name>

Description
VPNobjectnameforthepolicyrule
Parameter

Hint

Command

Range

Default

Dependency
None

add ipsec instance <instance_name> vpn <vpn-name> certificate


<certificate-value> {template <template-value> owner <ownervalue> local-addr <local-addr-value> remote-addr <remote-addrvalue> ca-certificate <ca-certificate-value> private-key
<private-key-value> [local-id-type <local-id-type-value>]?
[local-id <local-id-value>]?}
None
add ipsec instance <instance_name> vpn <vpn-name> secret
<secret-value> {template <template-value> owner <owner-value>
local-addr <local-addr-value> remote-addr <remote-addr-value>}

2.14.1.1.2.1.1
Table476

ipsecinstance<instance_name>vpn<vpn-name>certificate

ipsecinstance<instance_name>vpn<vpn-name>certificate

Description
Thiscommanddescribesthecertificatefilenameusedduringauthentication.Itmustbeconfiguredifthetemplateusedby
thevirtualprivatenetwork(VPN)hascertificateauthenticationmethod.ItshouldnotbeconfiguredifVPNhas'secret'
authenticationmethod.Itmustbeaplainfilenameandnotthepathofthefile.
Iftheauthenticationmethodtypedefinedbythetemplateis'certificate'andcertificateisnotgeneratedbyCertificate
managementframework,thencertificatefilemustbecopiedto/etc/ipsec/certs/ipsec.d/certsdirectorybeforeconfiguring
theVPN.Rootpermissionisneededtocopythefiles,andmakesurethefileshavecorrectpermissions.
IfcertificateisgeneratedbyCertificatemanagementframework,itwillbecopiedto
/etc/ipsec/certs/ipsec.d/defaultCertificate.pem.
Parameter

Hint

Command

Range

Default

Dependency
None

add ipsec instance <instance_name> vpn <vpn-name> certificate


<certificate-value> {template <template-value> owner <ownervalue> local-addr <local-addr-value> remote-addr <remote-addrvalue> ca-certificate <ca-certificate-value> private-key
<private-key-value> [local-id-type <local-id-type-value>]?
[local-id <local-id-value>]?}

Issue:03B

367

SCLICommands

2.14.1.1.2.1.1.1

Table477

MulticontrollerRNCSCLICommands

ipsecinstance<instance_name>vpn<vpn-name>certificate<certificate-value>

ipsecinstance<instance_name>vpn<vpn-name>certificate<certificatevalue>

Description
ThiscommandaddsIPSecvirtualprivatenetwork(VPN)connectionintoconfiguration.IPSecVPNcontainsIPSec
connectionspecificdata.VPNusesatemplatecontaininginternetkeyexchange(IKE)parameters,andthistemplatemust
beconfiguredbeforethecreationofVPNobject.ConfigurationofVPNobjectdefinesthelocalandremotepeeraddresses
thatdeterminetheIPSecconnectionend-points.Iftheauthenticationmethodtypedefinedbythetemplateiscertificate,
thenCAcertificate,certificatefileandprivatekeymustbecopiedto/etc/ipsec/certs/ipsec.d/cacerts,
/etc/ipsec/certs/ipsec.d/certsand/etc/ipsec/certs/ipsec.d/privatedirectoriesrespectivelybeforeconfiguringtheVPN.
Parameter

Hint

Range

Default

Theparameter"ca-certificate"definescertificationauthority
(CA)certificatefilename.Thefilemustbelocatedinthe
certificatedirectory.

CAcertificatefilename NA

ca-certificate

/etc/ipsec/certs/ipsec.d/cacerts.CAcertificatefilemustbe
manuallycopiedtothetargetdirectoryontherelatednode
beforeconfiguringtheVPNconnection.Ifitisgeneratedby
Certificatemanagementframework,itwillbecopiedto
/etc/ipsec/certs/ipsec.d/defaultCaCertificate.pem.

local-addr

local-id

local-id-type

368

Theparameter"local-addr"definesthesourceaddressor
subnetaddress.Thesourceaddressisconfiguredfora
virtualprivatenetwork(VPN)object.Ahostaddresswith
mask(includingmasklengthof32forIPv4and128forIPv6
addresses)isconsideredtobeasubnet.Localaddress
definesthegatewayaddressoftheIPSectunnelssothere
mustbearoutefromthataddresstotheremotehost.Local
addressmustbeconfiguredbeforethecreationoftheVPN
object.

VPNlocalIPv4orIPv6 NA
address

Theparameter"local-id"specifiesthevalueoftheinternet
keyexchange(IKE)identitytowardstheremotepeer.Ifthe
valueoftheparameterlocal-id-typeis"address"andthe
parameterlocal-idisnotset,thenthelocal-addresswillbe
setaslocal-id(default).Ifthevalueoftheparameterlocal-idtypeis"asn1dn",thentheusershouldnotsetthelocal-idas
theDistinguishedName(DN)fromthesubjectfieldofthe
certificatewillbeusedforauthenticationduringPhase1
negotiation.Ifthevalueoftheparameterlocal-id-typeis
"fqdn",thenitismandatorytoconfigurethelocal-id
parameterwithavalidfully-qualifieddomainname(FQDN).
Thevalueoftheparameter"local-id"shouldbeofthetype
"local-id-type".

localidentifierfor
authenticationat
remotepeer

Theparameter"local-id-type"referstothetypeofthe
localidentifiertypefor
identifiersenttotheremotehostforauthentication.Thetype authenticationat
canbe"ip-address"or"asn1dn"or"fully-qualifieddomain
remotepeer
name(FQDN)".Thedefaultvaluesforthisparameterare
"asn1dn"forIKEv1and"ip-address"forIKEv2.

NA

NA

Issue:03B

MulticontrollerRNCSCLICommands

Table477

SCLICommands

ipsecinstance<instance_name>vpn<vpn-name>certificate<certificatevalue>(Cont.)

owner

private-key

remote-addr

template

Theparameter"owner"definestheowneroftheIPSec
tunnel.Itmustbeeitherthenameofanodethathas
standaloneIPSecdeployment,orthenameofarecovery
groupthatisofactive-standbyredundancytype.

{NODE|RG}

NA

Theparameter"private-key"definestheprivatekeyfile
name.Thefilemustbelocatedinthecertificatedirectory.
/etc/ipsec/certs/ipsec.d/private.Privatekeyfilemustbe
manuallycopiedtothetargetdirectorybeforeconfiguring
thevirtualprivatenetwork(VPN)connection.Ifitis
generatedbyCertificatemanagementframework,itwillbe
copiedto/etc/ipsec/certs/ipsec.d/defaultPrivateKey.pem.

privatekeyfilename

NA

Theparameter"remote-addr"definesthedestination
VPNremoteIPv4or
addressorsubnetaddress.Thedestinationaddressis
IPv6address
configuredforvirtualprivatenetwork(VPN)object.Ahost
addresswithmask(includingmasklengthof32forIPv4and
masklengthof128forIPv6)isconsideredtobeasubnet.
Remoteaddressdefinesthegatewayaddressoftheremote
peeroftheIPSectunnelsotheremustbearoutetoremote
gatewayaddress.

NA

Theparameter"template"definesthenameofthetemplate
thatisreferredbythevirtualprivatenetwork(VPN)
connection.

NA

Command

thenameoftheIKE
templateusedto
configurethisVPN
Dependency
None

add ipsec instance <instance_name> vpn <vpn-name> certificate


<certificate-value> {template <template-value> owner <ownervalue> local-addr <local-addr-value> remote-addr <remote-addrvalue> ca-certificate <ca-certificate-value> private-key
<private-key-value> [local-id-type <local-id-type-value>]?
[local-id <local-id-value>]?}

2.14.1.1.2.1.2
Table478

ipsecinstance<instance_name>vpn<vpn-name>secret

ipsecinstance<instance_name>vpn<vpn-name>secret

Description
ThiscommanddefinesPre-Shared-Key.Secretkeyusedtoauthenticatetheremotepeerofthevirtualprivatenetwork
(VPN).ItmustbeconfiguredifthetemplateusedbytheVPNhasauthenticationmethodas'secret'.Secretkeymustbe
identicalatbothendsoftheVPNconnection.ItmustnotbeconfiguredifthetemplateusedbytheVPNhasauthentication
methodas'certificate'.
Parameter

Hint

Command

Range

Default

Dependency
None

add ipsec instance <instance_name> vpn <vpn-name> secret

Issue:03B

369

SCLICommands

Table478

MulticontrollerRNCSCLICommands

ipsecinstance<instance_name>vpn<vpn-name>secret(Cont.)

<secret-value> {template <template-value> owner <owner-value>


local-addr <local-addr-value> remote-addr <remote-addr-value>}

2.14.1.1.2.1.2.1

Table479

ipsecinstance<instance_name>vpn<vpn-name>secret<secret-value>

ipsecinstance<instance_name>vpn<vpn-name>secret<secret-value>

Description
ThiscommandaddsIPSecvirtualprivatenetwork(VPN)connectiontotheconfiguration.IPSecVPNcontainsIPSec
connectionspecificdata.VPNusesatemplatecontaininginternetkeyexchange(IKE)parameters,andthetemplatemust
beconfiguredbeforethecreationoftheVPNobject.ConfigurationoftheVPNobjectdefinesthelocalandremotepeer
addressesthatdeterminetheIPSecconnectionend-points.
Parameter

local-addr

owner

remote-addr

template

Hint

Range

Default

Theparameter"local-addr"definesthesourceaddressor
subnetaddress.Thesourceaddressisconfiguredfora
virtualprivatenetwork(VPN)object.Ahostaddresswith
mask(includingmasklengthof32forIPv4and128forIPv6
addresses)isconsideredtobeasubnet.Localaddress
definesthegatewayaddressoftheIPSectunnel,sothere
mustbearoutefromthataddresstoremotehost.

VPNlocalIPv4orIPv6 NA
address

Theparameter"owner"definestheowneroftheIPSec
tunnel.Itmustbeeitherthenameofanodethathas
standaloneIPSecdeployment,orthenameofarecovery
groupthatisofactive-standbyredundancytype.

{NODE|RG}

NA

Theparameter"remote-addr"definesthedestination
VPNremoteIPv4or
addressorsubnetaddress.Thedestinationaddressis
IPv6address
configuredforvirtualprivatenetwork(VPN)object.Ahost
addresswithmask(includingmasklengthof32forIPv4and
masklengthof128forIPv6)isconsideredtobeasubnet.
Remoteaddressdefinesthegatewayaddressoftheremote
peeroftheIPSectunnelsotheremustbearoutetoremote
gatewayaddress.

NA

Theparameter"template"definesthenameofthetemplate
thatisreferredbythevirtualprivatenetwork(VPN)
connection.

NA

Command

IKEtemplatenameto
configureVPN

Dependency
None

add ipsec instance <instance_name> vpn <vpn-name> secret


<secret-value> {template <template-value> owner <owner-value>
local-addr <local-addr-value> remote-addr <remote-addr-value>}

370

Issue:03B

MulticontrollerRNCSCLICommands

2.14.1.1.2.2
Table480

SCLICommands

ipsec instance <instance_name> vpn all

ipsecinstance<instance_name>vpnall

Description
ThiscommandshowsalltheIPSecvirtualprivatenetwork(VPN)configuration.
Parameter

Hint

Command

Range

Default

Dependency
None

show ipsec instance <instance_name> vpn all

2.14.1.1.2.3
Table481

ipsec instance <instance_name> vpn config

ipsecinstance<instance_name>vpnconfig

Description
ThiscommandshowsalltheIPSecvirtualprivatenetwork(VPN)configuration.ItispossibletospecifywhichVPNobjectto
showbyspecifyingitsname(name),thelocalIPaddress(local-addr),theremoteIPaddress(remote-addr),thenameof
thetemplateituses(template)ortheowneroftheIPSectunnel(owner).
Parameter

local-addr

name

owner

remote-addr

Issue:03B

Hint

Range

Theparameter"local-addr"definesthesourceaddressor
subnetaddress.Thesourceaddressisconfiguredfora
virtualprivatenetwork(VPN)object.Ahostaddresswith
mask(includingmasklengthof32forIPv4and128forIPv6
addresses)isconsideredtobeasubnet.Localaddress
definesthegatewayaddressoftheIPSectunnel,sothere
mustbearoutefromthataddresstoremotehost.

VPNlocalIPv4orIPv6 NA
address

Theparameter"name"definesthenameofthevirtual
privatenetwork(VPN)boject.

thenameoftheVPN
objectthatthepolicy
ruleobjectrefersto

NA

Theparameter"owner"definestheowneroftheIPSec
tunnel.Itmustbeeitherthenameofanodethathas
standaloneIPSecdeployment,orthenameofarecovery
groupthatisofactive-standbyredundancytype.

{NODE|RG}

NA

Theparameter"remote-addr"definesthedestination
VPNremoteIPv4or
addressorsubnetaddress.Thedestinationaddressis
IPv6address
configuredforvirtualprivatenetwork(VPN)object.Ahost
addresswithmask(includingmasklengthof32forIPv4and
masklengthof128forIPv6)isconsideredtobeasubnet.
Remoteaddressdefinesthegatewayaddressoftheremote
peeroftheIPSectunnelsotheremustbearoutetoremote
gatewayaddress.

Default

NA

371

SCLICommands

Table481
template

MulticontrollerRNCSCLICommands

ipsecinstance<instance_name>vpnconfig(Cont.)
Theparameter"template"definesthenameofthetemplate
thatisreferredbythevirtualprivatenetwork(VPN)
connection.

Command

thenameofthe
templateobjectthat
theVPNconnection
refersto

NA

Dependency
None

show ipsec instance <instance_name> vpn config {[name <namevalue>]? [owner <owner-value>]? [local-addr <local-addrvalue>]? [remote-addr <remote-addr-value>]? [template
<template-value>]?}

2.14.2 ipsec rule


Table482

ipsecrule

Description
add
ThiscommandaddstheIPSecpolicyrule.Therulenameshouldbeatamaximumof80characterslongandcannot
containspecialcharactersotherthan"-","\".IPSecpolicyruleisatrafficselectorthatdetermineswhethertheactualIP
trafficshouldbepassedencryptedorwithoutencryptionordiscarded.
delete
ThiscommanddeletesIPSecpolicyrulefromconfiguration.
show
ThiscommandshowsIPSecpolicyrule(s)configuration.
Parameter

Hint

Command

Range

Default

Dependency
None

add ipsec rule <rule-name> {owner <owner-value> src-addr <srcaddr-value> dst-addr <dst-addr-value> protocol <protocol_value>
action <action-value> [vpn <vpn-value>]? [src-port <src-portvalue>]? [dst-port <dst-port-value>]? [priority <priorityvalue>]? [mode <mode-value>]? [direction <dir-value>]?}
None
delete ipsec rule <name> {owner <owner-value>}
None
show ipsec rule all
None
show ipsec rule config {owner <owner_value> [name <name-

372

Issue:03B

MulticontrollerRNCSCLICommands

Table482

SCLICommands

ipsecrule(Cont.)

value>]? [vpn <vpn-value>]?}

2.14.2.1
Table483

ipsec rule <name>

ipsecrule<name>

Description
ThiscommanddeletesIPSecpolicyrulefromconfiguration.
Parameter

owner

Hint

Range

Default

Theparameter"owner"definestheowneroftheIPSec
tunnel.Itmustbeeitherthenameofanodethathas
standaloneIPSecdeployment,orthenameofarecovery
groupthatisofactive-standbyredundancytype.

{NODE|RG}

NA

Command

Dependency
None

delete ipsec rule <name> {owner <owner-value>}

2.14.2.2
Table484

ipsec rule <rule-name>

ipsecrule<rule-name>

Description
ThiscommandaddstheIPSecpolicyrule.IPSecpolicyruleisatrafficselectorthatdetermineswhethertheactualIPtraffic
shouldbepassedencryptedorwithoutencryptionordiscarded.
Parameter

action

direction

dst-addr

Hint

Range

Default

Theparameter"action"definestheactiontobeperformed
formatchedrules.Theactiontypes"esp","ah","pass",and
"discard"areaccepted.ItismandatorytospecifytheVPN
forESPandAHactionpolicies.

IPsecpolicyruleaction NA

Theparameter"direction"definestheruledirectiontobein
orout.Ifthisoptionisnotgiven,thenthedefaultis
assumed,whichisbothdirections.Directionisonlypossible
tobesetfordiscardorpassactions.

IPsecpolicyrule
direction

NA

Theparameter"dst-addr"referstotheip-addressoripsubnet/maskwhere

IPv4/IPv6addressor
subnet/mask

NA

ip-address:IPv4orIPv6addresswithoutamask.
ip-subnet/mask:IPv4orIPv6networkaddresswithamask.
Themaskcanvaryfrom1to32foranIPv4addressand1
to128foranIPv6address,exceptforsubnets0.0.0.0,::,or
0:0:0:0:0:0:0:0itmustbe0.

Issue:03B

373

SCLICommands

Table484

MulticontrollerRNCSCLICommands

ipsecrule<rule-name>(Cont.)
Ifip-addresswithoutmaskisused,theIDtypeusedinIKE
negotiationIPSecphasewillbeanIPaddressinsteadof
subnettype.

dst-port

mode

owner

priority

Theparameter"dst-port"allowsyoutoconfigurethe
0..65535
destinationportforpolicyorruleselector.Portnumbermay
onlybegivenforprotocolsforwhichitisrelevant.The
defaultis"0"andthismeansthatanydestinationportis
appliediftheprotocolsupportsports.Italsomeansnoportif
theprotocoldoesnotsupportports.

NA

Theparameter"mode"definesthepolicymodeforthe
IPsecpolicyrulemode NA
encryptedpackets.Validonlyiftheselectedpolicyactionis
"esp"or"ah".Intheruleobject'mode'meanstheIPSec
policymode.Currently,onlytunnelmodeissupported.In
tunnelmode,theentireIPpacketisencryptedand/or
authenticatedthenencapsulatedintoanewIPpacketwitha
newIPheader.
Theparameter"owner"definestheowneroftheIPSec
tunnel.Itmustbeeitherthenameofanodethathas
standaloneIPSecdeployment,orthenameofarecovery
groupthatisofactive-standbyredundancytype.

{NODE|RG}

Theparameter"priority"definesthepolicyrulepriorityvalue. 1..500
Itistheorderinwhichtherulesareapplied.Ahighervalue
meanslowerpriority.Prioritycanonlybeusedwithpassor
discardrules.

NA

NA

Thevaluerangeis[1..500]andthedefaultis10.

protocol

src-addr

Theparameter"protocol"definesprotocolforthepolicyrule
selector.Aninteger[0..255]or"any","udp","tcp","icmp",or
"icmp6".Thevalue'0'or'any'meansthatanyprotocolis
applied.

0..255

NA

Theparameter"src-addr"definestheip-addressoripsubnet/maskwhere

IPv4/IPv6addressor
subnet/mask

NA

ip-address:IPv4orIPv6addresswithoutamask.
ip-subnet/mask:IPv6orIPv6networkaddresswithamask.
Themaskcanvaryfrom1to32foranIPv4addressand1
to128foranIPv6address,exceptforsubnets0.0.0.0,::,or
0:0:0:0:0:0:0:0itmustbe0.
Ifip-addresswithoutmaskisused,theIDtypeusedinIKE
negotiationIPSecphasewillbeaddressinsteadofsubnet
type.

374

Issue:03B

MulticontrollerRNCSCLICommands

Table484

SCLICommands

ipsecrule<rule-name>(Cont.)

src-port

vpn

Theparameter"src-port"allowsyoutoconfigurethesource 0..65535
portforpolicyorruleselector.Portnumbermayonlybe
givenforprotocolsforwhichitisrelevant.Thedefaultis"0"
andthismeansthatanysourceportisappliediftheprotocol
supportsports.Italsomeansnoportiftheprotocoldoesnot
supportports.

NA

Theparameter"vpn"definesthenameofthevirtualprivate
network(VPN)objectreferredbythepolicyrule.

NA

Command

thenameoftheVPN
objectthatthepolicy
ruleobjectrefersto
Dependency
None

add ipsec rule <rule-name> {owner <owner-value> src-addr <srcaddr-value> dst-addr <dst-addr-value> protocol <protocol_value>
action <action-value> [vpn <vpn-value>]? [src-port <src-portvalue>]? [dst-port <dst-port-value>]? [priority <priorityvalue>]? [mode <mode-value>]? [direction <dir-value>]?}

2.14.2.3
Table485

ipsec rule all

ipsecruleall

Description
ThiscommandshowsalltheIPSecpolicyruleconfiguration.
Parameter

Hint

Command

Range

Default

Dependency
None

show ipsec rule all

2.14.2.4
Table486

ipsec rule config

ipsecruleconfig

Description
ThiscommandshowstheIPSecpolicyrule(s)configurationbasedonagivenfilter.Itispossibletospecifywhichruleto
showbyspecifyingitsname(name),virtualprivatenetwork(vpn)ortheowneroftheIPSectunnel(owner).
Parameter

Hint

Range

Default

Theparameter"name"definesthenameoftheexisting
IPSecpolicyrule.

thenameoftheIPsec
policyrule

NA

name

Issue:03B

375

SCLICommands

Table486
owner

vpn

MulticontrollerRNCSCLICommands

ipsecruleconfig(Cont.)
Theparameter"owner"definestheowneroftheIPSec
tunnel.Itmustbeeitherthenameofanodethathas
standaloneIPSecdeployment,orthenameofarecovery
groupthatisofactive-standbyredundancytype.

{NODE|RG}

NA

Theparameter"vpn"definesthenameofthevirtualprivate
network(VPN)objectreferredbythepolicyrule.

thenameoftheVPN
objectthatthepolicy
ruleobjectrefersto

NA

Command

Dependency
None

show ipsec rule config {owner <owner_value> [name <namevalue>]? [vpn <vpn-value>]?}

2.14.3 ipsec template


Table487

ipsectemplate

Description
add
Thiscommandaddsconfigurationtemplate.Atemplatecanbeinternetkeyexchangeprotocolversion1(IKEv1)orinternet
keyexchangeprotocolversion2(IKEv2)specific.BothtemplatescontainagroupofcommonIKEprotocolspecificsettings
suchasauthentication,encryption,andothers.Attributesofthetemplateareconnectionindependentandcanbeshared
byseveralvirtualprivatenetworks(VPNs).AtemplatecannotberemovedfromtheconfigurationifitisreferredbyVPN
objects.
delete
ThiscommanddeletestheIPSectemplateconfiguration.Atemplatecannotberemovedfromtheconfigurationifis
referredbythevirtualprivatenetwork(VPN)object(s).
show
ThiscommandshowstheconfiguredIPSectemplate(s).
Parameter

Hint

Command

Range

Default

Dependency
None

add ipsec template ikev1 <template-name> {owner <owner-value>


ike-enc <ike-enc-value> ike-hash <ike-hash-value> ike-auth
<ike-auth-value> ike-dh-group <ike-dh-group-value> ike-lifetime
<ike-lifetime-value> enc <enc-value> lifetime <lifetime-value>
auth <auth-value> [mode <mode-value>]? [pfs-group <pfsgroupvalue>]? [dpd-delay <dpd-delay-value>]? [dpd-max-fail <dpd-maxfail-value>]? [dpd-retry <dpd-retry-value>]?}
None
add ipsec template ikev2 <template-name> {owner <owner-value>
ike-enc <ike-enc-value> ike-hash <ike-hash-value> ike-auth
<ike-auth-value> ike-dh-group <ike-dh-group-value> ike-lifetime

376

Issue:03B

MulticontrollerRNCSCLICommands

Table487

SCLICommands

ipsectemplate(Cont.)

<ike-lifetime-value> enc <enc-value> lifetime <lifetime-value>


auth <auth-value> [dpd-action <dpd-action-value>]? [dpd-delay
<dpd-delay-value>]?}
None
delete ipsec template ikev1 <name> {owner <owner-value>}
None
delete ipsec template ikev2 <name> {owner <owner-value>}
None
show ipsec template ikev1 all
None
show ipsec template ikev1 config {[owner <owner-value>]? [name
<name-value>]? [ike-auth <ike-auth-value>]?}
None
show ipsec template ikev2 all
None
show ipsec template ikev2 config {[owner <owner-value>]? [name
<name-value>]? [ike-auth <ike-auth-value>]?}

2.14.3.1
Table488

ipsec template ikev1

ipsectemplateikev1

Description
add
Thiscommandaddsconfigurationtemplateforconnectionsusinginternetkeyexchangeprotocolversion1(IKEv1).
delete
Thiscommanddeletestheinternetkeyexchangeprotocolversion1(IKEv1)configurationtemplate.
show
ThiscommandshowstheconfiguredIPSectemplate(s)forinternetkeyexchangeprotocolversion1(IKEv1).
Parameter

Hint

Command

Range

Default

Dependency
None

add ipsec template ikev1 <template-name> {owner <owner-value>


ike-enc <ike-enc-value> ike-hash <ike-hash-value> ike-auth
<ike-auth-value> ike-dh-group <ike-dh-group-value> ike-lifetime
<ike-lifetime-value> enc <enc-value> lifetime <lifetime-value>
auth <auth-value> [mode <mode-value>]? [pfs-group <pfsgroup-

Issue:03B

377

SCLICommands

Table488

MulticontrollerRNCSCLICommands

ipsectemplateikev1(Cont.)

value>]? [dpd-delay <dpd-delay-value>]? [dpd-max-fail <dpd-maxfail-value>]? [dpd-retry <dpd-retry-value>]?}


None
delete ipsec template ikev1 <name> {owner <owner-value>}
None
show ipsec template ikev1 all
None
show ipsec template ikev1 config {[owner <owner-value>]? [name
<name-value>]? [ike-auth <ike-auth-value>]?}

2.14.3.1.1
Table489

ipsec template ikev1 <name>

ipsectemplateikev1<name>

Description
Thiscommanddeletestheinternetkeyexchangeprotocolversion1(IKEv1)configurationtemplate.
Parameter

owner

Hint

Range

Default

Theparameter"owner"definestheowneroftheIPSec
tunnel.Itmustbeeitherthenameofanodethathas
standaloneIPSecdeployment,orthenameofarecovery
groupthatisofactive-standbyredundancytype.

{NODE|RG}

NA

Command

Dependency
None

delete ipsec template ikev1 <name> {owner <owner-value>}

2.14.3.1.2
Table490

ipsec template ikev1 <template-name>

ipsectemplateikev1<template-name>

Description
Thiscommandaddsinternetkeyexchangeprotocolversion1(IKEv1)configurationtemplatetotheIPSecconfiguration.
TemplatecontainsagroupofcommonIKEprotocolspecificsettingssuchasauthentication,encryptionandothers.
AttributesofthetemplateareconnectionindependentandcanbesharedbyseveralVPNobjects.
Parameter

378

Hint

Range

Default

Issue:03B

MulticontrollerRNCSCLICommands

Table490

ipsectemplateikev1<template-name>(Cont.)

auth

dpd-delay

dpd-max-fail

dpd-retry

enc

ike-auth

ike-dh-group

ike-enc

ike-hash

ike-lifetime

Issue:03B

SCLICommands

Theparameter"auth"definesauthenticationalgorithmused
forinternetkeyexchange(IKE)negotiationinIPSecphase.

authentication
algorithmforIKE
negotiationIPsec
phase

NA

Theparameter"dpd-delay"definesthedelay(inseconds)
delayinsecondsfor
betweentwodeadpeerdetection(DPD)alivenessrequests. IKEv1DeadPeer
Donotspecifydpd-max-failanddpd-retryvalueswhendpd- Detection(DPD)
delayis0,asitdisablestheDPDmonitoring.Thevalue
rangeis[0..4294967295].

NA

Theparameter"dpd-max-fail"definesthemaximumnumber
ofalivenessrequest(withoutreply)beforeconsideringthe
peerisdead.Thevaluerangeis[1..4294967295]andthe
defaultvalueis5.

maxfailurevaluefor
IKEv1DPD

NA

Theparameter"dpd-retry"definesthetimeout(inseconds)
afterwhichadeadpeerdetection(DPD)alivenessis
consideredtohavefailed.Thevaluerangeis
[1..4294967295]andthedefaultvalueis5.

retrytimeoutin
secondsforIKEv1
DPD

NA

Theparameter"enc"definesencryptionalgorithmusedfor
internetkeyexchange(IKE)negotiationinIPSecphase.

encryptionalgorithm
forIKEnegotiation
IPsecphase

NA

Theparameter"ike-auth"definesthemethodusedfor
authenticationbetweenthepeersduringinternetkey
exchange(IKE)phaseofIKEnegotiation.

authenticationtypefor
IKEnegotiationIKE
phase

NA

Theparameter"ike-dh-group"(Diffie-HellmangroupforIKE
phase)definesthegroupofDiffie-Hellmanexponentiations
forinternetkeyexchange(IKE)phase.Groupcanbeoneof
thefollowing:modp768,modp1024,modp1536,or
modp2048.However,anumericalform(1,2,5,or14)is
usedtoselectthegroup.

Diffie-Hellmangroup
NA
forIKEnegotiationIKE
phase

Theparameter"ike-enc"definestheencryptionalgorithm
usedforinternetkeyexchange(IKE)negotiationinIKE
phase.

encryptionalgorithm
NA
forIKEnegotiationIKE
phase

Theparameter"ike-hash"definesthehashalgorithmused
forinternetkeyexchange(IKE)negotiationinIKEphase.

hashalgorithmforIKE
negotiationIKEphase

NA

Theparameter"ike-lifetime"definesthelifetime(inseconds) keylifetimeinseconds NA
oftheauthenticationkeys,determininghowlonganinternet forIKEnegotiationIKE
keyexchange(IKE)securityassociation(SA)wouldbe
phase
used.Thevaluerangeis[60..4294967295].

379

SCLICommands

Table490

MulticontrollerRNCSCLICommands

ipsectemplateikev1<template-name>(Cont.)
Theparameter"lifetime"definesinternetkeyexchange(IKE) keylifetimeinseconds NA
negotiationIPSecphasekeylifetime(inseconds)ofthe
forIKEnegotiation
authenticationkeys.IPSecphasekeylifetimemustnotbe
IPsecphase
longerthanIKEphasekeylifetime.Thevaluerangeis
[60..4294967295]

lifetime

mode

owner

pfs-group

Theparameter"mode"definestheinternetkeyexchange
IKEprotocolmodeforthetemplate.TheIKEprotocolmode
canbeeithermainoraggressiveforIKEv1.Mainmode
protectstheidentityofthepeerwhileinaggressivemode
theIPSecnegotiationisfaster.

IKEv1exchange
protocolmode

NA

Theparameter"owner"definestheowneroftheIPSec
tunnel.Itmustbeeitherthenameofanodethathas
standaloneIPSecdeployment,orthenameofarecovery
groupthatisofactive-standbyredundancytype.

{NODE|RG}

NA

Theparameter"pfs-group"definesPFS(PerfectForward
Security)Diffie-HellmangroupforIPSecIKEnegotiation
phase.ItdescribesthegroupofDiffie-Hellman
exponentiations.Differentgroupsprovidedifferentlengthsof
baseprimenumbersthatareusedfortheauthentication
process.Groupcanbeoneofthefollowing:modp768,
modp1024,modp1536,ormodp2048.However,anumerical
form(1,2,5,or14)isusedtoselectthegroup.

PFSDiffie-Hellman
groupforIKE
negotiationIPsec
phase

NA

Command

Dependency
None

add ipsec template ikev1 <template-name> {owner <owner-value>


ike-enc <ike-enc-value> ike-hash <ike-hash-value> ike-auth
<ike-auth-value> ike-dh-group <ike-dh-group-value> ike-lifetime
<ike-lifetime-value> enc <enc-value> lifetime <lifetime-value>
auth <auth-value> [mode <mode-value>]? [pfs-group <pfsgroupvalue>]? [dpd-delay <dpd-delay-value>]? [dpd-max-fail <dpd-maxfail-value>]? [dpd-retry <dpd-retry-value>]?}

2.14.3.1.3
Table491

ipsec template ikev1 all

ipsectemplateikev1all

Description
Thiscommandshowsalltemplate(s)configurationforinternetkeyexchangeprotocolversion1(IKEv1).
Parameter

Hint

Command

Range

Default

Dependency
None

show ipsec template ikev1 all

380

Issue:03B

MulticontrollerRNCSCLICommands

2.14.3.1.4
Table492

SCLICommands

ipsec template ikev1 config

ipsectemplateikev1config

Description
Thiscommandshowsallthetemplate(s)configurationforinternetkeyexchangeprotocolversion1(IKEv1).Template
configurationscanbefilteredbasedonIKEauthenticationtype(ike-auth),nameofthetemplate(name),orownerof
template(owner).
Parameter

Hint

Range

Default

Theparameter"ike-auth"definesthemethodusedfor
authenticationbetweenthepeersduringinternetkey
exchange(IKE)phaseofIKEnegotiation.

authenticationtypefor
IKEnegotiationIKE
phase

NA

ike-auth

name

owner

Theparameter"name"definesthenameofthetemplatethat thenameofthe
thevirtualprivatenetwork(VPN)connectionreferstousing
templateobjectthat
IKEv1.
theVPNconnection
refersto

NA

Theparameter"owner"definestheowneroftheIPSec
tunnel.Itmustbeeitherthenameofanodethathas
standaloneIPSecdeployment,orthenameofarecovery
groupthatisofactive-standbyredundancytype.

NA

Command

{NODE|RG}

Dependency
None

show ipsec template ikev1 config {[owner <owner-value>]? [name


<name-value>]? [ike-auth <ike-auth-value>]?}

2.14.3.2
Table493

ipsec template ikev2

ipsectemplateikev2

Description
add
Thiscommandaddsconfigurationtemplateforconnectionsusinginternetkeyexchangeversion2(IKEv2)protocol.
delete
Thiscommanddeletestheinternetkeyexchangeprotocolversion2(IKEv2)configurationtemplates.
show
ThiscommandshowstheconfiguredIPSectemplate(s)forinternetkeyexchangeprotocolversion2(IKEv2).
Parameter

Hint

Command

Range

Default

Dependency
None

add ipsec template ikev2 <template-name> {owner <owner-value>


ike-enc <ike-enc-value> ike-hash <ike-hash-value> ike-auth

Issue:03B

381

SCLICommands

Table493

MulticontrollerRNCSCLICommands

ipsectemplateikev2(Cont.)

<ike-auth-value> ike-dh-group <ike-dh-group-value> ike-lifetime


<ike-lifetime-value> enc <enc-value> lifetime <lifetime-value>
auth <auth-value> [dpd-action <dpd-action-value>]? [dpd-delay
<dpd-delay-value>]?}
None
delete ipsec template ikev2 <name> {owner <owner-value>}
None
show ipsec template ikev2 all
None
show ipsec template ikev2 config {[owner <owner-value>]? [name
<name-value>]? [ike-auth <ike-auth-value>]?}

2.14.3.2.1
Table494

ipsec template ikev2 <name>

ipsectemplateikev2<name>

Description
Thiscommanddeletestheinternetkeyexchangeprotocolversion2(IKEv2)configurationtemplates.
Parameter

owner

Hint

Range

Default

Theparameter"owner"definestheowneroftheIPSec
tunnel.Itmustbeeitherthenameofanodethathas
standaloneIPSecdeployment,orthenameofarecovery
groupthatisofactive-standbyredundancytype.

{NODE|RG}

NA

Command

Dependency
None

delete ipsec template ikev2 <name> {owner <owner-value>}

2.14.3.2.2
Table495

ipsec template ikev2 <template-name>

ipsectemplateikev2<template-name>

Description
AddnewConfigurationtemplateforconnectionsusingIKEv2protocol.IKEtemplatecontainsagroupofcommonsettings
forconnectionandIKEprotocolspecificsettingssuchasauthentication,encryptionandothers.Attributesofthetemplate
areconnectionindependentand