For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Open sourceSupportFAQsDocs Home
DocumentationCommand referenceRelease notes
DocumentationCommand referenceRelease notes
  • Itential Automation Gateway
    • Overview
    • Execution engine
    • Concepts
    • Feature comparison
        • Create certificates
        • Initial configuration
        • Configure gateway client
        • Configure client profiles
        • Create cluster in Gateway Manager
        • High availability clusters
        • Distributed execution clusters
          • Overview
          • Application variables
          • Client variables
          • Connect variables
          • Features variables
          • Log variables
          • Registry variables
          • Runner variables
          • Secrets variables
          • Server variables
          • Store variables
          • Terminal variables
      • Migrate inventory to IAG 5
    • IAG secret store
    • Inventory Manager
LogoLogo
Open sourceSupportFAQsDocs Home
On this page
  • GATEWAY_CLIENT_CERTIFICATE_FILE
  • Environment Variable
  • File
  • Default
  • GATEWAY_CLIENT_HOST
  • Environment Variable
  • File
  • Default
  • GATEWAY_CLIENT_PORT
  • Environment Variable
  • File
  • Default
  • GATEWAY_CLIENT_PRIVATE_KEY_FILE
  • Environment Variable
  • File
  • Default
  • GATEWAY_CLIENT_<PROFILE>_<SETTING>
  • Examples
  • GATEWAY_CLIENT_USE_TLS
  • Environment Variable
  • File
  • Default
Itential Automation GatewayDeploy and manageConfigureConfiguration variables

Client variables

Was this page helpful?
Previous

Connect variables

Next
Built with

GATEWAY_CLIENT_CERTIFICATE_FILE

The full path to the certificate file that the gateway client uses when it communicates with a gateway server. Required when GATEWAY_CLIENT_USE_TLS is enabled.

Environment Variable

GATEWAY_CLIENT_CERTIFICATE_FILE

File

Section: client

Key: certificate_file

Default

No default value provided


GATEWAY_CLIENT_HOST

The host address of a gateway server that a gateway client connects to when you set GATEWAY_APPLICATION_MODE to client.

Environment Variable

GATEWAY_CLIENT_HOST

File

Section: client

Key: host

Default

No default value provided


GATEWAY_CLIENT_PORT

The port of a gateway server that a gateway client connects to.

Environment Variable

GATEWAY_CLIENT_PORT

File

Section: client

Key: port

Default

50051


GATEWAY_CLIENT_PRIVATE_KEY_FILE

The full path to the private key file that the gateway client uses when it connects to a gateway server. Required when GATEWAY_CLIENT_USE_TLS is enabled.

Environment Variable

GATEWAY_CLIENT_PRIVATE_KEY_FILE

File

Section: client

Key: private_key_file

Default

No default value provided


GATEWAY_CLIENT_<PROFILE>_<SETTING>

IAG 5.4+

Overrides an individual setting for a named client profile. <PROFILE> is the uppercase profile name and <SETTING> is the uppercase setting name — for example, GATEWAY_CLIENT_PRODUCTION_HOST overrides the host setting for the production profile.

The following settings are supported:

SettingEnvironment variable suffix
host_HOST
port_PORT
api_key_API_KEY
certificate_file_CERTIFICATE_FILE
private_key_file_PRIVATE_KEY_FILE
use_tls_USE_TLS

Profile-specific environment variables take precedence over all other configuration sources for the given setting. For full precedence rules and profile configuration, see Configure client profiles.

Examples

$# Override host for the production profile
$export GATEWAY_CLIENT_PRODUCTION_HOST=gw.prod-us-east.example.com
$
$# Override port for the staging profile
$export GATEWAY_CLIENT_STAGING_PORT=50052

GATEWAY_CLIENT_USE_TLS

Determines whether a gateway client uses TLS when it connects to a gateway server.

Environment Variable

GATEWAY_CLIENT_USE_TLS

File

Section: client

Key: use_tls

Default

true