---
title: "Server Descriptor"
url: https://docs.zeroc.com/ice/3.8/services/icegrid/icegrid-gui-tool/application-tabs/icegrid-descriptors/server-descriptor
docs_index: https://docs.zeroc.com/llms.txt
---

> For an index of every page, see [llms.txt](https://docs.zeroc.com/llms.txt).

# Server Descriptor

A server represents an Ice server deployed on a node as part of an application. IceGrid supports three kinds of servers:

- **Plain Server** A normal Ice server, with typically a single Ice communicator. IceGrid generates a single Ice configuration file for this server.
- **IceBox Server** An IceBox server, with usually a number of IceBox services deployed in it. IceGrid generates an Ice configuration file for the IceBox server itself, and also a separate Ice configuration for each IceBox service.
- **Server Instance** A server (either plain server or IceBox server) defined using a server template.

## Plain Server

### Properties {#plain-server-properties}

The Server Properties panel offers the following fields:

- **Server ID** The ID of the server; corresponds to the [Ice.Admin.ServerId](https://docs.zeroc.com/ice/3.8/property-reference/ice-admin-properties.md#ice.admin.serverid) property. Each server must have a unique ID within an IceGrid deployment.
- **Description** A free-text description of this server.
- **Property Sets** List of property-set IDs; you refer to a [property set](https://docs.zeroc.com/ice/3.8/services/icegrid/icegrid-gui-tool/application-tabs/icegrid-descriptors/property-set-descriptor.md) to "include" all its properties in the server.
- **Properties** Ice properties private to this server.
- **Log Files** This table can be used to declare a number of log files used by this server. Path is the path to the log file (a relative path is relative to the IceGrid node working directory); when Property is set, IceGrid generates a property with this name and the log file path as value. You declare log files to be able to conveniently retrieve them using IceGrid GUI (in the [Live Deployment](https://docs.zeroc.com/ice/3.8/services/icegrid/icegrid-gui-tool/live-deployment-tab.md) tab) or with the [icegridadmin](https://docs.zeroc.com/ice/3.8/services/icegrid/icegridadmin-command-line-tool.md) command-line utility.
- **Path to Executable** Path to the server's executable; cannot be blank. The node resolves a relative path as described for the `exe` attribute of the [server element](https://docs.zeroc.com/ice/3.8/services/icegrid/icegrid-xml-reference/server-descriptor-element.md).
- **Ice Version** The Ice version of this server. If you don't provide a value, IceGrid assumes it's the same version as the IceGrid registry.
- **Working Directory** The working directory for the server when started by the IceGrid node.
- **Command Arguments** The command-line arguments given to the server when started by the IceGrid node.
- **Run as** On Linux and macOS, when the IceGrid node runs as root, it can run the server under any user name; enter this name here. When not set (the default), the server runs as the same user as the IceGrid node, except when the node runs as root: the server then runs as `nobody`, or, for a server allocated by a session, as the user named by the session ID. If the node uses a [user account mapper](https://docs.zeroc.com/ice/3.8/services/icegrid/icegrid-server-activation.md#activating-servers-with-specific-user-ids), the node passes the resulting name to the mapper, which returns the account that runs the server.
- **Environment Variables** The environment variables for the server when started by the IceGrid node. These variables are in addition to variables defined in the IceGrid node own environment.
- **Activation Mode** The server's activation mode. Must be one of:

| **Activation Mode** | **Description** |
| --- | --- |
| always | IceGrid keeps this server running all the time |
| manual | This server is started "manually", using IceGrid GUI or the [icegridadmin](https://docs.zeroc.com/ice/3.8/services/icegrid/icegridadmin-command-line-tool.md) command-line utility |
| on-demand | IceGrid starts this server when it resolves the object-adapter ID of an object adapter defined in this server |
| session | IceGrid starts a separate instance of this server for each IceGrid session that allocates this server |

The Activation Mode can also be a variable or a combination of variables that resolves to one of the values above.

- **Activation Timeout** When activating a server, IceGrid waits up to timeout seconds for the server to [activate](https://docs.zeroc.com/ice/3.8/services/icegrid/icegrid-server-activation.md). During this time, lookups for the corresponding adapter IDs are delayed. If not set or set to `0`, the IceGrid node uses the value of its [IceGrid.Node.WaitTime](https://docs.zeroc.com/ice/3.8/property-reference/icegrid-properties.md#icegrid.node.waittime) property.
- **Deactivation Timeout** When deactivating a server, IceGrid gives timeout seconds to the server to exit gracefully. After this timeout, the server process is killed. If not set or set to `0`, the IceGrid node uses the value of its [IceGrid.Node.WaitTime](https://docs.zeroc.com/ice/3.8/property-reference/icegrid-properties.md#icegrid.node.waittime) property.
- **Allocatable** Specifies whether the server can be allocated. A server is allocated implicitly when one of its allocatable objects is allocated. This checkbox is ignored if the server activation mode is session; a server with this activation mode is always allocatable. Default: false.

### Children {#plain-server-children}

A plain server can have [Adapter](https://docs.zeroc.com/ice/3.8/services/icegrid/icegrid-gui-tool/application-tabs/icegrid-descriptors/adapter-descriptor.md) children.

## IceBox Server

### Properties {#icebox-server-properties}

The Properties panel for an IceBox server is identical to the Properties panel for a Plain Server (see above).

IceGrid enables the Admin object in the main communicator of this IceBox server by generating `Ice.Admin.Endpoints=tcp -h 127.0.0.1`, unless the server's properties set [Ice.Admin.Enabled or Ice.Admin.Endpoints](https://docs.zeroc.com/ice/3.8/property-reference/ice-admin-properties.md). See [IceGrid and the Administrative Facility](https://docs.zeroc.com/ice/3.8/services/icegrid/icegrid-and-the-administrative-facility.md).

The Path to Executable is typically `icebox` (C++), `java` (for a Java IceBox) or `dotnet` (for a .NET IceBox).

### Children {#icebox-server-children}

An IceBox server can have [Service](https://docs.zeroc.com/ice/3.8/services/icegrid/icegrid-gui-tool/application-tabs/icegrid-descriptors/service-descriptor.md) children,

## Server Instance

A server instance is a server created from a server template; it may be a plain server or an IceBox server.

### Properties {#server-instance-properties}

The Server Instance Properties panel offers the following fields:

- **Template** The name of the [Server Template](https://docs.zeroc.com/ice/3.8/services/icegrid/icegrid-gui-tool/application-tabs/icegrid-descriptors/server-template-descriptor.md).
- **Parameters** Use this table to assign values to the template parameters defined in the server template.
- **Property Sets** List of property-set IDs; you refer to a [property set](https://docs.zeroc.com/ice/3.8/services/icegrid/icegrid-gui-tool/application-tabs/icegrid-descriptors/property-set-descriptor.md) to "include" all its properties in this server-instance.
- **Properties** Ice properties private to this server. Overall, the properties of the server instance are a combination of properties defined in the server template (including its own property sets references) augmented and possibly overridden by properties defined in the server instance.

### Children {#server-instance-children}

An instance of an IceBox server template can have [Property Set](https://docs.zeroc.com/ice/3.8/services/icegrid/icegrid-gui-tool/application-tabs/icegrid-descriptors/property-set-descriptor.md) children.

An instance of a plain server template cannot have any child.
