Software AG Products 10.5 | Administering CentraSite | CentraSite Command Line Tools | INOADMIN Command Line Tools
 
INOADMIN Command Line Tools
The inoadmin command line tool offers functionality for performing low-level administrative operations on the CentraSite Registry Repository. The functionality provided by inoadmin command tool includes:
*Starting and stopping the CentraSite Registry Repository.
*Maintaining the internal database that houses the CentraSite Registry Repository.
*Configuring port numbers used by the CentraSite Registry Repository.
*Configuring secure communication between the CentraSite Registry Repository and the CentraSite Application Server Tier (CAST).
You execute the inoadmin command in the command line tool inoadmin.cmd (Windows) or inoadmin.sh (UNIX). The command line tool is located in the utilities folder in the <CentraSiteInstall_Directory>. If you call the inoadmin command without parameters, you receive a summary of the command syntax and the available functions.
You can use environment variables to configure the inoadmin command tool behavior:
Environment variable
Purpose
INOADMIN_OUTPUT_TXT
Determines whether the inoadmin command output is displayed as an XML document or as a formatted table.
If the value is null (that is, if the value is not defined), the inoadmin output is displayed as an XML document. If any non-null value is specified, a formatted table is displayed.
INOADMIN_NO_ MESSAGE_OUTPUT
Determines whether progress status messages are output while inoadmin calls are running.
If this variable is null (that is, if the value is not defined), all progress status messages are output. If any other value is set for this variable, the progress status messages are suppressed and only the result is displayed.
INOADMIN_RUN_AS_JOB
Creates a job log that contains status information generated while inoadmin is running.
If you use inoadmin within a command script, you can use the return status to verify the successful completion of the command. A zero return status means that the command executed successfully, whereas a non-zero return status means that the command did not execute successfully.
The syntax is of the format:
inoadmin <inoadminScript> <inoadminScript Parameter>
Example:
inoadmin setlocation CentraSite <LocationType> <path> [<path> ...]
List of inoadmin Command Line Tools
Command Name
Description
setlocation
Modifies the currently defined path of a location.
showactivity
Displays the database activity information.
For more information, see Displaying the Database Activity.
showlocations
Shows a list of all the currently defined locations.
allowreplication
Registers the host name of the replication instance.
denyreplication
Deregisters the host name of the replication instance to prevent further re-replication.
setreplication
Sets a copy of the CentraSite Registry Repository as replication instance of the master on the given host.
resetreplication
Resets the replication instance to a normal server instance to use instead of the master instance which is lost for any reason.
replicationinfo
Indicates if the server is a master server or a replication server.
listproperties
Shows a list of all of the available database properties and their values.
For more information, see Database Configuration Parameters.
getproperty
Shows the value of a given property.
For more information, see Database Configuration Parameters.
setproperty
Modifies the value of a given property with the new value.
For more information, see Database Configuration Parameters.
setproperties
Modifies the values of several properties with the values specified in the (supplied) XML file.
For more information, see Database Configuration Parameters.
start CentraSite
Starts the CentraSite Registry Repository.
stop CentraSite
Terminates the CentraSite Registry Repository session normally and waits for currently active user transactions to finish.
stop CentraSite normal
Terminates the CentraSite Registry Repository session normally.
stop CentraSite rollback
Terminates the CentraSite Registry Repository immediately and rollbacks the currently active user transactions.
stop CentraSite abort
Causes an emergency shutdown of the CentraSite Registry Repository.
backup
Copies the contents of CentraSite internal database on the file system
For more information, see Backing Up the Database.
listbackups
Shows a list of all available backups and their backup keys.
For more information, see Displaying Backup List.
deletebackup
Deletes a backup that is no longer required.
For more information, see Deleting a Backup.
restore
Restores the contents of CentraSite 's internal database back to a previous state.
For more information, see the Restoring the Database from a Backup CentraSite Administrator’s Guide.
reorganize
Reclaims disk space in the CentraSite internal database.
listdbspaces
Displays information about the physical disk requirements of CentraSite 's internal database.
For more information, see Displaying the Database Space.
Return Codes from inoadmin Command Execution
The following table describes the return codes you might encounter when using the command line tool inoadmin.
Return Code
Description
0
Execution of the command was successful.
1
A required parameter was not specified.
2
The command includes an invalid parameter.
3
The command includes an invalid number of parameters.
4
The output that a command returned does not match the expected values specified with the version option.
5
The server was not registered.
6
The server already exists.
7
The state of the server is active.
8
The state of the server is inactive.
9
The server startup failed.
10
The specified file cannot be located. Make sure you have entered the correct path and file name.
11
A parameter specified an invalid name.
12
A parameter specified an invalid value.
13
An error occurred during command execution.
14
Access to the operating system file is denied.
15
The backup deletion failed.
16
The specified service cannot be found.
17
First time startup of the service failed.
18
First time startup of the service failed.
19
The directory name is not valid.
20
Indicates that the dbspace name is invalid.
21
An autorepair is pending.
22
An operating system file is locked by the server.
23
No space left on the database.
24
There is not enough memory to run the script.
25
The server to be set as replication instance was not created from a backup of the specified master.
26
The command is not allowed for a read-only server.
27
Database already updated cannot be set up as replication instance.
28
Master server must be restarted to set up a replication instance.
29
The command is not allowed for a master server.
30
The command is not allowed for a replication server.
31
The specified entry already exists.
32
The specified entry was not found.
33
The command is not allowed for a former replication database.