cSRX Environment Variables Overview
Docker allows you to store data such as configuration settings as environment variables in an environment file. At runtime, the environment variables are exposed to the application inside the container. You can set any number of parameters to take effect when the cSRX image launches. You set an environment variable by specifying the docker run -e VARIABLE=VALUE ... key.
A series of cSRX environment variables enables you to modify the characteristics of the cSRX instance when it is launched. The specification of an environment variable is not mandatory; most environment variables have a default value as shown in Table 1. If desired, you can launch the cSRX using the default environment variable settings.
For example, to launch a cSRX instance with an initial root account password, in secure-wire forwarding mode, and using the middle size cSRX configuration:
root@csrx-ubuntu3:~/csrx# docker run -d --privileged --network=mgt_bridge -e CSRX_ROOT_PASSWORD=<password> -e CSRX_SIZE="middle" -e CSRX_FORWARD_MODE="wire" --name=<csrx-container-name> <csrx-image-name>
 | Note: You must include the --privileged flag in the docker run command to enable the cSRX container to run in privileged mode. |
Table 1 summarizes the list of available cSRX environment variables along with a link to the topic that outlines its usage.
Table 1: Summary of cSRX Environment Variables
Variable | Description | Values | Default | Topic |
|---|---|---|---|---|
CSRX_SIZE | cSRX size. | "small" | "middle" | "large" | "large" | |
CSRX_FORWARD_MODE | Traffic forwarding mode. | "routing" | "wire" | "routing" | |
CSRX_PACKET_DRIVER | Packet I/O driver. | "poll" | "interrupt" | "poll" | |
CSRX_ROOT_PASSWORD | Initial root account password to log in to the cSRX container using SSH. | string | No default root password | Initial Root Password for Logging into a cSRX Container in a Linux Docker Environment |
CSRX_CTRL_CPU | CPU mask, indicating which CPU is running the cSRX control plane daemons (such as nsd, mgd, nstraced, utmd, and so on). | hex value | No CPU affinity | |
CSRX_DATA_CPU | CPU mask, indicating which CPU is running the cSRX data plane daemon (srxpfe). | hex value | No CPU affinity | |
CSRX_ARP_TIMEOUT | ARP entry timeout value for the control plane ARP learning or response. | decimal value | Same as the Linux host | |
CSRX_NDP_TIMEOUT | NDP entry timeout value for the control plane NDP learning or response. | decimal value | Same as the Linux host |
