Difference between revisions of "Recitaladmin"

From Recital Documentation Wiki
Jump to: navigation, search
(broadcast)
Line 14: Line 14:
 
===--convert <args>===
 
===--convert <args>===
 
This option is used to convert data from disparate hardware platforms  and  databases into and out of  Recital Databases.  See [[recitalconvert]] for full details.
 
This option is used to convert data from disparate hardware platforms  and  databases into and out of  Recital Databases.  See [[recitalconvert]] for full details.
 +
 +
===--users [ <args> ]===
 +
Perform user administration tasks on Recital.  See [[recitalusers]] for full details.
  
 
===--execute filename [ <args> ]===
 
===--execute filename [ <args> ]===
Line 20: Line 23:
 
  recitaladmin --execute  mqagent
 
  recitaladmin --execute  mqagent
 
</code>
 
</code>
 
===--users [ <args> ]===
 
Perform user administration tasks on Recital.  See [[recitalusers]] for full details.
 
  
 
===start [ -l | logging ]===
 
===start [ -l | logging ]===

Revision as of 17:38, 21 January 2010

Administration management tool used with the Recital software suite. It takes the following arguments.

Note: recitaladmin must be run as root. For systems with a hidden root account, please precede commands with ’sudo’.

--server <args>

Perform administration of the recital server daemon. See recitalserver for full details.

--replication <args>

Perform administration of the recital replication daemon. See recitalreplication for full details.

--integrity <args>

This option is used to verify and if needed, repair Recital data files. See recitalintegrity for full details.

--convert <args>

This option is used to convert data from disparate hardware platforms and databases into and out of Recital Databases. See recitalconvert for full details.

--users [ <args> ]

Perform user administration tasks on Recital. See recitalusers for full details.

--execute filename [ <args> ]

Execute program file in the background as an agent. Args specified are declared as character variables in the called program. The file name extension defaults to .prg. Only program files that have no user input or display output can be run.

recitaladmin --execute  mqagent

start [ -l | logging ]

Start the recital daemon. Logging may optionally be enabled.

recitaladmin start

stop

Stop the recital daemon. This will prevent new connections and disconnect existing connections. It has no effect on interactive users.

recitaladmin stop

shutdown [ message ]

Shutdown the recital daemon and interactive users. This will prevent new connections and disconnect existing connections and users. Subsequent interactive users logins are enabled. A shutdown message can be sent to interactive users before the shutdown.

recitaladmin shutdown  "Please log out."

disable

Disable the recital daemon and interactive users. This will prevent new connections, but not disconnect existing connections and users.

recitaladmin  disable

NOTE: An ODBC client attempting to connect to a disabled server will receive the following message:

Invalid license: errno(-24)

enable

Enable the recital daemon and interactive users. This will enable new connections and users

recitaladmin  enable

suspend

Suspend the recital daemon and interactive users. This will suspend all connections to the recital server and existing users.

recitaladmin  suspend

resume

Resume the recital daemon and interactive users. This will resume all suspended connections and users.

recitaladmin resume

logout [ message ]

Log out interactive users. A log out message can be sent to interactive users before the they are logged out.

recitaladmin  logout  "Please log out for system maintenance."

broadcast [ message ]

Broadcast a message to all current interactive users. If no message is specified then any previous broadcast message will be cleared.

recitaladmin  broadcast  "Hello everybody."

terminate

Terminate cleanly the specified recital process.

recitaladmin  terminate 999

help

Display this information

recitaladmin help

version

Display product version

recitaladmin  version