Device Configuration Properties

To view and edit device configuration properties at the root level: 1. Select Infrastructure from the Navigation menu.

2. In the tree view, click Details. 3. Select Configuration Properties.

Properties and Templates

To view and edit device configuration properties set at a specific device class, navigate to that class, click Details, and then select Configuration Properties.

You also can view and edit device configuration at the individual device level. Select the device from the device list, and then select Configuration Properties from the left panel.

The following table lists device configuration properties.

Table 5.1. Device Configuration Properties

Property Name Property Type Description

zCollectorClientTimeout int Allows you to set the timeout time of the collector client in sec- onds

zCollectorDecoding string Converts incoming characters to Unicode. zCollectorLogChanges Boolean Indicates whether to log changes.

zCollectorPlugins lines Links to all modeler plugins for this device.

zCommandCommandTimeout float Specifies the time to wait for a command to complete. zCommandCycleTime int Specifies the cycle time you use when executing zCommands

for this device or organizer. This property is not used directly by Zenoss Core; it is used in TALES expressions that can be set on command data sources.

zCommandExistanceTest string ***

zCommandLoginTimeout float Specifies the time to wait for a login prompt. zCommandLoginTries int Sets the number of times to attempt login.

zCommandPassword string Specifies the password to use when performing command logins and SSH.

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 col- lection.

zCommandProtocol string Establishes the protocol to use when performing command collec- tion. Possible values are SSH and telnet.

zCommandSearchPath lines Sets the path to search for any commands.

zCommandUsername string Specifies the user name to use when performing command collec- tion and SSH.

zDeviceTemplates lines Sets the templates associated with this device. Linked by name. 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 val- ue 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

Properties and Templates

Property Name Property Type Description

according to the value ( Used + Avail ) / Size when the df -PkH

command is run at the command line.

zIcon lines Specifies the icon to represent the device wherever device icon is shown, such as on the network map and device status page.

zIdiomUsername string

zIdiomPassword string

zIfDescription Boolean Shows the interface description field in the interface list. zInterfaceMapIgnoreDescriptions string Filters out interfaces based on description.

zInterfaceMapIgnoreNames string Filters out interfaces that should not be discovered. zInterfaceMapIgnoreTypes string Filters out interface maps that should not be discovered. zIpServiceMapMaxPort int Specifies the highest port to scan. The default is 1024. zKeyPath lines Sets the path to the SSH key for device access.

zLinks text 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 ex- cluded.

zLocalIpAddresses int 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 they might be added here as well.

zMaxOIDPerRequest int Sets the maximum number of OIDs to be sent by the SNMP col- lection daemons when querying information. Some devices have small buffers for handling this information so the number should be lowered.

zPingMonitorIgnore Boolean Whether or not to ping the device.

zProdStateThreshold int Production state threshold at which Zenoss Core will begin to monitor a device.

zPythonClass string DO NOT USE

zRouteMapCollectOnlyIndirect Boolean Only collect routes that are directly connected to the device. zRouteMapCollectOnlyLocal Boolean Only collect local routes. (These usually are manually configured

rather than learned through a routing protocol.)

zSnmpAuthPassword string 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.

zSnmpCommunities lines Array of SNMP community strings that ZenModeler uses when collecting SNMP information. When you set this property, com- munities are tried in order; the first in the list that is successful is used as zSnmpCommunity. If none is successful, then the current value of zSnmpCommunity is used. The default value for the en- tire system is "public."

Properties and Templates

Property Name Property Type Description

zSnmpCommunity string Community string to be used when collecting SNMP information. If it is different than what is found by ZenModeler, it will be set on the modeled device.

zSnmpMonitorIgnore Boolean Whether or not to ignore monitoring SNMP on a device.

zSnmpPort int Port that the SNMP agent listens on.

zSnmpPrivPassword string 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

zSnmpVer string SNMP version used. Valid values are v1, v2c, v3

zStatusConnectTimeout float The amount of time that the zenstatus daemon should wait before marking an IP service down.

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.

zWinEventlog Boolean Whether or not to send the log.

zWinEventlogClause string Allows for specific queries (per device) on the Windows event log.

zWinEventlogMinSeverity int Sets minimum severity to collect from the win event log. The higher the number, the lower the severity. (1 is most severe; 5 is least severe.)

zWinPassword string The password used to remotely login if it is a Windows machine. zWinUser string User name used to remotely login if it is a Windows machine. zWmiMonitorIgnore Boolean Use to turn on or off all WMI monitoring.

zXmlRpcMonitorIgnore Boolean Use to turn on or off all XML/RPC monitoring.