Download - NN10602-013_04.03_C20R18_CommandRef.pdf

C20 Converged Softswitch

Command Reference —GENWare-based platformRelease: C20 R18Document Revision: 04.03

Provides a comprehensive reference for all the C20-specific commandsin the GENWare platform command line interface and describes thecommand privileges and C20 role associated with each GENWarecommand group.

www.genband.com

NN10602-013

C20 Converged SoftswitchRelease: C20 R18Publication: NN10602-013Document status: StandardDocument release date: 30 September 2014

Copyright © 2010-2014 GENBAND. All rights reserved. Use of this documentation and its contents is subject tothe terms and conditions of the applicable end user or software license agreement, right to use notice, and allrelevant copyright protections.

GENBAND, the GENBAND corporate logo and tagline, and certain of GENBAND's product and solution namesare registered trademarks of GENBAND and its affiliates.

While the information in this document is believed to be accurate and reliable, except as otherwise expresslyagreed to in writing, GENBAND AND/OR ITS LICENSORS PROVIDES THIS DOCUMENT "AS IS" WITHOUTWARRANTY OR CONDITION OF ANY KIND, EITHER EXPRESS OR IMPLIED. The information and/or productsdescribed in this document are subject to change without notice.

THE INFORMATION CONTAINED HEREIN IS THE PROPERTY OF GENBAND OR ITS LICENSORS ANDMUST NOT BE DISCLOSED, OTHER THAN TO EMPLOYEES OF GENBAND OR CUSTOMERS WITH NEED-TO-KNOW, WITHOUT THE PRIOR WRITTEN CONSENT OF GENBAND OR ITS LICENSORS. THEINFORMATION MUST NOT BE DISCLOSED TO SUBCONTRACTORS OR REGULATORY AUTHORITIES. GENBAND MUST BE NOTIFIED OF ANY REQUEST OR ORDER FOR DISCLOSURE PRIOR TO SUCHDISCLOSURE.

Software and documentation owned by or under license with Nortel Networks included in this Release or in anydocument provided with this Release is Copyright © 2010 Nortel Networks or its licensors. All rights reserved. Useof this software and/or documentation and its contents is subject to the terms and conditions of the applicable enduser or software license agreement, right to use notice, and all relevant copyright protections.

ContentsNew in this Document 5 Introduction 7 C20-specific commands 9C20 management module commands 9

c20mm cbmg app-config config 9c20mm cbmg app-config show 10c20mm cbmg app-status bsy 10c20mm cbmg app-status offl 10c20mm cbmg app-status rts 10c20mm cbmg app-status show 11c20mm cbmg audio ams add 11c20mm cbmg audio ams archive restore 11c20mm cbmg audio ams archive show 11c20mm cbmg audio ams audit 12c20mm cbmg audio ams delete 12c20mm cbmg audio ams show det 12c20mm cbmg audio segment add 12c20mm cbmg audio segment delete 12c20mm cbmg audio segment replace 13c20mm cbmg core show 13c20mm cmtg app-config 13c20mm cmtg app-status 13c20mm cmtg bpt 14C20mm cmtg gwcuptool 14c20mm cmtg pde 14

GWC commands 15gwc gwc-em-config add 15gwc gwc-em-config delete 15gwc gwc-em-config modify 15gwc gwc-em-config show 16gwc gwc-sg-config add 16gwc gwc-sg-config delete 16gwc gwc-sg-config modify 17gwc gwc-sg-config show 17gwc gwc-sg-mtce cold-swact 17gwc gwc-sg -mtce login 18

IPfilter provisioning commands 18ipfilter device add 18

3

30 September 2014 Command Reference — GENWare-based platform NN10602-013 04.03Copyright © 2010-2014 GENBAND. All Rights Reserved.

ipfilter device associate 19ipfilter device audit 20ipfilter device delete 20ipfilter device dissociate 20ipfilter device fix 20ipfilter device list 21ipfilter device modify 21ipfilter exception add 21ipfilter exception delete 22ipfilter exception list <pattern> 22ipfilter filterdb dump 22ipfilter filterdb query 22ipfilter filterdb report 23ipfilter global set 23ipfilter global show 23ipfilter profile list 23ipfilter profile list previous 25ipfilter subnet add 26ipfilter subnet modify 27ipfilter vr link 27ipfilter vr list 27ipfilter vr unlink 28

SOS agent commands 28sosagent vca add 28sosagent vca delete 29sosagent vca dpsync 29sosagent vca imgtest 29sosagent vca jam 29sosagent vca load 30sosagent vca lock 30sosagent vca login 30sosagent vca niikey 30sosagent vca rex 31sosagent vca show 31sosagent vca swact 31sosagent vca sync 31sosagent vca unjam 32sosagent vca unload 32sosagent vca unlock 32software product import 32

Command summary 33Attributes 34

SST commands 35sst sst-sg-config add 35sst sst-sg-config delete 36sst sst-sg-config modify 36sst sst-sg-config show 36sst sst-sg-maintenance cold-swact 37sst sst-sg-maintenance login 37

GENiUS CLI command privilege reference 39Summary of GENWare CLI commands and privileges 40

4

30 September 2014 C20 Converged Softswitch NN10602-013 04.03Copyright © 2010-2014 GENBAND. All Rights Reserved.

New in this DocumentThe following sections detail what’s new in C20 Converged SoftswitchCommand Reference — GENWare-based platform (NN10602-013).

• “Document revision 04.03” (page 5)

• “Document Revision 04.02” (page 5)

• “Document Revision 04.01” (page 6)

Document revision 04.03September 30, 2014

New featuresThe Audio Bundle Tool (ABT) supports management of audio files thatwere created with an Audio Provisioning System. Added new ABTcommands:

• “c20mm cbmg audio ams add” (page 11)

• “c20mm cbmg audio ams archive restore” (page 11)

• “c20mm cbmg audio ams archive show” (page 11)

• “c20mm cbmg audio ams audit” (page 12)

• “c20mm cbmg audio ams delete” (page 12)

• “c20mm cbmg audio ams show det” (page 12)

• “c20mm cbmg audio segment add” (page 12)

• “c20mm cbmg audio segment delete” (page 12)

• “c20mm cbmg audio segment replace” (page 13)

Document Revision 04.02July 29, 2014. C20 R18

Other changesReplaced instances of “CS2K” with “C20”

5


Document Revision 04.01June 12, 2014. C20 R18

New featuresGVM for CS2K : CMTg (380099)

The command C20mm cmtg gwcuptool has been added to the section“C20 management module commands” (page 9). See “C20mm cmtggwcuptool” (page 14).

Other changes• Rebranded product name A2 to EXPERiUS AS.

• Updates to command attributes. See “C20 management modulecommands” (page 9).

6 New in this Document


IntroductionThis document contains two sections.

• Section one provides a comprehensive reference for all the C20-specific commands in the GENWare platform command line interface.

• Section two provides the command privileges and C20 role associatedwith each GENWare command group.For a comprehensive list of all GENWare platform commands, seeGENiUS Command Reference (630–01236–01) .

7


8 Introduction


C20-specific commandsThis chapter provides a comprehensive reference for all C20-specificcommands, including command examples and attributes for eachcommand.

Navigation• “C20 management module commands” (page 9)

• “GWC commands” (page 15)

• “IPfilter provisioning commands” (page 18)

• “SOS agent commands” (page 28)

• “SST commands” (page 35)

C20 management module commandsThis section contains the following cli command definitions.

• “c20mm cbmg app-config config” (page 9)

• “c20mm cbmg app-config show” (page 10)

• “c20mm cbmg app-status bsy” (page 10)

• “c20mm cbmg app-status offl” (page 10)

• “c20mm cbmg app-status rts” (page 10)

• “c20mm cbmg app-status show” (page 11)

• “c20mm cbmg core show” (page 13)

• “c20mm cmtg app-config” (page 13)

• “c20mm cmtg app-status” (page 13)

• “c20mm cmtg bpt” (page 14)

• “C20mm cmtg gwcuptool” (page 14)

• “c20mm cmtg pde” (page 14)

c20mm cbmg app-config configThis command allows you to configure a cbmg application.

9


Command summaryc20mm cbmg app-config config

Attributes Description<app-num> The number of the application to be configured.

c20mm cbmg app-config showDisplays the configuration status of all cbmg applications.

Command summaryc20mm cbmg app-config show

Attributes DescriptionNone N/A

c20mm cbmg app-status bsyPuts an application in a busy state.

Command summaryc20mm cbmg app-status bsy

Attributes Description<app-num> The number of the application to be busied.

c20mm cbmg app-status offlPuts an application in an offline state.

Command summaryc20mm cbmg app-status offl

Attributes Description<app-num> The number of the application to be taken offline.

c20mm cbmg app-status rtsReturns an application to service.

Command summaryc20mm cbmg app-status rts

Attributes Description<app-num> The number of the application to be returned to service.

10 C20-specific commands


c20mm cbmg app-status showDisplays the status of all cbmg applications.

Command summaryc20mm cbmg app-status show


c20mm cbmg audio ams addAdds an AMS, using the Audio Bundle Tool.

Command summaryc20mm cbmg audio ams add <AMS name> <file location>

Attribute Description<AMS name> The name you want to give the new AMS

<file location> The full path to the folder that contains the audio files for thisAMS to retrieve and place in its working folder.

c20mm cbmg audio ams archive restoreRestores an AMS’s audio file from the archive.

Command summaryc20mm cbmg audio ams archive restore <AMS name> <archive #>

Attribute Description<AMS name> The name of the AMS

<archive #> The number of the archive you want to restore. Find anarchive’s number by running the c20mm cbmg audio amsarchive show command.

c20mm cbmg audio ams archive showList the audio file archives for the specified AMS.

Command summaryc20mm cbmg audio ams archive show <AMS name>

Attribute Description<AMS name> The name of the AMS.

C20 management module commands 11


c20mm cbmg audio ams auditRun an audio file audit on an AMS that was added using the Audio BundleTool.

Command summaryc20mm cbmg audio ams audit <AMS name>


c20mm cbmg audio ams deleteDelete an AMS.

Command summaryc20mm cbmg audio ams del <AMS name>


c20mm cbmg audio ams show detList details of existing AMSs.

Command summaryc20mm cbmg audio ams show det

Attribute DescriptionNone N/A

c20mm cbmg audio segment addAdd an audio segment to an existing AMS.

Command summaryc20mm cbmg audio segment add <AMS name> <path and file>


<path and file> The full path and filename of the audio segment to be added.

c20mm cbmg audio segment deleteDelete a specified audio segment from an AMS.



Command summaryc20mm cbmg audio segment delete <AMS name> <audid>


<audid> The AUDID of the audio segment to delete.

c20mm cbmg audio segment replaceReplace an audio segment on an AMS with another, existing audiosegment.

Command summaryc20mm cbmg audio segment replace <AMS name> <path and file><audid>


<path and file> The full path and filename of the new audio segment to addto the AMS.

<audid> The AUDID of the segment you want to replace with the newaudio segment.

c20mm cbmg core showDisplays communication status with the core.

Command summaryc20mm cbmg core show


c20mm cmtg app-configAccesses the SESM configuration interface.

Command summaryc20mm cmtg app-config


c20mm cmtg app-statusDisplays the status of cmtg applications.

C20 management module commands 13


Command summaryc20mm cmtg app-status

Attributes Description<all> Shows all applications.

<ddmsproxy> Shows ddmsproxy applications.

(qca) (qca will be active in a later release.)

<sesm> Shows sesm applications.

<sam21em> Shows sam21em application

c20mm cmtg bptAccesses the Batch Provisioning Tool interface.

Command summaryc20mm cmtg bpt


C20mm cmtg gwcuptoolAccesses the GWC Upgrade Tool (GWCUpTool), which is used to upgradeGWCs on SAM21.

This command is supported for GWCs on SAM21 in a C20 on XA-Core orCompact network. It is not supported for GWCs on ATCA blade in a C20network.

Command summaryC20mm cmtg gwcuptool


c20mm cmtg pdeStarts the provisioning data export client for G2/G6.

Command summaryc20mm cmtg pde




GWC commandsThis section contains the following cli command definitions.

• “gwc gwc-em-config add” (page 15)

• “gwc gwc-em-config delete” (page 15)

• “gwc gwc-em-config modify” (page 15)

• “gwc gwc-em-config show” (page 16)

• “gwc gwc-sg-config add” (page 16)

• “gwc gwc-sg-config delete” (page 16)

• “gwc gwc-sg-config modify” (page 17)

• “gwc gwc-sg-config show” (page 17)

• “gwc gwc-sg-mtce cold-swact” (page 17)

• “gwc gwc-sg -mtce login” (page 18)

gwc gwc-em-config addAdds a GWC element manager.

Command summarygwc gwc-em-config add

Attributes Description<em-id> The element manager ID.

<gwc-em-ip> The element manager ip address.

<iems-em-ip> The IEMS element manager ip address.

gwc gwc-em-config deleteDeletes a GWC element manager.

Command summarygwc gwc-em-config delete


gwc gwc-em-config modifyModifies a GWC element manager.

Command summarygwc gwc-em-config modify

GWC commands 15



<gwc-em-ip> The element manager ip address.

<iems-em-ip> The IEMS element manager ip address.

gwc gwc-em-config showDisplays details of defined gwc element manager.

Command summarygwc gwc-em-config show

Attributes Descriptionall|<em-id> The element manager IDs.

Sub-attributes

brief keyword

compact keyword

detailed keyword

where keyword

gwc gwc-sg-config addAdds a gwc service group.

Command summarygwc gwc-sg-config add

Attributes Description<sg-name> The name of the service group.

Sub-attributes

brief keyword

compact keyword

detailed keyword

where keyword

<subnet> The pool name

<active-ip> The service group IP address

gwc gwc-sg-config deleteDeletes a gwc service group.



Command summarygwc gwc-sg-config delete


gwc gwc-sg-config modifyModifies a gwc service group.

Command summarygwc gwc-sg-config modify


<dns-ip-1|dns-ip-2|dns-ip-3|dns-ip-all|gwc-ip-act>

Keyword

<dns-ip-1> The DNS-1 IP address



<subnet> The pool-name

<active-ip> The service-group IP address

gwc gwc-sg-config showDisplays details of defined gwc service groups.

Command summarygwc gwc-sg-config show

Attributes Descriptionall|<sg-name> The names of the service groups.

gwc gwc-sg-mtce cold-swactSwitches activity between service units of a gwc service group.

Command summarygwc gwc-sg-mtce cold-swact


GWC commands 17


gwc gwc-sg -mtce loginLogs on to a GWC service group.

Command summarygwc gwc-sg -mtce login

Attributes Description<sg-name> The name of the service group. Requires password.

IPfilter provisioning commandsThis section contains the following cli command definitions.

• “ipfilter device add” (page 18)

• “ipfilter device associate” (page 19)

• “ipfilter device audit” (page 20)

• “ipfilter device delete” (page 20)

• “ipfilter device dissociate” (page 20)

• “ipfilter device fix” (page 20)

• “ipfilter device list ” (page 21)

• “ipfilter device modify” (page 21)

• “ipfilter exception add” (page 21)

• “ipfilter exception delete” (page 22)

• “ipfilter exception list <pattern>” (page 22)

• “ipfilter filterdb dump” (page 22)

• “ipfilter filterdb query” (page 22)

• “ipfilter filterdb report” (page 23)

• “ipfilter global set” (page 23)

• “ipfilter global show” (page 23)

• “ipfilter profile list” (page 23)

• “ipfilter subnet add” (page 26)

• “ipfilter subnet modify” (page 27)

• “ipfilter vr link” (page 27)

• “ipfilter vr list” (page 27)

• “ipfilter vr unlink” (page 28)

ipfilter device addAdds a device.



Command summaryipfilter device add external <device-label><profilename><vrlabel><ipaddress>subnet null[baseport] [force]

ipfilter device add internal <device-label><profilename><vrlabel><ipaddress>subnet null[baseport] [force]

Attributes DescriptionExternal--For devices outside the ATCA chassis.

<device-label> The unique name of the device.

<profile name> The device profile to use

<vrlabel> The name of the VR

<ipaddress> The device's IP address

<subnetaddr> The subnet Ip address

<subnetmasklength> The subnet mask length

[baseport] The base port to add to port numbers in the profile

[force] n/a

Internal--For devices within the ATCA chassis.

<profile name> The device profile to use


<ipaddress> The device's IP address

<subnetaddr> The subnet Ip address


[baseport] The base port to add to port numbers in the profile

[force] n/a

<device-label> The unique name of the device.

ipfilter device associateAssociates one or more devices.

Command summaryipfilter device associate <device 1><device 2>

IPfilter provisioning commands 19


Attributes Description<device 1> The name of device–1

<device 2> The name of device–2

ipfilter device auditAudits one or more devices.

Command summaryipfilter device audit

Attributes Description<device-label> The unique name of the device.

ipfilter device deleteDeletes one or more devices.

Command summaryipfilter device delete


ipfilter device dissociatedisassociates one or more devices.

Command summaryipfilter device dissociate <device 1><device 2>

Attributes Description<device 1> The name of device–1

<device 2> The name of device–2

ipfilter device fixFixes one or more devices.

Command summaryipfilter device fix




ipfilter device listLists devices.

Command summaryipfilter device list

Attributes Description<pattern> Option string that defines the name of a device or a pattern that

matches one or more devices. Wildcards "*" can be used. Thepattern is case sensitive.

ipfilter device modifyModifies a device.

Command summaryipfilter device modify <device-label><ipaddress>


<ipaddress> The device’s IP address

ipfilter exception addAdds port exceptions.

Command summaryipfilter exception add <exception-label><ULP><destAddress><masklength><sourcePort><destPort><vrLabel>bypass|discard subnet<subnetaddr><subnetmasklength>

Attributes Description<exception-label> The unique name of the exception

<ULP> Upper Layer Protocol (tcp, udp, etc.)

<destAddress> Tthe destination IP address

<masklength> Tthe mask length

sourcePort> The source port

<destPort> The destination port


bypass|discard keyword

subnet keyword



Attributes Description<subnetaddr> The subnet IP address


ipfilter exception deleteDeletes port exceptions.

Command summaryipfilter exception delete

Attributes Description<exception-label> The label for the exception to be deleted.

ipfilter exception list <pattern>Lists port exceptions.

Command summaryipfilter exception list <pattern>

Attributes Description<pattern> Option string that defines the name of an exception or a pattern

that matches one or more exceptions. Wildcards "*" can be used.The pattern is case sensitive.

ipfilter filterdb dumpDumps the database.

Command summaryipfilter filterdb dump


ipfilter filterdb queryQueries the database.

Command summaryipfilter filterdbquery<ulp><sourceip><sourceport><destip><destport><vrid>[verbose]



Attributes Description<ulp> The Upper Layer Protocol (tcp, udp, etc.)

<sourceip> The source IP address

<sourceport> The source port

<destip> The destination IP address

<destport> The destination port

<vrid> The VR ID

[verbose] Optional keyword to get a verbose query

ipfilter filterdb reportDisplays linked interfaces/VRs, devices, and exceptions.

Command summaryipfilter filterdb report


ipfilter global setSets the global policy value.

Command summaryipfilter global set

Attributes Descriptionallow To remove global deny policy.

restrict To install/apply global deny policy.

ipfilter global showDisplays the current global policy value (allow|restrict).

Command summaryipfilter global show


ipfilter profile listLists the supported device/subnet profiles.



Command summaryipfilter profile list <profilename>[verbose]

Attributes Description<profilename> Profile name or pattern with a trailing '*'.

[verbose] keyword to get additional info

Supported device/subnet profiles:

A2-ApplMan-PBXcomm-callp

EXPERiUS AS Application Manager for PBXCommunicator

A2-ApplMan-TR87-callp EXPERiUS AS Application Manager for TR87

A2-OAM For opening OAM flows from OSS to EXPERiUSAS NEs

A2-PA EXPERiUS AS Personal Agent profile

A2-SESM-MH-callp EXPERiUS AS sip multihomed - allows SIP overudp, tcp or tls and GCP

A2-SESM-extPA-callp Flows from an external PA to the EXPERiUS ASSESM - using PA baseport

A2-SIP-callp EXPERiUS AS sip lines - allows SIP over udp, tcpor tls

A2-SM-MH-OAM EXPERiUS AS SM flows from a remote CMT usedin Multi-Homed configuration

A2-SM-NED EXPERiUS AS SM flows for NED

A2-SM-extPA1-callp Flows from an external PA to the EXPERiUS ASSM - using SM baseport

A2-SM-extPA2-callp Flows from an external PA to the EXPERiUS ASSM - using PA baseport

CA-callp Opens SCTP flows to the Call Agent

CBMG Opens OAM flows to CBMG

CMT-A2-Prov Opens flows from the local CMT to the remoteMulti-Homed EXPERiUS AS Prov

DM-OAM Opens OAM flows (SSH, NTP, HTTPS) to DataManager

DNS Opens flows to a DNS server

GENView-Manager Opens OAM flows (SSH, NTP, HTTPS) toGENView Manager (all components)

GWC-callp Opens GWC callp flows to GWC

NGW-OAM Opens OAM flows for NGW



Attributes DescriptionNGW-callp Opens routing protocols for NGW

NTP Opens flows from a NTP server

PS-callp Opens COPS flow from Policy server

RADIUS Opens Radius flows as a client or server

SP2000-OAM Opens OAM flows (SSH, SNMP) to SP2000

SP2000-callp Opens M3UA flows to SP2000

SST-OAM Opens OAM flows (SSH and HTTPS) to Sessionserver Trunks

SST-callp Opens SIP and ICMP flows to Session ServerTrunks

trusted-OAM Opens all flows from a given external node

trusted-callp Opens all flows from a given external node

ipfilter profile list previousPrevious keyword specifies that the command will list the profiles used inprevious releases that can't be used for new ipfilter command

Command summaryipfilter profile list previous <profilename> [verbose]

Attributes Description<profilename Profile name or pattern with a trailing '*'

[verbose] keyword to get additional information

Profile names that can be used when using the keyword previous:

• A2-SESM-extApplMan-callp

• A2-SM-NED-OAM

• A2-SM-NED-callp

• A2-SM-extApplMan-callp

• A2E-MAS-callp

• A2E-OAM

• A2E-PA-OAM

• A2E-lines-callp

• CA-ACD-callp

• CA-CCMIS-callp



• CA-LI-callp

• CA-SS7-callp

• CA-VMS-callp

• CBM-OAM

• DM-RADIUS-OAM

• DNS-OAM

• DNS-callp

• GWC-AllTypes-callp

• GWC-AllTypes16-callp

• GWC-Audio-RMGC-callp

• GWC-Audio-callp

• GWC-GCP-callp

• GWC-H323-callp

• GWC-LgLines-callp

• GWC-PS-callp

• GWC-SmLines-callp

• GWC-Trunk-callp

• GWC-TrunksLinesAudio-callp

• NTP-OAM

• RADIUS-OAM

• SPFS-OAM

• SST-OCS-callp

• SST-SIP-SCTP-callp

• SST-SIP-TCP-callp

• SST-SIP-TLS-callp

• SST-SIP-UDP-callp

ipfilter subnet addAdds an internal or external subnet.

Command summaryipfilter subnet add internal <subnet-label><profilename><vrlabel><networknumber><masklength>subnet null [baseport] [force]



ipfilter subnet add external<subnet-label><profilename><vrlabel><networknumber><masklength>subnet null [baseport] [force]

Attributes Description<subnet-label> The unique name of the subnet

<profilename> The device profile to use


<networknumber> The subnet address of the subnet-label

<masklength> The subnet mask length of the subnet-label

<subnetaddr> The subnet IP address


[baseport] Tthe base port to add to port numbers in the profile

[force] n/a

ipfilter subnet modifyModifies the subnet.

Command summaryipfilter subnet modify <subnet-label><ipaddress><masklength>

Attributes Description<subnet label> The unique name of the subnet.

<ipaddress> The new subnet address of the subnet-label

<masklength> The new subnet mask length of the subnet-label

ipfilter vr linkLinks to a virtual router defined on the platform.

Command summaryipfilter vr link

Attributes Description<vr-label> The name of the VR (vr-label must contain "oam" or "callp").

<vr-id> The ID of the VR.

ipfilter vr listDisplays interfaces/virtual routers.



Command summaryipfilter vr list

Attributes Description[verbose] keyword

ipfilter vr unlinkUnlinks the specified interfaces/virtual routers.

Command summaryipfilter vr unlink

Attributes Description<vr-label> The name of the VR (vr-label must contain "oam" or "callp") to be

unlinked.

SOS agent commandsThis section contains the following cli command definitions relating to SOSagents.

• “sosagent vca add” (page 28)

• “sosagent vca delete” (page 29)

• “sosagent vca dpsync” (page 29)

• “sosagent vca imgtest” (page 29)

• “sosagent vca jam” (page 29)

• “sosagent vca load” (page 30)

• “sosagent vca lock” (page 30)

• “sosagent vca login” (page 30)

• “sosagent vca niikey” (page 30)

• “sosagent vca rex” (page 31)

• “sosagent vca show” (page 31)

• “sosagent vca swact” (page 31)

• “sosagent vca sync” (page 31)

• “sosagent vca unjam” (page 32)

• “sosagent vca unload” (page 32)

• “sosagent vca unlock” (page 32)

sosagent vca addProvisions the IRM address for the call agent service-group.



Command summarysosagent vca add

Attributes Description<sg-name> The service group name.

<activeirm ipv4 address> The service group IP address.

sosagent vca deleteDe-provision a service group.

Command summarysosagent vca delete


sosagent vca dpsyncDrop synchronization between service-units.

Command summarysosagent vca dpsync


<dpsync-standby-restart-type> The type (i.e. warm|cold|reload|no-restart).

sosagent vca imgtestRun an image test on inactive SOS instance.

Command summarysosagent vca imgtest


<imgtest-standby-restart-type> The type (i.e. warm|cold|reload).

sosagent vca jamDisable swacting to the service unit.

Command summarysosagent vca jam

SOS agent commands 29



<su-number> The service unit number.

sosagent vca loadLoad the service-unit application software.

Command summarysosagent vca load



sosagent vca lockLocks a service unit.

Command summarysosagent vca lock



<force> keyword

sosagent vca loginAccess the call agent interface.

Command summarysosagent vca login


sosagent vca niikeyEnable or disable the SOS image to boot as inactive.

Command summarysosagent vca niikey



Attributes Description<sg-name> The service group name (enable|disable).

sosagent vca rexRun Routine EXercise on hardware and SOS image.

Command summarysosagent vca rex


sosagent vca showDisplay configuration and operational data for the call agent SG.

Command summarysosagent vca show

Attributes Descriptionall|<sg-name> The service group names (all).

Subattributes

brief keyword

compact keyword

detailed keyword

where keyword

sosagent vca swactSwitch activity between service units.

Command summarysosagent vca swact



force keyword

sosagent vca syncSynchronize service units.



Command summarysosagent vca sync


sosagent vca unjamRe-enable swacting to the service unit.

Command summarysosagent vca unjam


<su-number> unsigned integer, range (0-65535)

sosagent vca unloadUnload the service-unit application software.

Command summarysosagent vca unload



sosagent vca unlockUnlock a service unit.

Command summarysosagent vca unlock



software product importImports product files from either a DVD or through electronic softwaredistribution (ESD) and makes it available to apply.

Each command must be on a separate line.



Command summarysoftware product import dvd

software product import dvd sosagent pcl all directory<directory-string>

software product import dvd sosagent pcl all service-group<sg-name> <su-number> <disk> <volume>

software product import dvd sosagent pcl cm directory<directory-string>

software product import dvd sosagent pcl cm service-group<sg-name> <su-number> <disk> <volume>

software product import dvd sosagent pcl ms directory<directory-string>

software product import dvd sosagent pcl ms service-group<sg-name> <su-number> <disk> <volume>

software product import dvd sosagent nonres directory<directory-string>

software product import dvd sosagent nonres service-group<sg-name> <su-number> <disk> <volume>

software product import dvd sosagent pm all directory<directory-string>

software product import dvd sosagent pm loads directory<directory-string>

software product import dvd sosagent pm all service-group<sg-name> <su-number> <disk> <volume>

software product import dvd sosagent pm patches directory<directory-string>

software product import dvd sosagent pm loads service-group<sg-name> <su-number> <disk> <volume>

software product import dvd sosagent pm patches service-group<sg-name> <su-number> <disk> <volume>

software product import esd

software product import esd sosagent pcl cm directory<directory-string>



software product import esd sosagent pcl all directory<directory-string>

software product import esd sosagent pcl all service-group<sg-name> <su-number> <disk> <volume>

software product import esd sosagent pcl cm service-group<sg-name> <su-number> <disk> <volume>

software product import esd sosagent pcl ms directory<directory-string>

software product import esd sosagent pcl ms service-group<sg-name> <su-number> <disk> <volume>

software product import esd sosagent nonres directory<directory-string>

software product import esd sosagent nonres service-group<sg-name> <su-number> <disk> <volume>

software product import esd sosagent pm loads directory<directory-string>

software product import esd sosagent pm all directory<directory-string>

software product import esd sosagent pm all service-group<sg-name> <su-number> <disk> <volume>

software product import esd sosagent pm patches directory<directory-string>

software product import esd sosagent pm loads service-group<sg-name> <su-number> <disk> <volume>

software product import esd sosagent pm patches service-group<sg-name> <su-number> <disk> <volume>

AttributesAttribute Descriptioncm computing module

<directory-string> path to the directory to put the software, stringlength 1-131

<disk> sd00 or sd01 sosagent disk

dvd for importing software from digital video disk (dvd)



Attribute Descriptionesd for importing software from electronic software

delivery (esd)

ms message switch

ncl non-core load

nonres non-resident software

pcl product core load

pm peripheral module

<sg-name> service group name, string length 1-31

<su-number> service unit number, range 0-31

<volume> sosagent disk volume, string length 1-31

SST commandsThis section contains the following cli command definitions relating to SST.

• “sst sst-sg-config add” (page 35)

• “sst sst-sg-config delete” (page 36)

• “sst sst-sg-config modify” (page 36)

• “sst sst-sg-config show” (page 36)

• “sst sst-sg-maintenance cold-swact” (page 37)

• “sst sst-sg-maintenance login” (page 37)

sst sst-sg-config addAdds an SST service group.

Command summarysst sst-sg-config add


<subnet-name> The name of the subnet.

<ip-range> one of: 4 or 8

<active-ip ipv4 address> The active IP address.

<oamp-cert> The OAMP certificate name.

<oamp-keypair> The OAMP key pair name.

<sipgw-cert> The SIPGW certificate name.

<sipgw-keypair> The SIPGW key pair name.

SST commands 35


Attributes Description<web-proxy-ip> The web proxy IP address.

<provisioning tag> The provisioning tag.

sst sst-sg-config deleteDeletes an SST service group.

Command summarysst sst-sg-config delete


sst sst-sg-config modifyModifies an SST service group. Used to specify the new IP address andnew PKI certificates.

Command summarysst sst-sg-config modify


<subnet-name> The name of the subnet.

<ip-range> one of: 4 or 8

<active-ip ipv4 address> The active IP address.

<oamp-cert> The OAMP certificate name.

<oamp-keypair> The OAMP key pair.

<sipgw-cert> The SIPGW certificate name.

<sipgw-keypair> The SIPGW key pair.

<web-proxy-ip> The web proxy IP address.

<provisioning tag> The provisioning tag.

sst sst-sg-config showDisplays details of defined SST service group(s).

Command summarysst sst-sg-config show



Attributes Descriptionall|<sg-name> The service group name (all).

brief keyword

compact keyword

detailed keyword

where keyword

sst sst-sg-maintenance cold-swactSwitches activity between service units of an SST service group.

Command summarysst sst-sg-maintenance cold-swact


sst sst-sg-maintenance loginLog on to the SST.

Command summarysst sst-sg-maintenance login

Attributes Description<sg-name> The service group name (requires password).

active-unit service group active unit

inactive-unit service group inactive unit

ip-address ipv4address ddd.ddd.ddd.ddd (ddd in decimal 0-255). servicegroup ip address

unit0 service group unit 0

unit1 service group unit 1

SST commands 37


GENiUS CLI command privilegereference

This chapter summarizes the privileges and C20 role requirementsassociated with each GENWare CLI command group, entity and verb.Users must have the associated privilege and role in order to execute thecommand.

NavigationConsult the following tables to determine the required privileges and rolesfor entering GENWare CLI commands.

• “admin command privileges” (page 40)

• “aim command privileges” (page 41)

• “cli-session command privileges” (page 43)

• “filter command privileges” (page 43)

• “firmware command privileges” (page 46)

• “fm command privileges” (page 46)

• “GWC command privileges” (page 48)

• “hardware commands” (page 49)

• “health command privileges” (page 52)

• “ike - required privileges” (page 52)

• “ipfilter command privileges” (page 53)

• “interfaces- required privileges” (page 56)

• “keycode - required privileges” (page 59)

• “netsec - required privileges” (page 60)

• “networking - required privileges” (page 60)

• “pki command privileges” (page 62)

• “pm - required privileges” (page 63)

• “postgres - required privileges” (page 64)

39


• “recovery - required privileges” (page 65)

• “resource-profile command privileges” (page 66)

• “rex command privileges” (page 66)

• “routing - required privileges” (page 67)

• “security - required privileges” (page 71)

• “shell command privileges” (page 74)

• “software - required privileges” (page 74)

• “sosagent - required privileges” (page 79)

• “sst - required privileges” (page 80)

• “storage - required privileges” (page 81)

• “switching - required privileges” (page 81)

• “system command privileges” (page 84)

• “time commands - required privileges” (page 84)

• “vm-host command privileges” (page 85)

• “vm-instance command privileges” (page 86)

• “vm-profile command privileges” (page 86)

Summary of GENWare CLI commands and privileges

admin command privilegesCommandGroup

Entity Verb Privilege type Privilege required(one of …)

C20 Rolerequired (oneof …)

admin bulk-input start, stop oamplatform CONFIG_WRITE Adminmgcadmmgcrwmgcmtc

admin bulk-input show oamplatform CONFIG_READ Admin Basicmgcadmmgcrwmgcmtcmgcro

admin remote-hosts

add, modify,delete,password-change

oamplatform CONFIG_WRITECONFIG_ADMIN

Adminmgcadmmgcrwmgcmtc

40 GENiUS CLI command privilege reference


admin command privileges (cont'd)CommandGroup



admin remote-hosts

show oamplatform CONFIG_READCONFIG_WRITECONFIG_ADMIN

Admin Basicmgcadmmgcrwmgcmtcmgcro

admin schedule add, delete,update

oamplatform CONFIG_ADMIN Adminmgcadm

admin schedule show oamplatform CONFIG_ADMINCONFIG_READCONFIG_WRITE


aim command privilegesCommandGroup

Entity Verb Privilege type Privilege required(one of)

C20 Rolerequired(one of …)

aim geo enable oamplatform CONFIG_WRITEFAULT_WRITE


aim geo show oamplatform CONFIG_WRITEFAULT_READ


aim service-group

add oamplatform CONFIG_WRITEFAULT_WRITE


aim service-group

delete oamplatform CONFIG_WRITEFAULT_WRITE


aim service-group

modify oamplatform CONFIG_WRITEFAULT_WRITE


Summary of GENWare CLI commands and privileges 41


aim command privileges (cont'd)CommandGroup



aim service-group

show oamplatform CONFIG_WRITEFAULT_READ


aim service-instance



aim service-unit

add oamplatform CONFIG_WRITEFAULT_WRITE


aim service-unit

delete oamplatform CONFIG_WRITEFAULT_WRITE


aim service-unit

jam oamplatform CONFIG_WRITEFAULT_ADMIN

Adminmgcadm

aim service-unit

load oamplatform CONFIG_WRITEFAULT_WRITE


aim service-unit

lock oamplatform CONFIG_WRITEFAULT_ADMIN

Adminmgcadm

aim service-unit

modify oamplatform CONFIG_WRITEFAULT_WRITE


aim service-unit



aim service-unit

shutdown oamplatform CONFIG_WRITEFAULT_ADMIN

Adminmgcadm

aim service-unit

swact oamplatform CONFIG_WRITEFAULT_ADMIN

Adminmgcadm



aim command privileges (cont'd)CommandGroup



aim service-unit

unjam oamplatform CONFIG_WRITEFAULT_ADMIN

Adminmgcadm

aim service-unit

unload oamplatform CONFIG_WRITEFAULT_WRITE


aim service-unit

unlock oamplatform CONFIG_WRITEFAULT_ADMIN

Adminmgcadm

aim si-assignment

show CONFIG_WRITEFAULT_READ


cli-session command privilegesCommandGroup



cli-session modify oamplatform CONFIG_WRITE Adminmgcadmmgcrwmgcmtc

cli-session show oamplatform CONFIG_READ Admin Basicmgcadmmgcrwmgcmtcmgcro

cli-session exit oamplatform CONFIG_READ Admin Basicmgcadmmgcrwmgcmtcmgcro

filter command privilegesCommandGroup



filter chain add oamplatform CONFIG_WRITE Admin mgcadmmgcrw mgcmtc

filter chain delete oamplatform CONFIG_WRITE Admin mgcadmmgcrw mgcmtc



filter command privileges (cont'd)CommandGroup



filter chain show oamplatform CONFIG_READ Admin Basicmgcadmmgcrw mgcmtcmgcro

filter policy add oamplatform CONFIG_WRITE Admin mgcadmmgcrw mgcmtc

filter policy delete oamplatform CONFIG_WRITE Admin mgcadmmgcrw mgcmtc

filter policy modify oamplatform CONFIG_WRITE Admin mgcadmmgcrw mgcmtc

filter policy show oamplatform CONFIG_READ Admin Basicmgcadmmgcrw mgcmtcmgcro

filter rule add oamplatform CONFIG_WRITE Admin mgcadmmgcrw mgcmtc

filter rule delete oamplatform CONFIG_WRITE Admin mgcadmmgcrw mgcmtc

filter rule modify oamplatform CONFIG_WRITE Admin mgcadmmgcrw mgcmtc

filter rule show oamplatform CONFIG_READ Admin Basicmgcadmmgcrw mgcmtcmgcro

filternetwork

filter-network-instance

add oamplatform CONFIG_WRITE Admin mgcadmmgcrw mgcmtc

filternetwork


delete oamplatform CONFIG_WRITE Admin mgcadmmgcrw mgcmtc

filternetwork


modify oamplatform CONFIG_WRITE Admin mgcadmmgcrw mgcmtc

filternetwork


show oamplatform CONFIG_READ Admin Basicmgcadmmgcrw mgcmtcmgcro



filter command privileges (cont'd)CommandGroup



filternetwork

filter-network-prefix


filternetwork



filternetwork



filter service filter-service-instance








filter service filter-service-protocol










firmware command privilegesCommandGroup


firmware create oamplatform CONFIG_ADMINCONFIG_WRITE


firmware delete oamplatform CONFIG_ADMINCONFIG_WRITE


firmware downgrade oamplatform CONFIG_ADMINCONFIG_WRITE


firmware remove-activity

oamplatform CONFIG_ADMINCONFIG_WRITE


firmware show oamplatform CONFIG_ADMIN Adminmgcadm

firmware upgrade oamplatform CONFIG_ADMINCONFIG_WRITE


fm command privilegesCommandGroup



fm alarm resync,show, start,stop

oamplatform FAULT_READ Admin Basicmgcadmmgcrwmgcmtc mgcro

fm alarm clear oamplatform FAULT_READ Adminmgcadm

fm alarm-suppress

add, delete,modify

oamplatform FAULT_ADMINCONFIG_ADMIN

Adminmgcadm

fm alarm-suppress

show oamplatform FAULT_READCONFIG_READ

Admin Basicmgcadmmgcrwmgcmtc mgcro



fm command privileges (cont'd)CommandGroup



fm log resync,show, start,stop


fm log-repository



fm log-repository

modify oamplatform FAULT_ADMINCONFIG_ADMIN

Adminmgcadm

fm log-suppress

add, delete,modify


Adminmgcadm

fm log-suppress



fm modeled-data

show oamplatform FAULT_READ Admin Basicmgcadmmgcrwmgcmtc mgcro

fm seclog show,resync


fm seclog-repository



fm seclog-repository

modify oamplatform FAULT_ADMINCONFIG_ADMIN

Adminmgcadm

fm syslog add, delete,modify


Adminmgcadm

fm syslog show oamplatform FAULT_READCONFIG_READ


fm syslog start, stop oamplatform FAULT_READ Admin Basicmgcadmmgcrwmgcmtc mgcro



fm command privileges (cont'd)CommandGroup



fm syslog-facility

add, delete,modify


Adminmgcadm

fm syslog-facility



GWC command privilegesCommandGroup



GWC gwc-em-config

add oamplatform CONFIG_WRITE Adminmgcadmmgcrwmgcmtc

GWC gwc-em-config

delete oamplatform CONFIG_WRITE Adminmgcadmmgcrwmgcmtc

GWC gwc-em-config

modify oamplatform CONFIG_WRITE Adminmgcadmmgcrwmgcmtc

GWC gwc-em-config

show oamplatform CONFIG_READ Admin Basicmgcadmmgcrwmgcmtcmgcro

GWC gwc-sg-config


GWC gwc-sg-config


GWC gwc-sg-config




GWC command privileges (cont'd)CommandGroup



GWC gwc-sg-config


GWC gwc-sg-mtce

cold-swact oamplatform CONFIG_WRITEFAULT_WRITE


GWC gwc-sg-mtce

login oamplatform CONFIG_WRITE Adminmgcadmmgcrwmgcmtc

hardware commandsCommandGroup

Entity Verb Privilegetype

Privilege required(one of …)


hardware app-blade abort,activate,deactivate,lock, offline,online, reset,unlock

oamplatform FAULT_ADMIN Adminmgcadm

hardware app-blade add, delete,modify

oamplatform CONFIG_WRITE Adminmgcadmmgcrwmgcmtc

hardware app-blade indicate oamplatform FAULT_READ Admin Basicmgcadmmgcrwmgcmtcmgcro

hardware app-blade remove-activity

oamplatform CONFIG_ADMINCONFIG_READCONFIG_WRITE




hardware commands (cont'd)CommandGroup




hardware app-blade show oamplatform CONFIG_READ Admin Basicmgcadmmgcrwmgcmtcmgcro

hardware app-blade test oamplatform FAULT_WRITE Adminmgcadmmgcrwmgcmtc

hardware disk abort, lock,unlock


hardware disk modify oamplatform CONFIG_WRITE Adminmgcadmmgcrwmgcmtc

hardware disk show oamplatform CONFIG_READ Admin Basicmgcadmmgcrwmgcmtcmgcro

hardware disk test oamplatform FAULT_WRITE Adminmgcadmmgcrwmgcmtc

hardware frame add, delete,modify


hardware frame show oamplatform CONFIG_READ Admin Basicmgcadmmgcrwmgcmtcmgcro

hardware ftm modify oamplatform CONFIG_WRITE Adminmgcadmmgcrwmgcmtc







hardware ftm show oamplatform CONFIG_READ Admin Basicmgcadmmgcrwmgcmtcmgcro

hardware pem show oamplatform CONFIG_READ Admin Basicmgcadmmgcrwmgcmtcmgcro

hardware pem modify oamplatform CONFIG_WRITE Adminmgcadmmgcrwmgcmtc

hardware port show oamplatform CONFIG_READ Admin Basicmgcadmmgcrwmgcmtcmgcro

hardware prpmc offline, online,reset, abort,lock, unlock


hardware prpmc test, modify oamplatform CONFIG_WRITE Adminmgcadmmgcrwmgcmtc

hardware prpmc show oamplatform CONFIG_READ Admin Basicmgcadmmgcrwmgcmtcmgcro

hardware rtm add, delete,modify


hardware rtm show oamplatform CONFIG_READ Admin Basicmgcadmmgcrwmgcmtcmgcro







hardware shelf add, delete,modify


hardware shelf show oamplatform CONFIG_READ Admin Basicmgcadmmgcrwmgcmtcmgcro

health command privilegesCommandGroup



health check oamplatform CONFIG_READ Admin Basicmgcadmmgcrwmgcmtcmgcro

ike - required privilegesCommandGroup



ike ike-alarm show oamplatform CONFIG_READ Admin Basicmgcadmmgcrwmgcmtcmgcro

ike ike-ipsec-profile

add, delete oamplatform SEC_ADMIN secadm

ike ike-ipsec-profile


ike ike-ipsec-session

add, delete,modify

oamplatform SEC_ADMIN secadm



ike - required privileges (cont'd)CommandGroup



ike ike-ipsec-session


ike ike-management

add, delete oamplatform SEC_ADMIN secadm

ike ike-management


ike ike-session

add, delete,modify, show


ike ike-session

pskrekey,pskmodify,pskrevert,psktest


ike ike-session-psk

show oamplatform SEC_ADMIN secadm

ipfilter command privilegesCommandGroup



ipfilter device add oamplatform CONFIG_ADMIN Adminmgcadm

ipfilter device modify oamplatform CONFIG_ADMIN Adminmgcadm

ipfilter device associate oamplatform CONFIG_ADMIN Adminmgcadm

ipfilter device audit oamplatform CONFIG_ADMIN CONFIG_READSEC_READ

AdminmgcadmBasic mgcrwmgcmtcmgcrosecadm secrwsecro



ipfilter command privileges (cont'd)CommandGroup



ipfilter device delete oamplatform CONFIG_ADMIN Adminmgcadm

ipfilter device dissociate oamplatform CONFIG_ADMIN Adminmgcadm

ipfilter device fix oamplatform CONFIG_ADMIN Adminmgcadm

ipfilter device list oamplatform CONFIG_ADMINCONFIG_READSEC_READ


ipfilter exception add oamplatform CONFIG_ADMIN Adminmgcadm

ipfilter exception delete oamplatform CONFIG_ADMIN Adminmgcadm

ipfilter exception list oamplatform CONFIG_ADMINCONFIG_READSEC_READ


ipfilter filterdb dump oamplatform CONFIG_ADMINCONFIG_READSEC_READ


ipfilter filterdb query oamplatform CONFIG_ADMINCONFIG_READSEC_READ




ipfilter command privileges (cont'd)CommandGroup



ipfilter filterdb report oamplatform CONFIG_ADMINCONFIG_READSEC_READ


ipfilter global set oamplatform CONFIG_ADMIN Adminmgcadm

ipfilter global show oamplatform CONFIG_ADMINCONFIG_READSEC_READ


ipfilter profiles list oamplatform CONFIG_ADMINCONFIG_READSEC_READ


ipfilter subnet add oamplatform CONFIG_ADMIN Adminmgcadm

ipfilter subnet modify oamplatform CONFIG_ADMIN Adminmgcadm

ipfilter vr link oamplatform CONFIG_ADMIN Adminmgcadm

ipfilter vr list oamplatform CONFIG_ADMINCONFIG_READSEC_READ


ipfilter vr unlink oamplatform CONFIG_ADMIN Adminmgcadm



interfaces- required privilegesCommandGroup




interfaces ae-lan show oamplatform CONFIG_READ Admin Basicmgcadmmgcrwmgcmtcmgcro

interfaces ae-lan-member


interfaces ae add, delete,modify, test


interfaces ae alarm,noalarm, lock,unlock


interfaces ae show oamplatform CONFIG_READ Admin Basicmgcadmmgcrwmgcmtcmgcro

interfaces ae-member

add, delete oamplatform CONFIG_WRITE Adminmgcadmmgcrwmgcmtc

interfaces ae-member


interfaces ae-physical

lock, offline,unlock, online,reset, test






interfaces- required privileges (cont'd)CommandGroup






interfaces eth-lan show oamplatform CONFIG_READ Admin Basicmgcadmmgcrwmgcmtcmgcro

interfaces eth modify, test oamplatform CONFIG_WRITE Adminmgcadmmgcrwmgcmtc

interfaces eth show oamplatform CONFIG_READ Admin Basicmgcadmmgcrwmgcmtcmgcro

interfaces eth alarm,noalarm, lock,unlock,


interfaces eth-physical

lock, offline,unlock, online,reset, test






interfaces gre add, delete,modify, test








interfaces gre show oamplatform CONFIG_READ Admin Basicmgcadmmgcrwmgcmtcmgcro

interfaces gre alarm, lock,noalarm,unlock


interfaces logical-interface


interfaces physical-interface


interfaces loopback show oamplatform CONFIG_READ Admin Basicmgcadmmgcrwmgcmtcmgcro

interfaces svti add, delete,modify


interfaces svti show oamplatform CONFIG_READ Admin Basicmgcadmmgcrwmgcmtcmgcro

interfaces svti alarm, lock,noalarm,unlock


interfaces svti test oamplatform CONFIG_WRITE Adminmgcadmmgcrwmgcmtc







interfaces vlan add, delete,modify


interfaces vlan show oamplatform CONFIG_READ Admin Basicmgcadmmgcrwmgcmtcmgcro

interfaces vlan alarm, lock,noalarm,unlock


interfaces vlan test oamplatform CONFIG_WRITE Adminmgcadmmgcrwmgcmtc

keycode - required privilegesCommandGroup




keycode file add, delete oamplatform SEC_WRITE secadmsecrw

keycode file show oamplatform SEC_READ secadmsecrw secro

keycode key-id add, delete oamplatform SEC_WRITE secadmsecrw

keycode key-id show oamplatform SEC_READ secadmsecrw secro

keycode system-id generate oamplatform SEC_WRITE secadmsecrw

keycode system-id show oamplatform SEC_READ secadmsecrw secro



netsec - required privilegesCommandGroup




netsec netsec-policy


netsec netsec-policy


netsec netsec-policy-alarm


netsec netsec-sa add, delete oamplatform SEC_ADMIN secadm

netsec netsec-sa show oamplatform SEC_READSEC_ADMIN

secadmsecrw secro

netsec netsec-sa-alarm


netsec netsec-wizard

run oamplatform SEC_ADMIN secadm

networking - required privilegesCommandGroup




networking alias add, delete oamplatform CONFIG_ADMIN Adminmgcadm

networking alias show oamplatform CONFIG_READ Admin Basicmgcadmmgcrwmgcmtcmgcro

networking ip activate,deactivate,modify




networking - required privileges (cont'd)CommandGroup




networking ip show oamplatform CONFIG_READ Admin Basicmgcadmmgcrwmgcmtcmgcro

networking ipmgr-port-entry

add, delete,modify


networking ipmgr-port-entry


networking pool add, delete oamplatform CONFIG_ADMIN Adminmgcadm

networking pool show oamplatform CONFIG_READ Admin Basicmgcadmmgcrwmgcmtcmgcro

networking pool modify oamplatform CONFIG_ADMIN Adminmgcadm

networking dhcp add oamplatform CONFIG_ADMINCONFIG_WRITE


networking dhcp delete oamplatform CONFIG_ADMINCONFIG_WRITE


networking dhcp modify oamplatform CONFIG_ADMINCONFIG_WRITE


networking dhcp show oamplatform CONFIG_READ Admin Basicmgcadmmgcrwmgcmtcmgcro



pki command privilegesCommandGroup



pki pki-certificate

create oamplatform SEC_WRITE secadmsecrw

pki pki-certificate

delete oamplatform SEC_WRITE secadmsecrw

pki pki-certificate

export oamplatform SEC_READ secadmsecrw secro

pki pki-certificate

import oamplatform SEC_WRITE secadmsecrw

pki pki-certificate

modify oamplatform SEC_WRITE secadmsecrw

pki pki-certificate

show oamplatform SEC_READ secadmsecrw secro

pki pki-certificate

validate oamplatform SEC_ADMIN secadm

pki pki-configuration

modify oamplatform SEC_WRITESEC_ADMIN

secadmsecrw

pki pki-configuration

show oamplatform SEC_READ secadmsecrw secro

pki pki-key-pair

add oamplatform SEC_ADMIN secadm

pki pki-key-pair

delete oamplatform SEC_ADMIN secadm

pki pki-key-pair

modify oamplatform SEC_ADMIN secadm

pki pki-key-pair

show oamplatform SEC_ADMIN secadm

pki pki-signing-request

create oamplatform SEC_ADMIN secadm



pm - required privilegesCommandGroup




pm aggregation

show oamplatform PERF_READ Admin Basicmgcadmmgcrwmgcmtcmgcro

pm aggregation

activate,deactivate

oamplatform PERF_ADMIN Adminmgcadm

pm data-source


pm groups show oamplatform PERF_READ Admin Basicmgcadmmgcrwmgcmtcmgcro

pm historical-index


pm register show oamplatform PERF_READ Admin Basicmgcadmmgcrwmgcmtcmgcro

pm repository show oamplatform PERF_READ Admin Basicmgcadmmgcrwmgcmtcmgcro

pm repository modify oamplatform CONFIG_ADMIN Adminmgcadm

pm retention show oamplatform PERF_READ Admin Basicmgcadmmgcrwmgcmtcmgcro

pm retention modify oamplatform CONFIG_ADMIN Adminmgcadm



pm - required privileges (cont'd)CommandGroup




pm threshold disable,enable

oamplatform PERF_ADMIN Adminmgcadm

pm threshold modify oamplatform PERF_WRITE Adminmgcadmmgcrwmgcmtc

pm threshold show oamplatform PERF_READ Admin Basicmgcadmmgcrwmgcmtcmgcro

postgres - required privilegesCommandGroup




postgres oamdb-db-config








recovery - required privilegesCommandGroup




recovery aim-service-group

show oamplatform

CONFIG_READFAULT_READ


recovery aim-service-unit

show oamplatform




lock, unjam,unlock

oamplatform

CONFIG_ADMINFAULT_ADMIN

Adminmgcadm


load, swact,unload

oamplatform

CONFIG_WRITEFAULT_WRITE


recovery aim-service-instance

show oamplatform



recovery aim-si-assignment

show oamplatform



recovery aim-geo show oamplatform





resource-profile command privilegesCommandGroup



resourceprofile

assignments

assign,unassign,update-mask



resourceprofile

assignments

show oamplatform CONFIG_ADMIN Adminmgcadm

resourceprofile

hardware-profile

add, delete,modify



resourceprofile

hardware-profile


resourceprofile

hardware-profilehw-assignments

assign,unassign,getmask,topology



resourceprofile

hardware-profilehw-assignments


resourceprofile

clone,delete,import,migrate,migrateSG,modify



resourceprofile


rex command privilegesCommandGroup



rex target add oamplatform CONFIG_ADMIN Adminmgcadm

rex target clear oamplatform CONFIG_ADMIN Adminmgcadm

rex target delete oamplatform CONFIG_ADMIN Adminmgcadm



rex command privileges (cont'd)CommandGroup



rex target show oamplatform CONFIG_READ Admin Basicmgcadmmgcrwmgcmtcmgcro

rex test abort oamplatform FAULT_ADMIN Adminmgcadm

rex test clear oamplatform FAULT_ADMIN Adminmgcadm

rex test run oamplatform FAULT_ADMIN Adminmgcadm

rex test show oamplatform CONFIG_READ Admin Basicmgcadmmgcrwmgcmtcmgcro

routing - required privilegesCommandGroup




routing diags ping,traceroute

oamplatform CONFIG_READ Admin Basicmgcadmmgcrwmgcmtcmgcro

routing ip-interface add, delete,lock, unlock


routing ip-interface show oamplatform CONFIG_READ Admin Basicmgcadmmgcrwmgcmtcmgcro

routing ip-interface modify oamplatform CONFIG_WRITE Adminmgcadmmgcrwmgcmtc



routing - required privileges (cont'd)CommandGroup




routing ospf-router add, delete,lock, unlock


routing ospf-area add, delete,modify


routing ospf-area show oamplatform CONFIG_READ Admin Basicmgcadmmgcrwmgcmtcmgcro

routing ospf-area-interface

add, delete,modify


routing ospf-area-interface


routing redistribution-options

add, delete,modify


routing redistribution-options


routing route-table show oamplatform CONFIG_READ Admin Basicmgcadmmgcrwmgcmtcmgcro

routing route-table get oamplatform CONFIG_READ Adminmgcadmmgcrwmgcmtc







routing static-route add, delete oamplatform CONFIG_WRITE Adminmgcadmmgcrwmgcmtc

routing static-route show oamplatform CONFIG_READ Admin Basicmgcadmmgcrwmgcmtcmgcro

routing static-route modify oamplatform CONFIG_WRITE Adminmgcadmmgcrwmgcmtc

routing traffic-classifier


routing traffic-classifier


routing vr-router add, delete,modify


routing vr-router show oamplatform CONFIG_READ Admin Basicmgcadmmgcrwmgcmtcmgcro

routing vrrp-interface

add, delete,lock, unlock












routing bfd add oamplatform CONFIG_WRITE Adminmgcadmmgcrwmgcmtc

routing bfd delete oamplatform CONFIG_WRITE Adminmgcadmmgcrwmgcmtc

routing bfd lock oamplatform CONFIG_WRITE Adminmgcadmmgcrwmgcmtc

routing bfd unlock oamplatform CONFIG_WRITE Adminmgcadmmgcrwmgcmtc

routing bfd modify oamplatform CONFIG_WRITE Adminmgcadmmgcrwmgcmtc

routing bfd show oamplatform CONFIG_WRITE Adminmgcadmmgcrwmgcmtc

routing bfd-session show oamplatform CONFIG_READ Admin Basicmgcadmmgcrwmgcmtcmgcro

routing ip-neighbor show oamplatform CONFIG_READ Admin Basicmgcadmmgcrwmgcmtcmgcro







routing router add oamplatform CONFIG_WRITE Adminmgcadmmgcrwmgcmtc

routing router delete oamplatform CONFIG_WRITE Adminmgcadmmgcrwmgcmtc

routing router modify oamplatform CONFIG_WRITE Adminmgcadmmgcrwmgcmtc

routing router show oamplatform CONFIG_READ Admin Basicmgcadmmgcrwmgcmtcmgcro

security - required privilegesCommandGroup



security auth-scheme


secadmsecrw

security auth-scheme

show oamplatform SEC_ADMINSEC_WRITESEC_READCONFIG_READ

secadmsecrw secroAdmin Basicmgcadmmgcrwmgcmtcmgcro

security interblade-sso


security interblade-sso


secadmsecrw

security key-management

regenerate oamplatform SEC_WRITESEC_ADMIN

secadmsecrw



security - required privileges (cont'd)CommandGroup



security linux-groups

add, delete oamplatform SEC_WRITESEC_ADMIN

secadmsecrw

security linux-groups


security radius-config

add, delete,modify

oamplatform SEC_WRITESEC_ADMIN

secadmsecrw

security radius-config


security radius-defaults

show oamplatform SEC_ADMINCONFIG_READ

secadmAdmin Basicmgcadmmgcrwmgcmtcmgcro

security radius-defaults


security role-details add, delete,modify


secadmsecrw

security role-details show oamplatform CONFIG_READ Admin Basicmgcadmmgcrwmgcmtcmgcro

security user-account

add, delete,modify


secadmsecrw

security user-account


security user-config modify oamplatform SEC_WRITESEC_ADMIN

secadmsecrw






security user-config show oamplatform CONFIG_READSEC_WRITESEC_ADMIN

Admin Basicmgcadmmgcrwmgcmtcmgcrosecadmsecrw

security user-defaults


secadmsecrw

security user-defaults

show oamplatform SEC_ADMINSEC_WRITESEC_READCONFIG_READ


security user-message

show oamplatform SEC_READCONFIG_READ


security user-message


secadmsecrw

security user-password

modify oamplatform FAULT_READFAULT_WRITEFAULT_ADMINCONFIG_READCONFIG_WRITECONFIG_ADMINACC_READACC_WRITEACC_ADMINPERF_READPERF_WRITEPERF_ADMINSEC_READSEC_WRITESEC_ADMIN

Admin Basicmgcadmmgcrwmgcmtcmgcrosecadmsecrw secro

security user-privclass







security user-privclass


security user-sessions

terminate oamplatform SEC_ADMIN secadm

shell command privilegesCommandGroup



shell oamplatform FAULT_ADMINCONFIG_ADMIN ACC_ADMINPERF_ADMINSEC_ADMIN

Adminmgcadmsecadm

software - required privilegesCommandGroup



software backup archive abort oamplatform CONFIG_ADMIN Adminmgcadm

software backup archivecreate


software backup archiverestore


software backup archive show oamplatform CONFIG_ADMINCONFIG_WRITECONFIG_READ


software backup file-registershow

oamplatform CONFIG_ADMINCONFIG_WRITECONFIG_READ




software - required privileges (cont'd)CommandGroup



software backup sos-registershow



software baseline apply oamplatform CONFIG_ADMIN Adminmgcadm

software baseline bl-reboot-status show



software baseline commit oamplatform CONFIG_ADMIN Adminmgcadm

software baseline reboot oamplatform CONFIG_WRITE Adminmgcadmmgcrwmgcmtc

software baseline reboot-complete


software baseline remove oamplatform CONFIG_ADMIN Adminmgcadm

software baseline remove-activity


software baseline show oamplatform CONFIG_READ Admin Basicmgcadmmgcrwmgcmtcmgcro

software baseline validate oamplatform CONFIG_ADMIN Adminmgcadm

software flash apply oamplatform CONFIG_ADMIN Adminmgcadm

software flash show oamplatform CONFIG_READ Admin Basicmgcadmmgcrwmgcmtcmgcro






software flash sync oamplatform CONFIG_ADMIN Adminmgcadm

software patch abort oamplatform CONFIG_READ Admin Basicmgcadmmgcrwmgcmtcmgcro

software patch apply oamplatform CONFIG_WRITE Adminmgcadmmgcrwmgcmtc

software patch create-inventory


software patch delete oamplatform CONFIG_WRITE Adminmgcadmmgcrwmgcmtc

software patch deselect oamplatform CONFIG_WRITE Adminmgcadmmgcrwmgcmtc

software patch import oamplatform CONFIG_WRITE Adminmgcadmmgcrwmgcmtc

software patch reboot oamplatform CONFIG_WRITE Adminmgcadmmgcrwmgcmtc

software patch reboot-complete


software patch reboot-statusshow








software patch remove oamplatform CONFIG_WRITE Adminmgcadmmgcrwmgcmtc

software patch remove-activity


software patch select oamplatform CONFIG_WRITE Adminmgcadmmgcrwmgcmtc

software patch show oamplatform CONFIG_READ Admin Basicmgcadmmgcrwmgcmtcmgcro

software patch status oamplatform CONFIG_REA Admin Basicmgcadmmgcrwmgcmtcmgcro

software patch validate oamplatform CONFIG_WRITE Adminmgcadmmgcrwmgcmtc

software product import oamplatform CONFIG_ADMIN Adminmgcadm

software product install oamplatform CONFIG_ADMIN Adminmgcadm

software product show oamplatform CONFIG_ADMINCONFIG_WRITECONFIG_READ


software product uninstall oamplatform CONFIG_ADMIN Adminmgcadm

software transfer copy oamplatform CONFIG_ADMIN Adminmgcadm






software transfer download oamplatform CONFIG_ADMIN Adminmgcadm

software transfer upload oamplatform CONFIG_ADMIN Adminmgcadm

software upgrade activate oamplatform CONFIG_ADMIN Adminmgcadm

software upgrade blade_statusshow



software upgrade check oamplatform CONFIG_ADMIN Adminmgcadm

software upgrade commit oamplatform CONFIG_ADMIN Adminmgcadm

software upgrade deactivate oamplatform CONFIG_ADMIN Adminmgcadm

software upgrade downgrade-blade


software upgrade final-data-migration


software upgrade initial-data-migration


software upgrade pre-check oamplatform CONFIG_ADMIN Adminmgcadm

software upgrade remove-activity


software upgrade show oamplatform CONFIG_ADMINCONFIG_WRITECONFIG_READ


software upgrade start oamplatform CONFIG_ADMIN Adminmgcadm

software upgrade stop oamplatform CONFIG_ADMIN Adminmgcadm






software upgrade su-statusshow



software upgrade upgrade-blade


sosagent - required privilegesCommandGroup



SosAgent vca add, delete,niikey

ca CONFIG_WRITE Adminmgcadmmgcrwmgcmtc

SosAgent vca dpsync,imgtest, mc-rex, sync, rex

ca PERF_ADMIN Adminmgcadm

SosAgent vca jam, lock,swact,unjam,unlock

ca CONFIG_ADMINFAULT_ADMIN

Adminmgcadm

SosAgent vca load ca CONFIG_WRITEFAULT_WRITE


SosAgent vca show ca CONFIG_READ Admin Basicmgcadmmgcsprovmgcrwmgcmtcmgcro trkadmtrksprov trkrwtrkmtc trkrolnadmlnsprov lnrwlnmtc lnro



sosagent - required privileges (cont'd)CommandGroup



SosAgent vca unload ca CONFIG_WRITEFAULT_WRITE


sosAgent vca login ca CONFIG_READ Admin Basicmgcadmmgcrwmgcmtcmgcro

sst - required privilegesCommandGroup

Entity Verb Privilege type Privilege required (one of …)


SST sst-sg-config


SST sst-sg-config


SST sst-sg-config


SST sst-sg-config


SST sst-sg-maintenance

cold-swact oamplatform CONFIG_ADMINFAULT_ADMIN

Adminmgcadm



storage - required privilegesCommandGroup



storage file-system

add, delete,modify


storage file-system

lock, unlock oamplatform CONFIG_ADMIN Adminmgcadm

storage file-system


storage file-system

snapshot oamplatform CONFIG_WRITE Adminmgcadmmgcrwmgcmtc

storage nfs-export add, delete oamplatform CONFIG_WRITE Adminmgcadmmgcrwmgcmtc

storage nfs-export show oamplatform CONFIG_READ Admin Basicmgcadmmgcrwmgcmtcmgcro

switching - required privilegesCommandGroup



switching mac-table show oamplatform CONFIG_READ Admin Basicmgcadmmgcrwmgcmtcmgcro

switching port-filter show oamplatform CONFIG_READ Admin Basicmgcadmmgcrwmgcmtcmgcro



switching - required privileges (cont'd)CommandGroup



switching port-state show oamplatform CONFIG_READ Admin Basicmgcadmmgcrwmgcmtcmgcro

switching profile modify oamplatform CONFIG_WRITE Adminmgcadmmgcrwmgcmtc

switching profile show oamplatform CONFIG_READ Adminmgcadmmgcrwmgcmtc

switching redundancy modify,prefer


switching redundancy show oamplatform CONFIG_READ Adminmgcadmmgcrwmgcmtc

switching redundancy swact oamplatform FAULT_ADMIN Adminmgcadm

switching redundancy-member

show oamplatform CONFIG_READ Adminmgcadmmgcrwmgcmtc

switching switch modify oamplatform CONFIG_WRITE Adminmgcadmmgcrwmgcmtc

switching switch show oamplatform CONFIG_READ Adminmgcadmmgcrwmgcmtc

switching switch-ae add-vlan,delete-vlan







switching switch-ae alarm,noalarm,lock, offline,online,unlock


switching switch-ae modify, show oamplatform CONFIG_READ Adminmgcadmmgcrwmgcmtc

switching switch-eth add-vlan,delete-vlan


switching switch-eth alarm,noalarm,lock, offline,online,unlock


switching switch-eth modify, show oamplatform CONFIG_READ Adminmgcadmmgcrwmgcmtc

switching switch-health

check oamplatform CONFIG_READ Adminmgcadmmgcrwmgcmtc

switching switch-vlan modify, add,delete


switching switch-vlan show oamplatform CONFIG_READ Adminmgcadmmgcrwmgcmtc






switching switch-vlan-member

show oamplatform CONFIG_READ Adminmgcadmmgcrwmgcmtc

switching traffic show oamplatform CONFIG_READ Adminmgcadmmgcrwmgcmtc

system command privilegesCommandGroup



system modify oamplatform CONFIG_ADMINFAULT_ADMIN

Adminmgcadm

system show oamplatform CONFIG_READ Admin Basicmgcadmmgcrwmgcmtcmgcro

time commands - required privilegesCommandGroup



time local-time show oamplatform CONFIG_READCONFIG_WRITE


time ntp add, delete oamplatform CONFIG_WRITE Adminmgcadmmgcrwmgcmtc

time ntp show oamplatform CONFIG_READ Admin Basicmgcadmmgcrwmgcmtcmgcro



time commands - required privileges (cont'd)CommandGroup



time override-timezone

add, delete,modify


time override-timezone


time system-timezone

add, modify oamplatform CONFIG_WRITE Adminmgcadmmgcrwmgcmtc

time system-timezone


vm-host command privilegesCommandGroup



vm-host setup oamplatform CONFIG_WRITE Adminmgcadmmgcrwmgcmtc

vm-host show oamplatform CONFIG_READ Admin Basicmgcadmmgcrwmgcmtcmgcro



vm-instance command privilegesCommandGroup



vm-instance create,delete,install, modify

oamplatform CONFIG_ADMINFAULT_ADMIN


vm-instance show oamplatform CONFIG_READ Admin Basicmgcadmmgcrwmgcmtcmgcro

vm-profile command privilegesCommandGroup



vm-profile add oamplatform CONFIG_ADMINCONFIG_READ


vm-profile clone, delete,import

oamplatform CONFIG_ADMIN Adminmgcadmmgcrwmgcmtc

vm-profile modify oamplatform CONFIG_WRITE Adminmgcadmmgcrwmgcmtc

vm-profile show oamplatform CONFIG_READ Admin Basicmgcadmmgcrwmgcmtcmgcro



C20 Converged Softswitch

Command Reference — GENWare-based platformRelease: C20 R18Publication: NN10602-013Document Revision: 04.03Document release date: 30 September 2014

Copyright © 2010-2014 GENBAND. All rights reserved. Use of this documentation and its contents is subject to the terms andconditions of the applicable end user or software license agreement, right to use notice, and all relevant copyright protections.

GENBAND, the GENBAND corporate logo and tagline, and certain of GENBAND's product and solution names are registeredtrademarks of GENBAND and its affiliates.

While the information in this document is believed to be accurate and reliable, except as otherwise expressly agreed to in writing,GENBAND AND/OR ITS LICENSORS PROVIDES THIS DOCUMENT "AS IS" WITHOUT WARRANTY OR CONDITION OF ANYKIND, EITHER EXPRESS OR IMPLIED. The information and/or products described in this document are subject to changewithout notice.

THE INFORMATION CONTAINED HEREIN IS THE PROPERTY OF GENBAND OR ITS LICENSORS AND MUST NOT BEDISCLOSED, OTHER THAN TO EMPLOYEES OF GENBAND OR CUSTOMERS WITH NEED-TO-KNOW, WITHOUT THEPRIOR WRITTEN CONSENT OF GENBAND OR ITS LICENSORS. THE INFORMATION MUST NOT BE DISCLOSED TOSUBCONTRACTORS OR REGULATORY AUTHORITIES. GENBAND MUST BE NOTIFIED OF ANY REQUEST OR ORDERFOR DISCLOSURE PRIOR TO SUCH DISCLOSURE.

Software and documentation owned by or under license with Nortel Networks included in this Release or in any documentprovided with this Release is Copyright © 2010 Nortel Networks or its licensors. All rights reserved. Use of this software and/ordocumentation and its contents is subject to the terms and conditions of the applicable end user or software license agreement,right to use notice, and all relevant copyright protections.

www.genband.com