← Back to Articles
site_vars file definitions
Last Updated: June 30, 2026
This file contains the required and optional variables for the ServAssure Collection Platform installation.
NOTE: See ServAssure Collection Platform site_vars to see a sample of this file. Confer with your CommScope representative to verify the correct values for this file.
Refer to the descriptions of each variable to determine appropriate settings based on details of your 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.
INSTALL_JAVA
Optional. Defines whether or not to install Java from a staged JDK tarball using Ansible.
Default: "NO"
Configuration:
INSTALL_JAVA: "NO"
Set to "YES" if you do not have Java installed; OpenJDK will then be installed from a staged tarball. This value must be "YES" if the variable JAVA_BINARY_FILENAME is used.
FORCE_INSTALL_JAVA
Optional. Defines whether to force the JDK installation from the staged JDK tarball using Ansible even if an acceptable Java version is found on the host.
Default: "NO"
Configuration:
FORCE_INSTALL_JAVA: "NO"
Setting this variable can help reset Java defaults to the intended version or allow installation of a newer version of Java on the hosts over the acceptable minimum Java requirement.
NOTE: This variable is only used if INSTALL_JAVA is set to "YES".
ARRIS_SWLIB
Required if enabled. Defines the path to the staged software directory. Required if INSTALL_JAVA is set to "YES".
Configuration:
ARRIS_SWLIB: filepath-to-staging-directory
JAVA_BINARY_FILENAME
Required if enabled. Defines the filename for the Java binaries to be staged. Required if INSTALL_JAVA is set to "YES".
Configuration:
JAVA_BINARY_FILENAME: filename-of-Java-binaries
The file name format is expected to resemble "openjdk-17.0.2_linux-x64_bin.tar.gz".
If OpenJDK17 needs to be installed, it can be done manually or via Ansible by staging the JDK17 tarball in the ARRIS_SWLIB path configured above. The system-setup-all.yml playbook looks for JDK17 on the hosts and if not found, locates this local tarball and configures it on the ServAssure Collection Platform hosts.
TENANT_NAME
Required. Defines the tenant name used for the environment.
Configuration: 
TENANT_NAME: name-of-nxt-engine-tenant
TENANT_NAME should match the NXT tenant name for NXT tenant into which data is being ingested if different site vars are being used.
ENRICHMENT_ENABLED
Optional. Defines the flag used to control the data push from ServAssure Collection Platform to the message bus for consumption by NXT or third-party applications.
Default: false
Configuration:
ENRICHMENT_ENABLED: false
Options are true and false.
USE_MGR_IP_FOR_INGEST_URL
Required if enabled. Defines a flag to force ServAssure Collection Manager to send its IP instead of DNS name for response path to ServAssure Poller if ServAssure Poller cannot resolve ServAssure Collection Manager by DNS name.
Configuration:
USE_MGR_IP_FOR_INGEST_URL: true
If this variable is not defined, the ServAssure Collection Platform installation automatically determines the setting based on whether ServAssure Poller can resolve the ServAssure Collection Manager hostname.
Options are true and false.

ARRIS E6000

Variables specific to ARRIS E6000. The following variables are used for retrieving DOCSIS 3.1 PNM data over FTP, and only need to be defined if using ARRIS E6000 and the user/pass or FTP mode/port are different than defaults.

ARRIS_CMTS_RX_MER_USERNAME
Optional. Defines the FTP username used for retrieving DOCSIS 3.1 PNM data.
Default: 'e6k'
Configuration:
ARRIS_CMTS_RX_MER_USERNAME: 'e6k'
This variable is specific to E6000 CER CMTS. Omit if not using E6000.
ARRIS_CMTS_RX_MER_PASSWORD
Optional. Defines the FTP password used for retrieving DOCSIS 3.1 PNM data.
Default: 'arris'
Configuration:
ARRIS_CMTS_RX_MER_PASSWORD: 'arris'
This variable is specific to E6000 CER CMTS. Omit if not using E6000.
ARRIS_CMTS_RX_MER_FTP_MODE
Optional. Defines the FTP mode; used for setting the FTP mode for retrieving DOCSIS 3.1 PNM data.
Default: 'hybrid'
Configuration:
ARRIS_CMTS_RX_MER_FTP_MODE: 'hybrid'
Options are:
  • secure (SFTP only)
  • hybrid (default value; attempt SFTP and fall back to FTP if necessary)
  • ftp (for FTP only)
ARRIS_CMTS_RX_MER_SSH_PORT
Optional. Defines the port number for SSH communications. Specify a string or integer value for SSH port access to the CMTS for SFTP.
Default: 22
Configuration:
ARRIS_CMTS_RX_MER_SSH_PORT: 22
ARRIS_RMD_RX_MER_USERNAME
Optional. Defines, in string format, the SCP username for Arris RMD PNM data.
Default: 'e6'
Configuration:
ARRIS_RMD_RX_MER_USERNAME: 'e6'
ARRIS_RMD_RX_MER_PASSWORD
Optional. Defines, in string format, the SCP password for Arris RMD PNM data.
Default: '99'
Configuration:
ARRIS_RMD_RX_MER_PASSWORD: '99'
ARRIS_RMD_RX_MER_SCP_PORT
Optional. Defines, as a string or integer, the port for SSH access to the RMD for SCP.
Default: '22'
Configuration:
ARRIS_RMD_RX_MER_SCP_PORT: '22'

Rabbit MQ

The following variables are for configuring Rabbit MQ.

RABBITMQ_MGMT_SSL_ENABLED
Optional. Enables SSL for the RabbitMQ management interface.
Default: false
Configuration:
RABBITMQ_MGMT_SSL_ENABLED: false
Options are true and false. If this value is true and certificate information is not supplied by also defining RABBITMQ_MGMT_CACERT_FILE,RABBITMQ_MGMT_CERT_FILE, and RABBITMQ_MGMT_KEY_FILE, a self-signed certificate is generated and used.

If the values for the files are different per host, the variables can be set on each Rabbit host in the inventory.

RABBITMQ_MGMT_CACERT_FILE
Required if enabled. Defines the certificate Authority (CA) certificate file path. Required if RABBITMQ_MGMT_SSL_ENABLED is set to true.
Configuration:
RABBITMQ_MGMT_CACERT_FILE: Certificate-Authority-certificate-filepath
RABBITMQ_MGMT_CERT_FILE
Required if enabled. Defines the server certificate file path. Required if RABBITMQ_MGMT_SSL_ENABLED is set to true.
Configuration:
RABBITMQ_MGMT_CERT_FILE: server-certificate-filepath
RABBITMQ_MGMT_KEY_FILE
Required if enabled. Defines the server private key file path. Required if RABBITMQ_MGMT_SSL_ENABLED is set to true.
Configuration:
RABBITMQ_MGMT_KEY_FILE: server-private-key-filepath
RABBITMQ_DB_DIR
Optional. Defines the directory path where RabbitMQ is installed.
Default: /var/lib/rabbitmq
Configuration:
RABBITMQ_DB_DIR: /var/lib/rabbitmq
RABBITMQ_DATA_DIR
Optional. Defines the directory path where RabbitMQ can store transient and persistent rabbit data other than the location specified by RABBITMQ_DB_DIR. RabbitMQ requires read/write permissions to this location.
Important: If you will use a directory other than the default listed below (/opt/arris/rabbit), before any upgrade of ServAssure Collection Platform you must first copy the contents of /opt/arris/rabbit to the new directory.
Default: /opt/arris/rabbit
Configuration:
RABBITMQ_DATA_DIR: /opt/arris/rabbit
RABBIT_CAP_ADDRESS_LIST
Required if enabled. Defines a comma-delimited list of RabbitMQ hosts, used in cases where ServAssure Poller is on premises and communicating to a RabbitMQ instance in the cloud.
Configuration:
RABBIT_CAP_ADDRESS_LIST: rabbit_host1,rabbit_host2
Do not set this variable for on-premises RabbitMQ installation.
RABBITMQ_ADMIN_USER
Optional. Defines the default user to access RabbitMQ.
Default: Contact CommScope Professional Services to obtain this value.
Configuration:
RABBITMQ_ADMIN_USER: default_username
RABBITMQ_ADMIN_PASSWORD
Optional. Defines the password for the default user to access RabbitMQ.
Default: Contact CommScope Professional Services to obtain this value.
Configuration:
RABBITMQ_ADMIN_PASSWORD: default_password

Backup

BACKUP_PROPERTY_FILES
Optional. Directs a backup of property files to be created during an install or upgrade when the files have changed.
Default: yes.
Configuration:
BACKUP_PROPERTY_FILES: yes

Heap Variables

The following variables tune heap sizes.

DOCSIS_MGR_MIN_HEAP
Optional. Defines the minimum size of the heap.
Default: 16G
Configuration:
DOCSIS_MGR_MIN_HEAP:16G
This variable can be used to override defaults for minimum JVM heap size. It should match the value set for DOCSIS_MGR_MAX_HEAP.
DOCSIS_MGR_MAX_HEAP
Optional. Defines the maximum heap size value.
Default: 16G
Configuration:
DOCSIS_MGR_MAX_HEAP:16G
This variable can be used to override defaults for minimum JVM heap size. It should match the value set for DOCSIS_MGR_MIN_HEAP.
DOCSIS_PLR_MIN_HEAP
Optional. Defines the minimum Java heap for the DOCSIS Poller JVM process.
Default: 8G
Configuration:
DOCSIS_PLR_MIN_HEAP: 8G
This variable can be used for overriding default minimum java heap for DOCSIS Poller JVM process.
DOCSIS_PLR_MAX_HEAP
Optional. Defines the maximum Java heap for the DOCSIS Poller JVM process.
Default: 8G
Configuration:
DOCSIS_PLR_MAX_HEAP: 8G
This variable can be used for overriding default maximum java heap for DOCSIS Poller JVM process.

Metrics host

METRICS_HOST
Required if enabled. Defines the IP address of Metrics Platform host for target environment.
Configuration:
METRICS_HOST:metrics-host-ip-address

CMTS CLI authentication and communications

DOCSIS_MGR_CLI_USERNAME
Optional. Defines the default username to access CMTS CLI in string format.
Default: 'e6k'
Configuration:
DOCSIS_MGR_CLI_USERNAME: 'e6k'
DOCSIS_MGR_CLI_PASSWORD
Optional. Defines the default password to access CMTS CLI in string format.
Default: 'arris'
Configuration:
DOCSIS_MGR_CLI_PASSWORD: 'arris'
DOCSIS_MGR_CLI_TYPE
Optional. Defines the CMTS CLI communication protocol type in string format.
Default: 'Telnet'
Configuration:
DOCSIS_MGR_CLI_TYPE: 'Telnet'
Accepted values are 'Telnet' or 'SSH'.

SNMPv3 CTM API access and authentication

NOTE: SNMPv3 support is a licensed feature that requires deployment and configuration of an external token manager as well as significant additional hardware and system resources. Please contact CommScope Technical Support for additional information.
DOCSIS_MGR_CTM_URL
Required if enabled. Defines the CTM API URL including HTTP protocol and port in string format: 'https://hostname:port'. This value is required to enable SNMPv3 collection.
Configuration:
DOCSIS_MGR_CTM_URL: 'https://hostname:8080'
DOCSIS_MGR_CTM_USER
Required if enabled. Defines the CTM API authentication username in string format. Required if DOCSIS_MGR_CTM_URL is defined.
Configuration:
DOCSIS_MGR_CTM_USER: 'username'
DOCSIS_MGR_CTM_PASS
Required if enabled. Defines the CTM API authentication password in string format. Required if DOCSIS_MGR_CTM_URL is defined.
Configuration:
DOCSIS_MGR_CTM_PASS: 'password'
This password is encrypted prior to configuring it in application properties.

ServAssure Poller-required performance variables

The following site vars are required to properly tune ServAssure Poller performance.

DOCSIS_PLR_DEVICE_COLLECTION_THREADS
Required. Defines the number of device collection threads to configure for the ServAssure Poller as an integer.
Configuration:
DOCSIS_PLR_DEVICE_COLLECTION_THREADS: 100
If upgrading from an earlier release, use the value for the ServAssure Poller property devicecollectionjob.corePoolSize. On a new install, 100 is recommended.
DOCSIS_PLR_BG_PRIORITY_THREADS
Required. Defines the number of background priority threads to configure for the ServAssure Poller as an integer.
Configuration:
DOCSIS_PLR_BG_PRIORITY_THREADS: 20
If upgrading from an earlier release, use the value for the ServAssure Poller property backgroundprioritypool.corePoolSize. On a new install, 20 is recommended.
DOCSIS_PLR_LOW_PRIORITY_THREADS
Required. Defines the number of low priority threads to configure for the ServAssure Poller as an integer.
Configuration:
DOCSIS_PLR_LOW_PRIORITY_THREADS: 5
If upgrading from an earlier release, use the value for the ServAssure Poller property lowprioritypool.corePoolSize. On a new install, 5 is recommended.
DOCSIS_PLR_HIGH_PRIORITY_THREADS
Required. Defines the number of high priority threads to configure for the ServAssure Poller as an integer.
Configuration:
DOCSIS_PLR_HIGH_PRIORITY_THREADS: 150
If upgrading from an earlier release, use the value for the ServAssure Poller property highprioritypool.corePoolSize. On a new install, 150 is recommended.
DOCSIS_PLR_ONDEMAND_THREADS
Required. Defines the number of on-demand threads to configure for the ServAssure Poller.
Configuration:
DOCSIS_PLR_ONDEMAND_THREADS: 100
If upgrading from an earlier release, use the value for the ServAssure Poller property ondemandpool.corePoolSize. On a new install, 100 is recommended.
DOCSIS_PLR_PNM_JOB_THREADS
Required. Defines number of threads in a ServAssure TFTP Receiver queue for a ServAssure Poller designated as a dedicated ServAssure TFTP Receiver in the host_inventory[docsis_poller] group.
Default: 50
Configuration:
DOCSIS_PLR_PNM_JOB_THREADS: 50
This value is required even if a dedicated ServAssure TFTP Receiver is not designated.
DOCSIS_PLR_SCRIPT_THREADS
Required. Defines the number of script threads for the ServAssure Poller.
Configuration:
DOCSIS_PLR_SCRIPT_THREADS: 50
If upgrading from an earlier release, use the value for the ServAssure Poller property scriptpool.corePoolSize. On a new install, 50 is recommended.
DOCSIS_PLR_RATE_LIMIT_SNMP_PER_SECOND
Required. Defines the ServAssure Poller rate limiter's SNMP requests generated per second as an integer.
Configuration:
DOCSIS_PLR_RATE_LIMIT_SNMP_PER_SECOND: 6000
If upgrading from an earlier release, use the value for the ServAssure Poller property snmp.outbound.rateLimitPerSecond. On a new install, 6000 is recommended.
DOCSIS_PLR_RATE_LIMIT_SNMP_PER_MILLI
Required. Defines the ServAssure Poller rate limiter's SNMP requests generated per millisecond as an integer.
Configuration:
DOCSIS_PLR_RATE_LIMIT_SNMP_PER_MILLI: 6
If upgrading from an earlier release, use the value for the ServAssure Poller property snmp.outbound.rateLimitPerMilli. On a new install, 6 is recommended.
DOCSIS_PLR_RATE_LIMIT_SNMP_IN_FLIGHT
Required. Defines the ServAssure Poller rate limiter's SNMP max requests in flight at any time as an integer.
Configuration:
DOCSIS_PLR_RATE_LIMIT_SNMP_IN_FLIGHT: 6000
If upgrading from an earlier release version, use the value for the ServAssure Poller property snmp.outbound.requestsInFlightLimit. On a new install, 6000 is recommended.