Ice Reference Documentation | ||
---|---|---|
<<< Previous | Slice Documentation | Next >>> |
interface |
The IceGrid administrative interface.
![]() | Allowing access to this interface is a security risk! Please see the IceGrid documentation for further information. |
Add an application to IceGrid.
Add an object to the object registry.
Add an object to the object registry and explicitly specify its type.
Enable or disable a server.
Get the list of endpoints for an adapter.
Get all the adapter ids registered with IceGrid.
Get all the IceGrid applications currently registered.
Get all the IceGrid nodes currently registered.
Get the object info of all the registered objects whose stringified identities match the given expression.
Get all the server ids registered with IceGrid.
Get an application descriptor.
Get the default application descriptor.
Get the hostname of this node.
Get the node information for the node with the given name.
Get the load averages of the node.
Get the object info for the object with the given identity.
Get the server information for the server with the given id.
Get a server's system process id.
Get a server's state.
Returns the checksums for the IceGrid Slice definitions.
Instantiate a server template from an application.
Check if the server is enabled or disabled.
Patch the given application data.
Patch a server.
Ping an IceGrid node to see if it is active.
Remove the adapter with the given id.
Remove an application from IceGrid.
Remove an object from the object registry.
Send signal to a server.
Shut down the IceGrid registry.
Shutdown an IceGrid node.
Start a server and wait for its activation.
Stop a server.
Synchronize a deployed application with the given application descriptor.
Update a deployed application with the given update application descriptor.
Update an object in the object registry.
Write message on server stdout or stderr @param id The id of the server.
void addApplication( |
Add an application to IceGrid. An application is a set of servers.
The application descriptor.
DeploymentException
Raised if application deployment failed.
void addObject(Object* obj) throws |
Add an object to the object registry. IceGrid will get the object type by calling ice_id on the given proxy. The object must be reachable.
The object to be added to the registry.
ObjectExistsException
Raised if the object is already registered.
void addObjectWithType(Object* obj, string type) throws |
Add an object to the object registry and explicitly specify its type.
The object to be added to the registry.
The object type.
ObjectExistsException
Raised if the object is already registered.
[ "ami" ] void enableServer(string id, bool enabled) throws |
Enable or disable a server. A disabled server can't be started on demand or administratively. The enable state of the server is not persistent, if the node is shutdown and restarted, the server will be enabled by default.
The id of the server.
True to enable the server, false to disable it.
ServerNotExistException
Raised if the server doesn't exist.
NodeUnreachableException
Raised if the node could not be reached.
StringObjectProxyDict getAdapterEndpoints(string adapterId) throws |
Get the list of endpoints for an adapter.
The adapter id.
A dictionary of adapter direct proxy classified by server id.
AdapterNotExistException
Raised if the adapter doesn't exist.
NodeUnreachableException
Raised if the node could not be reached.
::Ice::StringSeq getAllAdapterIds(); |
Get all the adapter ids registered with IceGrid.
The adapter ids.
::Ice::StringSeq getAllApplicationNames(); |
Get all the IceGrid applications currently registered.
The application names.
::Ice::StringSeq getAllNodeNames(); |
Get all the IceGrid nodes currently registered.
The node names.
ObjectInfoSeq getAllObjectInfos(string expr); |
Get the object info of all the registered objects whose stringified identities match the given expression.
The expression to match against the stringified identities of registered objects. The expression may contain a trailing wildcard (*) character.
All the object infos with a stringified identity matching the given expression.
::Ice::StringSeq getAllServerIds(); |
Get all the server ids registered with IceGrid.
The server ids.
|
Get an application descriptor.
The application name.
s The application descriptor.
ApplicationNotExistException
Raised if the application doesn't exist.
|
Get the default application descriptor.
string getNodeHostname(string name) throws |
Get the hostname of this node.
The node name.
NodeNotExistException
Raised if the node doesn't exist.
NodeUnreachableException
Raised if the node could not be reached.
|
Get the node information for the node with the given name.
The node name.
The node information.
NodeNotExistException
Raised if the node doesn't exist.
NodeUnreachableException
Raised if the node could not be reached.
[ "ami" ] |
Get the load averages of the node.
The node name.
The node load information.
NodeNotExistException
Raised if the node doesn't exist.
NodeUnreachableException
Raised if the node could not be reached.
|
Get the object info for the object with the given identity.
The identity of the object.
The object info.
ObjectNotRegisteredException
Raised if the object doesn't exist.
|
Get the server information for the server with the given id.
The server id.
s The server information.
ServerNotExistException
Raised if the server doesn't exist.
int getServerPid(string id) throws |
Get a server's system process id. The process id is operating system dependent.
The id of the server.
The server process id.
ServerNotExistException
Raised if the server doesn't exist.
NodeUnreachableException
Raised if the node could not be reached.
ServerState getServerState(string id) throws |
Get a server's state.
The id of the server.
The server state.
ServerNotExistException
Raised if the server doesn't exist.
NodeUnreachableException
Raised if the node could not be reached.
::Ice::SliceChecksumDict getSliceChecksums(); |
Returns the checksums for the IceGrid Slice definitions.
A dictionary mapping Slice type ids to their checksums.
void instantiateServer(string application, string node, |
Instantiate a server template from an application.
bool isServerEnabled(string id) throws |
Check if the server is enabled or disabled.
The id of the server.
ServerNotExistException
Raised if the server doesn't exist.
NodeUnreachableException
Raised if the node could not be reached.
[ "ami", "amd" ] void patchApplication(string name, bool shutdown) throws |
Patch the given application data. If the patch argument is an empty string, all the application servers depending on patch data will be patched.
The application name.
If true, the servers depending on the data to patch will be shutdown if necessary.
PatchException
Raised if the patch failed.
ApplicationNotExistException
Raised if the application doesn't exist.
[ "ami", "amd" ] void patchServer(string id, bool shutdown) throws |
Patch a server.
The id of the server.
If true, servers depending on the data to patch will be shutdown if necessary.
ServerNotExistException
Raised if the server doesn't exist.
NodeUnreachableException
Raised if the node could not be reached.
PatchException
Raised if the patch failed.
bool pingNode(string name)
throws
|
Ping an IceGrid node to see if it is active.
The node name.
true if the node ping succeeded, false otherwise.
NodeNotExistException
Raised if the node doesn't exist.
void removeAdapter(string adapterId) throws |
Remove the adapter with the given id.
AdapterNotExistException
Raised if the adapter doesn't exist.
void removeApplication(string name)
throws
|
Remove an application from IceGrid.
The application name.
ApplicationNotExistException
Raised if the application doesn't exist.
void removeObject( |
Remove an object from the object registry.
The identity of the object to be removed from the registry.
ObjectNotRegisteredException
Raised if the object doesn't exist.
void sendSignal(string id, string signal) throws |
Send signal to a server.
The id of the server.
The signal, for example SIGTERM or 15.
ServerNotExistException
Raised if the server doesn't exist.
NodeUnreachableException
Raised if the node could not be reached.
BadSignalException
Raised if the signal is not recognized by the target server.
[ "ami" ] void shutdownNode(string name) throws |
Shutdown an IceGrid node.
The node name.
NodeNotExistException
Raised if the node doesn't exist.
NodeUnreachableException
Raised if the node could not be reached.
[ "ami" ] void startServer(string id) throws |
Start a server and wait for its activation.
The id of the server.
True if the server was successfully started, false otherwise.
ServerNotExistException
Raised if the server doesn't exist.
NodeUnreachableException
Raised if the node could not be reached.
[ "ami" ] void stopServer(string id) throws |
Stop a server.
The id of the server.
ServerNotExistException
Raised if the server doesn't exist.
NodeUnreachableException
Raised if the node could not be reached.
void syncApplication( |
Synchronize a deployed application with the given application descriptor. This operation will replace the current descriptor with this new descriptor.
The application descriptor.
DeploymentException
Raised if application deployment failed.
ApplicationNotExistException
Raised if the application doesn't exist.
void updateApplication( |
Update a deployed application with the given update application descriptor.
The update descriptor.
DeploymentException
Raised if application deployment failed.
ApplicationNotExistException
Raised if the application doesn't exist.
void updateObject(Object* obj) throws |
Update an object in the object registry.
The object to be updated to the registry.
ObjectNotRegisteredException
Raised if the object doesn't exist.
void writeMessage(string id, string message, int fd) throws |
Write message on server stdout or stderr
The id of the server.
The message.
1 for stdout, 2 for stderr.
ServerNotExistException
Raised if the server doesn't exist.
NodeUnreachableException
Raised if the node could not be reached.
<<< Previous | Home | Next >>> |
IceGrid::AdaptiveLoadBalancingPolicy | Up | IceGrid::ApplicationDescriptor |