The zosadmin command line tool is used by administrators of the NetIQ Cloud Manager Orchestration Server to log in to the server, add or remove server components such as jobs and policies, to report on the status of nodes, users, and the audit database, and to perform other administrative functions.
This section includes information about the following:
The following table includes a list of zosadmin commands in order of common usage, and a description for each command.
Table 17-2 Available zosadmin Commands and Their Descriptions
|
Command |
Description |
|---|---|
|
Clean the audit database by removing old data |
|
|
Count the number of jobs in the audit database |
|
|
Generate an audit report |
|
|
Cancel all running jobs |
|
|
Create a new server instance |
|
|
Deploy a new component onto a server |
|
|
Disconnect and/or revoke user or node sessions |
|
|
Dump contents of the namespace (advanced diagnostics) |
|
|
Retrieve descriptions of all facts |
|
|
Retrieve an attribute |
|
|
help |
Displays help for any of the commands in this list |
|
Restore a server configuration to initial state |
|
|
Invoke an MBean method (advanced diagnostics) |
|
|
List the running servers |
|
|
Log in to the server |
|
|
Log out of the server |
|
|
Retrieve the list of active or inactive nodes |
|
|
Change admin password |
|
|
Redeploy a component on a server |
|
|
Back up and rotate the log files |
|
|
Display session information |
|
|
Set an attribute |
|
|
Start a local server |
|
|
Collect the status of a server |
|
|
Shut down the server |
|
|
Undeploy a component from the server |
|
|
Upgrade old server snapshot to current version |
|
|
Retrieve the list of active or inactive users |
|
|
Verify a component for syntax |
All zosadmin commands begin with zosadmin on the command line. The general format for a zosadmin command is zosadmin followed by the command name, followed by command line parameters, if needed:
zosadmin [standard_options] command [command_options_and_arguments]
Before you use the zosadmin CLI, make sure that your path is correctly pointing to the Orchestration /bin directory.
This section includes the following information:
Login is required to operate on a running server. The commands start, list, init, and create do not require a login. Use the following syntax to log in:
>zosadmin login -user=username Orhestration_Server_name Please enter current password for 'username': ******* Logged into Orchestration_grid_name> on Orchestration_Server_name
The login should now be complete.
Login information is stored in the /home directory, so further zosadmin commands use the saved login information. To operate on a different Orchestration Server, run zosadmin login to log in to the new Orchestration Server.
Enter the following command and parameter to retrieve the status of the current login:
>zosadmin login -c
Currently logged into testgrid on server 'tszen5'
Enter the following command to log out of the Orchestration Server:
>zosadmin logout
Logged out from testgrid