The icegridadmin
utility is a command-line tool for administering an IceGrid domain. Deploying an application with this utility requires an XML file that defines the descriptors.
On this page:
The IceGrid administration tool supports the following command-line options:
{zcode} Usage: icegridadmin [options] Options: -h, --help Show this message. -v, --version Display the Ice version. -e COMMANDS Execute COMMANDS. -d, --debug Print debug messages. -s, --server Start icegridadmin as a server (to parse XML files). -u, --username Login with the given username. -p, --password Login with the given password. -S, --ssl Authenticate through SSL. -r, --replica NAME Connect to the replica NAME. {zcode} |
The -e
option causes the tool to execute the given commands and then exit without entering an interactive mode. The -s
option starts icegridadmin
in a server mode that supports the IceGrid::FileParser
interface; a proxy for the object is printed to standard output. If neither -e
nor -s
is specified, the tool enters an interactive mode in which you issue commands at a prompt.
To communicate with the IceGrid registry, icegridadmin
establishes an administrative session. The tool uses SSL authentication if you specify the -S
option or define its equivalent property IceGridAdmin.AuthenticateUsingSSL
. Otherwise, icegridadmin
uses password authentication and prompts you for the username and password if you do not specify them via command-line options or properties. If you want icegridadmin
to establish its session using a Glacier2 router, define Ice.Default.Router
appropriately. See IceGrid Administrative Client Properties for more information on the tool's configuration properties.
Once the session is successfully established, icegridadmin
displays its command prompt. The help
command displays the following usage information:
help
exit
, quit
CATEGORY help
CATEGORY
COMMAND help
COMMAND
.The tool's commands are organized by category. The supported command categories are shown below:
application
node
registry
server
service
adapter
object
server template
service template
You can obtain more information about each category using the help
command:
{zcode} >>> application help {zcode} |
application add [-n | --no-patch] DESC [TARGET ... ] [NAME=VALUE ... ]
DESC
. If specified the optional targets are deployed. Variables are defined using the NAME=VALUE
syntax. The application is automatically patched unless the -n
or --no-patch
option is used to disable it.application remove NAME
NAME
.application describe NAME
NAME
.application diff [-s | --servers]
DESC [TARGET ...] [NAME=VALUE ...]
DESC
and the current deployment. If -s
or --servers
is specified, print the the list of servers affected by the differences. Variables are defined using the NAME=VALUE
syntax.application update [-n | --no-restart] DESC [TARGET ...] [NAME=VALUE ...]
DESC
. If -n
or --no-restart
is specified, the update will fail if it would require restarting one or more servers. Variables are defined using the NAME=VALUE
syntax. Use the diff --servers
command to discover which servers would be affected by an update, including those that would require a restart.application patch [-f | --force] NAME
NAME
. If -f
or --force
is specified, IceGrid will first shut down any servers that depend on the data to be patched.application list
node list
node describe NAME
NAME
.node ping NAME
NAME
.node load NAME
NAME
.node sockets [NAME]
NAME
. If NAME
is omitted, print the number of processor sockets for each node. (The IceGrid.Node.ProcessorSocketCount
property allows you to explicitly set this value for systems where the number of sockets cannot be obtained programmatically.)node show [OPTIONS] NAME [stderr | stdout]
-f
, --follow
-t
, --tail N
N
lines of text.-h
, --head N
N
lines of textnode shutdown NAME
NAME
. registry list
registry describe NAME
NAME
.registry ping NAME
NAME
.registry show [OPTIONS] NAME [stderr | stdout]
-f
, --follow
-t
, --tail N
N
lines of text.-h
, --head N
N
lines of text.registry shutdown NAME
NAME
. server list
server remove ID
ID
.server describe ID
ID
.server properties ID
ID
.server property ID NAME
NAME
of server ID
.server state ID
ID
.server pid ID
ID
.server start ID
ID
.server stop ID
ID
.server patch ID
ID
.server signal ID SIGNAL
SIGNAL
(such as SIGTERM
or 15
) to server ID
.server stdout ID MESSAGE
MESSAGE
on server ID
's standard output.server stderr ID MESSAGE
MESSAGE
on server ID
's standard error.server show [OPTIONS] ID [stderr | stdout | LOGFILE]
LOGFILE
. The supported options are shown below:-f
, --follow
-t
, --tail N
N
lines of text.-h
, --head N
N
lines of text.server enable ID
ID
.server disable ID
ID
. A disabled server cannot be started on demand. service start ID NAME
NAME
in IceBox server ID
.service stop ID NAME
NAME
in IceBox server ID
.service describe ID NAME
NAME
in IceBox server ID
.service properties ID NAME
NAME
from IceBox server ID
.service property ID NAME PROPERTY
PROPERTY
of service NAME
from IceBox server ID
.service list ID
ID
. adapter list
adapter endpoints ID
ID
.adapter remove ID
ID
. The object
command operates on well-known objects.
object add PROXY [TYPE]
object remove IDENTITY
object find TYPE
TYPE
.object describe EXPR
EXPR
. A trailing wildcard is supported in EXPR
, for example "object describe Ice*
".object list EXPR
EXPR
. A trailing wildcard is supported in EXPR
, for example "object list Ice*
". server template instantiate APPLICATION NODE TEMPLATE [NAME=VALUE ...]
NAME=VALUE
syntax.server template describe APPLICATION TEMPLATE
TEMPLATE
from the given application. service template describe APPLICATION TEMPLATE
TEMPLATE
from the given application. icegridadmin
requires that the locator proxy be defined in the configuration property Ice.Default.Locator
. If a configuration file already exists that defines this property, you can start icegridadmin
using the configuration file as shown below:
{zcode} $ icegridadmin --Ice.Config=<file> {zcode} |
Otherwise, you can define the property on the command line:
{zcode} $ icegridadmin --Ice.Default.Locator=<proxy> {zcode} |
Refer to the discussion of our ripper client for more information on configuring the Ice.Default.Locator
property for an IceGrid client.