Difference between revisions of "Recitaladmin"
Peterkelly (Talk | contribs) (→disable) |
Peterkelly (Talk | contribs) |
||
| Line 26: | Line 26: | ||
====[ -a ]==== | ====[ -a ]==== | ||
Run in verbose mode. | Run in verbose mode. | ||
| + | <code lang="bash"> | ||
recitaladmin --integrity -D southwind | recitaladmin --integrity -D southwind | ||
| − | + | </code> | |
===--convert=== | ===--convert=== | ||
This options is used to convert data from disparate hardware platforms and databases into and out of Recital Databases. | This options is used to convert data from disparate hardware platforms and databases into and out of Recital Databases. | ||
| Line 44: | Line 45: | ||
====[ -r ]==== | ====[ -r ]==== | ||
Recursively convert files in sub-directories. | Recursively convert files in sub-directories. | ||
| + | <code lang="bash"> | ||
recitaladmin --convert dbf ar*.dbf | recitaladmin --convert dbf ar*.dbf | ||
| − | + | </code> | |
===--execute=== | ===--execute=== | ||
====filename [ <args> ]==== | ====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. | 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. | ||
| + | <code lang="bash"> | ||
recitaladmin --execute mqagent | recitaladmin --execute mqagent | ||
| − | + | <code> | |
===--users=== | ===--users=== | ||
Perform user administration tasks on Recital | Perform user administration tasks on Recital | ||
| Line 59: | Line 62: | ||
====[ -l ]==== | ====[ -l ]==== | ||
This option will list the current recital users. | This option will list the current recital users. | ||
| + | <code lang="bash"> | ||
recitaladmin --users -l | recitaladmin --users -l | ||
| − | + | </code> | |
===shutdown=== | ===shutdown=== | ||
Shutdown the recital daemon and interactive users. This will prevent new connections and disconnect existing connections and users. | Shutdown the recital daemon and interactive users. This will prevent new connections and disconnect existing connections and users. | ||
====[ Message ]==== | ====[ Message ]==== | ||
A shutdown message can be sent to interactive users before the shutdown. | A shutdown message can be sent to interactive users before the shutdown. | ||
| + | <code lang="bash"> | ||
recitaladmin shutdown "Please log out." | recitaladmin shutdown "Please log out." | ||
| − | + | </code> | |
===disable=== | ===disable=== | ||
Disable the recital daemon and interactive users. This will prevent new connections, but not disconnect existing connections and users. | Disable the recital daemon and interactive users. This will prevent new connections, but not disconnect existing connections and users. | ||
| Line 78: | Line 83: | ||
===enable=== | ===enable=== | ||
Enable the recital daemon and interactive users. This will enable new connections and users | Enable the recital daemon and interactive users. This will enable new connections and users | ||
| + | <code lang="bash"> | ||
recitaladmin enable | recitaladmin enable | ||
| − | + | </code> | |
===suspend=== | ===suspend=== | ||
Suspend the recital daemon and interactive users. This will suspend all connections to the recital server and existing users. | Suspend the recital daemon and interactive users. This will suspend all connections to the recital server and existing users. | ||
| + | <code lang="bash"> | ||
recitaladmin suspend | recitaladmin suspend | ||
| − | + | </code> | |
===resume=== | ===resume=== | ||
| − | |||
Resume the recital daemon and interactive users. This will resume all suspended connections and users. | Resume the recital daemon and interactive users. This will resume all suspended connections and users. | ||
| + | <code lang="bash"> | ||
| + | recitaladmin resume | ||
| + | </code> | ||
===logout=== | ===logout=== | ||
Log out interactive users. | Log out interactive users. | ||
====[ Message ]==== | ====[ Message ]==== | ||
A log out message can be sent to interactive users before the they are logged out. | A log out message can be sent to interactive users before the they are logged out. | ||
| + | <code lang="bash"> | ||
recitaladmin logout "Please log out for system maintenance." | recitaladmin logout "Please log out for system maintenance." | ||
| − | + | </code> | |
===broadcast=== | ===broadcast=== | ||
Broadcast a message to all current interactive users. | Broadcast a message to all current interactive users. | ||
====[ Message ]==== | ====[ Message ]==== | ||
If no message is specified then any previous broadcast message will be cleared. | If no message is specified then any previous broadcast message will be cleared. | ||
| + | <code lang="bash"> | ||
recitaladmin broadcast "Hello everybody." | recitaladmin broadcast "Hello everybody." | ||
| − | + | </code> | |
===terminate=== | ===terminate=== | ||
Terminate cleanly the specified recital process. | Terminate cleanly the specified recital process. | ||
| + | <code lang="bash"> | ||
recitaladmin terminate 999 | recitaladmin terminate 999 | ||
| − | + | </code> | |
===help=== | ===help=== | ||
Display this information | Display this information | ||
| + | <code lang="bash"> | ||
recitaladmin help | recitaladmin help | ||
| − | + | </code> | |
===version=== | ===version=== | ||
Display product version | Display product version | ||
| + | <code lang="bash"> | ||
recitaladmin version | recitaladmin version | ||
| + | </code> | ||
Revision as of 10:01, 26 October 2009
Contents
recitaladmin
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
Perform administration of the recital server daemon. See recitalserver for full details.
--replication
Perform administration of the recital replication daemon. See recitalreplication for full details.
--integrity
This option is used to verify and if needed, repair a Recital data files.
[ -f table ]
Specify a table to verify a table.
[ -d directory ]
Specify a directory to verify all files in a directory.
[ -D database ]
Specify a database to verify a database.
[ -r ]
recursively process sub-directories.
[ -y ]
This will repair data errors if any are found.
[ -q ]
This will only display errors.
[ -a ]
Run in verbose mode.
recitaladmin --integrity -D southwind
--convert
This options is used to convert data from disparate hardware platforms and databases into and out of Recital Databases.
[ all ]
Convert all files in the current directory.
[ prg ]
Convert program scripts in the current directory.
[ dbf ]
Convert tables in the current directory.
[ mem ]
Convert memory varaible files in the current directory.
[ frx ]
Convert report files in the current directory.
[ <files> ]
An optional file list parameter can be specified to restrict the files converted.
[ -r ]
Recursively convert files in sub-directories.
recitaladmin --convert dbf ar*.dbf
--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 <code> ===--users=== Perform user administration tasks on Recital ====[ -r ]==== This options will reset the existing recital users file. All users must be log out before this task can be performed. ====[ -c ]==== This options will create a new users file if one doesn’t already exist. ====[ -l ]==== This option will list the current recital users. <code lang="bash"> recitaladmin --users -l
shutdown
Shutdown the recital daemon and interactive users. This will prevent new connections and disconnect existing connections and users.
[ Message ]
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 enablesuspend
Suspend the recital daemon and interactive users. This will suspend all connections to the recital server and existing users.
recitaladmin suspendresume
Resume the recital daemon and interactive users. This will resume all suspended connections and users.
recitaladmin resume
logout
Log out interactive users.
[ Message ]
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
Broadcast a message to all current interactive users.
[ Message ]
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 999help
Display this information
recitaladmin helpversion
Display product version
recitaladmin version
