Configure server

This information applies to Itential Platform 2023.2 and earlier.

Itential Platform reads properties.json at startup to get its basic configuration, including the serverName property described below.

serverName property

The serverName property was deprecated in the 2023.1 release and removed in Platform 6.0. The replacement is serverId. For more information, see Deprecation of the serverName property.

Use serverName to assign a unique identifying name to each Itential Platform server in your environment.

PropertyTypeDescription
serverNameStringA unique name that identifies the server. Any valid string is accepted, but must be unique within the environment. If not provided, defaults to a hashed value derived from the server’s MAC address and port.

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

Sample configurations

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