Administering EntireX Broker using the Command Central Command Line

This document covers the following topics:

Managing EntireX Broker Instances

Creating an EntireX Broker Instance

The following table lists the parameters to include when creating an EntireX Broker instance, using the Command Central instance management commands.

Command Parameter Description
create instances node_alias Required. Specifies the alias name of the installation in which the run-time component is installed.
product Required. Must be set to "EntireXCore".
type=Broker Required. EntireXCore instance type broker, no other types currently supported.
instance.name=brokername Required. Name of broker.
tcp.port=port Required if SSL port is not set; optional if SSL port is set. TCP port number range from 1024 to 65535.
ssl.port=port Required if TCP port is not set; optional if TCP port is set. SSL port number range from 1024 to 65535.
autostart=yes|no Optional. Enables/disables autostart. Default is disabled.
security=yes|no Optional. Enables/disables security. Default is disabled.

Example

  • To create a new instance for an installed EntireX of the type Broker, with name "MyBroker", listening on port 4711, in the installation with alias name "local": 

    sagcc create instances local EntireXCore type=Broker instance.name=MyBroker tcp.port=4711

    Information about the creation job - including the job ID - is displayed.

Deleting an EntireX Broker Instance

The following table lists the parameters to include when deleting an EntireX Broker instance, using the Command Central instance management commands.

Command Parameter Description
delete instances node_alias Required. Specifies the alias name of the installation in which the runtime component is installed.
componentid Required. EntireX Broker component identifier, prefix is "EntireXCore-EntireX-Broker-".

Example

  • To delete an instance of an EntireX Broker with the name "MyBroker" in the installation with alias name "local":

    sagcc delete instances local EntireXCore-EntireX-Broker-MyBroker

    Information about the deletion job - including the job ID - is displayed.

Displaying the EntireX Inventory

Listing all Inventory Components

The following table lists the parameters to include, when listing all EntireX instances, using the Command Central list inventory commands.

Command Parameter Description
list inventory components node_alias Required. Specifies the alias name of the installation in which the runtime component is installed.
componentid Required. All EntireX components have the prefix "EntireXCore".

Example

  • To list inventory components of instance EntireX in the installation with alias name "local":

    sagcc list inventory components local EntireXCore*

    A list of all EntireX runtime components will be displayed.

Overview of EntireX

Monitoring the EntireX Broker

Displaying the Status and Monitoring Information of an EntireX Component

The following table lists the parameters to include when displaying the state of an EntireX component, using the Command Central get monitoring commands.

Command Argument Description
sagcc get monitoring state componentid Required. Specifies the ID of the runtime component for which you want to retrieve information.

Example

  • To display state information about the EntireX Broker "MyBroker" in the installation with alias name "local":

    sagcc get monitoring state local EntireXCore-EntireX-Broker-MyBroker

Controlling the EntireX Broker with Lifecycle Actions

Starting an EntireX Component

The following table lists the parameters to include when starting an EntireX component, using the Command Central exec lifecycle commands.

Command Parameter Description
exec lifecycle node_alias Required. Specifies the alias name of the installation in which the runtime component is installed.
componentid Required. Specifies the ID of the runtime component on which to act.

Example

  • To start the EntireX Broker component "MyBroker" in the installation with alias name "local":

    sagcc exec lifecycle start local EntireXCore-EntireX-Broker-MyBroker

    Information about the job - including the job ID - will be displayed.

Stopping an EntireX Component

The following table lists the parameters to include when stopping an EntireX component, using the Command Central exec lifecycle commands.

Command Parameter Description
exec lifecycle node_alias Required. Specifies the alias name of the installation in which the runtime component is installed.
componentid Required. Specifies the ID of the runtime component on which to act.

Example

  • To stop the EntireX Broker component MyBroker, in the installation with alias name "local":

    sagcc execlifecycle stop local EntireXCore-EntireX-Broker-MyBroker

    Information about the job - including the job ID - will be displayed.

Restarting an EntireX Component

The following table lists the parameters to include when restarting an EntireX component, using the Command Central exec lifecycle commands.

Command Parameter Description
exec lifecycle node_alias Required. Specifies the alias name of the installation in which the runtime component is installed.
componentid Required. Specifies the ID of the runtime component on which to act.

Example

  • To restart the EntireX Broker component "MyBroker", in the installation with alias name "local":

    sagcc execlifecyclerestart local EntireXCore-EntireX-Broker-MyBroker

    Information about the job - including the job ID - will be displayed.

Configuring EntireX Broker

EntireX Broker Application Monitoring

Displaying Application Monitoring Parameters

Here you can modify the EntireX Broker application monitoring parameters:

Parameter Value
Enabled true | false
CollectorHost <appmondc-host>
CollectorPort <appmonde-port>

If Enabled=true is set, the EntireX Broker application monitoring will be switched on with the next broker start. The following table lists the parameters to include when configuring application monitoring of an EntireX component, using the Command Central configuration commands.

Command Parameter Description
get configuration data node_alias Required. Specifies the alias name of the installation in which the runtime component is installed.
componentid Required. Specifies the component ID of a runtime component on which to act.
instanceid Required. APPLICATION-MONITORING.
-o file Optional. Specifies the file where you want the output written.

    Examples

  • To display the application monitoring parameters of the EntireX Broker with the name "MyBroker" in the installation with alias name "local": 

    sagcc get configuration data local
EntireXCore-EntireX-Broker-MyBroker APPLICATION-MONITORING

  • To store the application monitoring parameters of the EntireX Broker with the name "MyBroker" in the installation with alias name "local" in the file appmon.json in the current working directory: 

    sagcc get configuration data local
EntireXCore-EntireX-Broker-MyBroker APPLICATION-MONITORING -o appmon.json

Updating Application Monitoring Parameters

Command Parameter Description
update configuration data node_alias Required. Specifies the alias name of the installation in which the runtime component is installed.
componentid Required. Specifies the component ID of a runtime component on which to act.
instanceid Required. APPLICATION-MONITORING.
-i file Required. Specifies the file from where you want the input read.

Example

  • To load the application monitoring parameters from the file appmon.json of the current working directory for the EntireX Broker with the name "MyBroker" in the installation with alias name "local": 

    sagcc update configuration data local
EntireXCore-EntireX-Broker-MyBroker APPLICATION-MONITORING -i appmon.json

EntireX Broker Attribute File

Displaying the Content of the EntireX Broker Attribute File

Here you can modify the EntireX Broker attribute file. See the Broker Attributes documentation for details of individual attributes. The following table lists the parameters to include when configuring the attribute file of an EntireX component, using the Command Central configuration commands.

Command Parameter Description
get configuration data node_alias Required. Specifies the alias name of the installation in which the runtime component is installed.
componentid Required. Specifies the component ID of a runtime component on which to act.
instanceid Required. ATTRIBUTE-FILE.
-o file Optional. Specifies the file where you want the output written.

Examples

  • To display the attributes of the EntireX Broker with the name "MyBroker" in the installation with alias name "local":

    sagcc get configuration data local
EntireXCore-EntireX-Broker-MyBroker ATTRIBUTE-FILE

  • To store the content of the attribute file of the EntireX Broker with the name "MyBroker" in the installation with alias name "local" in the file myAttributeFile.txt in the current working directory: 

    sagcc get configuration data local
EntireXCore-EntireX-Broker-MyBroker ATTRIBUTE-FILE -o myAttributeFile.txt

Updating the Content of the EntireX Broker Attribute File

Command Parameter Description
update configuration data node_alias Required. Specifies the alias name of the installation in which the runtime component is installed.
componentid Required. Specifies the component ID of a runtime component on which to act.
instanceid Required. ATTRIBUTE-FILE.
-i file Required. Specifies the file from where you want the input read.

Example

  • To load the content of the EntireX Broker attribute file myAttributeFile.json from the current working directory into the attribute file of the EntireX Broker with the name "MyBroker" in the installation with alias name "local": 

    sagcc update configuration data local
EntireXCore-EntireX-Broker-MyBroker ATTRIBUTE-FILE -i myAttributeFile.json

EntireX Broker Autostart Parameter

Displaying the Autostart Parameter

Here you can control the start behavior of an EntireX Broker. If Enable=true is set, the broker starts automatically with the next system start. The following table lists the parameters to include when configuring the autostart parameter of an EntireX component, using the Command Central configuration commands.

Command Parameter Description
get configuration data node_alias Required. Specifies the alias name of the installation in which the runtime component is installed.
componentid Required. Specifies the component ID of a runtime component on which to act.
instanceid Required. BROKER-AUTOSTART.
-o file Optional. Specifies the file where you want the output written.

Examples

  • To display the autostart parameters of the EntireX Broker with the name "MyBroker" in the installation with alias name "local":

    sagcc get configuration data local
EntireXCore-EntireX-Broker-MyBroker BROKER-AUTOSTART

  • To store the autostart parameters of the EntireX Broker with the name "MyBroker" in the installation with alias name "local" in the file autostart.json in the current working directory: 

    sagcc get configuration data local
EntireXCore-EntireX-Broker-MyBroker BROKER-AUTOSTART -o autostart.json

Updating the Autostart Parameter

Command Parameter Description
update configuration data node_alias Required. Specifies the alias name of the installation in which the runtime component is installed.
componentid Required. Specifies the component ID of a runtime component on which to act.
instanceid Required. BROKER-AUTOSTART.
-i file Required. Specifies the file from where you want the input read.

Example

  • To load the autostart parameters from the file autostart.json of the current working directory into the attribute file of the EntireX Broker with the name "MyBroker" in the installation with alias name "local": 

    sagcc update configuration data local
EntireXCore-EntireX-Broker-MyBroker BROKER-AUTOSTART -i autostart.json

Configuring EntireX Broker Monitoring KPIs

Displaying the Monitoring KPIs

Here you can modify the ranges of the KPIs for alerting for one broker instance.

KPI Setting
Absolute number of Clients "entirex.broker.kpi.1.max=200"
Critical alert relative to maximum "entirex.broker.kpi.1.critical=0.95"
Marginal alert relative to maximum "entirex.broker.kpi.1.marginal=0.80"
Absolute number of Servers "entirex.broker.kpi.2.max=50"
Critical alert relative to maximum "entirex.broker.kpi.2.critical=0.95"
Marginal alert relative to maximum "entirex.broker.kpi.2.marginal=0.80"
Absolute number of Conversations "entirex.broker.kpi.3.max=1000"
Critical alert relative to maximum "entirex.broker.kpi.3.critical=0.95"
Marginal alert relative to maximum "entirex.broker.kpi.3.marginal=0.80"

Do not change the other properties!

The following table lists the parameters to include when configuring the Monitoring KPIs' parameters of an EntireX component, using the Command Central configuration commands.

Command Parameter Description
get configuration data node_alias Required. Specifies the alias name of the installation in which the runtime component is installed.
componentid Required. Specifies the component ID of a runtime component on which to act.
instanceid Required. MONITORING-KPI.
-o file Optional. Specifies the file where you want the output written.

Examples

  • To display the monitoring KPI properties of the EntireX Broker with the name "MyBroker" in the installation with alias name "local": 

    sagcc get configuration data local
EntireXCore-EntireX-Broker-MyBroker MONITORING-KPI

  • To store the monitoring kpi properties of the EntireX Broker with the name "MyBroker" in the installation with alias name "local" in the file my.properties in the current working directory. 

    sagcc get configuration data local
EntireXCore-EntireX-Broker-MyBroker MONITORING-KPI -o my.properties

Updating the Monitoring KPIs

Command Parameter Description
sagcc update configuration data node_alias Required. Specifies the alias name of the installation in which the runtime component is installed.
componentid Required. Specifies the component ID of a runtime component on which to act.
instanceid Required. MONITORING-KPI.
-i file Required. Specifies the file from where you want the input read.

Example

  • To load the content of the my.properties file from the current working directory into the spm.properties of EntireX Broker with name = "MyBroker" in the installation with alias name "local": 

    sagcc update configuration data local
EntireXCore-EntireX-Broker-ETB001 MONITORING-KPI -i my.properties

Configuring the EntireX Broker Persistent Store

Here you can modify the EntireX Broker persistent store parameters:

Parameter Value
Enabled true | false
PStore COLD | HOT
PStoreType CTREE | ADABAS
PStoreAdabasDBID <dbid>
PStoreAdabasFNR <fnr>

See Broker-specific Attributes for description of the PSTORE parameters. The new parameters will be used with the next broker start. The following table lists the parameters to include when displaying or modifying persistent store parameters of an EntireX component, using the Command Central configuration commands.

Displaying the Persistent Store Parameters

Command Parameter Description
get configuration data node_alias Required. Specifies the alias name of the installation in which the runtime component is installed.
componentid Required. Specifies the component ID of a runtime component on which to act.
instanceid Required. BROKER-PSTORE.
-o file Optional. Specifies the file where you want the output written.

Examples

  • To display the persistent store properties of the EntireX Broker with the name "MyBroker" in the installation with alias name "local": 

    sagcc get configuration data local
EntireXCore-EntireX-Broker-MyBroker BROKER-PSTORE

  • To store the persistent store parameters of the EntireX Broker with the name "MyBroker" in the installation with alias name "local" in the file pstore.json in the current working directory: 

    sagcc get configuration data local
EntireXCore-EntireX-Broker-MyBroker BROKER-PSTORE -o pstore.json

Updating the Persistent Store Parameters

Command Parameter Description
update configuration data node_alias Required. Specifies the alias name of the installation in which the runtime component is installed.
componentid Required. Specifies the component ID of a runtime component on which to act.
instanceid Required. BROKER-PSTORE.
-i file Required. Specifies the file from where you want the input read.

Example

  • To load the parameters described in the pstore.json file from the current working directory into the attribute file of the EntireX Broker with the name "MyBroker" in the installation with alias name "local": 

    sagcc update configuration data local
EntireXCore-EntireX-Broker-MyBroker BROKER-PSTORE -i pstore.json

Configuring EntireX SSL Ports

Here you can modify the EntireX Broker SSL port configuration:

Parameter Value
Enabled true | false
Port <n> range from 1024 to 65535
KeyFile <filename>
KeyPasswdEncrypted <encrypted password>
KeyStore <filename>
TrustStore <filename>
ClientTrustStore <filename>

See SSL/TLS-specific Attributes for description of parameters. The new parameters will be used with the next broker start. The following table lists the parameters to include when displaying or modifying parameters of an EntireX component, using the Command Central configuration commands.

Displaying the EntireX Broker SSL Port Configuration

Command Parameter Description
get configuration data node_alias Required. Specifies the alias name of the installation in which the runtime component is installed.
componentid Required. Specifies the component ID of a runtime component on which to act.
instanceid Required. SSL.
-o file Optional. Specifies the file where you want the output written.

Examples

  • To display the SSL parameters of the EntireX Broker with the name "MyBroker" in the installation with alias name "local":

    sagcc get configuration data local EntireXCore-EntireX-Broker-MyBroker SSL

  • To store the SSL parameters of the EntireX Broker with the name "MyBroker" in the installation with alias name "local" in the file ssl.json in the current working directory: 

    sagcc get configuration data local
EntireXCore-EntireX-Broker-MyBroker SSL -o ssl.json

Updating the EntireX Broker SSL Port Configuration

Command Parameter Description
update configuration data node_alias Required. Specifies the alias name of the installation in which the runtime component is installed.
componentid Required. Specifies the component ID of a runtime component on which to act.
instanceid Required. SSL.
-i file Required. Specifies the file where you want the input read.

Example

  • To load the SSL parameters described in the ssl.json file from the current working directory into the attribute file of the EntireX Broker with the name "MyBroker" in the installation with alias name "local": 

    sagcc update configuration data local
EntireXCore-EntireX-Broker-MyBroker SSL -i ssl.json

Configuring EntireX TCP Ports

Here you can modify the EntireX Broker TCP port configuration:

Parameter Value
Enabled true | false
Port <n> range from 1024 to 65535

See TCP/IP-specific Attributes for description of parameters. The new parameters will be used with the next broker start. The following table lists the parameters to include when displaying or modifying parameters of an EntireX component, using the Command Central configuration commands.

Displaying the EntireX Broker TCP Port Configuration

Command Parameter Description
get configuration data node_alias Required. Specifies the alias name of the installation in which the runtime component is installed.
componentid Required. Specifies the component ID of a runtime component on which to act.
instanceid Required. TCP.
-o file Optional. Specifies the file where you want the output written.

Examples

  • To display the TCP parameters of the EntireX Broker with the name "MyBroker" in the installation with alias name "local":

    sagcc get configuration data local EntireXCore-EntireX-Broker-MyBroker TCP

  • To store the TCP parameters of the EntireX Broker with the name "MyBroker" in the installation with alias name "local" in the file tcp.json in the current working directory: 

    sagcc get configuration data local
EntireXCore-EntireX-Broker-MyBroker TCP -o tcp.json

Updating the EntireX Broker TCP Port Configuration

Command Parameter Description
update configuration data node_alias Required. Specifies the alias name of the installation in which the runtime component is installed.
componentid Required. Specifies the component ID of a runtime component on which to act.
instanceid Required. TCP.
-i file Required. Specifies the file where you want the input read.

Example

  • To load the parameters described in the tcp.json file from the current working directory into the attribute fileof the EntireX Broker with the name "MyBroker" in the installation with alias name "local": 

    sagcc update configuration data local
EntireXCore-EntireX-Broker-MyBroker TCP -i tcp.json

Configuring EntireX Broker Security

Here you can modify the EntireX Broker security configuration:

Parameter Value
Enabled true | false
AuthType OS | LDAP
LdapUrl ldap://HostName[:PortNumber]
LdapDn <string>

See Security-specific Attributes for description of parameters. The new parameters will be used with the next broker start. The following table lists the parameters to include when displaying or modifying parameters of an EntireX component, using the Command Central configuration commands. This section covers the following topics:

Displaying EntireX Broker Security Parameters

Command Parameter Description
get configuration data node_alias Required. Specifies the alias name of the installation in which the runtime component is installed.
componentid Required. Specifies the component ID of a runtime component on which to act.
instanceid Required. BROKER-SECURITY.
-o file Optional. Specifies the file where you want the output written.

Examples

  • To display the broker security parameters of the EntireX Broker with the name "MyBroker" in the installation with alias name "local": 

    sagcc get configuration data local
EntireXCore-EntireX-Broker-MyBroker BROKER-SECURITY

  • To store the security parameters of the EntireX Broker with the name "MyBroker" in the installation with alias name "local" in the file security.json in the current working directory: 

    sagcc get configuration data local
EntireXCore-EntireX-Broker-MyBroker BROKER-SECURITY -o security.json

Updating EntireX Broker Security Parameters

Command Parameter Description
update configuration data node_alias Required. Specifies the alias name of the installation in which the runtime component is installed.
componentid Required. Specifies the component ID of a runtime component on which to act.
instanceid Required. BROKER-SECURITY.
-i file Required. Specifies the file from where you want the input read.

Example

  • To load the parameters described in the security.json file from the current working directory into the attribute fileof the EntireX Broker with the name "MyBroker" in the installation with alias name "local": 

    sagcc update configuration data local
EntireXCore-EntireX-Broker-MyBroker BROKER-SECURITY -i security.json

Configuring the EntireX Broker Trace Level

Here you can modify the EntireX Broker trace configuration:

"Tracelevel":"0", "1", "2", "3" or "4"

See TRACE-LEVEL for description of the attribute. The new parameter will be used with the next broker start. The following table lists the parameters to include when displaying or modifying parameters of an EntireX component, using the Command Central configuration commands.

Displaying EntireX Broker Trace Level

Command Parameter Description
get configuration data node_alias Required. Specifies the alias name of the installation in which the runtime component is installed.
componentid Required. Specifies the component ID of a runtime component on which to act.
instanceid Required. BROKER-TRACELEVEL.
-o file Optional. Specifies the file where you want the output written.

Examples

  • To display the broker tracelevel parameters of the EntireX Broker with the name "MyBroker" in the installation with alias name "local": 

    sagcc get configuration data local
EntireXCore-EntireX-Broker-MyBroker BROKER-TRACELEVEL

  • To store the trace level parameters of the EntireX Broker with the name "MyBroker" in the installation with alias name "local" In the file trace.json of the current working directory: 

    sagcc get configuration data local
EntireXCore-EntireX-Broker-MyBroker BROKER-TRACELEVEL -o trace.json

Updating EntireX Broker Trace Level

Command Parameter Description
update configuration data node_alias Required. Specifies the alias name of the installation in which the runtime component is installed.
componentid Required. Specifies the component ID of a runtime component on which to act.
instanceid Required. BROKER-TRACELEVEL.
-i file Required. Specifies the file from where you want the input read.

Example

  • To load the parameters described in the trace.json file from the current working directory into the attribute file of the EntireX Broker with the name "MyBroker" in the installation with alias name "local": 

    sagcc update configuration data local
EntireXCore-EntireX-Broker-MyBroker BROKER-TRACELEVEL-i trace.json

Logging EntireX Broker

Here you can view, get the content of, or download the EntireX Broker log files. The following table lists the parameters to include when displaying or modifying parameters of an EntireX component, using the Command Central list commands.

Listing all EntireX Broker Log Files

Command Parameter Description
list diagnostics logs node_alias Required. Specifies the alias name of the installation in which the runtime component is installed.
componentid Required. Specifies the component ID of a runtime component on which to act.

Example

  • To list the log files of the EntireX Broker with the name "MyBroker" in the installation with alias name "local":

    sagcc list diagnostics logs local EntireXCore-EntireX-Broker-MyBroker

Getting Content from or Downloading EntireX Broker Log Files

Command Parameter Description
get diagnostics logs node_alias Required. Specifies the alias name of the installation in which the runtime component is installed.
componentid Required. Specifies the component ID of a runtime component on which to act.
full | tail | head Optional. Shows full log file content, or only tail or head.
export -o file Optional. Creates a zip file of the logs.

Examples

  • To list the tail of the log file MyBroker.log of the EntireX Broker with the name "MyBroker" in the installation with alias name "local": 

    sagcc get diagnostics logs local
EntireXCore-EntireX-Broker-MyBroker MYBROKER.log tail

  • To create and download a zip file myfile.zip of the logs of the EntireX Broker with the name "MyBroker" in the installation with alias name "local". 

    sagcc get diagnostics logs local
EntireXCore-EntireX-Broker-MyBroker export -o myfile.zip

Administration

EntireX Broker Services

Here you can view and control EntireX Broker Services. The following table lists the parameters to include when displaying or modifying parameter of an EntireX component, using the Command Central configuration commands. This section covers the following topics:

List Running EntireX Broker Services

Command Parameter Description
list administration component Specifies that a component will be administered.
node_alias Required. Specifies the alias name of the installation in which the runtime component is installed.
componentid Required. Specifies the component ID of a runtime component on which to act.
Services Specifies what is to be administered.
listServices Required. List all services.
-f xml | json Required. Specifies XML or JSON as the output format.

Examples

  • To display a list of services of the running EntireX Broker with the name "MyBroker" in the installation with alias name "local".broker in JSON format: 

    sagcc list administration component local
EntireXCore-EntireX-Broker-MyBroker Services listServices -f json

  • To store a list of services of the EntireX Broker with the name "MyBroker" in the installation with alias name "local" in JSON format in the file services.json of the current working directory: 

    sagcc list administration component local
EntireXCore-EntireX-Broker-MyBroker Services listServices -o services.json

Stop Running EntireX Broker Services

Command Parameter Description
exec administration component Specifies that a component will be administered.
node_alias Required. Specifies the alias name of the installation in which the runtime component is installed.
componentid Required. Specifies the component ID of a runtime component on which to act.
Services Specifies what is to be administered.
stopService Required. Stop a service.
serviceName=class/server/service Required. Name of a service to stop.
-f json | text | xml Required. Specifies the output format.

Example

  • To stop all servers of the service RPC/SRV1/CALLNAT of the EntireX Broker with the name "MyBroker" in the installation with alias name "local": 

    sagcc exec administration component local
EntireXCore-EntireX-Broker-MyBroker Services stopService serviceName=RPC/SRV1/CALLNAT -f text

List EntireX Broker Server Instances

Command Parameter Description
list administration component Specifies that a component will be administered.
node_alias Required. Specifies the alias name of the installation in which the runtime component is installed.
componentid Required. Specifies the component ID of a runtime component on which to act.
Services Specifies what is to be administered.
listServers Required. List all servers.
serviceName=class/server/service Optional. Shows only servers of this service.
-f xml | json Required. Specifies XML or JSON as the output format.

Examples

  • To display all servers of the EntireX Broker with the name "MyBroker" in the installation with alias name "local" in XML format:

    sagcc list administration component local
EntireXCore-EntireX-Broker-MyBroker Services listServers -f xml

  • To display a list of servers of the current service of the EntireX Broker with the name "MyBroker" in the installation with alias name "local" in XML format: 

    sagcc list administration component local
EntireXCore-EntireX-Broker-MyBroker Services listServers serviceName=RPC/SRV1/CALLNAT -f xml

  • To store a list of servers in JSON format in the file services.json of the current working directory:

    sagcc list administration component local
EntireXCore-EntireX-Broker-MyBroker Services listServers serviceName=RPC/SRV1/CALLNAT -o server.json

Stop EntireX Broker Server Instances

Command Parameter Description
exec administration component Specifies that a component will be administered.
node_alias Required. Specifies the alias name of the installation in which the runtime component is installed.
componentid Required. Specifies the component ID of a runtime component on which to act.
Services Specifies what is to be administered.
stopServer Required. Stop a specific server.
physicalUserId= piud Required. Physical user ID of the server to be stopped; puid can be got by the list server instances command.
-f json | text | xml Required. Specifies the output format.

Example

  • To stop server with puid: MTZBcHIwNC0wNzU4MzAtMDAwMDAwLTAwMDAwOQ==of the EntireX Broker with the name "MyBroker" in the installation with alias name "local": 

    sagcc exec administration component local
EntireXCore-EntireX-Broker-MyBroker Services stopServer  physicalUserId=MTZBcHIwNC0wNzU4MzAtMDAwMDAwLTAwMDAwOQ== -f text

Administering EntireX Broker Trace Level

Here you can dynamically control the trace level of a running EntireX Broker. The following table lists the parameters to include when displaying or modifying parameter of an EntireX component, using the Command Central exec administration command. The change is effective immediately; there is no need to restart the EntireX Broker.

Displaying the Trace Level of a Running EntireX Broker

Command Parameter Description
exec administration component Required. Specifies that a component will be administered.
node_alias Required. Specifies the alias name of the installation in which the runtime component is installed.
componentid Required. Specifies the component ID of a runtime component on which to act.
Trace_Level Required. Specifies what is to be administered.
load tracelevel=? Required. Get the trace level.
-f xml | json Required. Specifies XML or JSON as the output format.

Examples

  • To display the current tracelevel of the running EntireX Broker with the name "MyBroker" in the installation with alias name "local" in JSON format on stdout: 

    sagcc exec administration component local EntireXCore-EntireX-Broker-MyBroker Trace_Level load tracelevel=? -f json

  • To display the current trace level of the running EntireX Broker with the name "MyBroker" in the installation with alias name "local" in XML format on stdout: 

    sagcc exec administration component local EntireXCore-EntireX-Broker-MyBroker Trace_Level load tracelevel=? -f xml

Updating the Trace Level of a Running EntireX Broker

Command Parameter Description
exec administration component Required. Specifies that a component will be administered.
node_alias Required. Specifies the alias name of the installation in which the runtime component is installed.
componentid Required. Specifies what is to be administered.
Trace_Level Required.
update tracelevel=0|1|2|3|4 Required. Update the trace level of a running broker.
-f xml | json Required. SpecifiesXML or JSON as the output format.

Example

  • To change the current trace level of the running EntireX Broker with the name "MyBroker" in the installation with alias name "local": 

    sagcc exec administration component local EntireXCore-EntireX-Broker-MyBroker Trace_Level update tracelevel=2 -f json