addr-trap (nrcmd)				           addr-trap (nrcmd)


NAME
    addr-trap - Configures free-address monitoring by the DHCP server

SYNOPSIS
    addr-trap <name> create
    addr-trap <name> delete
    addr-trap enable <attribute>
    addr-trap <name> disable <attribute>
    addr-trap <name> set <attribute>=<value> [<attribute>=<value> ...]
    addr-trap <name> unset <attribute>
    addr-trap <name> get <attribute>
    addr-trap list | listnames
    addr-trap <name> [show]

DESCRIPTION
    The addr-trap command configures values that the DHCP server uses 
    to monitor free-address levels. Use this command with the SNMP 
    server to provide  SNMP notification trap messages as free-address 
    levels change within the DHCP server.


EXAMPLES

STATUS

SEE ALSO
    scope, trap-recipient

PROPERTIES
  Attributes:

    enable[3] (AT_BOOL, Optional, default: on)
        Indicates whether this configuration is active, causing scopes to
        track their free-address levels and possibly send trap events.

    high-threshold[5] (AT_PERCENT, Optional, default: 25%)
        Sets the level at which the 'low' threshold will be re-enabled,
        and the high-threshold trap will be generated.
        See the low-threshold for details on how the free-address level
        is calculated.

    low-threshold[4] (AT_PERCENT, Optional, default: 20%)
        Sets the free-address level at which a low-threshold trap will be
        generated, and the 'high' threshold will be re-enabled.
        For scopes, the free-address level is calculated as follows:
                available non-reserved leases
          100 * -----------------------------
                   total configured leases
        where the counts are the sum across all of the scopes included
        in the aggregation.
        For prefixes, the free-address level is calculated as follows:
                  max-leases - dynamic leases
          100 *   ---------------------------
                          max-leases
        where the counts are the sum across all of the prefixes included
        in the aggregation.

    mode[2] (AT_ENUMINT(), Optional, default: scope)
        Indicates how scopes should aggregate their free address levels.
        The 'scope' mode causes each scope to track its own free-address
        level independently. This is an IPv4 only mode.
        The 'network' mode causes all of the scopes configured by this
        object to aggregate their free-address levels if they share a
        'primary-subnet'. This is an IPv4 only mode.
        The 'selection-tags' grouping causes scopes to aggregate their
        free-address information together if they share a primary-subnet
        and if their lists of selection tags match exactly. This is an IPv4 
        only mode.
        The 'prefix' mode causes each prefix to track its own free-address 
        level independently.  This is an IPv6 only mode.
        The 'link' mode causes all of the prefixes configured by this
        object to aggregate their free-address levels if they share a
        link.  This is an IPv6 only mode.
        The 'v6-selection-tags' grouping causes prefixes to aggregate
        their free-address information if they share a link, and if their
        lists of selection tags match exactly.  This is an IPv6 only mode.
        The 'countonly' and 'v6-countonly' groupings are used
        for the built-in aggregation objects that are used to provide
        top-utilized information when no traps are configured.
        No traps will be fired for these modes.

    name[1] (AT_STRING, Required, default: <none>)
        Gives a unique name to the configuration object.

