← Back to Articles
site_vars file
Last Updated: June 30, 2026

This file contains the required variables for the CommScope installation. Contact CommScope for the correct information to place within this file. See the site_vars file distributed with ServAssure NXT for an example.

Refer to the descriptions of each variable to determine appropriate settings based on details of the installation environment. Variables are classified as:
  • Required: You must provide a value.
  • Required if enabled: The variable and value may be commented out and disabled. If it is enabled, you must provide a value.
  • Optional: You are not required to provide a value; a default is used if you do not provide a value.
  • Optional and deprecated: This variable has been deprecated. If you do not provide a value a default value is not used.
  • Not used: This variable is not used and is shown only for historical comparison.
NOTE: You must provide values for Required variables. If a variable is Optional, a default value is provided if you do not designate a value. Some variables are disabled (commented out). These can be included in the site_vars file by removing the commenting characters to enable the variable.
DEPLOYMENT
Optional and deprecated. Defines the deployment environment.
Default: standard
Configuration: 
DEPLOYMENT: standard
INSTALL_JAVA
Optional. Indicates if the installation should install Java.
Default: NO
Configuration:
INSTALL_JAVA: NO
Set value to YES if you do not have Java installed. OpenJDK will be installed from the YUM repositories. If you are using Oracle JDK, you must have the required Oracle JDK installed before installing ServAssure NXT. For legal reasons, CommScope is not permitted to install Java on your host servers.
ARRIS_SWLIB
Optional. The location of the JDK. This path can be used to install the Oracle JDK. If the desired path differs from the default value, use this variable to change it.
Default: /opt/arris/ansible/ac_files
Configuration:
ARRIS_SWLIB: /opt/arris/ansible/ac_files
TENANT_NAME
Required. The name of your ServAssure NXT tenant or database.
Configuration:
TENANT_NAME:tenantUsername
TENANT_PASS
Required. The password for your ServAssure NXT tenant or database.
Configuration:
TENANT_PASS:tenantPassword
TENANT_TTL
Not used.
The TTL value is set when creating the TENANT in NXT Engine.
Only set this variable if directed to do so by CommScope Professional Services.
ALLOWED_TENANTS
Optional. Used for Multi-Tenant UI support. This is a comma-separated list of tenants that users can log in to on the UI. This variable is commented out by default. TENANT_NAME is used instead
Contact CommScope Professional Services for guidance on using this variable.
NXT_USERNAME
Required. The username to be configured as your first "admin" user for the initial UI/Application Server login.
Configuration:
NXT_USERNAME: applicationUsername
NXT_PASSWORD
Required. The password to be configured for the NXT_USERNAME.
Configuration:
NXT_PASSWORD: applicationPassword

Heartbeat configuration variables

HEARTBEAT_INTERVAL
Optional. Controls whether the heartbeat feature is installed. Specifies the interval (in minutes) a heartbeat is sent.
Default:
Configuration:
HEARTBEAT_INTERVAL: number
All related NOTIFICATION variables (below) are also optional.
If HEARTBEAT_INTERVAL is 0 or commented out, the heartbeat will not be installed and any installation of it will be uninstalled. If HEARTBEAT_INTERVAL > 0, the heartbeat script is installed and a cron is configured to execute it at the specified HEARTBEAT_INTERVAL.
Refer to ServAssure® NXT Operations Guide for more details on this feature.
NOTIFICATION_URLS
Optional. A comma-separated list of URLs to which ServAssure NXT posts heartbeat messages. Only used when HEARTBEAT_INTERVAL is configured.
Default:
Configuration:
NOTIFICATION_URLS: URL_1,URL_2,URL_3
NOTIFICATION_USER
Optional. User name (if required) for URL to which heartbeat message is POSTed. Only used when HEARTBEAT_INTERVAL is configured.
Default:
Configuration:
NOTIFICATION_USER: username
NOTIFICATION_PASSWORD
Optional. Password (if required) for URL to which heartbeat message is POSTed. Only used when HEARTBEAT_INTERVAL is configured.
Default:
Configuration:
NOTIFICATION_PASSWORD: password

High Availability variable

HAPROXY_VIP
Required if enabled. This variable is commented out by default. It specifies the Virtual IP to use when more than one HAPROXY host is defined in inventory. When more than one host is defined, the HA features of HAPROXY are enabled. The HAPROXY_HA_VIP # allows ONE IP address to be used to support the HA features.
Configuration:
HAPROXY_HA_VIP: 'IP_address'
To use this variable, uncomment the variable, and put the IP Address you have chosen as your VIP within the quotation marks.
NOTE: The IP address used here should also be set for the ctvip, stvip, atvip, and ntvip variables in the host inventory.

Rabbit JMS variable

ENABLE_RABBIT_JMS
Optional. Configures ServAssure NXT to connect to the RabbitMQ message bus in environments where ServAssure NXT integrates with ServAssure Collection Platform. Possible values are true or false.
Default: false
Configuration:
ENABLE_RABBIT_JMS: true
Before setting this variable to true, RabbitMQ must be installed using the ServAssure Collection Platform installation package.

Insight variables

NXT_INSIGHT_ENABLED
Optional. Configures the Insight Views connection to NXT Engine when integrated with Insight Views.
Default: false
Configuration:
NXT_INSIGHT_ENABLED: true
Before setting this variable to true, Insight Views must be installed using the Insight Views installation package.
NXT_INSIGHT_INTEGRATION
Required if ServAssure NXT is integrated with Insight Views. Configures NXT Engine properties to use the correct keystore password for SSL Certificates when starting up and connecting to Kafka.
Configuration:
NXT_INSIGHT_INTEGRATION:
  kafka_nxt_engine_keystore_pw: keystore_password
Each line under NXT_INSIGHT_INTEGRATION should be indented two spaces.

Property override

NXT_ENG_PROPERTIES
Optional. Overrides NXT Engine properties.
Consult CommScope Professional Services to change this setting.

Node API variable

NODE_API_TIER_PORT
Required if ServAssure Node API is installed. Defines the port to communicate with ServAssure Node API through HAProxy.
Default: 9000
Configuration:
NODE_API_TIER_PORT: 9000
This value maps to the [haproxy] ntvip role group.

ServAssure Dashboard for Alarm Central variables

DASHBOARD_LOAD_BALANCER_DOMAIN_NAME
Optional. Domain name for the ServAssure Dashboard for Alarm Central load balancer.
Default: the first node in the [dashboard] group is used as a load balancer if this variable is not provided.
Configuration:
DASHBOARD_LOAD_BALANCER_DOMAIN_NAME: domainName
Set this value only when the value for ENABLE_NGINX_AS_LOAD_BALANCER is false.
DASHBOARD_LOAD_BALANCER_PORT
Optional. Default port for the ServAssure Dashboard for Alarm Central load balancer.
Default: 8888
Configuration:
DASHBOARD_LOAD_BALANCER_PORT: 8888
UPDATED_DASHBOARD_API_PORT
Optional. Default port for the ServAssure Dashboard for Alarm Central API.
Default: 8089
Configuration:
UPDATED_DASHBOARD_API_PORT: 8089

Customer-specific variables

Customer- specific variables (Appserver, NXT-Engine, Cassandra) are optional. You can use the following variables to override default values.

Appserver variables

Use appserver variables to define your own keystore with custom site SSL certificates in your site_vars file. To use an appserver variable, enable the following variables by removing the commenting characters around them then enter the appropriate information. If these variables are commented out, ServAssure NXT creates a default keystore with self-signed certificates.
NXT_UI_KEYSTORE_FILE
Required if enabled. Path to keystore file.
Configuration:
NXT_UI_KEYSTORE_FILE: pathToFile
NXT_UI_KEYSTORE_PASS
Required if enabled. Password for keystore.
Configuration:
NXT_UI_KEYSTORE_PASS: keystorePassword
NXT_UI_KEYSTORE_TYPE
Required if enabled. Type of the keystore used. Possible values are:
  • JKS
  • PKCS11
  • PKCS12
Enter only one value.
Configuration:
NXT_UI_KEYSTORE_TYPE: JKS

NXT-Engine variables

Similar to defining the keystores above for the Appserver, you can define custom site SSL certificates for the NXT Engine Administration UI. If these variables are commented out, ServAssure NXT creates a default keystore with self-signed certificates.
NXT_ENG_SECURE_UI
Required if enabled. Defines if the ServAssure NXT Engine Admin UI needs to use secure access. Possible values are true or false.
Default: false
Configuration:
NXT_ENG_SECURE_UI: false
NXT_ENG_KEYSTORE_FILE
Required if enabled. Path to keystore file.
Configuration:
NXT_ENG_KEYSTORE_FILE: pathToFile
NXT_ENG_KEYSTORE_PASS
Required if enabled. Password for keystore.
Configuration:
NXT_UI_KEYSTORE_PASS: keystorePassword

Cassandra variables

If you have configured a different mount point for the Cassandra data directory, use these variables to define paths different from the default paths. Change pathTo... field only.
NOTE:/var/lib/cassandra is a default if these variables are commented out or not defined.
CASSANDRA_DATA_DIR
Optional. Path to the Cassandra data directory. Use this override if your data mount point is different from the default.
Default: /var/lib/cassandra/data
Configuration: 
CASSANDRA_DATA_DIR: pathToDataDirectory
CASSANDRA_COMMITLOG_DIRECTORY
Optional. Path to the Cassandra commit log directory. Use this override if your commitlog mount point is different from the default.
Default: /var/lib/cassandra/commitlog
Configuration:
CASSANDRA_COMMITLOG_DIRECTORY: pathToCommitlogDirectory
CASSANDRA_SAVED_CACHES_DIRECTORY
Optional. Path to the Cassandra saved cache directory. Use this override if your saved_caches mount point is different from the default.
Default: /var/lib/cassandra/saved_caches
Configuration:
CASSANDRA_SAVED_CACHES_DIRECTORY: pathToSavedCachesDirectory

Trap Receiver-specific variables

TENANT_NAME
Required. Defines the basic authentication for the ingest service and affects tenant used in ServAssure Metrics Platform reporting.
Configuration:
TENANT_NAME: tenantName
TRAPRX_INGEST_PORT
Optional. Overrides the automatically determined ingest port for transmitting traps to ServAssure NXT.
Default: 8182 or 8183 if HA_Proxy is configured.
Configuration:
TRAPRX_INGEST_PORT: 8182
TRAPRX_INGEST_HOST
Optional. Overrides the automatically determined ingest host for transmitting traps to ServAssure NXT.
Default: HA_Proxy, Cache Tier VIP or Application Tier VIP, depending on configuration.
Configuration:
TRAPRX_INGEST_HOST: hostname
TRAPRX_COMM_STRING
Optional. The community string used by the Trap Receiver to authenticate incoming traps. If this property is commented out, authentication is disabled and traps will be allowed without checking the community string. If community string authentication is enabled, devices that send the traps should be configured with the same community string in order for the traps to be processed.
Default:
Configuration:
TRAPRX_COMM_STRING: communityString
TRAPRX_ACL_HOSTS
Optional. A comma-separated list of IP addresses from which the incoming traps are accepted. Each IP address should be a valid IPv4 or IPv6 address, or an IP address with CIDR notation for IP address blocks. By default, this property is commented out, leaving the IP filtering disabled. When filtering is disabled traps from all the source IPs are accepted.
Default:
Configuration: 
TRAPRX_ACL_HOSTS: 1.90.4.165,192.168.2.0/24,2620:0:ed0:b620::17,2620:0:ed0:b620::17/64
TRAPRX_BIND_ADDR
Optional. The IP address where the Trap Receiver listens for incoming SNMP trap messages.
Default: 0.0.0.0
Configuration:
TRAPRX_BIND_ADDR: ipAddress
Default value causes Trap Receiver to listen on all the available network interfaces of the machine where the Trap Receiver is installed.
TRAPRX_BIND_PORT
Optional. The port on which the Trap Receiver process is listening. Possible value is a number in the range of 1-65535.
Default: 162
Configuration: 
TRAPRX_BIND_PORT: port
Inbound UDP traffic must be allowed for this port on the Trap Receiver.