The following is an example of a completed site_vars file.
# Installation Deployment Environment
# Install JAVA JDK
# ServAssure Poller requires a later Java JDK. If you have installed the JDK yourself, you can leave the default (no) as is.
# NOTE: You must encapsulate the YES/NO in quotes as seen below
# "YES" - Install Java JDK
# "NO" - Do NOT Install Java JDK (DEFAULT)
#
# NOTE: If you set this to "YES", then ARRIS_SWLIB must be defined, and the JDK software must be present in that path.
# JAVA_BINARY_FILENAME must also be defined and set to the filename of the staged tar.gz archive of the JDK.
#
# INSTALL_JAVA: "NO"
# FORCE_INSTALL_JAVA: "NO"
# This variable is "NO" by default but can be set to "YES" to force Ansible to install the intended Java version even if it finds
# the acceptable version is already there. This can help with JDK 15/17 dual compatibility by forcing the upgrade to the staged JDK17
# even if the acceptable JDK15 is found on the host.
ARRIS_SWLIB: <path to staged software directory>
JAVA_BINARY_FILENAME: <e.g "openjdk-15.0.2_linux-x64_bin.tar.gz" or "openjdk-17.0.1_linux-x64_bin.tar.gz">
#
TENANT_NAME: <name of nxt-engine tenant associated with this DOCSIS poller platform>
ENRICHMENT_ENABLED: <true|false> Defaults to false - Flag used to control data push from ServAssure Poller to message bus for consumption
# by NXT or third party applications
# USE_MGR_IP_FOR_INGEST_URL: <true|false> If poller can't resolve manager by dns name this flag can be used to force manager to send its
# ip down to poller instead of dns name for response path. If variable is not defined, installation will auto determine the setting based on if the pollers can resolve the managers hostname.
#
# Variables specific to ARRIS E6000
# Used for retrieving DOCSIS 3.1 PNM data over FTP and SCP
# Only specify if using ARRIS E6000 and user/pass or FTP mode/port are different than defaults
# ARRIS_CMTS_RX_MER_USERNAME: <'user' string format for FTP username for Arris E6000 PNM data - default is 'e6k'>
# ARRIS_CMTS_RX_MER_PASSWORD: <'pass' string format for FTP password for Arris E6000 PNM data - default is 'arris'>
# ARRIS_CMTS_RX_MER_FTP_MODE: <'secure|hybrid|ftp' string format for secure access protocol to E6000, see documentation for more info -
# default is 'hybrid'>
# ARRIS_CMTS_RX_MER_SSH_PORT: <'22' string or integer value for SSH port access to the CMTS for SFTP - default is 22>
# ARRIS_RMD_RX_MER_USERNAME: <'user' string format for SCP username for Arris RMD PNM data - default is 'e6'>
# ARRIS_RMD_RX_MER_PASSWORD: <'pass' string format for SCP password for Arris RMD PNM data - default is '99'>
# ARRIS_RMD_RX_MER_SCP_PORT: <'22' string or integer value for SSH port access to the RMD for SCP - default is 22>
#
# RABBITMQ_MGMT_SSL_ENABLED: <true, false> Enables ssl for rabbit management interface.
# If RABBITMQ_MGMT_SSL_ENABLED is true and the following cert vars are not set (all three), a self signed certificate is generated and
# used for enabling ssl. The values for RABBITMQ_MGMT_CACERT_FILE,RABBITMQ_MGMT_CERT_FILE,RABBITMQ_MGMT_KEY_FILE are full paths to
# the ssl certificate information on each rabbit host. If the values are different per host, the vars can be set on each rabbit host
# in inventory to its repective file locations.
# RABBITMQ_MGMT_CACERT_FILE: Certificate Authority (CA) certificate file path
# RABBITMQ_MGMT_CERT_FILE: Server certificate file path
# RABBITMQ_MGMT_KEY_FILE: Server private key file path
#
# Configure RabbitMQ database directory to be set during clean install for configuring non-default location
# RABBITMQ_DB_DIR: '/path/to/new/rabbitmq/db/dir'
#
BACKUP_PROPERTY_FILES: <yes:no> Defaults to yes if not set. Creates a backup of properties files on install/upgrade
# when they have changed.
#
# DOCSIS_MGR_MIN_HEAP: (optional, used for overriding default minimum java heap for ServAssure Collection Manager jvm process)
# DOCSIS_MGR_MAX_HEAP: (optional, used for overriding default minimum java heap for ServAssure Collection Manager jvm process)
# DOCSIS_PLR_MIN_HEAP: (optional, used for overriding default minimum java heap for ServAssure Collection Manager jvm process)
# DOCSIS_PLR_MAX_HEAP: (optional, used for overriding default minimum java heap for ServAssure Collection Manager jvm process)
#
# IP address of metrics host for target environment
METRICS_HOST: <ip of metrics host>
#
# Variables used to configure CMTS CLI authentication and communication protocol
# DOCSIS_MGR_CLI_USERNAME: <'user'> string format for default username for access to CMTS CLI
# DOCSIS_MGR_CLI_PASSWORD: <'pass'> string format for default password for access to CMTS CLI
# DOCSIS_MGR_CLI_TYPE: <'Telnet'/'SSH'> string format for either 'Telnet' or 'SSH' for CMTS CLI communication protocol
#
# Variables used to configure SNMPv3 CTM API access and authentication
# SNMPv3 will not be enabled unless DOCSIS_MGR_CTM_URL is defined along with authentication
# DOCSIS_MGR_CTM_URL: <'https://x.x.x.x:8080'> string format for CTM API URL including http protocol and port
# DOCSIS_MGR_CTM_USER: <'user'> string format for CTM API authentication username
# DOCSIS_MGR_CTM_PASS: <'pass'> string format for CTM API authentication password
#
# Variable used to designate number of threads in ServAssure TFTP Receiver queue
DOCSIS_PLR_PNM_JOB_THREADS: <'50' integer value for number of threads in dedicated ServAssure TFTP Receiver job queue>
DOCSIS_PLR_DEVICE_COLLECTION_THREADS: <required, integer value to configure number of device collection threads for the ServAssure Poller - recommended value: 100>
DOCSIS_PLR_BG_PRIORITY_THREADS: <required, integer value to configure number of background priority threads for the ServAssure Poller - recommended value: 20>
DOCSIS_PLR_LOW_PRIORITY_THREADS: <required, integer value to configure number of low priority threads for the ServAssure Poller - recommended value: 5>
DOCSIS_PLR_HIGH_PRIORITY_THREADS: <required, integer value to configure number of high priority threads for the ServAssure Poller - recommended value: 150>
DOCSIS_PLR_ONDEMAND_THREADS: <required, integer value to configure number of on-demand threads for the ServAssure Poller - recommended value: 100>
DOCSIS_PLR_SCRIPT_THREADS: <required, integer value to configure number of script threads for the ServAssure Poller - recommended value: 50>
DOCSIS_PLR_RATE_LIMIT_SNMP_PER_SECOND: <required, integer value to configure the ServAssure Poller rate limiter's SNMP requests generated per second - recommended value: 6000>
DOCSIS_PLR_RATE_LIMIT_SNMP_PER_MILLI: <required, integer value to configure the ServAssure Poller rate limiter's SNMP requests generated per millisecond - recommended value: 6>
DOCSIS_PLR_RATE_LIMIT_SNMP_IN_FLIGHT: <required, integer value to configure the ServAssure Poller rate limiter's SNMP max requests in flight at any time - recommended value: 6000>
# MULTI-INTERFACE SUPPORT
# For configuring alternative interfaces for intracluster communication, see the host_inventory example configuration.