The script to run Persistence Service’s executable is located in <NDDSHOME>/bin.
RTI Persistence Service Usage: rtipersistenceservice [options] Options: -cfgFile <file> Configuration file. This parameter is optional since the configuration can be loaded from other locations -cfgName <name> Configuration name. This parameter is required and it is used to find a <persistence_service> matching tag in the configuration files -appName <name> Application name. Used to identify this execution for remote administration and to name the DomainParticipants Default: -cfgName -identifyExecution Appends the host name and process ID to the appName to help ensure unique names -domainId <int> domain ID for the DomainParticipants created by the service Default: Use XML value -remoteAdministrationDomainId <int> Enables remote administration and sets the domain ID for the communication Default: Use XML value -restore <0|1> Indicates whether or not persistence service must restore its state from the persistent storage
Default: Use XML value -noAutoStart Use this option if you plan to start RTI Persistence Service remotely -infoDir <dir> The info directory of the running persistence service. The service writes a ps.pid file into this directory when is started. When the service finalizes the file is deleted Default: None -maxObjectsPerThread <int> Sets the maximum number of objects that can be stored per thread for a DomainParticipantFactory
Default: Connext DDS default -serviceThreadStackSize <int> Service thread stack size Default: OS default -disableDatabaseLocking Disable database locking Default: Enabled -heapSnapshotPeriod <sec> Enables heap monitoring. Persistence Service will generate a heap snapshot every <sec> Default: heap monitoring is disabled Valid range: [1, 86400] -heapSnapshotDir <dir> When heap monitoring is enabled this parameter configures the directory where the snapshots will be stored. The snapshot file name format is PS_heap_<appName>_<processId>_<index>.log Default: current working directory -verbosity [0-6] RTI Persistence Service verbosity
* 0 - silent
* 1 - exceptions (Core Libraries and Service)
* 2 - warnings (Service)
* 3 - information (Service)
* 4 - warnings (Core Libraries and Service)
* 5 - tracing (Service)
* 6 - tracing (Core Libraries and Service)
Default: 1 (exceptions) -version Prints RTI Persistence Service version -help Displays this information
The command-line options are described with more detail in Persistence Service Command-Line Options
|
Command-line Option |
Description |
|
-appName <string> |
Assigns a name to the execution of Persistence Service. Remote commands will refer to the persistence service using this name. In addition, the name of the DomainParticipants created by Persistence Service will be based on this name as follows: RTI Persistence Service: <appName>: <participantName>(<pub|sub>) Default: The name given with -cfgName if present, otherwise it is “RTI_Persistence_Service” |
|
-cfgFile <string> |
Specifies an XML configuration file for the Persistence Service. The parameter is optional since the Persistence Service configuration can be loaded from other locations. See How to Load the Persistence Service XML Configuration for further details. |
|
-cfgName <string> |
Required. Selects a Persistence Service configuration. The same configuration files can be used to configure multiple persistence services. Each Persistence Service instance will load its configuration from a different <persistence_service> tag based on the name specified with this option. If not specified, Persistence Service will print the list of available configurations and then exit. |
|
-identifyExecution |
Appends the host name and process ID to the service name provided with the -appName option. This helps ensure unique names for remote administration. |
|
-disableDatabaseLocking |
Disables database locking. If Persistence Service is started with this flag, the database locking mechanism used to detect other instances using the same database will be disabled. This feature only has effect when <persistent_storage> is used. Default: Database locking is enabled by default |
|
-domainId <ID> |
Sets the domain ID for the DomainParticipants created by Persistence Service. If not specified, the value in the <participant> XML tag (see Participant Tags) is used. |
|
-remoteAdministrationDomainId <ID> |
Enables remote administration and sets the domain ID for remote communication. When remote administration is enabled, Persistence Service will create a DomainParticipant, Publisher, Subscriber, DataWriter, and DataReader in the designated DDS domain. This option overwrites the value of the tag <domain_id> within <administration>. Default: Use the value <domain_id> under <administration>. |
|
-help |
Prints the Persistence Service version and list of command-line options. |
|
-licenseFile <file> |
Specifies the license file (path and filename). Only applicable to licensed versions of Persistence Service. If not specified, Persistence Service looks for the license as described in the RTI Connext DDS Core Libraries Getting Started Guide. |
|
-restore <0|1> |
Indicates whether or not Persistence Service must restore its state from the persistent storage. 0 = do not restore; 1 = do restore. If this option is not specified, the corresponding XML value in the <persistent_storage> tag (see Persistent Storage tags) is used. |
|
-noAutoStart |
Indicates that Persistence Service will not be started when the process is executed. Use this option if you plan to start Persistence Service remotely, as described in Administering Persistence Service from a Remote Location. |
|
-infoDir <dir> |
The info directory of the running Persistence Service. Using this command line option, Persistence Service can be configured to create a file used to monitor the status of the last shutdown. At startup, the Persistence Service instance will create a file called ps.pid into the directory specified by -infoDir. If Persistence Service is shutdown gracefully, the file will be deleted before the process exists. If Persistence Service is not shutdown gracefully, the file will not be deleted. You can detect the shutdown state of Persistence Service by checking for the presence of the ps.pid file. If the file is present and Persistence Service is no longer running, the previous shutdown was not graceful. If Persistence Service is started and a ps.pid file exists, Persistence Service will immediately shutdown. In this case, you must remove the file before Persistence Service can be restarted again. Default: The file ps.pid will not be generated. |
|
-maxObjectsPerThread <int> |
Parameter used to configure the maximum objects per thread in the DomainParticipantFactory created by Persistence Service. Default: DDS default |
|
-serviceThreadStackSize <int> |
Service thread stack size. Default: DDS default |
|
-verbosity |
Persistence Service verbosity: 0 - No verbosity 1 - Exceptions (Core Libraries and Persistence Service) (default) 2 - Warning (Persistence Service) 3 - Information (Persistence Service) 4 - Warning (Core Libraries and Persistence Service) 5 - Tracing (Persistence Service) 6 - Tracing (Core Libraries and Persistence Service) Each verbosity level, n, includes all the verbosity levels smaller than n. |
|
-version |
Prints the Persistence Service version. |
© 2018 RTI