Device configuration properties

The following table lists device configuration properties. For information about accessing device configuration properties, see Viewing and overriding device properties.

Device configuration properties
Property name Property type Description
zAggregatorCollectionInterval int Aggregator collection interval in seconds. Default is 300.
zCiscoACEUseSSL boolean Whether to use SSL when connecting to ACE XML API.
zCiscoNXAPIInterval int Value in seconds of the rediscovery interval using the Cisco NX-API protocol. Default value is 300.
zCiscoNXAPIPort int Port for connecting to NX-API.
zCiscoNXAPIUseSSL boolean Whether to use SSL when connecting to NX-API.
zCiscoRemodelEventClassKeys lines Allows you to modify the list of SNMP traps that will cause the product schedule an immediate remodeling of the device from which the trap was sent.
zCiscoUCSCIMCEventsInterval int Event collection interval in seconds. Default is 60.
zCiscoUCSCIMCPerfInterval int Metric collection interval in seconds. Default is 300.
zCiscoUCSCIMCSSLProtocol string The SSL/TLS protocol used to connect to a CIMC device.
zCiscoUCSManagerPassword password Password for UCS Manager user name.
zCiscoUCSManagerPerfInterval int Seconds between UCS Manager statistics collections. Default value is 300.
zCiscoUCSManagerPort int Port used to connect to the UCS Manager or CIMC XML APIs. Default is 443 and typically should not be changed.
zCiscoUCSManagerUseSSL boolean Whether to use SSL when connecting to the UCS Manager or CIMC XML APIs. Default is true and typically should not be changed.
zCiscoUCSManagerUser string UCS Manager user name.
zCollectorClientTimeout int Allows you to set the timeout time of the collector client in seconds
zCollectorDecoding string Converts incoming characters to Unicode.
zCollectorLogChanges boolean Indicates whether to log changes.
zCommandCollectionInterval int The default collection interval (number of seconds) for command datasources.
zCommandExistanceTest string DEPRECATED - No longer used.
zCommandLoginTimeout float Specifies the time to wait for a login prompt.
zCommandLoginTries int Sets the number of times to attempt login.
zCommandPath string Sets the default path where ZenCommand plug-ins are installed on the local Zenoss Core box (or on a remote box where SSH is used to run the command).
zCommandPort int Specifies the port to connect to when performing command collection.
zCommandProtocol string Establishes the protocol to use when performing command collection. Possible values are SSH and telnet.
zCommandSearchPath lines Sets the path to search for any commands.
zCommandUserCommandTimeout float Specifies the number of seconds to wait for a user command to complete.
zDBInstances *** ***instancecredentials. This setting is only relevant when the zenoss.winrm.WinMSSQL modeler plugin is enabled. Multiple instances can be specified to monitor multiple SQL Server instances per server. The default instance is MSSQLSERVER. Fill in the user and password to use SQL authentication. Leave the user and password blank to use Windows authentication.
zDatasourceDebugLogging boolean True or False to debug calculated/aggregated data sources on a single device.
zDockerMonitorContainerSize boolean True or false to monitor the real size and virtual size of each container once every ten minutes. The default is false (not enabled) because the command takes a long time to run when many containers, or large containers are used.
zDockerMonitorContainerStats boolean True or false to collect the statistics of each container once every five minutes. The default is true (enabled).
zDockerMonitorContainerStatus boolean True or false to check the status of the Docker daemon once per minute. The default is true (enabled).
zEnablePassword boolean True or False to specify use of password for Cisco routers.
zFileSystemMapIgnoreNames string Sets a regular expression of file system names to ignore.
zFileSystemMapIgnoreTypes lines Do not use.
zFileSystemSizeOffset int SNMP typically reports the total space available to privileged users. Zenoss Core (like the df command) reports capacity based on the space available to non-privileged users. The value of zFileSystemSizeOffset should be the fraction of the total space that is available to non-privileged users. The default reserved value is 5% of total space, so zFileSystemSizeOffset is preset to .95. If the reserved portion is different than 5%, then adjust the value of zFileSystemSizeOffset accordingly. The fraction should be set according to the value (Used + Avail) / Size when the df -PkH command is run at the command line.
zHardDiskMapMatch string Regular expression that uses the disk ID in the diskstats output to filter disk activity statistics for inclusion in performance monitoring.
zILOCollectSamples boolean True or false to collect and save raw data for debug purposes.
zILOPassword password The ILO authentication password. Data from ILO devices is provided by a HTTPS interface listening on port 443. The following properties control access to ILO devices: zILOUserName, zILOPassword, zILOUseSSL, and zILOPort.
zILOPort string The TCP port for ILO communication. Data from ILO devices is provided by a HTTPS interface listening on port 443. The following properties control access to ILO devices: zILOUserName, zILOPassword, zILOUseSSL, and zILOPort.
zILOUseSSL boolean True or false to use HTTPS for ILO communication. Data from ILO devices is provided by a HTTPS interface listening on port 443. The following properties control access to ILO devices: zILOUserName, zILOPassword, zILOUseSSL, and zILOPort.
zIdiomPassword password IDIOM API password for Cisco IDS/IPS devices.
zIdiomUsername string IDIOM API username for Cisco IDS/IPS devices.
zIfDescription boolean Shows the interface description field in the interface list.
zIgnoreUnmounted boolean True or false to specify whether to ignore unmounted drives.
zInterfaceMapIgnoreDescriptions string Filters out interfaces based on description.
zInterfaceMapIgnoreNames string Filters out interfaces that should not be discovered. If you want to use an expression to define this property, note that only Python regular expressions are valid.
zInterfaceMapIgnoreTypes string Filters out interface maps that should not be discovered.
zIpServiceMapMaxPort int Specifies the highest port to scan. The default is 1024.
zJBossJmxManagementAuthenticate boolean DEPRECATED - No longer used.
zJBossJmxManagementPassword password DEPRECATED - No longer used.
zJBossJmxManagementPort int DEPRECATED - No longer used.
zJBossJmxManagementUsername string DEPRECATED - No longer used.
zJmxAuthenticate boolean True or False to enable/disable authentication.
zJmxManagementPort int Port that enables JMX management
zJmxPassword password JMX username password
zJmxUsername string JMX username
zLDAPBaseDN string DEPRECATED - No longer used.

The Base Distinguished Name for your LDAP server. Typically this is the organization's domain name (for example, dc=foobar,dc=com).

zLDAPBindDN string DEPRECATED - No longer used.

The Distinguished Name to use for binding to the LDAP server, if authentication is required.

zLDAPBindPassword string DEPRECATED - No longer used.

The password to use for binding to the LDAP server, if authentication is required.

zLTMVirtualServerIgnoreNames string Regular expression that can be used to prevent matching LTM Virtual Servers from being modeled.
zLinks string Specifies a place to enter any links associated with the device.
zLocalInterfaceNames string Regular expression that uses interface name to determine whether the IP addresses on an interface should be incorporated into the network map. For instance, a loopback interface "lo" might be excluded.
zLocalIpAddresses string Specifies IP addresses that should be excluded from the network map (for example, 127.x addresses). If you have addresses that you reuse for connections between clustered machines, you might add those addresses.
zMaxOIDPerRequest int Sets the maximum number of OIDs to be sent by the SNMP collection daemons when querying information. Some devices have small buffers for handling this information, so a lower value might be appropriate.
zMySQLConnectionString string Enables setting the path, type and credentials for the MySQL connections. For example: Path: /server/Linux/devices/localhost.localdomain, Type: miltilnecredentials, MYSQL connection credentials: User Password Port
zMySqlPassword password MySQL user password
zMySqlPort string MySQL connection port
zMySqlTimeout int MySQL timeout. Default value is 30s.
zMySqlUsername string MySQL user name.
zNetAppNumRecordsPerRequest int Number of records per NetApp Monitor request. Default is 100.
zNetAppSSL boolean Boolean true or false to enable SSL use with the NetApp Monitor.
zNmapPortscanOptions string Options used on nmap when scanning ports. Used in IpServiceMap.
zPingMonitorIgnore boolean Specify whether to ping the device.
zProdStateThreshold int Production state threshold at which Zenoss Core will begin to monitor a device.
zPropertyMonitorInterval int Polling interval of the configured property data sources. System-wide setting. Default is 300s.
zPythonClass string DO NOT USE
zRancidGroup string DEPRECATED - No longer used.

RANCID group attribute. Controls what router.db file the device is written to. Can be set at the device class or device level. Default is router on the /Network/Router/Cisco class.

zRancidRoot string DEPRECATED - No longer used.

File system directory where RANCID is installed. It may be NFS mounted from the RANCID server. Default is /opt/rancid.

zRancidType string DEPRECATED - No longer used.

RANCID type attribute. Controls what device type is written to the router.db file. Can be set at the device class or device level. Default is cisco on the /Network/Router/Cisco class.

zRancidUrl string DEPRECATED - No longer used.

Base URL.

zRouteMapCollectOnlyIndirect boolean Only collect routes that are indirectly connected to the device.
zRouteMapCollectOnlyLocal boolean Only collect local routes. (These usually are manually configured rather than learned through a routing protocol.)
zRouteMapMaxRoutes int Sets maximum number of routes to collect. Default value is 500.
zSnmpAuthPassword password The shared private key used for authentication. Must be at least 8 characters long.
zSnmpAuthType string Use "MD5" or "SHA" signatures to authenticate SNMP requests
zSnmpCollectionInterval int Defines, in seconds, how often the system collects performance information for each device.
zSnmpContext string Configures zSNMP context to map logical network entity such as a topology or protocol instance.
zSnmpDiscoveryPorts int List of UDP ports to try when performing SNMP discovery. Defaults to 161 if not set.
zSnmpEngineId string SNMPv3 engine ID for the device. Will be discovered when SNMPv3 is used.
zSnmpPrivPassword password The shared private key used for encrypting SNMP requests. Must be at least 8 characters long.
zSnmpPrivType string "DES" or "AES" cryptographic algorithms.
zSnmpSecurityName string The Security Name (user) to use when making SNMPv3 requests.
zSnmpTimeout float Timeout time in seconds for an SNMP request
zSnmpTries int Amount of tries to collect SNMP data
zStatusConnectTimeout float The amount of time that the zenstatus daemon should wait before marking an IP service down.
zSugarCRMBase - DEPRECATED - No longer used.
zSugarCRMPassword password DEPRECATED - No longer used.

Password for the zSugarCRMUsername user.

zSugarCRMTestAccount - DEPRECATED - No longer used.
zSugarCRMUsername string DEPRECATED - No longer used.

User name that is allowed to log in to the Sugar CRM server.

zSysedgeDiskMapIgnoreNames string Regular expression used by zenoss.snmp.SysedgeDiskMap modeler plugin. Disks with matching names will not be modeled.
zTelnetEnable boolean When logging into a Cisco device issue the enable command to enable access during command collection.
zTelnetEnableRegex string Regular expression to match the enable prompt.
zTelnetLoginRegex string Regular expression to match the login prompt.
zTelnetPasswordRegex string Regular expression to match the password prompt.
zTelnetPromptTimeout float Time to wait for the telnet prompt to return.
zTelnetSuccessRegexList lines List of regular expressions to match the command prompt.
zTelnetTermLength boolean On a Cisco device, set term length to Zero.
zTomcatJ2EEApplicationName string DEPRECATED - No longer used.

Used to construct MBean names for a specific application deployed on Tomcat, typically used for JSP and Servlet statistics.

zTomcatJ2EEServerName string DEPRECATED - No longer used.

Used to construct MBean names for a specific application deployed on Tomcat, typically used for JSP and Servlet statistics.

zTomcatJmxManagementAuthenticate - DEPRECATED - No longer used.
zTomcatJmxManagementPassword password

DEPRECATED - No longer used.

JMX password.
zTomcatJmxManagementPort int

DEPRECATED - No longer used.

The port number used to gather JMX information.
zTomcatJmxManagementUsername string

DEPRECATED - No longer used.

JMX username for authentication.
zTomcatListenHost string

DEPRECATED - No longer used.

The hostname on which Tomcat is listening for web requests. This is used to construct MBean names
zTomcatListenPort string

DEPRECATED - No longer used.

The Tomcat connector, which is a port and protocol (http, jk...) that Tomcat is listening on. This is used to construct MBean names that monitor bytes, error and requests on that connector.
zTomcatServletName string

DEPRECATED - No longer used.

Specific Servlet name to monitor.
zTomcatServletUri string

DEPRECATED - No longer used.

URI of Servlet to monitor.
zTomcatWebAppUri string

DEPRECATED - No longer used.

URI path for a Tomcat web application. Used to construct MBean names.
zUsesManageIp boolean True or False to specify use of manage IP. Used to avoid setting manage IP when a device is added.

Default is True for most device classes.

zUsesStandardDeviceCreationJob boolean True or False to specify whether to use the standard device creation job.
zVCloudPassword password DEPRECATED - No longer used.

Password for the zVCloudUsername user.

zVCloudPort int DEPRECATED - No longer used.

Value of the cell port number.

zVCloudUsername string DEPRECATED - No longer used.

User name for the cell in the form username@organization. For example, if you want to define the cell administrator, enter administrator@system.

zVSphereEndpointHost string vSphere host name
zVSphereEndpointPassword password vSphere username password
zVSphereEndpointPort int Port that is used to connect to vSphere Endpoint.
zVSphereEndpointUseSsl boolean vSphere boolean true or false for SSL use
zVSphereHostPingBlacklist lines List of regular expressions to control which management IP address to ping (matches against hostname:nicname:ip).
zVSphereHostSystemPassword password Password that is used to access ESX hosts via ssh and API.
zVSphereLUNContextMetric boolean Controls whether to use LUN-specific metric names when storing performance data.

Note: The default value is False. Changing the value to True causes historical metrics to become inaccessible. For more information, contact Zenoss Support.

zVSphereModelCache lines vSphere model cache
zVSphereModelIgnore lines vSphere model ignore
zVSphereModelMpIndexObjs int Advanced tuning parameter. For more information, contact Zenoss Support.
zVSphereModelMpLevel int Advanced tuning parameter. For more information, contact Zenoss Support.
zVSpherePerfDelayCollectionMinutes int Value of how long to lag performance data collection. Default value is 0.
zVSpherePerfMaxAgeMinutes int Default value is 28 minutes.
zVSpherePerfParallelQueries int Default value is 6.
zVSpherePerfQueryChunkSize int Value of how many performance requests to make at a time. Default value is 250.
zVSpherePerfQueryRaw20 boolean Default value is true.
zVSpherePerfQueryTimeout int Default value is 200.
zVSpherePerfQueryVcChunkSize int Default value is 64.
zVSpherePerfQueryVcRaw20 boolean Default value is false.
zVSpherePerfRecoveryMinutes int Default value is 240 minutes.
zVSphereVMContextMetric boolean Controls whether to use VM-specific metric names when storing performance data.

Note: The default value is False. Changing the value to True causes historical metrics to become inaccessible. For more information, contact Zenoss Support.

zVSpherePerfWindowSize int DEPRECATED - No longer used.
zWBEMPassword password WBEM password
zWBEMPort int Value of the WBEM port number. Default value is 5989.
zWBEMUseSSL boolean True or false value to use SSL. Default value is true.
zWBEMUsername string WBEM username
zWebLogicJmxManagementAuthenticate - DEPRECATED - No longer used.
zWebLogicJmxManagementPassword password

DEPRECATED - No longer used.

JMX password
zWebLogicJmxManagementPort int

DEPRECATED - No longer used.

The port number used to gather JMX information.
zWebLogicJmxManagementUsername string

DEPRECATED - No longer used.

JMX username for authentication
zWebTxAgent string Default value is ZenWebTx/1.0.
zWebTxPassword password WebTx password
zWebTxRealm string WebTx realm
zWebTxUser string WebTx user
zWebsphereAuthRealm string

DEPRECATED - No longer used.

Used for HTTP basic authentication. This field is not required, and is empty by default.
zWebsphereNode string

DEPRECATED - No longer used.

Used by the provided template to build the queries for the data to collect. You must supply a value for this field. For example: serverA
zWebspherePassword password

DEPRECATED - No longer used.

Used for HTTP basic authentication. This field is not required, and is empty by default.
zWebsphereServer string Used by the provided template to build the xpath queries for the data to collect. You must supply a value for this field. For example: serverAB, There is no default value.
zWebsphereURLPath string Path to the PMI servlet on a WebSphere instance. The default value is the default path on a WebSphere installation: wasPerTool/servlet/perfservlet
zWebsphereUser string

DEPRECATED - No longer used.

Used for HTTP basic authentication. This field is not required, and is empty by default.
zWinKDC string IP address or Fully Qualified Domain Name of a valid Windows domain controller. Must be set if domain authentication is used.
zWinKeyTabFilePath string This property is currently used and reserved for future use when keytab files are supported.
zWinPerfmonInterval int Interval, in seconds, at which Windows Perfmon datapoints will be collected. Default value is 300. It is possible to override the collection interval for individual counters.
zWinRMClusterNodeClass string Path under which to create cluster nodes.
zWinRMEnvelopeSize int Used when WinRM configuration setting "MaxEnvelopeSizekb" exceeds default of 512k.
zWinRMKrb5DisableRDNS boolean Set to true to disable reverse DNS lookups by Kerberos. Only set at /Server/Microsoft level.
zWinRMKrb5includedir string Directory path for Kerberos configuration files.
zWinRMLocale string Communication locale to use for monitoring. Reserved for future use.
zWinRMPassword password Password for the user defined by zWinRMUser
zWinRMPort int The port on which the Windows server is listening for WinRM or WS-Management connections. Default value is 5985. It is uncommon for this to be configured as anything else.
zWinRMServerName string

This property should only be used in conjunction with domain authentication when the DNS PTR record for a monitored server's managed IP address does not resolve to the name by which the server is known in Active Directory. For example, if myserver1 is known as myserver1.ad.example.com by Active Directory and is being managed by IP address 192.51.100.21, but 192.51.100.21 resolves to www.example.com, you will have to set zWinRMServerName to myserver1.ad.example.com for domain authentication to work.

If many Windows servers in your environment do not have DNS PTR records that match Active Directory, it is recommended that you set the name of the Zenoss device to be the fully-qualified Active Directory name and set zWinRMServerName to ${here/titleOrId} at the /Server/Microsoft/Windows device class. This avoids the necessity of setting zWinRMServerName on every device.

It is recommended to leave zWinRMServerName blank if local authentication is used, or DNS PTR records match Active Directory. This allows Zenoss to not rely on DNS resolution while monitoring, and avoids the overhead of configuring zWinRMServerName.

zWinRMUser string The syntax used for zWinRMUser controls whether Zenoss will attempt Windows local authentication or domain (kerberos) authentication. If the value of zWinRMUser is username, local Windows authentication will be used. If zWinRMUser is username@example.com, domain authentication will be used. The zWinKDC and potentially the zWinRMServerName properties become important.
zWinRSCodePage int Code page used by monitoring user account.
zWinScheme string Must be set to http or https. Default value is http.
zWinTrustedKDC string Windows Trusted KDC.
zWinTrustedRealm string Windows Trusted Realm.
zWinUseWsmanSPN boolean Set to true if HTTP/HTTPS service principles are exclusively for use by a particular service account.
zWSMANPassword password Password for WSMAN user name.
zWSMANPort int The port number used to gather WSMAN information. Defaults to 443.
zWSMANUseSSL boolen True or false value to use SSL. Default value is true.