IECTL Environment Variables¶
IECTL supports several environment variables that can modify its behavior. These variables are useful for automation, CI/CD pipelines, and specific deployment scenarios.
Authentication Token Variables¶
When these token environment variables are set and the corresponding configuration exists, IECTL will skip authentication API calls and use the provided token directly, improving performance.
IED_TOKEN¶
export IED_TOKEN="your-ied-authentication-token"
- Purpose: Industrial Edge Device authentication token
- Behavior: When an IED configuration is added via
iectl config add ied
and this environment variable is set, authentication calls will be skipped and the specified token will be used - Usage: Improves performance by avoiding repeated authentication to IED
IEM_TOKEN¶
export IEM_TOKEN="your-iem-authentication-token"
- Purpose: Industrial Edge Management authentication token
- Behavior: When an IEM configuration is added via
iectl config add iem
and this environment variable is set, authentication calls will be skipped and the specified token will be used - Usage: Improves performance by avoiding repeated authentication to IEM
IEHUB_TOKEN¶
export IEHUB_TOKEN="your-iehub-authentication-token"
- Purpose: Industrial Edge Hub authentication token
- Behavior: When an IEHUB configuration is added via
iectl config add iehub
and this environment variable is set, authentication calls will be skipped and the specified token will be used - Usage: Improves performance by avoiding repeated authentication to IEHUB
Security Configuration¶
EDGE_SKIP_TLS¶
export EDGE_SKIP_TLS=1
- Purpose: Skip TLS certificate verification for self-signed certificates
- Applies to: IEM and IED connections
- Use case: Development environments or deployments with self-signed certificates
- Security warning: Only use in trusted environments
Proxy Configuration¶
HTTP_PROXY¶
export HTTP_PROXY="http://proxy.example.com:8080"
# or with authentication
export HTTP_PROXY="http://user:password@proxy.example.com:8080"
- Purpose: HTTP proxy server for IECTL network requests
- Format:
protocol://[user:password@]host:port
HTTPS_PROXY¶
export HTTPS_PROXY="https://proxy.example.com:8443"
# or with authentication
export HTTPS_PROXY="https://user:password@proxy.example.com:8443"
- Purpose: HTTPS proxy server for IECTL network requests
- Format:
protocol://[user:password@]host:port
NO_PROXY¶
export NO_PROXY="localhost,127.0.0.1,*.example.com"
- Purpose: Comma-separated list of hosts/IPs to bypass proxy
- Supported formats:
- Hostnames:
*.example.com
- IP addresses:
127.0.0.1
,192.168.1.1
- Localhost:
localhost
For more information see
Example Usage¶
Token-based Authentication¶
Linux/macOS¶
export IED_TOKEN=$(iectl ied token fetch -q "{.data.access_token}")
export IEM_TOKEN=$(iectl iem token fetch -q "{.data.access_token}")
export IEHUB_TOKEN=$(iectl iehub token fetch -q "{.access_token}")
Windows (PowerShell)¶
$env:IED_TOKEN = iectl ied token fetch -q "{.data.access_token}"
$env:IEM_TOKEN = iectl iem token fetch -q "{.data.access_token}"
$env:IEHUB_TOKEN = iectl iehub token fetch -q "{.access_token}"
Now run commands - they will use the pre-fetched tokens¶
iectl ied system statistics
iectl iem device list
iectl iehub library list
Development Environment with Self-signed Certificates¶
# Skip TLS verification for development
export EDGE_SKIP_TLS=1
# Run IECTL commands
iectl iem device list
Publisher Environment Variables¶
For IE App Publisher specific environment variables (workspace, Docker engine, etc.), see the IECTL Environment Variables Guide.
NOTICE
Publisher Configuration
The preferred way to configure the IE App Publisher is using the iectl config add publisher
command.
Related Documentation¶
- Environment Variables - Complete list including publisher-specific variables
- Managing Configurations - Persistent configuration management
- Fetch & Use Authentication Tokens - How to fetch authentication tokens
- Configure Proxy Settings - Detailed proxy configuration