IceGrid.AdminPrx

class IceGrid.AdminPrx

Bases: ObjectPrx

Provides administrative access to an IceGrid deployment.

Notes

The Slice compiler generated this proxy class from Slice interface ::IceGrid::Admin.

addApplication(descriptor: ApplicationDescriptor, context: dict[str, str] | None = None) → None

Adds an application to IceGrid.

Parameters:

• descriptor (ApplicationDescriptor) – The application descriptor.

• context (dict[str, str]) – The request context for the invocation.

Raises:

• AccessDeniedException – Thrown when the session doesn’t hold the exclusive lock or when another session is holding the lock.

• DeploymentException – Thrown when the application deployment failed.

Return type:

None

addApplicationAsync(descriptor: ApplicationDescriptor, context: dict[str, str] | None = None) → Awaitable[None]

Adds an application to IceGrid.

Parameters:

• descriptor (ApplicationDescriptor) – The application descriptor.

• context (dict[str, str]) – The request context for the invocation.

Returns:

An awaitable that is completed when the invocation completes.

Return type:

Awaitable[None]

syncApplication(descriptor: ApplicationDescriptor, context: dict[str, str] | None = None) → None

Synchronizes a deployed application. This operation replaces the current descriptor with a new descriptor.

Parameters:

• descriptor (ApplicationDescriptor) – The new application descriptor.

• context (dict[str, str]) – The request context for the invocation.

Raises:

• AccessDeniedException – Thrown when the session doesn’t hold the exclusive lock or when another session is holding the lock.

• ApplicationNotExistException – Thrown when the application doesn’t exist.

• DeploymentException – Thrown when the application deployment failed.

Return type:

None

syncApplicationAsync(descriptor: ApplicationDescriptor, context: dict[str, str] | None = None) → Awaitable[None]

Synchronizes a deployed application. This operation replaces the current descriptor with a new descriptor.

Parameters:

• descriptor (ApplicationDescriptor) – The new application descriptor.

• context (dict[str, str]) – The request context for the invocation.

Returns:

An awaitable that is completed when the invocation completes.

Return type:

Awaitable[None]

updateApplication(descriptor: ApplicationUpdateDescriptor, context: dict[str, str] | None = None) → None

Updates a deployed application.

Parameters:

• descriptor (ApplicationUpdateDescriptor) – The update descriptor.

• context (dict[str, str]) – The request context for the invocation.

Raises:

• AccessDeniedException – Thrown when the session doesn’t hold the exclusive lock or when another session is holding the lock.

• ApplicationNotExistException – Thrown when the application doesn’t exist.

• DeploymentException – Thrown when the application deployment failed.

Return type:

None

updateApplicationAsync(descriptor: ApplicationUpdateDescriptor, context: dict[str, str] | None = None) → Awaitable[None]

Updates a deployed application.

Parameters:

• descriptor (ApplicationUpdateDescriptor) – The update descriptor.

• context (dict[str, str]) – The request context for the invocation.

Returns:

An awaitable that is completed when the invocation completes.

Return type:

Awaitable[None]

syncApplicationWithoutRestart(descriptor: ApplicationDescriptor, context: dict[str, str] | None = None) → None

Synchronizes a deployed application. This operation replaces the current descriptor with a 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.

Parameters:

• descriptor (ApplicationDescriptor) – The application descriptor.

• context (dict[str, str]) – The request context for the invocation.

Raises:

• AccessDeniedException – Thrown when the session doesn’t hold the exclusive lock or when another session is holding the lock.

• ApplicationNotExistException – Thrown when the application doesn’t exist.

• DeploymentException – Thrown when the application deployment failed.

Return type:

None

syncApplicationWithoutRestartAsync(descriptor: ApplicationDescriptor, context: dict[str, str] | None = None) → Awaitable[None]

Synchronizes a deployed application. This operation replaces the current descriptor with a 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.

Parameters:

• descriptor (ApplicationDescriptor) – The application descriptor.

• context (dict[str, str]) – The request context for the invocation.

Returns:

An awaitable that is completed when the invocation completes.

Return type:

Awaitable[None]

updateApplicationWithoutRestart(descriptor: ApplicationUpdateDescriptor, context: dict[str, str] | None = None) → None

Updates a deployed application. This operation succeeds only when 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.

Parameters:

• descriptor (ApplicationUpdateDescriptor) – The update descriptor.

• context (dict[str, str]) – The request context for the invocation.

Raises:

• AccessDeniedException – Thrown when the session doesn’t hold the exclusive lock or when another session is holding the lock.

• ApplicationNotExistException – Thrown when the application doesn’t exist.

• DeploymentException – Thrown when the application deployment failed.

Return type:

None

updateApplicationWithoutRestartAsync(descriptor: ApplicationUpdateDescriptor, context: dict[str, str] | None = None) → Awaitable[None]

Updates a deployed application. This operation succeeds only when 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.

Parameters:

• descriptor (ApplicationUpdateDescriptor) – The update descriptor.

• context (dict[str, str]) – The request context for the invocation.

Returns:

An awaitable that is completed when the invocation completes.

Return type:

Awaitable[None]

removeApplication(name: str, context: dict[str, str] | None = None) → None

Removes an application from IceGrid.

Parameters:

• name (str) – The application name.

• context (dict[str, str]) – The request context for the invocation.

Raises:

• AccessDeniedException – Thrown when the session doesn’t hold the exclusive lock or when another session is holding the lock.

• ApplicationNotExistException – Thrown when the application doesn’t exist.

• DeploymentException – Thrown when the application deployment failed.

Return type:

None

removeApplicationAsync(name: str, context: dict[str, str] | None = None) → Awaitable[None]

Removes an application from IceGrid.

Parameters:

• name (str) – The application name.

• context (dict[str, str]) – The request context for the invocation.

Returns:

An awaitable that is completed when the invocation completes.

Return type:

Awaitable[None]

instantiateServer(application: str, node: str, desc: ServerInstanceDescriptor, context: dict[str, str] | None = None) → None

Instantiates a server template.

Parameters:

• application (str) – The application name.

• node (str) – The name of the node where the server will be deployed.

• desc (ServerInstanceDescriptor) – The descriptor of the server instance to deploy.

• context (dict[str, str]) – The request context for the invocation.

Raises:

• AccessDeniedException – Thrown when the session doesn’t hold the exclusive lock or when another session is holding the lock.

• ApplicationNotExistException – Thrown when the application doesn’t exist.

• DeploymentException – Thrown when the application deployment failed.

Return type:

None

instantiateServerAsync(application: str, node: str, desc: ServerInstanceDescriptor, context: dict[str, str] | None = None) → Awaitable[None]

Instantiates a server template.

Parameters:

• application (str) – The application name.

• node (str) – The name of the node where the server will be deployed.

• desc (ServerInstanceDescriptor) – The descriptor of the server instance to deploy.

• context (dict[str, str]) – The request context for the invocation.

Returns:

An awaitable that is completed when the invocation completes.

Return type:

Awaitable[None]

getApplicationInfo(name: str, context: dict[str, str] | None = None) → ApplicationInfo

Gets an application descriptor.

Parameters:

• name (str) – The application name.

• context (dict[str, str]) – The request context for the invocation.

Returns:

The application descriptor.

Return type:

ApplicationInfo

Raises:

ApplicationNotExistException – Thrown when the application doesn’t exist.

getApplicationInfoAsync(name: str, context: dict[str, str] | None = None) → Awaitable[ApplicationInfo]

Gets an application descriptor.

Parameters:

• name (str) – The application name.

• context (dict[str, str]) – The request context for the invocation.

Returns:

The application descriptor.

Return type:

Awaitable[ApplicationInfo]

getDefaultApplicationDescriptor(context: dict[str, str] | None = None) → ApplicationDescriptor

Gets the default application descriptor.

Parameters:

context (dict[str, str]) – The request context for the invocation.

Returns:

The default application descriptor.

Return type:

ApplicationDescriptor

Raises:

DeploymentException – Thrown when the default application descriptor is invalid or unreachable.

getDefaultApplicationDescriptorAsync(context: dict[str, str] | None = None) → Awaitable[ApplicationDescriptor]

Gets the default application descriptor.

Parameters:

context (dict[str, str]) – The request context for the invocation.

Returns:

The default application descriptor.

Return type:

Awaitable[ApplicationDescriptor]

getAllApplicationNames(context: dict[str, str] | None = None) → list[str]

Gets all the IceGrid applications currently registered.

Parameters:

context (dict[str, str]) – The request context for the invocation.

Returns:

The application names.

Return type:

list[str]

getAllApplicationNamesAsync(context: dict[str, str] | None = None) → Awaitable[list[str]]

Gets all the IceGrid applications currently registered.

Parameters:

context (dict[str, str]) – The request context for the invocation.

Returns:

The application names.

Return type:

Awaitable[list[str]]

getServerInfo(id: str, context: dict[str, str] | None = None) → ServerInfo

Gets information about a server.

Parameters:

• id (str) – The server ID.

• context (dict[str, str]) – The request context for the invocation.

Returns:

The server information.

Return type:

ServerInfo

Raises:

ServerNotExistException – Thrown when the server doesn’t exist.

getServerInfoAsync(id: str, context: dict[str, str] | None = None) → Awaitable[ServerInfo]

Gets information about a server.

Parameters:

• id (str) – The server ID.

• context (dict[str, str]) – The request context for the invocation.

Returns:

The server information.

Return type:

Awaitable[ServerInfo]

getServerState(id: str, context: dict[str, str] | None = None) → ServerState

Gets the state of a server.

Parameters:

• id (str) – The server ID.

• context (dict[str, str]) – The request context for the invocation.

Returns:

The server state.

Return type:

ServerState

Raises:

• DeploymentException – Thrown when the deployment of the server failed.

• NodeUnreachableException – Thrown when the node is unreachable.

• ServerNotExistException – Thrown when the server doesn’t exist.

getServerStateAsync(id: str, context: dict[str, str] | None = None) → Awaitable[ServerState]

Gets the state of a server.

Parameters:

• id (str) – The server ID.

• context (dict[str, str]) – The request context for the invocation.

Returns:

The server state.

Return type:

Awaitable[ServerState]

getServerPid(id: str, context: dict[str, str] | None = None) → int

Gets the system process ID of a server. The process ID is operating system dependent.

Parameters:

• id (str) – The server ID.

• context (dict[str, str]) – The request context for the invocation.

Returns:

The process ID.

Return type:

int

Raises:

• DeploymentException – Thrown when the deployment of the server failed.

• NodeUnreachableException – Thrown when the node is unreachable.

• ServerNotExistException – Thrown when the server doesn’t exist.

getServerPidAsync(id: str, context: dict[str, str] | None = None) → Awaitable[int]

Gets the system process ID of a server. The process ID is operating system dependent.

Parameters:

• id (str) – The server ID.

• context (dict[str, str]) – The request context for the invocation.

Returns:

The process ID.

Return type:

Awaitable[int]

getServerAdminCategory(context: dict[str, str] | None = None) → str

Gets 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.

Parameters:

context (dict[str, str]) – The request context for the invocation.

Returns:

The category for server admin objects.

Return type:

str

getServerAdminCategoryAsync(context: dict[str, str] | None = None) → Awaitable[str]

Gets 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.

Parameters:

context (dict[str, str]) – The request context for the invocation.

Returns:

The category for server admin objects.

Return type:

Awaitable[str]

getServerAdmin(id: str, context: dict[str, str] | None = None) → ObjectPrx | None

Gets a proxy to the admin object of a server.

Parameters:

• id (str) – The server ID.

• context (dict[str, str]) – The request context for the invocation.

Returns:

A proxy to the admin object of the server. This proxy is never null.

Return type:

ObjectPrx | None

Raises:

• DeploymentException – Thrown when the deployment of the server failed.

• NodeUnreachableException – Thrown when the node is unreachable.

• ServerNotExistException – Thrown when the server doesn’t exist.

getServerAdminAsync(id: str, context: dict[str, str] | None = None) → Awaitable[ObjectPrx | None]

Gets a proxy to the admin object of a server.

Parameters:

• id (str) – The server ID.

• context (dict[str, str]) – The request context for the invocation.

Returns:

A proxy to the admin object of the server. This proxy is never null.

Return type:

Awaitable[ObjectPrx | None]

enableServer(id: str, enabled: bool, context: dict[str, str] | None = None) → None

Enables or disables 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.

Parameters:

• id (str) – The server ID.

• enabled (bool) – true to enable the server, false to disable it.

• context (dict[str, str]) – The request context for the invocation.

Raises:

• DeploymentException – Thrown when the deployment of the server failed.

• NodeUnreachableException – Thrown when the node is unreachable.

• ServerNotExistException – Thrown when the server doesn’t exist.

Return type:

None

enableServerAsync(id: str, enabled: bool, context: dict[str, str] | None = None) → Awaitable[None]

Enables or disables 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.

Parameters:

• id (str) – The server ID.

• enabled (bool) – true to enable the server, false to disable it.

• context (dict[str, str]) – The request context for the invocation.

Returns:

An awaitable that is completed when the invocation completes.

Return type:

Awaitable[None]

isServerEnabled(id: str, context: dict[str, str] | None = None) → bool

Checks if the server is enabled or disabled.

Parameters:

• id (str) – The server ID.

• context (dict[str, str]) – The request context for the invocation.

Returns:

true if the server is enabled, false otherwise.

Return type:

bool

Raises:

• DeploymentException – Thrown when the deployment of the server failed.

• NodeUnreachableException – Thrown when the node is unreachable.

• ServerNotExistException – Thrown when the server doesn’t exist.

isServerEnabledAsync(id: str, context: dict[str, str] | None = None) → Awaitable[bool]

Checks if the server is enabled or disabled.

Parameters:

• id (str) – The server ID.

• context (dict[str, str]) – The request context for the invocation.

Returns:

true if the server is enabled, false otherwise.

Return type:

Awaitable[bool]

startServer(id: str, context: dict[str, str] | None = None) → None

Starts a server and waits for its activation.

Parameters:

• id (str) – The server id.

• context (dict[str, str]) – The request context for the invocation.

Raises:

• DeploymentException – Thrown when the deployment of the server failed.

• NodeUnreachableException – Thrown when the node is unreachable.

• ServerNotExistException – Thrown when the server doesn’t exist.

• ServerStartException – Thrown when the server startup failed.

Return type:

None

startServerAsync(id: str, context: dict[str, str] | None = None) → Awaitable[None]

Starts a server and waits for its activation.

Parameters:

• id (str) – The server id.

• context (dict[str, str]) – The request context for the invocation.

Returns:

An awaitable that is completed when the invocation completes.

Return type:

Awaitable[None]

stopServer(id: str, context: dict[str, str] | None = None) → None

Stops a server.

Parameters:

• id (str) – The server ID.

• context (dict[str, str]) – The request context for the invocation.

Raises:

• DeploymentException – Thrown when the deployment of the server failed.

• NodeUnreachableException – Thrown when the node is unreachable.

• ServerNotExistException – Thrown when the server doesn’t exist.

• ServerStopException – Thrown when the server stop failed.

Return type:

None

stopServerAsync(id: str, context: dict[str, str] | None = None) → Awaitable[None]

Stops a server.

Parameters:

• id (str) – The server ID.

• context (dict[str, str]) – The request context for the invocation.

Returns:

An awaitable that is completed when the invocation completes.

Return type:

Awaitable[None]

sendSignal(id: str, signal: str, context: dict[str, str] | None = None) → None

Sends a signal to a server.

Parameters:

• id (str) – The server ID.

• signal (str) – The signal, for example SIGTERM or 15.

• context (dict[str, str]) – The request context for the invocation.

Raises:

• BadSignalException – Thrown when the signal is not recognized by the target server.

• DeploymentException – Thrown when the deployment of the server failed.

• NodeUnreachableException – Thrown when the node is unreachable.

• ServerNotExistException – Thrown when the server doesn’t exist.

Return type:

None

sendSignalAsync(id: str, signal: str, context: dict[str, str] | None = None) → Awaitable[None]

Sends a signal to a server.

Parameters:

• id (str) – The server ID.

• signal (str) – The signal, for example SIGTERM or 15.

• context (dict[str, str]) – The request context for the invocation.

Returns:

An awaitable that is completed when the invocation completes.

Return type:

Awaitable[None]

getAllServerIds(context: dict[str, str] | None = None) → list[str]

Gets the IDs of all the servers registered with IceGrid.

Parameters:

context (dict[str, str]) – The request context for the invocation.

Returns:

The server IDs.

Return type:

list[str]

getAllServerIdsAsync(context: dict[str, str] | None = None) → Awaitable[list[str]]

Gets the IDs of all the servers registered with IceGrid.

Parameters:

context (dict[str, str]) – The request context for the invocation.

Returns:

The server IDs.

Return type:

Awaitable[list[str]]

getAdapterInfo(id: str, context: dict[str, str] | None = None) → list[AdapterInfo]

Gets adapter information for the replica group or adapter with the given ID.

Parameters:

• id (str) – The adapter or replica group ID.

• context (dict[str, str]) – The request context for the invocation.

Returns:

A sequence of AdapterInfo. If id refers to an adapter, this sequence contains a single element. If id refers to a replica group, this sequence contains adapter information for each member of the replica group.

Return type:

list[AdapterInfo]

Raises:

AdapterNotExistException – Thrown when the adapter or replica group doesn’t exist.

getAdapterInfoAsync(id: str, context: dict[str, str] | None = None) → Awaitable[list[AdapterInfo]]

Gets adapter information for the replica group or adapter with the given ID.

Parameters:

• id (str) – The adapter or replica group ID.

• context (dict[str, str]) – The request context for the invocation.

Returns:

A sequence of AdapterInfo. If id refers to an adapter, this sequence contains a single element. If id refers to a replica group, this sequence contains adapter information for each member of the replica group.

Return type:

Awaitable[list[AdapterInfo]]

removeAdapter(id: str, context: dict[str, str] | None = None) → None

Removes the adapter with the given ID.

Parameters:

• id (str) – The adapter ID.

• context (dict[str, str]) – The request context for the invocation.

Raises:

• AdapterNotExistException – Thrown when the adapter doesn’t exist.

• DeploymentException – Thrown when the application deployment failed.

Return type:

None

removeAdapterAsync(id: str, context: dict[str, str] | None = None) → Awaitable[None]

Removes the adapter with the given ID.

Parameters:

• id (str) – The adapter ID.

• context (dict[str, str]) – The request context for the invocation.

Returns:

An awaitable that is completed when the invocation completes.

Return type:

Awaitable[None]

getAllAdapterIds(context: dict[str, str] | None = None) → list[str]

Gets the IDs of all adapters registered with IceGrid.

Parameters:

context (dict[str, str]) – The request context for the invocation.

Returns:

The adapter IDs.

Return type:

list[str]

getAllAdapterIdsAsync(context: dict[str, str] | None = None) → Awaitable[list[str]]

Gets the IDs of all adapters registered with IceGrid.

Parameters:

context (dict[str, str]) – The request context for the invocation.

Returns:

The adapter IDs.

Return type:

Awaitable[list[str]]

addObject(obj: ObjectPrx | None, context: dict[str, str] | None = None) → None

Adds an object to the object registry. IceGrid gets the object type by calling ice_id on obj. The object must be reachable.

Parameters:

• obj (ObjectPrx | None) – A proxy to the object. This proxy is never null.

• context (dict[str, str]) – The request context for the invocation.

Raises:

• DeploymentException – Thrown when the object can’t be added.

• ObjectExistsException – Thrown when the object is already registered.

Return type:

None

addObjectAsync(obj: ObjectPrx | None, context: dict[str, str] | None = None) → Awaitable[None]

Adds an object to the object registry. IceGrid gets the object type by calling ice_id on obj. The object must be reachable.

Parameters:

• obj (ObjectPrx | None) – A proxy to the object. This proxy is never null.

• context (dict[str, str]) – The request context for the invocation.

Returns:

An awaitable that is completed when the invocation completes.

Return type:

Awaitable[None]

updateObject(obj: ObjectPrx | None, context: dict[str, str] | None = None) → None

Updates 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.

Parameters:

• obj (ObjectPrx | None) – A proxy to the object. This proxy is never null.

• context (dict[str, str]) – The request context for the invocation.

Raises:

• DeploymentException – Thrown when the object can’t be updated.

• ObjectNotRegisteredException – Thrown when the object isn’t registered with the registry.

Return type:

None

updateObjectAsync(obj: ObjectPrx | None, context: dict[str, str] | None = None) → Awaitable[None]

Updates 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.

Parameters:

• obj (ObjectPrx | None) – A proxy to the object. This proxy is never null.

• context (dict[str, str]) – The request context for the invocation.

Returns:

An awaitable that is completed when the invocation completes.

Return type:

Awaitable[None]

addObjectWithType(obj: ObjectPrx | None, type: str, context: dict[str, str] | None = None) → None

Adds an object to the object registry and explicitly specifies its type.

Parameters:

• obj (ObjectPrx | None) – The object to be added to the registry. The proxy is never null.

• type (str) – The type name.

• context (dict[str, str]) – The request context for the invocation.

Raises:

• DeploymentException – Thrown when the application deployment failed.

• ObjectExistsException – Thrown when the object is already registered.

Return type:

None

addObjectWithTypeAsync(obj: ObjectPrx | None, type: str, context: dict[str, str] | None = None) → Awaitable[None]

Adds an object to the object registry and explicitly specifies its type.

Parameters:

• obj (ObjectPrx | None) – The object to be added to the registry. The proxy is never null.

• type (str) – The type name.

• context (dict[str, str]) – The request context for the invocation.

Returns:

An awaitable that is completed when the invocation completes.

Return type:

Awaitable[None]

removeObject(id: Identity, context: dict[str, str] | None = None) → None

Removes 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.

Parameters:

• id (Identity) – The identity of the object to remove.

• context (dict[str, str]) – The request context for the invocation.

Raises:

• DeploymentException – Thrown when the object can’t be removed.

• ObjectNotRegisteredException – Thrown when the object isn’t registered with the registry.

Return type:

None

removeObjectAsync(id: Identity, context: dict[str, str] | None = None) → Awaitable[None]

Removes 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.

Parameters:

• id (Identity) – The identity of the object to remove.

• context (dict[str, str]) – The request context for the invocation.

Returns:

An awaitable that is completed when the invocation completes.

Return type:

Awaitable[None]

getObjectInfo(id: Identity, context: dict[str, str] | None = None) → ObjectInfo

Gets the object info for the object.

Parameters:

• id (Identity) – The identity of the object.

• context (dict[str, str]) – The request context for the invocation.

Returns:

The object info.

Return type:

ObjectInfo

Raises:

ObjectNotRegisteredException – Thrown when the object isn’t registered with the registry.

getObjectInfoAsync(id: Identity, context: dict[str, str] | None = None) → Awaitable[ObjectInfo]

Gets the object info for the object.

Parameters:

• id (Identity) – The identity of the object.

• context (dict[str, str]) – The request context for the invocation.

Returns:

The object info.

Return type:

Awaitable[ObjectInfo]

getObjectInfosByType(type: str, context: dict[str, str] | None = None) → list[ObjectInfo]

Gets the object info of all the registered objects with a given type.

Parameters:

• type (str) – The type name.

• context (dict[str, str]) – The request context for the invocation.

Returns:

The object infos.

Return type:

list[ObjectInfo]

getObjectInfosByTypeAsync(type: str, context: dict[str, str] | None = None) → Awaitable[list[ObjectInfo]]

Gets the object info of all the registered objects with a given type.

Parameters:

• type (str) – The type name.

• context (dict[str, str]) – The request context for the invocation.

Returns:

The object infos.

Return type:

Awaitable[list[ObjectInfo]]

getAllObjectInfos(expr: str, context: dict[str, str] | None = None) → list[ObjectInfo]

Gets the object info of all the registered objects whose stringified identities match the given expression.

Parameters:

• expr (str) – The expression to match against the stringified identities of registered objects. The expression may contain a trailing wildcard (*) character.

• context (dict[str, str]) – The request context for the invocation.

Returns:

All the object infos with a stringified identity matching the given expression.

Return type:

list[ObjectInfo]

getAllObjectInfosAsync(expr: str, context: dict[str, str] | None = None) → Awaitable[list[ObjectInfo]]

Gets the object info of all the registered objects whose stringified identities match the given expression.

Parameters:

• expr (str) – The expression to match against the stringified identities of registered objects. The expression may contain a trailing wildcard (*) character.

• context (dict[str, str]) – The request context for the invocation.

Returns:

All the object infos with a stringified identity matching the given expression.

Return type:

Awaitable[list[ObjectInfo]]

pingNode(name: str, context: dict[str, str] | None = None) → bool

Pings an IceGrid node to see if it is active.

Parameters:

• name (str) – The node name.

• context (dict[str, str]) – The request context for the invocation.

Returns:

true if the node ping succeeded, false otherwise.

Return type:

bool

Raises:

NodeNotExistException – Thrown when the node doesn’t exist.

pingNodeAsync(name: str, context: dict[str, str] | None = None) → Awaitable[bool]

Pings an IceGrid node to see if it is active.

Parameters:

• name (str) – The node name.

• context (dict[str, str]) – The request context for the invocation.

Returns:

true if the node ping succeeded, false otherwise.

Return type:

Awaitable[bool]

getNodeLoad(name: str, context: dict[str, str] | None = None) → LoadInfo

Gets the load averages of a node.

Parameters:

• name (str) – The node name.

• context (dict[str, str]) – The request context for the invocation.

Returns:

The node load information.

Return type:

LoadInfo

Raises:

• NodeNotExistException – Thrown when the node doesn’t exist.

• NodeUnreachableException – Thrown when the node is unreachable.

getNodeLoadAsync(name: str, context: dict[str, str] | None = None) → Awaitable[LoadInfo]

Gets the load averages of a node.

Parameters:

• name (str) – The node name.

• context (dict[str, str]) – The request context for the invocation.

Returns:

The node load information.

Return type:

Awaitable[LoadInfo]

getNodeInfo(name: str, context: dict[str, str] | None = None) → NodeInfo

Gets the node information of a node.

Parameters:

• name (str) – The node name.

• context (dict[str, str]) – The request context for the invocation.

Returns:

The node information.

Return type:

NodeInfo

Raises:

• NodeNotExistException – Thrown when the node doesn’t exist.

• NodeUnreachableException – Thrown when the node is unreachable.

getNodeInfoAsync(name: str, context: dict[str, str] | None = None) → Awaitable[NodeInfo]

Gets the node information of a node.

Parameters:

• name (str) – The node name.

• context (dict[str, str]) – The request context for the invocation.

Returns:

The node information.

Return type:

Awaitable[NodeInfo]

getNodeAdmin(name: str, context: dict[str, str] | None = None) → ObjectPrx | None

Gets a proxy to the admin object of an IceGrid node.

Parameters:

• name (str) – The IceGrid node name.

• context (dict[str, str]) – The request context for the invocation.

Returns:

A proxy to the IceGrid node’s admin object. This proxy is never null.

Return type:

ObjectPrx | None

Raises:

• NodeNotExistException – Thrown when the node doesn’t exist.

• NodeUnreachableException – Thrown when the node is unreachable.

getNodeAdminAsync(name: str, context: dict[str, str] | None = None) → Awaitable[ObjectPrx | None]

Gets a proxy to the admin object of an IceGrid node.

Parameters:

• name (str) – The IceGrid node name.

• context (dict[str, str]) – The request context for the invocation.

Returns:

A proxy to the IceGrid node’s admin object. This proxy is never null.

Return type:

Awaitable[ObjectPrx | None]

getNodeProcessorSocketCount(name: str, context: dict[str, str] | None = None) → int

Gets the number of physical processor sockets in the computer where an IceGrid node is deployed. Note that this operation returns 1 on operating systems where this can’t be automatically determined and where the IceGrid.Node.ProcessorSocketCount property for the node is not set.

Parameters:

• name (str) – The node name.

• context (dict[str, str]) – The request context for the invocation.

Returns:

The number of processor sockets or 1 if the number of sockets can’t be determined.

Return type:

int

Raises:

• NodeNotExistException – Thrown when the node doesn’t exist.

• NodeUnreachableException – Thrown when the node is unreachable.

getNodeProcessorSocketCountAsync(name: str, context: dict[str, str] | None = None) → Awaitable[int]

Gets the number of physical processor sockets in the computer where an IceGrid node is deployed. Note that this operation returns 1 on operating systems where this can’t be automatically determined and where the IceGrid.Node.ProcessorSocketCount property for the node is not set.

Parameters:

• name (str) – The node name.

• context (dict[str, str]) – The request context for the invocation.

Returns:

The number of processor sockets or 1 if the number of sockets can’t be determined.

Return type:

Awaitable[int]

shutdownNode(name: str, context: dict[str, str] | None = None) → None

Shuts down an IceGrid node.

Parameters:

• name (str) – The node name.

• context (dict[str, str]) – The request context for the invocation.

Raises:

• NodeNotExistException – Thrown when the node doesn’t exist.

• NodeUnreachableException – Thrown when the node is unreachable.

Return type:

None

shutdownNodeAsync(name: str, context: dict[str, str] | None = None) → Awaitable[None]

Shuts down an IceGrid node.

Parameters:

• name (str) – The node name.

• context (dict[str, str]) – The request context for the invocation.

Returns:

An awaitable that is completed when the invocation completes.

Return type:

Awaitable[None]

getNodeHostname(name: str, context: dict[str, str] | None = None) → str

Get the hostname of a node.

Parameters:

• name (str) – The node name.

• context (dict[str, str]) – The request context for the invocation.

Returns:

The node hostname.

Return type:

str

Raises:

• NodeNotExistException – Thrown when the node doesn’t exist.

• NodeUnreachableException – Thrown when the node is unreachable.

getNodeHostnameAsync(name: str, context: dict[str, str] | None = None) → Awaitable[str]

Get the hostname of a node.

Parameters:

• name (str) – The node name.

• context (dict[str, str]) – The request context for the invocation.

Returns:

The node hostname.

Return type:

Awaitable[str]

getAllNodeNames(context: dict[str, str] | None = None) → list[str]

Gets the names of all IceGrid nodes currently registered.

Parameters:

context (dict[str, str]) – The request context for the invocation.

Returns:

The node names.

Return type:

list[str]

getAllNodeNamesAsync(context: dict[str, str] | None = None) → Awaitable[list[str]]

Gets the names of all IceGrid nodes currently registered.

Parameters:

context (dict[str, str]) – The request context for the invocation.

Returns:

The node names.

Return type:

Awaitable[list[str]]

pingRegistry(name: str, context: dict[str, str] | None = None) → bool

Pings an IceGrid registry to see if it is active.

Parameters:

• name (str) – The registry name.

• context (dict[str, str]) – The request context for the invocation.

Returns:

true if the registry ping succeeded, false otherwise.

Return type:

bool

Raises:

RegistryNotExistException – Thrown when the registry doesn’t exist.

pingRegistryAsync(name: str, context: dict[str, str] | None = None) → Awaitable[bool]

Pings an IceGrid registry to see if it is active.

Parameters:

• name (str) – The registry name.

• context (dict[str, str]) – The request context for the invocation.

Returns:

true if the registry ping succeeded, false otherwise.

Return type:

Awaitable[bool]

getRegistryInfo(name: str, context: dict[str, str] | None = None) → RegistryInfo

Gets the registry information of an IceGrid registry.

Parameters:

• name (str) – The registry name.

• context (dict[str, str]) – The request context for the invocation.

Returns:

The registry information.

Return type:

RegistryInfo

Raises:

• RegistryNotExistException – Thrown when the registry doesn’t exist.

• RegistryUnreachableException – Thrown when the registry is unreachable.

getRegistryInfoAsync(name: str, context: dict[str, str] | None = None) → Awaitable[RegistryInfo]

Gets the registry information of an IceGrid registry.

Parameters:

• name (str) – The registry name.

• context (dict[str, str]) – The request context for the invocation.

Returns:

The registry information.

Return type:

Awaitable[RegistryInfo]

getRegistryAdmin(name: str, context: dict[str, str] | None = None) → ObjectPrx | None

Gets a proxy to the admin object of an IceGrid registry.

Parameters:

• name (str) – The registry name.

• context (dict[str, str]) – The request context for the invocation.

Returns:

A proxy to the admin object of an IceGrid registry. This proxy is never null.

Return type:

ObjectPrx | None

Raises:

RegistryNotExistException – Thrown when the registry doesn’t exist.

getRegistryAdminAsync(name: str, context: dict[str, str] | None = None) → Awaitable[ObjectPrx | None]

Gets a proxy to the admin object of an IceGrid registry.

Parameters:

• name (str) – The registry name.

• context (dict[str, str]) – The request context for the invocation.

Returns:

A proxy to the admin object of an IceGrid registry. This proxy is never null.

Return type:

Awaitable[ObjectPrx | None]

shutdownRegistry(name: str, context: dict[str, str] | None = None) → None

Shuts down an IceGrid registry.

Parameters:

• name (str) – The registry name.

• context (dict[str, str]) – The request context for the invocation.

Raises:

• RegistryNotExistException – Thrown when the registry doesn’t exist.

• RegistryUnreachableException – Thrown when the registry is unreachable.

Return type:

None

shutdownRegistryAsync(name: str, context: dict[str, str] | None = None) → Awaitable[None]

Shuts down an IceGrid registry.

Parameters:

• name (str) – The registry name.

• context (dict[str, str]) – The request context for the invocation.

Returns:

An awaitable that is completed when the invocation completes.

Return type:

Awaitable[None]

getAllRegistryNames(context: dict[str, str] | None = None) → list[str]

Gets the names of all the IceGrid registries currently registered.

Parameters:

context (dict[str, str]) – The request context for the invocation.

Returns:

The registry names.

Return type:

list[str]

getAllRegistryNamesAsync(context: dict[str, str] | None = None) → Awaitable[list[str]]

Gets the names of all the IceGrid registries currently registered.

Parameters:

context (dict[str, str]) – The request context for the invocation.

Returns:

The registry names.

Return type:

Awaitable[list[str]]

shutdown(context: dict[str, str] | None = None) → None

Shuts down the IceGrid registry.

Parameters:

context (dict[str, str]) – The request context for the invocation.

Return type:

None

shutdownAsync(context: dict[str, str] | None = None) → Awaitable[None]

Shuts down the IceGrid registry.

Parameters:

context (dict[str, str]) – The request context for the invocation.

Returns:

An awaitable that is completed when the invocation completes.

Return type:

Awaitable[None]

static checkedCast(proxy: ObjectPrx | None, facet: str | None = None, context: dict[str, str] | None = None) → AdminPrx | None

Creates a new proxy from an existing proxy after confirming the target object’s type via a remote invocation.

Parameters:

• proxy (ObjectPrx | None) – The source proxy.

• facet (str | None, optional) – A facet name.

• context (dict[str, str] | None, optional) – The request context.

Returns:

A new proxy with the requested facet, or None if the source proxy is None or if the target object/facet does not support the requested type.

Return type:

ObjectPrx | None

static checkedCastAsync(proxy: ObjectPrx | None, facet: str | None = None, context: dict[str, str] | None = None) → Awaitable[AdminPrx | None]

Creates a new proxy from an existing proxy after confirming the target object’s type via a remote invocation.

Parameters:

• proxy (ObjectPrx | None) – The source proxy.

• facet (str | None, optional) – A facet name.

• context (dict[str, str] | None, optional) – The request context.

Returns:

A new proxy with the requested facet, or None if the source proxy is None or if the target object/facet does not support the requested type.

Return type:

ObjectPrx | None

static uncheckedCast(proxy: ObjectPrx, facet: str | None = None) → AdminPrx

static uncheckedCast(proxy: None, facet: str | None = None) → None

Creates a new proxy from an existing proxy.

Parameters:

• proxy (ObjectPrx | None) – The source proxy.

• facet (str | None, optional) – A facet name.

Returns:

A new proxy with the requested facet, or None if the source proxy is None.

Return type:

ObjectPrx | None

static ice_staticId() → str

Returns the Slice type ID associated with this type.

Returns:

The Slice type ID.

Return type:

str