Command Line Options
Command-line options configure an NMS service when it starts. This section lists common Service options and the additional options accepted by individual services. Consult the applicability information in each section: DBService and ODService have separate parsers, and options accepted by one service are not necessarily accepted by another. Adapter-specific options are documented in the Adapters Guide; DMSService options are documented with the Power Flow Services reference.
Supply options in the program or instance entries in system.dat and restart the affected service to apply changes. The -init option for SMService, DBService, and ODService is intended for the initialization configuration, system.dat.init. Defaults below describe behavior when an option is omitted; an explicit setting in a project configuration overrides that default.
In the syntax below, angle brackets identify required values, square brackets identify optional values, and an ellipsis permits repetition. Enter values without the brackets and preserve the spelling and case shown.
Common Service Options
These entries apply to SMService, DDService, JMService, MBService, MTService, SwService, TSService, corbagateway, publisher, mycentricity, RTAdapter, CalcAdapter, IccpAdapter, IVRAdapter, DMSService. DBService and ODService use separate parsers and handlers; use their own sections. A service-specific entry takes precedence over a common entry. The publisher process uses the corbagateway handler.
-dbname <name>
Connect to the named DBService environment. Use the same name supplied to DBService -service.
Example:
DBService -service dd -process_name DDDBService
DDService -dbname dd
-debug [<level> | <facility> [level] ...]
Enable service debugging. Without arguments, enable global debugging. A numeric argument selects the global level. Facility/level pairs select individual facilities; a facility without a level uses 1.
Notes: Set -debug_bitwise on before -debug to select several individual levels per facility. Facility names are registered by the target service and are case-sensitive.
-debug_bitwise <on|off>
Select independent debug levels rather than all levels up to a threshold. Only the value on enables this mode.
Default: Off.
-debugDevice <device>
Restrict device-specific diagnostic output to the specified device.
Aliases: -debug_device, -deviceDebug, -device_debug.
-disable_debug_thread <name> [name ...]
Suppress debug output for threads whose names contain one of the specified strings.
-dumpcache
Dump service caches when supported by the target service during shutdown, restart, or a warm-to-hot transition.
Default: Disabled.
-nodaemon
Compatibility option accepted by the shared parser. It makes no change; foreground operation is already the default.
-pgtiming <on|off|start|stop|0|1> | -pgtiming stats <on|off|start|stop|dump|print|clear|reset>
Control process-group timing output or separately collect accumulated process-group statistics.
Notes: Timing and statistics collection are separate controls. Arguments are lowercase as shown. Missing or unrecognized arguments leave the corresponding setting unchanged. Output appears in the target service log; these diagnostic settings are local to the process and do not update system.dat.
• on or start: enable timing output; off or stop: disable it. Numeric 0 disables timing and a positive integer enables it.
• stats on or stats start: begin collecting statistics. stats off or stats stop: print the accumulated statistics and stop collection.
• stats dump or stats print: print accumulated statistics without clearing them or stopping collection.
• stats clear: clear accumulated statistics without printing their previous values. stats reset: print the accumulated statistics, then clear them. Neither changes whether collection is enabled.
Example:
MTService -pgtiming stats on
-trace_msgs
Enable CMMS message tracing.
Use: Oracle Support diagnostics.
-warm
Start as a non-primary warm instance and set database access to read-only. Only use with services configured to support warm operation.
Prerequisites: A supported warm-service deployment.
SMService
The common service entries also apply, except where overridden below.
-file <filename>
Read service configuration from the selected system.dat file.
Default: $NMS_HOME/etc/system.dat.
-init
Enable system-monitor initialization mode for the minimal service set in system.dat.init.
Prerequisites: Intended for system.dat.init during system initialization, not the normal system.dat service configuration.
Notes: The supplied system.dat.init.template enables -init for SMService, DBService, and ODService.
Example:
program SMService SMService -init
-local
Use localhost as the local server name when matching configuration.
-noinit
Do not force-reset instance state during initial configuration.
-parallel
Start managed processes in parallel.
-serial
Start managed processes serially.
DBService
-database <database>
Select the logical RDBMS database.
Default: RDBMS_HOST environment variable when the option is omitted.
-debug [level] | -debug <facility> <level> | -debug logging
Configure DBService debug output. With no value, use level 1. The logging form enables database-logging diagnostics.
-debugSqlTiming <milliseconds>
Log SQL execution timing. Value 1 logs all statements; larger values log statements exceeding the threshold in milliseconds. Value 0 disables timing output.
-forceCursorSharing
Set cursor_sharing to FORCE for RDBMS sessions managed by this DBService.
-init
Start in initialization mode for the services configured in system.dat.init.
Prerequisites: Intended for system.dat.init during system initialization, not the normal system.dat service configuration.
Caution: Use only as part of the system initialization procedure; return to the normal service configuration for regular operation.
Notes: Sets DBS_INIT_MODE=YES and bypasses the normal active-environment startup check. A non-UTC database timezone is reported as a warning rather than a fatal error so initialization/migration can proceed.
Example:
program DBService DBService -init
-logs <directory>
Set the DBService log directory.
Default: LOG_DIRECTORY, or /usr/cmms/logs if unset.
-maxconnections <count>
Set the maximum number of concurrent RDBMS connections (dbrdwr processes).
-period <seconds>
Set the connection initialization retry interval; values below 5 are raised to 5 seconds.
-process_name <name>
Use a process name other than the executable name.
-queryOut
Enable copying SQL queries to standard output. This startup flag takes no value; use the queryout message to change it at runtime.
-service <name>
Set the database service environment name.
Default: ops.
-singlethread
Limit DBService to one RDBMS connection.
Aliases: -s.
-sqlOut
Enable copying SQL updates to standard output. This startup flag takes no value; use the sqlout message to change it at runtime.
-warm
Start as a non-primary warm instance.
Prerequisites: A configured warm-service deployment.
DDService
The common service entries also apply, except where overridden below.
-alarms [category ...]
Select categories of generated alarms. Categories can be combined.
Default: ALL when -alarms has no values.
Notes: Non-status digital-change alarms are controlled separately by the alarmDigital rule.
• CONDITIONS: tag, note, and condition actions.
• EVENTS: controls sent to SCADA.
• EXP or MANUAL: manually initiated device operations.
• UNEXP: SCADA device operations.
• MEASURES: measurement changes and overrides.
• ABNORMAL: abnormal device statuses.
• SMS: service-monitor alarms.
• SCADA_OFF_NOMINAL: off-nominal SCADA pseudo alarms; excluded from ALL.
• ALL: all standard alarm categories.
-alarmUncontrolledZones [seconds]
Generate alarms for control zones without a controller or subscriber. The optional value is the repeat interval in seconds; without it, use one-shot annunciation.
-allowReset
Allow a full model reset for testing or training.
Caution: Never enable on a production system.
-alphaZoneSort
Sort authority-tool zones alphabetically instead of by CONTROL_ZONES.sequence.
-czTimeOut <seconds>
Set the control-zone transfer timeout.
Default: 300 seconds.
-delegate [ncg] [crew]
Enable delegated-zone processing. With no values, only the delegating owner can operate devices. ncg permits authorized NCG users; crew prevents operations while a crew is assigned. Both values can be combined.
-doNotSyncSCADA
Do not automatically remove Instruct conditions when a SCADA control response arrives.
Caution: Changes normal SCADA synchronization behavior; use only for the intended interface configuration.
-enableODSCache
Enable local Object Directory client caching.
-lookAheadIgnoreClasses <class,class,...>
Skip the listed condition classes when populating Look Ahead conditions.
Aliases: -laic.
-maxStudySessions <count>
Limit open study sessions; each session consumes MTService and DMSService memory.
Default: 50.
-noconditionloc
Disable condition coordinates.
-nopurgehistory
Disable automatic history-table purging.
-noScadaEvents
Suppress alarms generated for SCADA events when the interface already supplies those alarms.
-override
Override the wait period for manually operated telemetered devices. For devices with digital measurements but no controls-table entry, measurement attribute 0 remains the SCADA-reported state.
-period [value]
Accepted for compatibility; has no effect.
Status: Obsolete.
-preventGroundedTagRemoval
Prevent removing tags from a grounded or earthed segment.
-purgehistory <hh:mm>
Schedule automatic history purging at the specified daily time.
Default: 00:15.
-sendAsyncSCADA
Enable asynchronous SCADA control messages for interfaces that cannot subscribe to message-bus process groups.
-shadow
Accepted for compatibility; has no effect.
Status: Obsolete.
-subscribezone
Accepted for compatibility; subscription mode is now the only supported zone-ownership mode.
Status: Obsolete.
-summaryobjects
Enable mapping conditions to secondary summary objects on other maps.
-systemNCG <ncg>
Select the network control group used for system alarms.
-user
This option is unavailable and terminates DDService startup.
Status: Unavailable.
-validateOperation
Check CLOSE operations for connections between hot phases.
Caution: Adds processing overhead; intended for models with cross-phase objects.
-zones
Enable control-zone authorization.
JMService
The common service entries also apply, except where overridden below.
-groupingParam <name=value> [name=value ...]
Override grouping scheduler parameters.
• GRPQ_BLOCKSIZE_HIGH=350 and GRPQ_BLOCKSIZE_LOW=200: maximum calls per iteration when congested and normal.
• GRPQ_USER_REQ_HIGH=25 and GRPQ_USER_REQ_LOW=5: calls processed before allowing user requests.
• GRPQ_CONGEST_LEVEL=5000: grouping queue congestion threshold.
• GRPQ_MAX_USER_REQ=2: pending user requests that interrupt grouping.
• GRPQ_WAIT_TIMEOUT=120000: user-request wait timeout in milliseconds.
• STABLE_WAIT_THRESHOLD=2,3: high and low broadcast thresholds, in that order.
-noAutoERT
Disable automatic estimated-restoration-time calculations; users and interfaces can still assign ERTs.
-noBroadcaster
Disable outage broadcasting for external OMS integrations.
-noGrouping
Disable outage grouping for external OMS integrations.
MBService
The common service entries also apply, except where overridden below.
-allowPending <value>
Obsolete compatibility option. The parser still consumes the next argument; remove this option from startup configuration.
Status: Obsolete.
-deleteConditions [condition_class ...]
Allow deletion of devices with conditions of the listed classes; report affected devices. With no classes, allow all condition classes.
Caution: Without this override, deleting a device with conditions aborts the build.
-deleteOffNominalCls <device_class> [device_class ...]
Allow deletion of off-nominal devices of the listed classes and report them.
-deleteOffNominals
Allow deletion of all off-nominal devices and report them.
Caution: Without an override, deleting off-nominal devices aborts the build.
-destinations <mask>
Select error-report destinations by concatenating their letters.
• D: database; E: standard error (service log); F: patch error file; B: broadcast; S: system log; N: no destinations.
Example:
MBService -destinations SED
-disableConnectionCheck
Do not assign new generic nodes when the number of connections to a node changes.
-export
Export electrical model files under $OPERATIONS_MODELS/export when generating updated map files. Background maps are excluded.
-exportxml
Add XML model exports alongside the -export output.
Prerequisites: -export.
-lookupChangedNCG
Use FEEDER_NCG to identify the new NCG when promoting an alternate view with a new partition.
-monitor_model_interval <seconds>
Set the positive interval for monitoring model changes.
-nojms
Run without JMService, as in a model-build environment or initial build.
-offline
Enable initial offline model-build operation without the full service set.
-previewMaps
Generate preliminary maps after a patch is applied.
-report
Generate a readable patch-change report in data/reports/Patch\#.report.
-sortFeeders
Populate downstream switch SORT_ID attributes within feeder-based geographic partitions.
Prerequisites: Feeder-based partitioning, appropriate attribute-table columns, and DEVICE_ATTRIBUTES mappings.
Notes: Values combine the switch and parent IDs, for example 00002-00001.
MTService
The common service entries also apply, except where overridden below.
-cc_threshold <count>
Set the connected-component chooser threshold.
Use: Oracle Support diagnostics.
-groundThroughFIDs
Propagate ground color through feeder heads.
Caution: Can require solving an entire island instead of one feeder, reducing performance. Grounded and energized colors can produce FAULT coloring near feeder heads.
-ignoreloops
Disable loop processing when loop colors are not required, reducing topology-processing cost.
-includeDevOnDownstream
Include supply nodes connected to the operated device when determining downstream affected customers in Look Ahead.
Notes: The option name is case-insensitive. Use -includeDevOnDownstream; the longer spelling -includeDeviceOnDownstream in older documentation is not recognized.
-name <name>
Set the MTService process name.
-phaseCheckXFMs <class_number> [class_number ...]
Check nominal energization for listed device classes attached to supply nodes. Log partially energized instances and treat only the hot phases as available.
Caution: Remove after correcting the model; checking can substantially slow startup and recache.
-simple_network_protector_solves
Disable complex HV/LV network protector processing.
Aliases: -snps.
-sth
Enable single-threaded topology processing.
Use: Oracle Support diagnostics.
ODService
-aggregates
Cache aggregate definitions, including those used for Feeder Focus.
-cache <class> [class ...]
Cache aliases for the specified device classes.
-db_types <type> [type ...]
Load aliases for the specified ALIAS_MAPPING.DB_TYPE values.
-debug [<facility> <level>]
Enable default debugging when no facility is supplied, or set one named facility level.
-delay [minutes]
Delay loading alias information to allow other services to start.
Default: 30 minutes when -delay is supplied without a value.
-dumpcache
Dump caches when stopping, restarting, or transitioning from warm to active operation.
-exclusive
Limit the expected service membership to one instance.
-ignore <db_type> [db_type ...]
Exclude specified database types when caching aliases.
-init
Start in initialization mode for the services configured in system.dat.init.
Prerequisites: Intended for system.dat.init during system initialization, not the normal system.dat service configuration.
Caution: Use only as part of the system initialization procedure; return to the normal service configuration for regular operation.
Notes: Bypasses the normal check requiring an active environment or a warm service instance.
Example:
program ODService ODService -init
-locations
Cache object locations.
-mru [count]
Enable the most-recently-used alias cache. Alias lookup checks the MRU cache, the general cache, then the database.
Default: When enabled without a count, use 10 entries.
Notes: The supplied system.dat.template explicitly configures 100 entries.
-noalias <class> [class ...]
Do not query aliases for the listed classes. The accepted option is -noalias; -noAliases is not recognized.
-nonotify
Do not receive model-build notifications.
Use: Oracle Support diagnostics.
-period <seconds>
Set initialization retry interval; the minimum is 5 seconds.
-stats
Enable MRU cache statistics.
-warm
Start as a non-primary warm instance with read-only database access.
SwService
The common service entries also apply, except where overridden below.
-connectRetry <count>
Set retry count for web-service network failures. Values are clamped to 0 through 8; retry delay doubles from 1 second up to 32 seconds.
Default: 0 (no retries).
-outgoingURL <url>
Set the NMS switching web-service endpoint.
Example:
SwService -outgoingURL https://<host>:<port>/ExternalSwmanServiceImpl
-process_name <name>
Use a process name other than SwService.
-sslCert <file>
Set the SSL certificate used for switching web-service access.
-wallet <directory>
Set the wallet folder containing credentials for the switching web service.
TSService
The common service entries also apply, except where overridden below.
-feederClass <class_name>
Select the feeder class used to build Trouble Summary information.
-help
Print startup usage and stop without starting normal processing.
Notes: The legacy usage text advertises -db. That switch is not accepted by the parser; use the common -dbname \<name\> option for database selection.
-noTroubleSum
Disable Trouble Summary calculation while allowing a configured outage-summary script to run.
-outageSumPeriod <minutes>
Set the positive interval for running the outage-summary script.
Default: 10 minutes.
-outageSumScript <script>
Set the script to run for outage-summary updates.
Default: No outage-summary script is run.
-period <minutes>
Set the positive interval for Trouble Summary recalculation.
Default: 10 minutes.
corbagateway
The common service entries also apply, except where overridden below.
-db_connections <count>
Set the number of database connections created when the gateway starts.
Default: 30.
-enableodscache
Enable Object Directory client caching.
-help
Print gateway and advertised TAO ORB startup options, then exit.
-implname <name>
Set the InterSys implementation name registered with the CORBA Naming Service.
Default: InterSys.
-intersys_agent_round_trip_timeout <seconds>
Set the positive CORBA publisher request round-trip timeout.
Default: 30 seconds.
Prerequisites: -publisher.
-iorfile <filename>
Write the InterSys interoperable object reference to the selected file.
-logfile <filename>
Accepted and its value consumed, but no longer used to select a log.
Status: Obsolete.
-numThreads <count>
Set the number of CORBA event-loop threads to a positive integer.
Default: 1.
Notes: The compiled default is 1; the supplied system.dat.template configures corbagateway with 15 threads.
-ORBDebugLevel <level>
Set ORB diagnostics; higher levels produce more output.
Default: 0.
Notes: TAO ORB option; separate from NMS -debug facilities.
-ORBInitRef NameService=<IOR>
Set the CORBA Naming Service object reference.
Notes: Consumed by TAO ORB_init before the NMS service parser.
Example:
corbagateway -ORBInitRef NameService=iioploc://<host>:<port>/NameService
-ORBListenEndpoints <endpoint>
Select the interface/endpoint on which the server ORB listens.
Notes: Consumed by TAO ORB_init before the NMS service parser.
-ORBLogFile <filename>
Redirect ACE_DEBUG and ACE_ERROR output to the selected ORB log file.
Notes: TAO ORB option; separate from the NMS service log.
-ORBNegotiateCodesets <0|1>
Enable code-set negotiation with 1 or omit it with 0.
Default: 1.
Caution: Disabling negotiation prevents interoperability with ORBs using different character encodings.
Notes: TAO ORB option consumed before the NMS parser. The gateway usage spells this -ORBNegotiateCodesets; system.dat.template uses -ORBNegotiateCodeSets. Preserve the spelling supported by the installed TAO build.
-ORBSvcConf <filename>
Load TAO service-configuration directives from the specified file.
Notes: TAO ORB option.
-ORBVerboseLogging <0|1|2>
Set the amount of status information included on ORB debug-log lines.
Default: 0.
Notes: TAO ORB option.
-parallel
Accepted for compatibility; no longer used.
Status: Obsolete.
-process_name <name>
Set the gateway process identity used on the NMS message bus.
-pub_interval <iterations>
Set the positive number of event-processing iterations between publisher heartbeat messages.
Default: 13 iterations.
Prerequisites: -publisher.
-pub_timeout <milliseconds>
Set the positive sleep interval between publisher event-processing iterations.
Default: 800 milliseconds.
Prerequisites: -publisher.
-publisher [exclusive] [nocorba|corba_only]
Enable the publisher in this gateway instance.
Notes: The suboptions are case-sensitive. Select the publisher mode appropriate to this instance in system.dat.
• exclusive: run the publisher without the InterSys request implementation.
• nocorba: use publisher operation without a CORBA publisher object.
• corba_only: select CORBA-only publisher mode.
-scadacontrols
Allow Java client requests to issue SCADA controls through this gateway instance.
Default: Client-issued SCADA controls rejected.
Caution: Enable only on the intended client-request gateway instance.
-username <name>
Set the USERNAME environment value used for NMS gateway messaging. This does not change the operating-system login.
-xmldir <directory>
Set the directory containing XML and XSL files.
Aliases: -cwd.
Notes: -cwd is deprecated; use -xmldir. Directory separators are normalized and a trailing separator is added.
mycentricity (Service Alert)
The common service entries also apply, except where overridden below.
-check [count]
Set the number of events checked during Service Alert processing. Without a count, select the maximum supported integer count.
Default: 0.
-crew
Enable crew-action processing.
-cust_columns <column1,column2,...>
Include the specified extra CES_CUSTOMERS columns in customer data.
Notes: Supply a comma-separated list as one argument.
-devattr
Load device-class attributes for Service Alert processing.
-devopwait <seconds>
Set the device-operation wait to a positive number of seconds.
Default: 0.
-encoding <name>
Set the XML output encoding.
Default: UTF-8.
-help
Print Service Alert startup usage and exit.
-logfile <filename>
Consume a legacy logfile argument without changing the log destination.
Status: Obsolete.
-nhub <group>
Set the Notification Hub contact group.
-persistent
Enable persistent delivery for Service Alert email and script messages.
-xmldir <directory>
Select the directory containing XML and XSL files.
Aliases: -cwd.