Commander Variables
  • 29 Oct 2024
  • Dark
    Light
  • PDF

Commander Variables

  • Dark
    Light
  • PDF

Article summary

GATEWAY_COMMANDER_CERTIFICATE_FILE

Specifies the full path to the certificate file to use when creating a secure,
encrypted gateway commander connection.

Environment Variable

GATEWAY_COMMANDER_CERTIFICATE_FILE

File

Section: commander
Key: certificate_file

Default

/etc/gateway/certificates/commander.pem


GATEWAY_COMMANDER_ENABLED

Enables or disables the connection to Itential Cloud services. Commander is the service that handles connections to gateways.

Environment Variable

GATEWAY_COMMANDER_ENABLED

File

Section: commander
Key: enabled

Default

true


GATEWAY_COMMANDER_HOST

Configures the hostname or IP address (e.g., 127.0.0.1) to use when attempting to create a websocket connection to Itential Cloud services. Commander is the service that handles connections to gateways.

Environment Variable

GATEWAY_COMMANDER_HOST

File

Section: commander
Key: host

Default

No default value provided


GATEWAY_COMMANDER_PORT

Configures the TCP port number to use when connecting to the Itential commander cloud service.

Environment Variable

GATEWAY_COMMANDER_PORT

File

Section: commander
Key: port

Default

443


GATEWAY_COMMANDER_PRIVATE_KEY_FILE

Specifies the full path to the private key file to use when creating a connection
to the Itential cloud services.

Environment Variable

GATEWAY_COMMANDER_PRIVATE_KEY_FILE

File

Section: commander
Key: private_key_file

Default

/etc/gateway/certificates/commander-key.pem


GATEWAY_COMMANDER_SERVER_HA_ENABLED

Used when there are multiple all in one or core nodes for a particular GATEWAY_APPLICATION_CLUSTER_ID. When core HA is enabled, the gateway will run in active/standby mode with 1 (one) server connecting to Itential cloud services, and the others will be in standby mode. If the active node goes down for any reason, one of the standby nodes will create a connection to Itential cloud services and begin running.

Environment Variable

GATEWAY_COMMANDER_SERVER_HA_ENABLED

File

Section: commander
Key: server_ha_enabled

Default

false


GATEWAY_COMMANDER_SERVER_HA_IS_PRIMARY

If GATEWAY_COMMANDER_SERVER_HA_ENABLED is set to true, set one of the nodes to be the primary using this configuration variable. If all nodes are online, this node will take the highest precedence over the other nodes and will form the connection to Itential Cloud services. Only one core HA node can be connected to Itential Cloud services at a time. If this node loses connection to commander or the etcd database for any reason, one of the standby nodes will take its place.

Environment Variable

GATEWAY_COMMANDER_SERVER_HA_IS_PRIMARY

File

Section: commander
Key: server_ha_is_primary

Default

false



Was this article helpful?

Changing your password will log you out immediately. Use the new password to log back in.
First name must have atleast 2 characters. Numbers and special characters are not allowed.
Last name must have atleast 1 characters. Numbers and special characters are not allowed.
Enter a valid email
Enter a valid password
Your profile has been successfully updated.