In this section:


This object allows you to assign server module roles, set the coredump server profile, and perform server actions such as restart, soft reset and start software upgrade.

Command Syntax

% set system serverAdmin <name> 
	coredumpProfile <name> 
	deviceSmartAttribute <integer>
    hwType <0-255 characters>
	modularType <false | true>
	pktPortSpeed <speed1Gbps | speed10Gbps>
	role <primary | secondary>
 
% request system serverAdmin <name>
	forceCoreDump coreDumpType <full | partial>
	removeCoredump coreDumpFilename <file name>
	restart 
	softReset 
	startSoftwareUpgrade
		integrityCheck <perform | skip>
		package <name>
		rpmName <name>
		versionCheck <perform | skip>

Command Parameters (set)

Command Parameters (set)

Parameter

Length/Range

Description

<serverName>

N/A

Choose the SBC server name.

coredumpProfile

1-23 characters

<profile name> – Enter a Core Dump Profile name, or choose the default profile.

deviceSmartAttribute

N/A

The smart control attribute value that reports disk life remaining. 

hwType

0-255 characters

 <hw description> – Textual description of the SBC hardware type.
modularType N/A

If set to 'true', the SBC uses modular DSPs,

  • false
  • true

pktPortSpeed

N/A 

Packet port speed setting.

  • speed1Gbps
  • speed10Gbps

role

N/A 

The server module role. When set to 'primary', role designates a server for internal processing.

  • primary (default)
  • secondary


Command Parameters (request)

Command Parameters (request)

Parameter

Description

<serverName>

The unique name of the server.

forceCoreDump


Warning

You should only use the "full" option during a maintenance window and under the instruction of Ribbon Support. This command takes a number of minutes to complete and can delay the switchover processing, resulting in a short outage.

Use this command to force the termination of a fixed set of application processes with accompanying core dumps for troubleshooting purposes. By default, a full dump is performed if no option is specified.

Before the command executes, the user is prompted to confirm or cancel the operation. If canceled, no further action is taken, and application operation is not affected.

removeCoredump

Use this object to remove the specified coredump from the chosen server.

  • coredumpFileName <filename> – The name of the coredump file.

restart

Restart the specified server.

softReset

Restart the application on the server without rebooting the server.

startSoftwareUpgrade

Use this control to start a software upgrade on the specified server.

  • integrityCheck – Use this flag to specify whether or not to perform an integrity check (signature validation) against SBC software updates and patches as they are uploaded to the SBCsystem.
    • perform (default)
    • skip 
  • package – Name of the new package.
  • rpmName – Name of the rpm/package, if different from the file name of the .tar.gz.
  • versionCheck– Use this flag to perform/skip version checking during software upgrades.
    • perform (default)
    • skip

Full Application Process List

CamProcess

ChmProcess

CpxAppProc

DiamProcess

DnsProcess

DsProcess

EmaProcess

EnmProcessMain

FmMasterProcess

IkeProcess

ImProcess

IpmProcess

PathchkProcess

PesProcess

PipeProcess

PrsProcess

RtmProcess

SamProcess

ScmProcess_0

ScmProcess_1

ScmProcess_2

ScmProcess_3

ScpaProcess

SmProcess

SsaProcess

SsreqProcess



Partial Application Process List

DsProcess

PrsProcess

RtmProcess

SamProcess

ScmProcess_0

ScmProcess_1

ScmProcess_2

ScmProcess_3

SmProcess

Command Examples

To display server administration configuration from an SBC RESTCONF API system:

admin%sbc01 show system serverAdmin SBC01
coredumpProfile default;
deviceSmartAttrib    0;
role            primary;
modularType     false;
hwType          ConnexIP5200;
pktPortSpeed    speed1Gbps;


To display server administration configuration from an SBC SWe cloud system:

admin@vsbc1% show system serverAdmin
serverAdmin vsbc1 {
    coredumpProfile default;
    deviceSmartAttrib    0;
    role            primary;
    modularType     false;
    hwType          ConnexIP5000;
    hwSubType       virtualCloud;


  • No labels