Configure server | Itential

This information applies to Itential Platform 2023.2 and earlier release versions.

The properties.json file is located at the root level of the installation directory and initializes Itential Platform. Once initialization is complete, Itential Platform reads properties.json to get its basic configuration, including the serverName and serverId properties described below.

serverName property

The serverName property was deprecated in the 2023.1 release and is scheduled for removal in the Platform 6 release. The replacement property is serverId. See Deprecation of the serverName property.

The serverName property lets administrators define a unique identifying name for each Itential Platform server in their environment.

Property	Type	Description
`serverName`	String	Specifies the name the server uses to identify itself. Any valid string can be used, but each name should be unique within its environment. If not provided, `serverName` defaults to a hashed value derived from the server’s MAC address and Itential Platform port.

Note: The /status API returns the name of the server containing the current database. If serverName is missing or invalid, the /status API returns a null reference value.

Sample configurations

1 "serverName": "ecs-1.example.com"

1 "serverName": "ECSH01234"

serverId property

The serverId property lets administrators define a unique identifying name for each Itential Platform server. Set in properties.json, it provides a user-friendly, consistent way to name servers without relying on generated IP addresses. The serverId value can also be used in Blue-Green deployments.

Sample configurations

Single server

1 "serverId": "iap-1"

Multi-server

1 "serverId": "IAP1.primary"
2 "serverId": "IAP2.primary"
3 "serverId": "IAP3.primary"

1 "serverId": "IAP1.secondary"
2 "serverId": "IAP2.secondary"
3 "serverId": "IAP3.secondary"

Implement serverId

When changing or adding the serverId value and restarting Itential Platform, any tasks in a “running” state that are not one of the following task types will be orphaned:

childJob
manual
forEach
eventListener

This only occurs when serverId is first set or changed. Subsequent restarts will not orphan jobs as long as serverId remains unchanged. Itential recommends pausing the task worker and ensuring no jobs are running before setting serverId.

If your Itential Platform stack has a Disaster Recovery (DR) implementation, ensure the DR cluster does not contain duplicate serverId values from the primary cluster. Itential Platform only checks for duplicate serverId values at the cluster level, not globally. Duplicate serverId values across clusters can cause tasks to be orphaned when the load balancer switches from DR to the primary cluster.