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.
Synchronize a deployed application with the given application descriptor.
Update a deployed application with the given update application descriptor.
Remove an application from IceGrid.
Instantiate a server template from an application on the given node.
Patch the given application data.
Get an application descriptor.
Get the default application descriptor.
Get all the IceGrid applications currently registered.
Get the server information for the server with the given id.
Get a server's state.
Get a server's system process id.
Enable or disable a server.
Check if the server is enabled or disabled.
Start a server and wait for its activation.
Stop a server.
Patch a server.
Send signal to a server.
Write message on server stdout or stderr.
Get all the server ids registered with IceGrid.
Get the adapter information for the replica group or adapter with the given id.
Remove the adapter with the given id.
Get all the adapter ids registered with IceGrid.
Add an object to the object registry.
Update an object in the object registry.
Add an object to the object registry and explicitly specify its type.
Remove an object from the object registry.
Get the object info for the object with the given identity.
Get the object info of all the registered objects with the given type.
Get the object info of all the registered objects whose stringified identities match the given expression.
Ping an IceGrid node to see if it is active.
Get the load averages of the node.
Get the node information for the node with the given name.
Shutdown an IceGrid node.
Get the hostname of this node.
Get all the IceGrid nodes currently registered.
Shut down the IceGrid registry.
Returns the checksums for the IceGrid Slice definitions.
void addApplication( |
Add an application to IceGrid.
The application descriptor.
AccessDeniedException
Raised if the session doesn't hold the exclusive lock or if another session is holding the lock.
DeploymentException
Raised if application deployment failed.
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.
AccessDeniedException
Raised if the session doesn't hold the exclusive lock or if another session is holding the lock.
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.
AccessDeniedException
Raised if the session doesn't hold the exclusive lock or if another session is holding the lock.
DeploymentException
Raised if application deployment failed.
ApplicationNotExistException
Raised if the application doesn't exist.
void removeApplication(string name) throws |
Remove an application from IceGrid.
The application name.
AccessDeniedException
Raised if the session doesn't hold the exclusive lock or if another session is holding the lock.
ApplicationNotExistException
Raised if the application doesn't exist.
void instantiateServer(string application, string node, |
Instantiate a server template from an application on the given node.
The application name.
The name of the node where the server will be deployed.
The descriptor of the server instance to deploy.
AccessDeniedException
Raised if the session doesn't hold the exclusive lock or if another session is holding the lock.
DeploymentException
Raised if server instantiation failed.
ApplicationNotExistException
Raised if the application doesn't exist.
[ "ami", "amd" ] void patchApplication(string name, bool shutdown) throws |
Patch the given application data.
The application name.
If true, the servers depending on the data to patch will be shutdown if necessary.
ApplicationNotExistException
Raised if the application doesn't exist.
PatchException
Raised if the patch failed.
|
Get an application descriptor.
The application name.
The application descriptor.
ApplicationNotExistException
Raised if the application doesn't exist.
|
Get the default application descriptor.
DeploymentException
Raised if the default application descriptor can't be accessed or is invalid.
::Ice::StringSeq getAllApplicationNames(); |
Get all the IceGrid applications currently registered.
The application names.
|
Get the server information for the server with the given id.
The server id.
The server information.
ServerNotExistException
Raised if the server doesn't exist.
ServerState getServerState(string id) throws |
Get a server's state.
The server id.
The server state.
ServerNotExistException
Raised if the server doesn't exist.
NodeUnreachableException
Raised if the node could not be reached.
DeploymentException
Raised if the server couldn't be deployed on the node.
int getServerPid(string id) throws |
Get a server's system process id. The process id is operating system dependent.
The server id.
The server's process id.
ServerNotExistException
Raised if the server doesn't exist.
NodeUnreachableException
Raised if the node could not be reached.
DeploymentException
Raised if the server couldn't be deployed on the node.
[ "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 server id.
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.
DeploymentException
Raised if the server couldn't be deployed on the node.
bool isServerEnabled(string id) throws |
Check if the server is enabled or disabled.
The server id.
ServerNotExistException
Raised if the server doesn't exist.
NodeUnreachableException
Raised if the node could not be reached.
DeploymentException
Raised if the server couldn't be deployed on the node.
[ "ami" ] void startServer(string id) throws |
Start a server and wait for its activation.
The server id.
True if the server was successfully started, false otherwise.
ServerNotExistException
Raised if the server doesn't exist.
ServerStartException
Raised if the server couldn't be started.
NodeUnreachableException
Raised if the node could not be reached.
DeploymentException
Raised if the server couldn't be deployed on the node.
[ "ami" ] void stopServer(string id) throws |
Stop a server.
The server id.
ServerNotExistException
Raised if the server doesn't exist.
ServerStopException
Raised if the server couldn't be stopped.
NodeUnreachableException
Raised if the node could not be reached.
DeploymentException
Raised if the server couldn't be deployed on the node.
[ "ami", "amd" ] void patchServer(string id, bool shutdown) throws |
Patch a server.
The server id.
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.
DeploymentException
Raised if the server couldn't be deployed on the node.
PatchException
Raised if the patch failed.
void sendSignal(string id, string signal) throws |
Send signal to a server.
The server id.
The signal, for example SIGTERM or 15.
ServerNotExistException
Raised if the server doesn't exist.
NodeUnreachableException
Raised if the node could not be reached.
DeploymentException
Raised if the server couldn't be deployed on the node.
BadSignalException
Raised if the signal is not recognized by the target server.
void writeMessage(string id, string message, int fd) throws |
Write message on server stdout or stderr.
The server id.
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.
DeploymentException
Raised if the server couldn't be deployed on the node.
::Ice::StringSeq getAllServerIds(); |
Get all the server ids registered with IceGrid.
The server ids.
AdapterInfoSeq getAdapterInfo(string id)
throws
|
Get the adapter information for the replica group or adapter with the given id.
The adapter id.
A sequence of adapter information structures. If the given id refers to an adapter, this sequence will contain only one element. If the given id refers to a replica group, the sequence will contain the adapter information of each member of the replica group.
AdapterNotExistException
Raised if the adapter or replica group doesn't exist.
[ "ami" ] void removeAdapter(string adapterId) throws |
Remove the adapter with the given id.
AdapterNotExistException
Raised if the adapter doesn't exist.
::Ice::StringSeq getAllAdapterIds(); |
Get all the adapter ids registered with IceGrid.
The adapter ids.
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.
DeploymentException
Raised if the object can't be added. This might be raised if the invocation on the proxy to get the object type failed.
void updateObject(Object* obj) throws |
Update an object in the object registry. Only objects added with this interface can be updated with this operation. Objects added with deployment descriptors should be updated with the deployment mechanism.
The object to be updated to the registry.
ObjectNotRegisteredException
Raised if the object isn't registered with the registry.
DeploymentException
Raised if the object can't be updated. This might happen if the object was added with a deployment descriptor.
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 removeObject( |
Remove an object from the object registry. Only objects added with this interface can be removed with this operation. Objects added with deployment descriptors should be removed with the deployment mechanism.
The identity of the object to be removed from the registry.
ObjectNotRegisteredException
Raised if the object isn't registered with the registry.
DeploymentException
Raised if the object can't be removed. This might happen if the object was added with a deployment descriptor.
|
Get the object info for the object with the given identity.
The identity of the object.
The object info.
ObjectNotRegisteredException
Raised if the object isn't registered with the registry.
ObjectInfoSeq getObjectInfosByType(string type); |
Get the object info of all the registered objects with the given type.
The type of the object.
The object infos.
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.
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.
[ "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 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" ] 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.
string getNodeHostname(string name) throws |
Get the hostname of this node.
The node name.
The node hostname.
NodeNotExistException
Raised if the node doesn't exist.
NodeUnreachableException
Raised if the node could not be reached.
::Ice::StringSeq getAllNodeNames(); |
Get all the IceGrid nodes currently registered.
The node names.
::Ice::SliceChecksumDict getSliceChecksums(); |
Returns the checksums for the IceGrid Slice definitions.
A dictionary mapping Slice type ids to their checksums.
<<< Previous | Home | Next >>> |
IceGrid::AdaptiveLoadBalancingPolicy | Up | IceGrid::AdminSession |