The IceGrid administrative interface.
Allowing access to this interface is a security risk! Please see the IceGrid documentation for further information.
addApplication — Add an application to IceGrid.
syncApplication — Synchronize a deployed application with the given application descriptor.
updateApplication — Update a deployed application with the given update application descriptor.
syncApplicationWithoutRestart — Synchronize a deployed application with the given application descriptor.
updateApplicationWithoutRestart — Update a deployed application with the given update application descriptor only if no server restarts are necessary for the update of the application.
removeApplication — Remove an application from IceGrid.
instantiateServer — Instantiate a server template from an application on the given node.
patchApplication — Patch the given application data.
getApplicationInfo — Get an application descriptor.
getDefaultApplicationDescriptor — Get the default application descriptor.
getAllApplicationNames — Get all the IceGrid applications currently registered.
getServerInfo — Get the server information for the server with the given id.
getServerState — Get a server's state.
getServerPid — Get a server's system process id.
getServerAdminCategory — Get the category for server admin objects.
getServerAdmin — Get a proxy to the server's admin object.
enableServer — Enable or disable a server.
isServerEnabled — Check if the server is enabled or disabled.
startServer — Start a server and wait for its activation.
stopServer — Stop a server.
patchServer — Patch a server.
sendSignal — Send signal to a server.
writeMessage — Write message on server stdout or stderr. (Deprecated)
getAllServerIds — Get all the server ids registered with IceGrid.
getAdapterInfo — Get the adapter information for the replica group or adapter with the given id.
removeAdapter — Remove the adapter with the given id.
getAllAdapterIds — Get all the adapter ids registered with IceGrid.
addObject — Add an object to the object registry.
updateObject — Update an object in the object registry.
addObjectWithType — Add an object to the object registry and explicitly specify its type.
removeObject — Remove an object from the object registry.
getObjectInfo — Get the object info for the object with the given identity.
getObjectInfosByType — Get the object info of all the registered objects with the given type.
getAllObjectInfos — Get the object info of all the registered objects whose stringified identities match the given expression.
pingNode — Ping an IceGrid node to see if it is active.
getNodeLoad — Get the load averages of the node.
getNodeInfo — Get the node information for the node with the given name.
getNodeProcessorSocketCount — Get the number of physical processor sockets for the machine running the node with the given name.
shutdownNode — Shutdown an IceGrid node.
getNodeHostname — Get the hostname of this node.
getAllNodeNames — Get all the IceGrid nodes currently registered.
pingRegistry — Ping an IceGrid registry to see if it is active.
getRegistryInfo — Get the registry information for the registry with the given name.
shutdownRegistry — Shutdown an IceGrid registry.
getAllRegistryNames — Get all the IceGrid registrys currently registered.
shutdown — Shut down the IceGrid registry.
getSliceChecksums — Returns the checksums for the IceGrid Slice definitions.
Add an application to IceGrid.
descriptor
— The application descriptor.
IceGrid::AccessDeniedException — Raised if the session doesn't hold the exclusive lock or if another session is holding the lock.
IceGrid::DeploymentException — Raised if application deployment failed.
Synchronize a deployed application with the given application descriptor. This operation will replace the current descriptor with this new descriptor.
descriptor
— The application descriptor.
IceGrid::AccessDeniedException — Raised if the session doesn't hold the exclusive lock or if another session is holding the lock.
IceGrid::DeploymentException — Raised if application deployment failed.
IceGrid::ApplicationNotExistException — Raised if the application doesn't exist.
Update a deployed application with the given update application descriptor.
descriptor
— The update descriptor.
IceGrid::AccessDeniedException — Raised if the session doesn't hold the exclusive lock or if another session is holding the lock.
IceGrid::DeploymentException — Raised if application deployment failed.
IceGrid::ApplicationNotExistException — Raised if the application doesn't exist.
Synchronize a deployed application with the given application descriptor. This operation will replace the current descriptor with this new descriptor only if no server restarts are necessary for the update of the application. If some servers need to be restarted, the synchronization is rejected with a DeploymentException.
descriptor
— The application descriptor.
IceGrid::AccessDeniedException — Raised if the session doesn't hold the exclusive lock or if another session is holding the lock.
IceGrid::DeploymentException — Raised if application deployment failed.
IceGrid::ApplicationNotExistException — Raised if the application doesn't exist.
Update a deployed application with the given update application descriptor only if no server restarts are necessary for the update of the application. If some servers need to be restarted, the synchronization is rejected with a DeploymentException.
descriptor
— The update descriptor.
IceGrid::AccessDeniedException — Raised if the session doesn't hold the exclusive lock or if another session is holding the lock.
IceGrid::DeploymentException — Raised if application deployment failed.
IceGrid::ApplicationNotExistException — Raised if the application doesn't exist.
Remove an application from IceGrid.
name
— The application name.
IceGrid::AccessDeniedException — Raised if the session doesn't hold the exclusive lock or if another session is holding the lock.
IceGrid::ApplicationNotExistException — Raised if the application doesn't exist.
Instantiate a server template from an application on the given node.
application
— The application name.
node
— The name of the node where the server will be deployed.
desc
— The descriptor of the server instance to deploy.
IceGrid::AccessDeniedException — Raised if the session doesn't hold the exclusive lock or if another session is holding the lock.
IceGrid::DeploymentException — Raised if server instantiation failed.
IceGrid::ApplicationNotExistException — Raised if the application doesn't exist.
Patch the given application data.
name
— The application name.
shutdown
— If true, the servers depending on the data to patch will be shut down if necessary.
IceGrid::ApplicationNotExistException — Raised if the application doesn't exist.
IceGrid::PatchException — Raised if the patch failed.
Get an application descriptor.
name
— The application name.
The application descriptor.
IceGrid::ApplicationNotExistException — Raised if the application doesn't exist.
Get the default application descriptor.
IceGrid::DeploymentException — Raised if the default application descriptor can't be accessed or is invalid.
Get all the IceGrid applications currently registered.
The application names.
Get the server information for the server with the given id.
id
— The server id.
The server information.
IceGrid::ServerNotExistException — Raised if the server doesn't exist.
Get a server's state.
id
— The server id.
The server state.
IceGrid::ServerNotExistException — Raised if the server doesn't exist.
IceGrid::NodeUnreachableException — Raised if the node could not be reached.
IceGrid::DeploymentException — Raised if the server couldn't be deployed on the node.
Get a server's system process id. The process id is operating system dependent.
id
— The server id.
The server's process id.
IceGrid::ServerNotExistException — Raised if the server doesn't exist.
IceGrid::NodeUnreachableException — Raised if the node could not be reached.
IceGrid::DeploymentException — Raised if the server couldn't be deployed on the node.
Get the category for server admin objects. You can manufacture a server admin proxy from the admin proxy by changing its identity: use the server ID as name and the returned category as category.
The category for server admin objects.
Get a proxy to the server's admin object.
id
— The server id.
A proxy to the server's admin object
IceGrid::ServerNotExistException — Raised if the server doesn't exist.
IceGrid::NodeUnreachableException — Raised if the node could not be reached.
IceGrid::DeploymentException — Raised if the server couldn't be deployed on the node.
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 shut down and restarted, the server will be enabled by default.
id
— The server id.
enabled
— True to enable the server, false to disable it.
IceGrid::ServerNotExistException — Raised if the server doesn't exist.
IceGrid::NodeUnreachableException — Raised if the node could not be reached.
IceGrid::DeploymentException — Raised if the server couldn't be deployed on the node.
Check if the server is enabled or disabled.
id
— The server id.
IceGrid::ServerNotExistException — Raised if the server doesn't exist.
IceGrid::NodeUnreachableException — Raised if the node could not be reached.
IceGrid::DeploymentException — Raised if the server couldn't be deployed on the node.
Start a server and wait for its activation.
id
— The server id.
IceGrid::ServerNotExistException — Raised if the server doesn't exist.
IceGrid::ServerStartException — Raised if the server couldn't be started.
IceGrid::NodeUnreachableException — Raised if the node could not be reached.
IceGrid::DeploymentException — Raised if the server couldn't be deployed on the node.
Stop a server.
id
— The server id.
IceGrid::ServerNotExistException — Raised if the server doesn't exist.
IceGrid::ServerStopException — Raised if the server couldn't be stopped.
IceGrid::NodeUnreachableException — Raised if the node could not be reached.
IceGrid::DeploymentException — Raised if the server couldn't be deployed on the node.
Patch a server.
id
— The server id.
shutdown
— If true, servers depending on the data to patch will be shut down if necessary.
IceGrid::ServerNotExistException — Raised if the server doesn't exist.
IceGrid::NodeUnreachableException — Raised if the node could not be reached.
IceGrid::DeploymentException — Raised if the server couldn't be deployed on the node.
IceGrid::PatchException — Raised if the patch failed.
Send signal to a server.
id
— The server id.
signal
— The signal, for example SIGTERM or 15.
IceGrid::ServerNotExistException — Raised if the server doesn't exist.
IceGrid::NodeUnreachableException — Raised if the node could not be reached.
IceGrid::DeploymentException — Raised if the server couldn't be deployed on the node.
IceGrid::BadSignalException — Raised if the signal is not recognized by the target server.
Write message on server stdout or stderr.
This operation is deprecated as of version 3.3.
writeMessage is deprecated, use instead the Process facet of the server Admin object.
id
— The server id.
message
— The message.
fd
— 1 for stdout, 2 for stderr.
IceGrid::ServerNotExistException — Raised if the server doesn't exist.
IceGrid::NodeUnreachableException — Raised if the node could not be reached.
IceGrid::DeploymentException — Raised if the server couldn't be deployed on the node.
Get all the server ids registered with IceGrid.
The server ids.
Get the adapter information for the replica group or adapter with the given id.
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.
IceGrid::AdapterNotExistException — Raised if the adapter or replica group doesn't exist.
Remove the adapter with the given id.
id
— The adapter id.
IceGrid::AdapterNotExistException — Raised if the adapter doesn't exist.
Get all the adapter ids registered with IceGrid.
The adapter ids.
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.
obj
— The object to be added to the registry.
IceGrid::ObjectExistsException — Raised if the object is already registered.
IceGrid::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.
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.
obj
— The object to be updated to the registry.
IceGrid::ObjectNotRegisteredException — Raised if the object isn't registered with the registry.
IceGrid::DeploymentException — Raised if the object can't be updated. This might happen if the object was added with a deployment descriptor.
Add an object to the object registry and explicitly specify its type.
obj
— The object to be added to the registry.
type
— The object type.
IceGrid::ObjectExistsException — Raised if the object is already registered.
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.
id
— The identity of the object to be removed from the registry.
IceGrid::ObjectNotRegisteredException — Raised if the object isn't registered with the registry.
IceGrid::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.
id
— The identity of the object.
The object info.
IceGrid::ObjectNotRegisteredException — Raised if the object isn't registered with the registry.
Get the object info of all the registered objects with the given type.
type
— The type of the object.
The object infos.
Get the object info of all the registered objects whose stringified identities match the given expression.
expr
— 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.
Ping an IceGrid node to see if it is active.
name
— The node name.
true if the node ping succeeded, false otherwise.
IceGrid::NodeNotExistException — Raised if the node doesn't exist.
Get the load averages of the node.
name
— The node name.
The node load information.
IceGrid::NodeNotExistException — Raised if the node doesn't exist.
IceGrid::NodeUnreachableException — Raised if the node could not be reached.
Get the node information for the node with the given name.
name
— The node name.
The node information.
IceGrid::NodeNotExistException — Raised if the node doesn't exist.
IceGrid::NodeUnreachableException — Raised if the node could not be reached.
Get the number of physical processor sockets for the machine running the node with the given name. Note that this method will return 1 on operating systems where this can't be automatically determined and where the IceGrid.Node.ProcessorSocketCount property for the node is not set.
name
— The node name.
The number of processor sockets or 1 if the number of sockets can't determined.
IceGrid::NodeNotExistException — Raised if the node doesn't exist.
IceGrid::NodeUnreachableException — Raised if the node could not be reached.
Shutdown an IceGrid node.
name
— The node name.
IceGrid::NodeNotExistException — Raised if the node doesn't exist.
IceGrid::NodeUnreachableException — Raised if the node could not be reached.
Get the hostname of this node.
name
— The node name.
The node hostname.
IceGrid::NodeNotExistException — Raised if the node doesn't exist.
IceGrid::NodeUnreachableException — Raised if the node could not be reached.
Get all the IceGrid nodes currently registered.
The node names.
Ping an IceGrid registry to see if it is active.
name
— The registry name.
true if the registry ping succeeded, false otherwise.
IceGrid::RegistryNotExistException — Raised if the registry doesn't exist.
Get the registry information for the registry with the given name.
name
— The registry name.
The registry information.
IceGrid::RegistryNotExistException — Raised if the registry doesn't exist.
IceGrid::RegistryUnreachableException — Raised if the registry could not be reached.
Shutdown an IceGrid registry.
name
— The registry name.
IceGrid::RegistryNotExistException — Raised if the registry doesn't exist.
IceGrid::RegistryUnreachableException — Raised if the registry could not be reached.
Get all the IceGrid registrys currently registered.
The registry names.
Shut down the IceGrid registry.
Returns the checksums for the IceGrid Slice definitions.
A dictionary mapping Slice type ids to their checksums.