#
# Copyright (C) 1995-2007 by Cisco Systems Inc.
# This program contains proprietary and confidential information.
# All rights reserved.
#
# The data dictionary for genobj blobs.
#
# Formatting rules and best practices (Mark Stapp 6/5/02)
#  1. Wrap descriptions at 66 characters -- this makes on-line help
#     fit in an 80 column screen for nrcmd.
#
#  2. You do not need to provide a CPP macro name (ATTRHDRNAME):
#     the 'gmake datadict' step will derive a name from an
#     attribute name and class name.
#
#  3. Pick good attribute names:
#     a) lower case
#     b) hyphens, not underscores or CamelCase for word separation
#     c) remember that users may have to type it and the gui may
#        have to display it --  longer is not always better.
#
#  4. You don't have to set ATTRVIZ -- only if the attribute
#     visibility is different than the class visibility, which
#     defaults to 5.
#
#  5. Flags that can be set on attributes:
#       AF_IMMUTABLE
#         - can't be changed once it is initialized
#       AF_REQUIRED
#         - must have a value -- can be modified, but not unset
#       AF_INITIALIZE
#         - attr will be assigned a default value if none is
#           specified when object is created.
#       AF_FEATURE/ATTRFEAT
#         - this attribute controls the behavior or interpretation
#           of other attributes.
#       AF_REFERENCE
#         - this attribute is a reference to another object.
#           Provide the class id and optionally the attribute id
#           in the ATTRVAL:.
#           for an objref, only the classid is needed
#	AF_UNIQUE
#	  - this attribute must have a value that's unique among
#           all the objects of this class
#	AF_NOTREE
#	  - if this object is written to mcd in old-style mcd tree
#	    form, don't write this attribute
#	AF_PRINT_ALT
#	  - use an alternate ascii string output format for this
#	    attribute. For example, print AT_TIME in 'weeks days
#	    minutes seconds' format, or print AT_BOOL as 'enabled'
#           or 'disabled'.
#
#  6. Provide a default value with ATTRDEFVAL: <value> that
#     accurately describes the behavior of the server.
#
#  7. Use the most specific types possible.  For example if there
#     is a range of seconds, use AT_RANGETIME(5m-60h).  Look in
#     ao_obj.h for a description of the available types.
#
#  8. gmake datadict
#     a) in libsrc/cnrschema to update ao_classdef_auto.h from
#        cnr_datadict
#     b) in libsrc/ccmschema to update ccm_classdef_auto.h from
#        ccm_datadict (in cnr-sdk/src).
#     Always check the diffs for *_classdef_auto.h as a sanity
#     check.
#      - the number of lines changed should be consistent with the
#        changes made to the datadict file.
#      - changes to the parsing or emitting code in ao_class.c may
#        cause global changes, but this is rare.
#
#  9. be especially careful about AF_INITIALIZE. Adding this flag
#     will cause data to be forced into the database when an
#     object is created. The UIs can represent the default value
#     that will be used, and that's often exactly what you want.
#     In general, only use INITIALIZE if the server cannot
#     function with the attribute unset - if a default applies,
#     try just including ATTRDEFVAL instead.
#
# 10. If objects of a class have a meaningful 'name' attribute, be
#     sure to set the 'CLASSNAME' at the beginning of the class
#     definition to point to that attr. Consider using
#     AF_REQUIRED and AF_UNIQUE for the attribute.
#
# 11. If an attribute is no longer used, add a DEPRECATED line to
#     it.  The DEPRECATED value should be the pcv in which the
#     attr became deprecated. The UIs may group DEPRECATED attrs
#     together, or hide them from the user.
#
# This file is the authoritative description of the classes and
# attributes.  It should be parsed to generate ao_classdef_auto.h.
#
# The three SCHEMA numbers are:
#  Genobj version number, major schema version, minor schema
#  version.  The genobj version shouldn't change very often.  It
#  defines assumptions about genobj data layout (header size,
#  header semantics, data semantics).
#
#  The major schema number should be changed any time the
#  hierarchy links between classes are changed.  This will happen
#  often during early development, but more rarely later on
#
#  The minor schema number should be changed any time the data
#  dictionary is changed: attributes added or renamed,
#  non-hierarchical references added
#
# The format of this file is the following sequence of
# (name, value) pairs:
#  <file> : <schema> <classdef-list> ;
#
#  <classdef-list>: <classdef> <classdef-list> | nil ;
#
#  <classdef> : <class> <croot> <cid> <cname> <cnamedesc> <ckey>
# <cdesc> <cviz>
#
#  <attrdef-list>: <attrdef> <attrdef-list> | nil ;
#
#  <attrdef> : <attr> <aid> <ahdr> <atype> <adesc> <aviz> <afeat>
#            | <vattr> <vtype> <vviz> <vdep> <vdesc>
#
# <class> : CLASS <value>
#  - the name of the class
# <croot> : CLASSROOT <value> | nil
#
#  - the root name for C/C++ macros AO_CLASSID_<croot>,
# AO_CLASSNAME_<croot>,
#    defaults to the value of <class>
# <cid>   : CLASSID <value>
#  - the class id
# <cname> : CLASSNAME <value> | nil
#  - the attribute which is the name of objects in this class
# <cnamedesc> : CLASSNAMEDESC <value> | nil
#  - the description of the name semantics
# <ckey> : CLASSKEY <value> | nil
#  - the attribute which is the MCD key for objects in this class.
#    If this value is 0, or unset, the name attribute will be used
#    as the key for MCD.
# <cdesc> : CLASSDESC <value> | nil
#  - the textual description of the class
# <cflags> : CLASSFLAGS <value> | nil
#  - the flags for this class; see ao_class.h for the valid flags.
# <cviz> : CLASSVIZ <value> | nil
#  - the visibility of this class
#    CLASSPCV
#  - the PCV at which this class was introduced into the schema
#    CLASSDEPRECATED
#  - the PCV at which this class was deprecated (this also sets the
#    'CF_DEPRECATED' flag value.
# <attr>   : ATTR <value>
#  - the name of the attribute
# <aid>    : ATTRID <value>
#  - the attribute id of the attribute
# <ahdr>   : ATTRHDRNAME <value> | nil
#  - the C/C++ macro name for the attribute id -- this starts off
#    as 'AO_<croot>_<attr>' but will remain constant even if the
#    <croot> or <attr> values change.
# <atype>  : ATTRTYPE <value>
#  - the type of the attribute
# <adef>   : ATTRDEFVAL <value> | nil
#  - the default value for this attribute
# <sdef>   : ATTRDEFATTRID <value> | nil
#  - another attribute id that defines the default value
#    for this attribute. The attribute type match.
# <aflags> : ATTRFLAGS <value> | nil
#  - the flags for this attribute
# <aval>   : ATTRVAL <value>
#  - the extra value for attribute type information.  This
#    information is fairly unstructured, but it is consistently
#    used for various base types:
#     AT_NLIST(): 32 bit value
#       type-id for basic types
#       1<<16 | class-id for AT_OBJ(Class)
#       2<<16 | class-id for AT_OBJREF(Class)
#     AT_SECRET: 32 bit value that is the attr-id of the
# AT_CLEARTEXT attr
#     AT_CLEARTEXT: 32 bit value that is the attr-id of the
#        AT_SECRET attr
#     AF_REFERENCE: 32 bit value = attr-id << 16 | class-id
# <aviz>   : ATTRVIZ <value>
#  - the visibility of this attribute, defaults to 5, lower numbers
#    are harder to see.  Let's use 3 for system expert and 1 for
#    AIC use
# <adesc>  : ATTRDESC <value> | nil
#  - the textual description of the attribute
# <afeat>  : ATTRFEAT <value> | nil
#  - the controling 'feature' attribute or condition for this
#    attribute.
#    For example, MCNSEnabled controls the other MCNS attributes;
#    and the type of a zone controls the existence or absence of
#    some zone features
#
# XXX: Although the ATTRFEAT mechanism can be used to implement
# enumerated unions, it is pretty clumsy.  Once I get around to
# the yacc based parser, it should become cleaner.
#
# NOTE on attribute visibility:
#   The visibility model is similar to rocks and tides.  The
#   visibility number for an attribute is the height of the rock
#   off the bottom, and the visibility number for the context is
#   the height of the tide.  At low tide, you see lots of rocks,
#   at high tide you don't see as many.
#
#   The default visibility for the CLI is 5.  This means that
#   attributes with a visibility level greater or equal to 5 will
#   be shown.  Attributes with a lower visibility number (0 - 4)
#   will only be visible if the session visibility level is
#   lowered.
#
#   If no ATTRVIZ attribute specifier is provided, the attribute
#   will be given a visibility of 5.
#
#
# NOTE -- At this time, the SCHEMA version number is not being
# actively incremented. You do not have to modify it when you
# modify this datadict.
#

SCHEMA: 1.1.13
# CLASSID RANGE Core classes 1 - 10
#
# These classes will not be used directly or indirectly configure
# servers.
CLASS: ClassDesc
CLASSID: 1
CLASSVIZ: 3
CLASSDESC:: eod
The aobj_h encoding of an ao_class_h structure, mainly used for
sending to remote clients that want to know the schema for a given
datastore.
eod

ATTR: name
ATTRID: 1
ATTRTYPE: AT_STRING
ATTRDESC:: eod
The name of this SCP class.
eod

ATTR: id
ATTRID: 2
ATTRTYPE: AT_RANGEINT(1-65534)
ATTRDESC:: eod
The 16 bit integer id for this SCP class.  This
is the value that is stored in the SCP object
instance and is used as the key for the class
information in the schema.
eod

ATTR: attrs
ATTRID: 3
ATTRTYPE: AT_NLIST(AT_OBJ(AttrDesc))
# 1 << 16 | 2
ATTRVAL: 65538
ATTRDESC:: eod
The list of defined attributes for this SCP class.
eod

ATTR: desc
ATTRID: 4
ATTRTYPE: AT_STRING
ATTRDESC:: eod
The description of this SCP class.
eod

ATTR: name-attr
ATTRID: 5
ATTRTYPE: AT_BYTE
ATTRDESC:: eod
The attribute that provides the name for objects of this class.
If not set, an attribute named 'name', or attribute with id == 1
is used as the name attribute.
eod

ATTR: key-attr
ATTRID: 6
ATTRTYPE: AT_BYTE
ATTRDESC:: eod
The attribute that provides the database key for objects of this
class.  Only used in the MCD database.  Defaults to the name
attribute (with its default semantics) if not set.
eod

ATTR: root-name
ATTRID: 7
ATTRTYPE: AT_STRING
ATTRDESC:: eod
The root name for C preprocessor macros.  Usually derived from
the class name.
eod

ATTR: visibility
ATTRID: 9
ATTRTYPE: AT_BYTE
ATTRDESC:: eod
The visibilty of the class.  Similar in semantics to attribute
visibility, but not as widely used.
eod

ATTR: schema-version
ATTRID: 10
ATTRTYPE: AT_INT
ATTRDESC:: eod
The schema version for this specific SCP class description.
eod

ATTR: desc-flags
ATTRID: 11
# should be same as ScpMessageDesc.desc-flags
ATTRTYPE: AT_FLAGSINT(secondary=1, read-only=2)
ATTRDEFVAL: 0
ATTRDESC:: eod
Provide various flags about this class description, currently:
 secondary   - indicates that this class description is part of a
               role definition rather than a complete
               specification of its attributes.
 read-only   - implies that primary is false and that in the
               containing role (sub-role), the message should be
               considered to be read-only.
eod

ATTR: constraint-filter
ATTRID: 12
ATTRTYPE: AT_EXPR
ATTRDESC:: eod
What filter should be used for constraining access to objects
of this class (used for role or sub-role constraints).
eod

ATTR: prototype
ATTRID: 13
ATTRTYPE: AT_NAMEREF(ClassDesc)
ATTRVAL: 1
ATTRDESC:: eod
The (AT_STRING) name of the class that provides the
prototype (base-class) for this class.  This is used
to provide a simple syntactic sugar version of single-level,
single inheritance.  If multiple classes should share a
common set of attributes, then a prototype class can be
defined with the common attributes and the 'derived'
classes can specify what prototype they should match.
The actual enforcing of the match between prototype
and 'derived' class could either be implementing an
assertion that each attribute defined in the prototype
is identically defined in the 'derived' class, or it
could actually set the prototype attributes in the
'derived' class.
eod

# note that there are corresponding manifest constants for
# the class flags in ao_class.h
ATTR: flags
ATTRID: 14
ATTRTYPE: AT_ENUMINT(persistent=1,deprecated=2)
ATTRDESC:: eod
Flags values associated with the class definition.
eod
ATTR: introduced-pcv
ATTRID: 15
ATTRTYPE: AT_PCV
ATTRDESC:: eod
The PCV at which the class was introduced into the schema.
eod

ATTR: deprecated-pcv
ATTRID: 16
ATTRTYPE: AT_PCV
ATTRDESC:: eod
The PCV at which the class was deprecated.
eod

CLASS: AttrDesc
CLASSID: 2
CLASSVIZ: 5
CLASSDESC:: eod
The aobj_h encoding of an ao_attr_h structure, mainly used for
sending to remote clients that want to know the schema for a given
datastore.
eod

ATTR: name
ATTRID: 1
ATTRTYPE: AT_STRING
ATTRDESC:: eod
The name of this attribute.
eod

ATTR: id
ATTRID: 2
ATTRTYPE: AT_INT
ATTRDESC:: eod
The 16 bit id of this attribute.  This is the
value that is stored in the object instance and is
used along with the class id for looking up the attribute
description in a schema.
eod

ATTR: base-type
ATTRID: 3
ATTRTYPE: AT_ATTRTYPE
ATTRFLAGS: AF_PRINT_ALT
ATTRDESC:: eod
The 32 bit type id for the basic type of this attribute.
eod

ATTR: flags
ATTRID: 4
ATTRTYPE: AT_FLAGSINT(AF_PRINT_ALT=1,AF_MIXED_CASE=2,AF_NO_CONFIG_OPTION=3,AF_CONST_OPTION=4,AF_SUPPORTS_ENCAP_OPTION=6,AF_REQUIRED=17,AF_SIGNED=18,AF_TRANSIENT=19,AF_CLASSNAME=20,AF_FEATURE=21,AF_IMMUTABLE=22,AF_NOTREE=23,AF_INITIALIZE=24)
ATTRDESC:: eod
The general set of flags describing this attribute.  These flags
cover a wide range of behavior, including: textual representation,
persistence, and requirements.
eod

ATTR: desc
ATTRID: 5
ATTRTYPE: AT_STRING
ATTRDESC:: eod
The description of the attribute (such as this one).
eod

ATTR: default-value
ATTRID: 6
ATTRTYPE: AT_BLOB
ATTRVIZ: 3
ATTRDESC:: eod
The default value for this attribute, stored in raw form.
This is the value that should be used when this specific
attribute is unset in an object.  If the attribute has
the flag AF_INITIALIZE set, this value will (should) be
set in newly created objects.
eod

ATTR: extra-value
ATTRID: 7
ATTRTYPE: AT_BLOB
ATTRVIZ: 3
ATTRDESC:: eod
The 'extra' value for this attribute, stored in raw form.
Use of the extra value is still in flux.
eod

ATTR: feature-id
ATTRID: 8
ATTRTYPE: AT_BYTE
ATTRVIZ: 3
ATTRDESC:: eod
If this attribute is part of a feature set, the feature-id
will indicate the attribute that controls that feature set.
eod

ATTR: visibility
ATTRID: 9
ATTRTYPE: AT_BYTE
ATTRVIZ: 3
ATTRDEFVAL: 5
ATTRDESC:: eod
The visibility of this attribute.  This value is used by
user interfaces to determine which attributes should be
shown.
eod

ATTR: hdr-name
ATTRID: 10
ATTRTYPE: AT_STRING
ATTRVIZ: 1
ATTRDESC:: eod
The C preprocessor name to use for this attribute's id.
eod

ATTR: mcd-path
ATTRID: 11
ATTRTYPE: AT_STRING
ATTRVIZ: 1
ATTRDESC:: eod
The relative path to use when storing this attribute in
an MCD tree.
eod

ATTR: enumerations
ATTRID: 12
#ATTRTYPE: AT_NLIST(ScpEnumTmpl)
ATTRTYPE: AT_NLIST(AT_PACK(BIS))
ATTRVIZ: 3
# AT_PACK = 36
ATTRVAL: 36
ATTRDESC::eod
Could be a list of ScpEnumTmpl objects, but that is not very dense.
Let's try a typed pack with the first byte being a type, and
encoding definitions for type 1 (BIS):
  B - type: value = 0
  I - integer value: one of the allowed integer values, ignored
      for ENUMSTR
  S - name: the name of the integer value, may be an empty string
eod

ATTR: parent
ATTRID: 13
#ATTRTYPE: AT_OBJREF(ScpAttr|ScpClass|OptDesc)
ATTRTYPE: AT_OID
ATTRVIZ: 3
ATTRDESC:: eod
The parent could be:
  1. another attribute if this is a sub-option description.
  2. a ScpClass object if this is a schema attribute description
eod

ATTR: typestr
ATTRID: 14
ATTRTYPE: AT_STRING
ATTRVIZ: 1
DEPRECATED: 7.0
ATTRDESC:: eod
The string description of this attribute type as a
way to encode more type structure than 32 bits can
hold.
eod

ATTR: type
ATTRID: 15
#ATTRTYPE: AT_OBJREF(ScpAttrType)
ATTRTYPE: AT_OID
ATTRVIZ: 1
DEPRECATED: 7.0
ATTRDESC:: eod
A reference to the type for this attribute.  This is not
currently used but is here in anticipation of moving the
type information from the attribute to the type.
eod

ATTR: sepstr
ATTRID: 16
ATTRTYPE: AT_STRING
ATTRVIZ: 1
ATTRDESC:: eod
The separation string to use when printing (and perhaps
parsing) sequences of components.
eod

ATTR: children
ATTRID: 17
ATTRTYPE: AT_NLIST(AT_OBJ(AttrDesc))
# 1<<16 | 2
ATTRVAL: 65538
ATTRVIZ: 1
ATTRDESC:: eod
If we are using nested objects, have each parent contain its
children
eod

ATTR: spec
ATTRID: 18
ATTRTYPE: AT_STRING
ATTRVIZ: 3
ATTRDESC:: eod
The name of the OptionDefinitionSet that this attribute/option
definition is part of.
eod

ATTR: deprecated
ATTRID: 19
ATTRTYPE: AT_PCV
ATTRVIZ: 3
ATTRDESC:: eod
The product compatibility version in which this attribute
was deprecated.
eod

ATTR: optional
ATTRID: 20
ATTRTYPE: AT_BOOL
ATTRVIZ: 3
ATTRDESC:: eod
Is this attribute optional -- mainly used for message descriptions.
eod

#
# AF_PRINT_ALT allows string form to parse/unparse
# AF_FEATURE allows integers that are not in the set of enums
#
ATTR: repeat
ATTRID: 21
ATTRTYPE: AT_ENUMINT(ZERO_OR_MORE=0x80000000,ONE_OR_MORE=0x80000001,EVEN_NUMBER=0x80000003)
ATTRDEFVAL: 0
ATTRFLAGS: AF_PRINT_ALT, AF_FEATURE
ATTRDESC:: eod
The repeat count for this type.  Used when this is describing
an option definition. The high bit is reserved to indicate
enumerated flags. If the high bit is clear, the value is
interpreted as a numeric count.
A value of zero is the same as a value of one, as it is not
meaningful to set a repeat of exactly zero. Use the 'zero or
more' enumerated flag instead.
The following enumerated values are currently supported:
 0x80000000   - zero or more values
 0x80000001   - one or more values
 0x80000003   - an even number of values (2 or more)
eod

#
# end AttrDesc
#

CLASS: ScpAttrType
CLASSID: 3
CLASSVIZ: 3
CLASSDESC:: eod
The aobj_h encoding of an attribute type description.  Currently
this is a placeholder until the common attribute type information
is moved out of specific attribute objects into separate, possibly
shared, objects.
eod

ATTR: name
ATTRID: 1
ATTRTYPE: AT_STRING
ATTRDESC:: eod
The name of the type
eod

ATTR: base
ATTRID: 2
ATTRTYPE: AT_INT
ATTRDESC:: eod
The base type of this type.
eod

ATTR: extra-value
ATTRID: 3
ATTRTYPE: AT_BLOB
ATTRDESC:: eod
Any extra value needed for the base type.
eod

ATTR: desc
ATTRID: 4
ATTRTYPE: AT_STRING
ATTRDESC:: eod
The description for this type
eod

CLASS: ScpMessageDesc
CLASSID: 4
CLASSVIZ: 3
CLASSDESC:: eod
The description of an SCP message (as opposed to an actual
message, which is encoded as Message(6).
eod

ATTR: function
ATTRID: 1
ATTRTYPE: AT_STRING
ATTRDESC:: eod
The function name of the message.  Unlike WSDL, the same message
name will be used for request and response pairs of messages.
eod

ATTR: desc
ATTRID: 2
ATTRTYPE: AT_STRING
ATTRDESC:: eod
The description of the message.
eod

ATTR: request-attrs
ATTRID: 3
ATTRTYPE: AT_NLIST(OBJ(AttrDesc))
# 1<<16 | 2
ATTRVAL: 65538
ATTRDESC:: eod
The attributes in the request message.
eod

ATTR: response-attrs
ATTRID: 4
ATTRTYPE: AT_NLIST(OBJ(AttrDesc))
# 1<<16 | 2
ATTRVAL: 65538
ATTRDESC:: eod
The attributes in the response message.
eod

ATTR: primary-interface
ATTRID: 5
ATTRTYPE: AT_STRING
ATTRDESC:: eod
The name of the primary interface for this message.
eod

ATTR: secondary-interfaces
ATTRID: 6
ATTRTYPE: AT_NLIST(AT_STRING)
# AT_STRING = 5
ATTRVAL: 5
ATTRDESC:: eod
The names of the secondary interfaces for this message, if known.
eod

ATTR: desc-flags
ATTRID: 7
# should be same as ClassDesc.desc-flags
ATTRTYPE: AT_FLAGSINT(secondar=1,read-only=2)
ATTRDESC:: eod
Provide various flags about this message description, currently:
 secondary   - indicates that this message description is part of
               a role definition rather than a complete
               specification of its parameters.
 read-only   - implies that secondary is true and that in the
               containing role (sub-role), the message should be
               considered to be read-only.
eod

ATTR: errors
ATTRID: 8
ATTRTYPE: AT_NLIST(AT_OBJ(ScpMessageError))
ATTRDESC:: eod
A list of information about the specific error codes that can be
returned from handling this (request) message.
eod

ATTR: prototype
ATTRID: 9
ATTRTYPE: AT_NAMEREF(ScpMessageDesc)
ATTRDESC:: eod
The (AT_STRING) name of the message that provides the
prototype for this message.  One significant use of
this prototype reference is with the class-specific
Get<Class>List messages that all (should) follow the
same pattern for arguments and return values as the
prototypical GetClassList message.
eod

ATTR: constraint-filter
ATTRID: 10
ATTRTYPE: AT_EXPR
ATTRDESC:: eod
What filter should be used for constraining callers of this
message.
This filter expression would have the request message's data object
defined as req (or req-data) in the evaluation context.
eod

CLASS: ChangeEntry
CLASSROOT: CHANGE_ENTRY
CLASSID: 5
CLASSDESC:: eod
A change to a single object.  ChangeEntry objects
are grouped into ChangeSets and applied to the database.
eod

ATTR: oid
ATTRID: 1
ATTRTYPE: AT_OID
ATTRDESC:: eod
The OID of the object being modified by this change entry.
eod

ATTR: classid
ATTRID: 2
ATTRTYPE: AT_INT
ATTRDESC:: eod
The optional class id for the object.  Mainly an efficiency hack to
avoid a database query by OID to make decisions on handling a
change.
eod

ATTR: wseq
ATTRID: 3
ATTRTYPE: AT_INT
ATTRDESC:: eod
The write sequence (DBSN) for this object prior to the change.
eod

ATTR: op
ATTRID: 4
ATTRTYPE: AT_ENUMINT(null=0, add=1, del=2, mod=3)
ATTRDESC:: eod
The operation (add, modify or delete) that this change
entries encodes.
eod

ATTR: obj
ATTRID: 5
ATTRTYPE: AT_OBJ(0)
ATTRDESC:: eod
The complete object for add and del operations
eod

ATTR: attrs
ATTRID: 6
ATTRTYPE: AT_NLIST(AT_PACK(BBB+B+|BB+B+B+))
# AT_PACK = 36
ATTRVAL: 36
ATTRDESC:: eod
A list of the modified attributes stored as a packed blob in one
of two encodings:
 A. B - sub-operation,
    B - attrid,
    B+ - old value (lenlen encoded),
    B+ - new val
 B. B - sub-operation,
    B+ - path,
    B+ - old value,
    B+ - new value
The first encoding is only used for the ATTR_MODIFY
sub-operation (1).

Look in scp.h, at the enum Scp_ChangeSubOp for a list of the enum
values.
eod

ATTR: name
ATTRID: 7
ATTRTYPE: AT_STRING
ATTRDESC:: eod
An optional name of the changed object, mostly used for
modification operations on objects that are known by name.
eod

ATTR: dbtxn-seq
ATTRID: 8
ATTRTYPE: AT_INT
ATTRVIZ: 3
ATTRDESC:: eod
The database transaction sequence number used by CCM
to record aggregated lease history detail change entries.
eod

ATTR: dbtxn-generation
ATTRID: 9
ATTRTYPE: AT_INT
ATTRVIZ: 3
ATTRDESC:: eod
The generation number for database transaction sequence numbers that
exceed the 32-bit number space.
eod

#
# the Message class
#
CLASS: Message
CLASSROOT: MESSAGE
CLASSID: 6
CLASSNAME: 3
CLASSVIZ: 0
CLASSDESC:: eod
The Message class is used to describe objects that are sent between
processes to implement the CNR Server Control Protocol (SCP).
eod

ATTR: msgid
ATTRID: 1
ATTRTYPE: AT_INT
ATTRDESC:: eod
The identifier of this message.  Generated by the sender of
the message, and is only unique for a given sender.  Mainly
used for response messages to refer back to their request.
eod

ATTR: type
ATTRID: 2
ATTRTYPE: AT_ENUMINT(none=0, request=1, reply=2, event=3, error=10)
ATTRFLAGS: AF_PRINT_ALT
ATTRDESC:: eod
The type or direction of this message.  Currently, we only
support request/reply messages, and events generated by the
DHCP and DNS servers to report SNMP traps.
eod

ATTR: function
ATTRID: 3
ATTRTYPE: AT_STRING
ATTRDESC:: eod
The message name.  This is the key that the server uses
to match a message to its actual handler implementation.
It also serves as the key for matching a message to the
specification of its request and response attributes.
eod

ATTR: refid
ATTRID: 4
ATTRTYPE: AT_INT
ATTRDESC:: eod
In a reply or event message, the message-id of the request
message that this message is a reply to.
eod

ATTR: intval
ATTRID: 5
ATTRTYPE: AT_INT
ATTRVIZ: 0
DEPRECATED: 7.1.0
ATTRDESC:: eod
Not used, originally intended to be a shortcut for just
sending a single integer.
eod

ATTR: strval
ATTRID: 6
ATTRHDRNAME: AO_MESSAGE_STRVAL
ATTRTYPE: AT_INT
ATTRVIZ: 0
DEPRECATED: 7.1.0
ATTRDESC:: eod
Not used, originally intended to be a shortcut for just
sending a single string.
eod

ATTR: ipval
ATTRID: 7
ATTRTYPE: AT_IPADDR
ATTRVIZ: 0
DEPRECATED: 7.1.0
ATTRDESC:: eod
Not used, originally intended to be a shortcut for just
sending a single IP address.
eod

ATTR: oidval
ATTRID: 8
ATTRTYPE: AT_OID
ATTRVIZ: 0
DEPRECATED: 7.1.0
ATTRDESC:: eod
Not used, originally intended to be a shortcut for just
sending a single OID.
eod

ATTR: blobval
ATTRID: 9
ATTRTYPE: AT_BLOB
ATTRVIZ: 0
DEPRECATED: 7.1.0
ATTRDESC:: eod
Not used, originally intended to be a shortcut for just
sending a single blob value.
eod

ATTR: data
ATTRID: 10
ATTRTYPE: AT_OBJ(0)
ATTRDESC:: eod
The embedded object containing the message arguments.
eod

ATTR: task-id
ATTRID: 11
ATTRTYPE: AT_INT
ATTRDESC:: eod
An indication that this message was generated by an asynchronous
Task on the sender. The motivation for this attribute is to
suppress further data propagation in the handler of this message.
A secondary motivation is being able to track changes back to a
Task and from there to a ChangeSet and thus an admin id.
In general, Tasks should not be used.
eod

ATTR: status
ATTRID: 20
ATTRTYPE: AT_INT
ATTRDESC:: eod
The 32 bit error code describing this error. This is
interpreted as an areturn_t using the AX_* macros and names.
AOK represents success.
eod

ATTR: statstr
ATTRID: 21
ATTRTYPE: AT_STRING
ATTRDESC:: eod
An optional text string describing this error. This string
may be specified to override the standard text associated with
the status error code.
eod

ATTR: exception-list
ATTRID: 22
ATTRTYPE: AT_NLIST(AT_OBJ(RemoteRequestStatus))
ATTRDESC:: eod
The list of errors encountered when processing this message.
The exception-list attribute will never be set for messages
that have an AOK status return.
eod

ATTR: error-code
ATTRID: 23
ATTRTYPE: AT_INT
DEPRECATED: 7.1.0
ATTRDESC:: eod
This attribute is deprecated.

A per-message detailed error code used by the PushSubnet
and ReclaimSubnet messages.  See the message
specification for the exact interpretation of this
error code.  The combination of the status, which is
a general category of error and error-code, which is
the specific error location should allow us to span
eod

ATTR: pcv
ATTRID: 24
ATTRTYPE: AT_PCV
ATTRDESC:: eod
A version associated with the process sending the message. This is
used to permit forward and backward compatibility checks.
eod

# end of Message class


CLASS: ScpConnection
CLASSID: 7
CLASSVIZ: 0
CLASSDESC:: eod
The aobj_h definition of a connection
eod

ATTR: id
ATTRID: 1
ATTRTYPE: AT_INT
ATTRDESC:: eod
A random id for identifying this session.
(Currently an offset in the server's connection list)
eod

ATTR: admin-name
ATTRID: 2
ATTRTYPE: AT_STRING
ATTRDESC:: eod
The user id for this connection.
eod

ATTR: remote-addr
ATTRID: 3
ATTRTYPE: AT_IPADDR
ATTRDESC:: eod
The remote address for this connection.
eod

#
# the Changeset class
#
CLASS: ChangeSet
CLASSID: 8
CLASSROOT: CHANGESET
CLASSDESC:: eod
A set of change entries applied to database objects. The list
of ChangeEntry objects is embedded in the ChangeSet object.
Changesets are use to report a set of database operations when
performing complex tasks such as failover synchronization,
and to record database change history for auditing purposes.
eod

ATTR: wseq
ATTRID: 1
ATTRTYPE: AT_INT
ATTRDESC:: eod
The write sequence (DBSN) that this change set created.
eod

ATTR: change-list
ATTRID: 2
ATTRTYPE: AT_NLIST(AT_OBJ(ChangeEntry))
# 1<<16 | classid(ChangeEntry) 9
ATTRVAL: 65545
ATTRDESC:: eod
The list of changes in this change set.
eod

ATTR: state
ATTRID: 3
ATTRTYPE: AT_ENUMINT(none=0, init=1, applied=2, error=3)
ATTRDESC:: eod
The state of this change set.  This is used to clarify
the multiple uses of a change set, which include:
a transaction that a client wants to apply, a
change log entry for a datastore, and a way to
report errors about a failed change attempt.
eod

ATTR: dbgen
ATTRID: 4
ATTRTYPE: AT_INT
ATTRDESC:: eod
What generation of the database do these apply to, in
case the 32 bit DBSN rolls.
eod

ATTR: change-date
ATTRID: 5
ATTRTYPE: AT_DATE
ATTRDESC:: eod
When were these changes made
eod

ATTR: admin-name
ATTRID: 6
ATTRTYPE: AT_STRING
ATTRDESC:: eod
Who made these changes
eod

ATTR: task-id
ATTRID: 7
ATTRTYPE: AT_INT
ATTRDESC:: eod
What Task triggered these changes
eod

ATTR: dbid
ATTRID: 8
ATTRTYPE: AT_ENUMINT(CCM=0,MCD=1,SNMP=2,DNS=3,DHCP=4,TFTP=5,CNRAGENT=6)
ATTRFLAGS: AF_PRINT_ALT
ATTRDESC:: eod
What server/database was the target of the change? This holds the
well-known dbid of the database storing the changeset. We've
captured these in scp.h and in ScpLib.java.
eod

ATTR: result-list
ATTRID: 10
ATTRTYPE: AT_NLIST(AT_OBJ(ConsistencyDetail))
ATTRFLAGS: AF_TRANSIENT
ATTRDESC:: eod
The errors encountered in applying this change set.
eod

ATTR: server-id
ATTRID: 11
ATTRTYPE: AT_OID
ATTRDESC:: eod
The oid of the server. This field is set after successfully
pushing a list of objects to a remote server.
eod

ATTR: atomic
ATTRID: 12
ATTRTYPE: AT_BOOL
ATTRDEFVAL: true
ATTRDESC:: eod
Can this changeset be fragmented if it is too large for the
underlying datastore transaction configuration?
If false, the apply changeset code will break it up into smaller
changesets. If true, an error will be returned if there are too
many operations.
eod

ATTR: flags
ATTRID: 13
ATTRTYPE: AT_FLAGSINT(atomic=1,no-propagation=2,no-ccm-propagation=3)
ATTRFLAGS: AF_PRINT_ALT
ATTRDESC:: eod
Flags values to indicate various conditions.

  atomic    the changeset is atomic: if false, the datastore
            code is allowed to break the changeset into multiple
            datastore transactions.

  no-propagation propagation code may skip some propagation
                 steps when processing this changeset
  no-ccm-propagation propagation code may skip some ccm
                 propagation steps when processing this changeset
eod

ATTR: remote-error-list
ATTRID: 14
ATTRTYPE: AT_NLIST(AT_OBJ(RemoteRequestStatus))
ATTRFLAGS: AF_TRANSIENT
DEPRECATED: 7.1.0
ATTRDESC:: eod
This attribute is deprecated.

The results of applying this change set, will be set if there
is an error in applying the change set to remote systems.
eod

# end of Changeset class


# the results from applying a change entry
CLASS: ChangeResult
CLASSID: 9
CLASSVIZ: 0

ATTR: id
ATTRID: 1
ATTRTYPE: int
ATTRDESC:: eod
The index of the corresponding ChangeEntry, for sparse arrays
with just the errors.
eod

ATTR: error-code
ATTRID: 2
ATTRTYPE: AT_INT
ATTRDESC:: eod
The discriminant telling us which of the payload objects is
valid and expected.  Perhaps a bit redundant the class id of
the object, or its attribute id.
eod

ATTR: exception
ATTRID: 3
ATTRTYPE: AT_OBJ(ConsistencyViolation)
ATTRDESC:: eod
The RuleViolation object describing why the change failed.  This
is the general error reporting mechanism
eod

ATTR: detail
ATTRID: 4
ATTRTYPE: AT_OBJ(ConsistencyDetail)
ATTRDESC:: eod
The Detail object for when we are too lazy to cons up a complete
RuleViolation, such as invalid-object errors
eod

ATTR: current-obj
ATTRID: 5
ATTRTYPE: AT_OBJ(0)
ATTRDESC:: eod
For concurrency errors, send back the current object
eod

CLASS: Task
CLASSID: 10
CLASSVIZ: 3
CLASSPCV: 4.0.0
CLASSDESC::eod
A unit of work to be performed by a component system.
Initially will be used to encode propagation within and
between the CCM and MCD datastores in the JackSprat release.
Eventually will be used whereever changes need to be described,
such as in:
  * Future work for planned configuration changes
  * Updates in response to consistency rule violations
  * Updates in response to running out of address space
eod

ATTR: id
ATTRID: 1
ATTRTYPE: AT_INT
ATTRDESC:: eod
The unique id of this task on the originating system.
eod

ATTR: db-id
ATTRID: 2
ATTRTYPE: AT_INT
ATTRDESC:: eod
The Datastore id for this task which qualifies DBSN
  0   -  means the current datastore
  1   - is the CCM datastore for this JackSprat release
  2   - is the local MCD datastore associated with the CCM
        datastore
  3-n - are the remote datastores
The db-id can also be used as the conn id.
eod

ATTR: state
ATTRID: 3
ATTRTYPE: AT_ENUMINT(NONE=0, INIT=1, QUEUED=2, EXECUTING=3, DONE=4, ERROR=5)
ATTRDESC:: eod
The state of this task.
eod

ATTR: dbsn
ATTRID: 4
ATTRTYPE: AT_INT
ATTRDESC:: eod
The DBSN of the ChangeSet that triggered this task
eod

ATTR: req-list
ATTRID: 7
ATTRTYPE: AT_NLIST(AT_OBJ(Message))
# 1<<16 | classid(ChangeEntry) 6
ATTRVAL: 65542
ATTRDESC:: eod
The requests that make up this task.
eod

ATTR: resp-list
ATTRID: 8
ATTRTYPE: AT_NLIST(AT_OBJ(Message))
# 1<<16 | classid(ChangeEntry) 6
ATTRVAL: 65542
ATTRDESC:: eod
The results from the requests in the task.
eod

#
# the Secret class
#
CLASS: Secret
CLASSID: 11
CLASSPCV: 4.0.0
CLASSDESC:: eod
Defines a class of objects that are secret; for example
passwords. A secret object is stored separately from the
object using it, and referenced by ID (OID).
The secret is stored with more security, while other objects
that could contain secrets avoid the complexity of encryption,
since they only contain a reference that is
meaningless without access to the Secret object.
eod

ATTR: password
ATTRID: 1
ATTRTYPE: AT_BLOB
ATTRDESC:: eod
This is really the value associated with the secret.  It might
be a cleartext password, or it may be some form of hash of the
clear text.  The exact semantics of this blob of data are
determined by the value of the type attribute(2).
eod

ATTR: type
ATTRID: 2
ATTRTYPE: AT_ENUMINT(cleartext=1)
ATTRDEFVAL: 1
ATTRDESC:: eod
The type of the value in this secret.  May be a clear-text
password, or may be a hash of some form.  Currently, the only
defined type is cleartext == 1.
eod

# end of Secret class


# C l i e n t E n t r y
# ClientEntry

CLASS: ClientEntry
CLASSROOT: CE
CLASSID: 12
CLASSNAME: 8
CLASSPCV: 1.0.0
CLASSNAMEDESC:: eod
Names a ClientEntry using one of the following:

   Its MAC address for a single client entry.

   The literal string 'default' for the default client entry.

   In releases prior to 6.2 only, the name of a client-class
   for client-class entries.

Previously, two collections of ClientEntry objects existed: the
client list and the client-class list.  The objects in the client
list are named with either their MAC address or the literal string
'default'.  The DHCP server looks up these entries on each DHCP
request to find out how it should process the request.  The
objects in the client-class list are named with arbitrary strings
that serve as the name of the client-class that they represent.

The DHCP server uses the unauthenticated-client-class-name and the
client-class-name attributes in the individual client objects to
determine which class they belong to, and then reads the default
attributes from the client-class object with that name.

The above was true until CNR 6.2, but as of that release, the DHCP
server was able to configure ClientClass objects directly instead
of having to assume that they are ClientEntry objects.  So, from
now on, you don't have to ensure that new attribute id's match in
the ClientEntry (CE) and ClientClass (CC) objects.  Existing
attributes still shouldn't change, of course.

The client list has ClientEntry objects, and the client-class list
has ClientClass objects.
eod

CLASSVIZ: 5
CLASSDESC:: eod
Defines the selection criteria and configuration for a
specific client.
eod

ATTR: client-class-name
ATTRID: 1
ATTRHDRNAME: AO_CE_CLIENT_CLASS_NAME
ATTRTYPE: AT_STRING
ATTRMCDPATH: client-class-name
ATTRVIZ: 5
ATTRDESC:: eod
Identifies the client-class to which a client belongs. If the client
is not a member of a client-class, then the DHCP server uses the
default client-class properties.
eod

ATTR: host-name
ATTRID: 2
ATTRHDRNAME: AO_CE_HOST_NAME
ATTRTYPE: AT_STRING
ATTRMCDPATH: host-name
ATTRVIZ: 5
ATTRDESC:: eod
Specifies the hostname. Use this string to replace any hostname
DHCP option that the DHCP client sends. The two forms for
specifying the hostname are:

1.  A string that does not start with an at (@) sign. This form
    of host-name value is used to override the DHCP client
    request host name. When you enter a valid name, you cause
    the DHCP server to ignore any host-name specified by this
    client, and, instead, use this client-entry attribute. The
    actual value of the hostname option in the client's DHCP
    packet is ignored. You can use any valid DNS name. You
    cannot use underscores (_)in the hostname.

2.  A string that starts with an at (@) sign. Network Registrar
    uses this form of hostname value to signal the following
    special handling:

    @host-name-option
       Causes the server to use whatever hostname option the
       client sent. This is the default behavior if there is no
       entry for hostname in either the client or client-class.

    @no-host-name-option
       Causes the server to drop the hostname option that the
       client sent, and not replace it. If you have disabled DNS
       name synthesis, then the client will have no name placed
       into DNS.

    @use-macaddress
       Causes the server to synthesize a hostname for the
       client that is derived from its MAC address, and is
       thus unique. This token is used to ensure that a
       client has a valid name in DNS.

This feature is maintained for compatibility with earlier versions.
Additional options for hostname synthesis are provided on the
DNSUpdateConfig object referenced by the policy hierarchy.
eod

ATTR: domain-name
ATTRID: 3
ATTRHDRNAME: AO_CE_DOMAIN_NAME
ATTRTYPE: AT_STRING
ATTRMCDPATH: domain-name
ATTRVIZ: 5
ATTRDESC:: eod
Gives the domain name (which must be a zone) to use when performing
DNS updates. Places the client's A record in this DNS domain.
This feature is maintained for compatibility with prior versions.
Additional options to specify the forward zone are provided on
the client policy (or embedded policy) and its referenced
DNSUpdateConfig objects.
eod

ATTR: policy-name
ATTRID: 4
ATTRHDRNAME: AO_CE_POLICY_NAME
ATTRTYPE: AT_STRING
ATTRMCDPATH: policy-name
ATTRVIZ: 5
ATTRDESC:: eod
Identifies the policy to add to Network Registrar's DHCP policy
search list for this client.
eod

ATTR: action
ATTRID: 5
ATTRHDRNAME: AO_CE_ACTION
ATTRTYPE: AT_FLAGSINT(exclude=1,deprecated-one-shot=2,deprecated-use-release-grace-period=3,none=32)
ATTRMCDPATH: action
ATTRVIZ: 5
ATTRDESC:: eod
Describes the action the DHCP server takes for this client.

    1  exclude - causes the server to ignore all
       communication from this client.
    2  deprecated-one-shot - now deprecated.
    3  deprecated-use-release-grace-period - now deprecated.
    32 none

If you specify the exclude action in the default client
entry, then any client not specifically registered through
the client command cannot communicate with the server.

Note: The deprecated flags (2,3) are now available through
the policy command attributes inhibit-all-renews and
release-grace-period.
eod

ATTR: old-inclusion-mask
ATTRID: 6
ATTRHDRNAME: AO_CE_INCLUSION_MASK
ATTRTYPE: AT_INT
ATTRMCDPATH: inclusion-mask
ATTRVIZ: 1
DEPRECATED: 7.0
ATTRDESC:: eod
This attribute is not used.
eod

ATTR: old-exclusion-mask
ATTRID: 7
ATTRHDRNAME: AO_CE_EXCLUSION_MASK
ATTRTYPE: AT_INT
ATTRMCDPATH: exclusion-mask
ATTRVIZ: 1
DEPRECATED: 7.0
ATTRDESC:: eod
This attribute is not used.
eod

ATTR: name
ATTRID: 8
ATTRHDRNAME: AO_CE_NAME
ATTRTYPE: AT_STRING
ATTRFLAGS: AF_REQUIRED, AF_IMMUTABL, EAF_UNIQUE, AF_JAVADOC
ATTRMCDPATH: name
ATTRVIZ: 3
ATTRDESC:: eod
Provides the name of the client.
eod

ATTR: authenticate-until
ATTRID: 9
ATTRHDRNAME: AO_CE_AUTHENTICATION_EXPIRES
ATTRTYPE: AT_DATE
ATTRMCDPATH: authentication-expires
ATTRVIZ: 5
ATTRDESC:: eod
Sets an authentication expiration date, using date format or the
forever keyword. Dates can be in the 2h (two hours ago, for
example) or month day hour:minute[:second] year format.

Formats for the date are:

 +<num><unit>
    Time in the future, where num is a decimal number and unit
    is s, m, h, d, or w for seconds, minutes, hours, days or
    weeks, respectively.

 <month> <day> <hour>:<minute>[:<second>] <year>
    Month, day, 24-hour time, and 2-or-4-digit-year.
    For example:Jun 30 20:00:00 2007. Enter the time that is
    local to the nrcmd process.

 forever
    Does not expire the authentication for this client.
eod

ATTR: authentication-sequence
ATTRID: 10
ATTRHDRNAME: AO_CE_AUTHENTICATION_SEQUENCE
ATTRTYPE: AT_INT
ATTRMCDPATH: authentication-sequence
ATTRVIZ:  1
DEPRECATED: 7.0
ATTRDESC:: eod
This attribute is not used.
eod

ATTR: unauthenticated-client-class-name
ATTRID: 11
ATTRHDRNAME: AO_CE_UNAUTHENTICATED_CLIENT_CLASS_NAME
ATTRTYPE: AT_STRING
ATTRMCDPATH: unauthenticated-client-class-name
ATTRVIZ: 5
ATTRDESC:: eod
Identifies the client-class to use if this client is no longer
authenticated.
eod

ATTR: user-defined
ATTRID: 12
ATTRHDRNAME: AO_CE_COOKIE_STR
ATTRTYPE: AT_STRING
ATTRMCDPATH: cookie-str
ATTRVIZ: 5
ATTRDESC:: eod
Contains an opaque user-defined string that can be set and
queried. This attribute has no effect on the operation of the
DHCP server.
eod

ATTR: environment-dictionary
ATTRID: 13
ATTRHDRNAME: AO_CE_ENV_DICTIONARY
ATTRTYPE: AT_DICT(AT_STRING)
ATTRMCDPATH: environment-dictionary
ATTRVIZ: 3
ATTRDESC:: eod
A set of strings which will be added to the environment dictionary
when this client is the result of a client entry lookup.
eod

ATTR: selection-criteria
ATTRID: 14
ATTRHDRNAME: AO_CE_INCLUSION_CRITERIA
ATTRTYPE: AT_ARRAY(AT_STRING)
ATTRMCDPATH: inclusion-criteria
ATTRVIZ: 5
ATTRDESC:: eod
Lists selection tags for this client. All the criteria in this
list must appear in the scope/prefix selection tags for a
scope/prefix to be considered acceptable to this client.
eod

ATTR: selection-criteria-excluded
ATTRID: 15
ATTRHDRNAME: AO_CE_EXCLUSION_CRITERIA
ATTRTYPE: AT_ARRAY(AT_STRING)
ATTRMCDPATH: exclusion-criteria
ATTRVIZ: 3
ATTRDESC:: eod
Lists excluded selection tags for this client. None of the
criteria in this list may appear in the scope/prefix selection
tags for a scope/prefix to be considered acceptable to this
client.
eod

ATTR: version
ATTRID: 16
ATTRHDRNAME: AO_CE_VERSION
ATTRTYPE: AT_INT
ATTRMCDPATH: version
ATTRVIZ: 1

ATTR: status
ATTRID: 17
ATTRHDRNAME: AO_CE_STATUS
ATTRTYPE: AT_ENUMINT(success=0, no-results=1, ldap-failure=2)
ATTRVIZ: 1
ATTRMCDPATH: status
ATTRDESC::eod
For internal use only.
eod

ATTR: embedded-policy
ATTRID: 18
ATTRHDRNAME: AO_CE_EMBEDDED_POLICY
ATTRTYPE: AT_OBJ(Policy)
ATTRMCDPATH: embedded-policy
ATTRVIZ: 5
ATTRDESC:: eod
Specifies the embedded policy object for this client.
eod

ATTR: over-limit-client-class-name
ATTRID: 19
ATTRHDRNAME: AO_CE_OVER_LIMIT_CLIENT_CLASS_NAME
ATTRTYPE: AT_STRING
ATTRMCDPATH: over-limit-client-class-name
ATTRVIZ: 5
ATTRDESC:: eod
Identifies which client-class to use if this client is over the
limit allowed for the number of simultaneous active leases with
a common limitation-id.
eod

ATTR: limitation-id
ATTRID: 20
ATTRHDRNAME: AO_CE_LIMITATION_ID
ATTRTYPE: AT_EXPR
ATTRMCDPATH: limitation-id
ATTRVIZ: 1
DEPRECATED: 7.0
ATTRDESC:: eod
Specifies an expression that evaluates to a binary large object
(blob) or a string that can be used as a blob. The resulting
value groups leases which have a maximum limit on the number of
simultaneous active leases allowed. To configure the limit, use
the limitation-count attribute of the policy command.
See also the over-limit-client-class-name attribute.
eod

ATTR: client-lookup-id
ATTRID: 21
ATTRHDRNAME: AO_CE_CLIENT_LOOKUP_ID
ATTRTYPE: AT_EXPR
ATTRMCDPATH: client-lookup-id
ATTRVIZ: 1
DEPRECATED: 7.0
ATTRDESC:: eod
Gives an expression which evaluates to a string (or a blob which is a
valid string).  The resulting value specifies the key value to be
used to lookup the client in the client database, either locally
or through LDAP.
eod

ATTR: reservation-id
ATTRID: 22
ATTRHDRNAME: AO_CE_RESERVATION_ID
ATTRTYPE: AT_EXPR
ATTRMCDPATH: reservation-id
ATTRVIZ: 1
DEPRECATED: 7.0
ATTRDESC:: eod
Gives an expression which evaluates to a string (or a blob which is a
valid string).  The resulting value specifies the key to be used
to lookup any reservations that have been made for this client.
eod

ATTR: max-client-lookups
ATTRID: 23
ATTRHDRNAME: AO_CE_MAX_CLIENT_LOOKUPS
ATTRTYPE: AT_INT
ATTRMCDPATH: max-client-lookups
ATTRVIZ: 1
DEPRECATED: 7.0
ATTRDESC:: eod
An integer which specifies the maximum number of client database
lookups allowed.  Should be a small number (e.g., 2 or so).  The
default value (if none is specified in either the client or
client-class) is 1.
This might have been in CNR 6.0, but the looping looked too
difficult compared to the value to customers, and so we decided
not to implement it.  If we ever do looping, use this property to
control the number of loops.
eod

ATTR: default-vpn
ATTRID: 24
ATTRHDRNAME: AO_CE_DEFAULT_VPN_NAME
ATTRTYPE: AT_NAMEREF(VPN)
ATTRVAL: 1127
ATTRVIZ: 5
ATTRDESC:: eod
Names the VPN to assign to clients that do not already have a
vpn-id or vrf-name value.
eod

ATTR: override-vpn
ATTRID: 25
ATTRHDRNAME: AO_CE_OVERRIDE_VPN_NAME
ATTRTYPE: AT_NAMEREF(VPN)
ATTRVAL: 1127
ATTRVIZ: 5
ATTRDESC:: eod
Names the VPN to assign to clients, no matter what values
clients present as VPN-IDs or vrf-names.
eod

ATTR: add-to-environment-dictionary
ATTRID: 26
ATTRTYPE: AT_STRING
ATTRDESC:: eod
Lists attribute-value pairs that are added to the environment
dictionary whenever this client-class is associated with an
incoming DHCP request.  You can use these attribute-value pairs
to configure extensions or expressions without having to rewrite
the executable code in the extension or expression.

The string must have the format:
"attribute1=value1,attribute2=value2, ... ,attributen=valuen"
eod

# end ClientEntry



# C l i e n t S t a t e
# ClientState

CLASS: ClientState
CLASSROOT: CLIENT_STATE
CLASSID: 13
CLASSVIZ: 3
CLASSDESC:: eod
Ask Kim or Mark
eod

ATTR: client-id
ATTRID: 1
ATTRHDRNAME: AO_CLIENT_STATE_CLIENT_ID
ATTRTYPE: AT_STRING
ATTRMCDPATH: client-id

ATTR: initialization-sequence
ATTRID: 2
ATTRHDRNAME: AO_CLIENT_STATE_INITIALIZATION_SEQUENCE
ATTRTYPE: AT_INT
ATTRMCDPATH: initialization-sequence

ATTR: client-state-flags
ATTRID: 3
ATTRHDRNAME: AO_CLIENT_STATE_CLIENT_STATE_FLAGS
ATTRTYPE: AT_INT
ATTRMCDPATH: client-state-flags

ATTR: client-state-lease-address
ATTRID: 4
ATTRHDRNAME: AO_CLIENT_STATE_CLIENT_STATE_LEASE_ADDRESS
ATTRTYPE: AT_IPADDR
ATTRMCDPATH: client-state-lease-address

CLASS: Session
CLASSROOT: SESSION
CLASSID: 14
CLASSVIZ: 1
CLASSDESC:: eod
Ask Peter or Caesar
eod

ATTR: session-mgr-key
ATTRID: 1
ATTRHDRNAME: AO_SESSION_MGR_KEY
ATTRTYPE: AT_STRING
ATTRMCDPATH: session-mgr-key

ATTR: session-id
ATTRID: 2
ATTRHDRNAME: AO_SESSION_ID
ATTRTYPE: AT_INT
ATTRMCDPATH: session-id

ATTR: session-start-time
ATTRID: 3
ATTRHDRNAME: AO_SESSION_START_TIME
ATTRTYPE: AT_DATE
ATTRMCDPATH: session-start-time

ATTR: session-nas-identifier
ATTRID: 4
ATTRHDRNAME: AO_SESSION_NAS_IDENTIFIER
ATTRTYPE: AT_STRING
ATTRMCDPATH: session-nas-identifier

ATTR: session-nas-ip-address
ATTRID: 5
ATTRHDRNAME: AO_SESSION_NAS_IP_ADDRESS
ATTRTYPE: AT_IPADDR
ATTRMCDPATH: session-nas-ip-address

ATTR: session-nas-port
ATTRID: 6
ATTRHDRNAME: AO_SESSION_NAS_PORT
ATTRTYPE: AT_INT
ATTRMCDPATH: session-nas-port

ATTR: session-user-name
ATTRID: 7
ATTRHDRNAME: AO_SESSION_USER_NAME
ATTRTYPE: AT_STRING
ATTRMCDPATH: session-user-name

ATTR: session-ip-dynamic-resourcemanager
ATTRID: 8
ATTRHDRNAME: AO_SESSION_IP_DYNAMIC_RESOURCEMANAGER
ATTRTYPE: AT_STRING
ATTRMCDPATH: session-ip-dynamic-resourcemanager

ATTR: session-ip-dynamic-resource
ATTRID: 9
ATTRHDRNAME: AO_SESSION_IP_DYNAMIC_RESOURCE
ATTRTYPE: AT_IPADDR
ATTRMCDPATH: session-ip-dynamic-resource

ATTR: session-ip-per-nas-port-resourcemanager
ATTRID: 10
ATTRHDRNAME: AO_SESSION_IP_PER_NAS_PORT_RESOURCEMANAGER
ATTRTYPE: AT_STRING
ATTRMCDPATH: session-ip-per-nas-port-resourcemanager

ATTR: session-ip-per-nas-port-resource
ATTRID: 11
ATTRHDRNAME: AO_SESSION_IP_PER_NAS_PORT_RESOURCE
ATTRTYPE: AT_IPADDR
ATTRMCDPATH: session-ip-per-nas-port-resource

ATTR: session-ipx-dynamic-resourcemanager
ATTRID: 12
ATTRHDRNAME: AO_SESSION_IPX_DYNAMIC_RESOURCEMANAGER
ATTRTYPE: AT_STRING
ATTRMCDPATH: session-ipx-dynamic-resourcemanager

ATTR: session-ipx-dynamic-resource
ATTRID: 13
ATTRHDRNAME: AO_SESSION_IPX_DYNAMIC_RESOURCE
ATTRTYPE: AT_BLOB
ATTRMCDPATH: session-ipx-dynamic-resource

ATTR: session-concurrent-session-counter-resourcemanager
ATTRID: 14
ATTRHDRNAME: AO_SESSION_CONCURRENT_SESSION_COUNTER_RESOURCEMANAGER
ATTRTYPE: AT_STRING
ATTRMCDPATH: session-concurrent-session-counter-resourcemanager
ATTR: session-concurrent-session-counter-resource
ATTRID: 15
ATTRHDRNAME: AO_SESSION_CONCURRENT_SESSION_COUNTER_RESOURCE
ATTRTYPE: AT_INT
ATTRMCDPATH: session-concurrent-session-counter-resource
ATTR: session-user-session-counter-resourcemanager
ATTRID: 16
ATTRHDRNAME: AO_SESSION_USER_SESSION_COUNTER_RESOURCEMANAGER
ATTRTYPE: AT_STRING
ATTRMCDPATH: session-user-session-counter-resourcemanager
ATTR: session-user-session-counter-resource
ATTRID: 17
ATTRHDRNAME: AO_SESSION_USER_SESSION_COUNTER_RESOURCE
ATTRTYPE: AT_INT
ATTRMCDPATH: session-user-session-counter-resource

#
# the ConsistencyRule class
#
CLASS: ConsistencyRule
CLASSID: 15
CLASSVIZ: 3
CLASSPCV: 4.0.0
CLASSDESC:: eod
The ConsistencyRule class describes an object that reports on the
violation of a consistency rule.
eod

ATTR: id
ATTRID: 1
ATTRTYPE: AT_INT
ATTRFLAGS: AF_UNIQUE
ATTRDESC:: eod
The unique id of the rule, the very small numbers 1-10 or so
should be reserved for intrinsic rules, and their should be some
categorization ranges of ids for general categories such as
Subnet checks, etc.
eod

ATTR: desc
ATTRID: 2
ATTRTYPE: AT_STRING
ATTRDESC:: eod
The textual description of the rule
eod

# end of ConsistencyRule class

#
# the ConsistencyRule class
#
CLASS: ConsistencyViolation
CLASSID: 16
CLASSPCV: 4.0.0
CLASSDESC:: eod
The ConsistencyViolation class describes an object that reports
on the violation of a consistency rule.
eod

ATTR: rule-id
ATTRID: 1
ATTRTYPE: AT_INT
ATTRDESC:: eod
The numeric id of the rule that was violated.
eod

ATTR: obj-list
ATTRID: 2
ATTRTYPE: AT_NLIST(AT_OBJ(0))
# 1<<16 | 0
ATTRVAL: 65536
ATTRDESC:: eod
The list of objects that contributed to this specific
ConsistencyRule violation
eod

ATTR: detail-list
ATTRID: 3
ATTRTYPE: AT_NLIST(AT_OBJ(ConsistencyDetail))
# 1<<16 | 17
ATTRVAL: 65553
ATTRDESC:: eod
The list of details, usually about the attributes, for each object
that contributed to the ConsistencyRule violation
eod

ATTR: index
ATTRID: 4
ATTRTYPE: AT_INT
ATTRDESC:: eod
If there are multiple changes in a request, the index attribute
can be used to identify which one caused this violation.
eod

ATTR: assertion-id
ATTRID: 5
ATTRTYPE: AT_INT
ATTRDESC:: eod
The numeric id representing the type of assertion.
eod

ATTR: attr-id
ATTRID: 6
ATTRTYPE: AT_INT
ATTRDESC:: eod
The numeric id representing the type of assertion.
eod

ATTR: desc
ATTRID: 7
ATTRTYPE: AT_STRING
ATTRDESC:: eod
The optional textual description for the consistency violation.
eod

# end of ConsistencyViolation class

#
# the ConsistencyDetail class
#
CLASS: ConsistencyDetail
CLASSID: 17
CLASSPCV: 4.0.0
CLASSDESC:: eod
Describes the detailed attribute-level errors
for a specific object.
eod

ATTR: obj
ATTRID: 1
ATTRTYPE: AT_OID
ATTRDESC:: eod
Identifies the object for which this detail applies.
The referenced object should be listed in the associated
ConsistencyViolation obj-list.
This attribute is no longer used, except as required for
compatibility with existing Consistency Reports.
eod

ATTR: attrs
ATTRID: 2
ATTRTYPE: AT_NLIST(AT_PACK(BBB*))
# AT_PACK = 36
ATTRVAL: 36
ATTRDESC:: eod
Lists the  attributes that are in conflict with the rule defined
in the associated ConsistencyViolation.
This attribute is no longer used, except as required for
compatibility with existing Consistency Reports.
The encoding of the per-attribute exception information is
terse.  It consists of:

   B  - one byte of attribute id
   B  - one byte of type
   B* - remaining bytes formatted with respect to the type byte:
       type         semantics
        1            string text (null terminated)
        2            attr-error value (1 byte, common +
                     rule-specific semantics)
        3            attr-error value (1 byte) plus null
                     terminated string text
        4            AIC error code (4 bytes)
        5            AIC error code (4 bytes) plus null terminated
                     string text

 Common Attr Error codes (for type 2 and type 3):
   1  - required attribute missing
   2  - invalid attribute data
   3  - unique attribute duplicated
   4  - DNS name unresolvable
   5  - transient attribute trying to be persisted
   6  - schema conversion for this attribute failed
eod

ATTR: classid
ATTRID: 3
ATTRTYPE: AT_SHORT
ATTRDESC:: eod
Defines the class id of the error object.
eod

# New error definition attributes to replace the
# obj and attrs classid attributes
ATTR: error-object
ATTRID: 4
ATTRTYPE: AT_OBJ
ATTRDESC:: eod
Specifies the object that contains this validation error.
eod

ATTR: error-code
ATTRID: 5
ATTRTYPE: AT_INT
ATTRDESC:: eod
Specifies the error code representing this validation error.
eod

ATTR: error-string
ATTRID: 6
ATTRTYPE: AT_STRING
ATTRDESC:: eod
Provides a text description of this error. This string
may be specified to override the standard text associated with
this error code.
eod

ATTR: error-attr-list
ATTRID: 7
ATTRTYPE: AT_NLIST(AT_OBJ(AttrErrorDetail))
ATTRDESC:: eod
Lists the attribute-level errors in this object.
eod

# end of ConsistencyDetail class



CLASS: ScpInfo
CLASSID: 18
CLASSPCV: 4.0.0
CLASSDESC:: eod
Defines the information that a CCM server returns.
eod

ATTR: interfaces
ATTRID: 1
ATTRTYPE: AT_NLIST(AT_PACK(BIS))
# AT_PACK = 36
ATTRVAL: 36
ATTRDESC:: eod
Lists the interfaces, and the version numbers, that this
server supports.  Each pack consists of a type byte and then a
version and an interface name:
   B  - one byte of type (originally 0):
   I  - A version number 32 bit integer
   S  - the null terminated string name of the interface
eod

ATTR: ccm-server-type
ATTRID: 2
ATTRTYPE: AT_ENUMINT(UNKNOWN=0, LOCAL_CCM=1, REGIONAL_CCM=2, CMTS=3)
ATTRDESC:: eod
Identifies the server type:
  0 - UNKNOWN
  1 - LOCAL_CCM
  2 - REGIONAL_CCM
  3 - CMTS
eod

ATTR: product-version
ATTRID: 3
ATTRTYPE: AT_PCV
ATTRDESC:: eod
Identifies the product version number in major, minor, rev form
(x.x.x).
eod

ATTR: compatibility-version
ATTRID: 4
ATTRTYPE: AT_PCV
ATTRDESC:: eod
Identifies the product compatibility version number in major,
minor, rev form (x.x.x).
eod

ATTR: ccm-dbsn
ATTRID: 5
ATTRTYPE: AT_INT
ATTRDESC:: eod
Displays the current DBSN of the CCM datastore.
eod

ATTR: mcd-dbsn
ATTRID: 6
ATTRTYPE: AT_INT
ATTRDESC:: eod
Displays the current DBSN of the MCD datastore.
eod

ATTR: build-string
ATTRID: 7
ATTRTYPE: AT_STRING
ATTRDESC:: eod
Identifies the current build string of the product.
This attribute is primarily useful during development
when the build to version number is not stable.
eod

ATTR: version-string
ATTRID: 8
ATTRTYPE: AT_STRING
ATTRDESC:: eod
The current version string, which may contain more information
than the version number: "T" or "EFT", for example, or patch
release numbers.
eod

# This class is initially needed to convey role information to
# clients, but could also be used to provide further information
# about an interface, so I will call it ScpInterfaceDesc.  Since
# every role has a corresponding interface, this object can
# completely describe a role as well.
CLASS: ScpInterfaceDesc
CLASSID: 19
CLASSVIZ: 3
CLASSDESC:: eod
A description of a CNR user role.
eod

ATTR: name
ATTRID: 1
ATTRTYPE: AT_STRING
ATTRFLAGS: AF_UNIQUE
ATTRDESC::eod
Designates the role name.
eod

ATTR: role-name
ATTRID: 2
ATTRTYPE: AT_STRING
ATTRVIZ: 3
ATTRDESC::eod
Used if we have a different set of names for the roles.
eod

ATTR: sub-roles
ATTRID: 3
ATTRTYPE: AT_NLIST(AT_STRING)
# AT_STRING = 5
ATTRVAL: 5
ATTRVIZ: 3
ATTRDESC::eod
Lists subroles contained in this role.
eod

# Note that the following two lists match the current
# interface/message relationship, but as we gain more
# experience with sub-roles, it may become more useful
# to provide groupings of messages by sub-role.  This
# will require a different structure, perhaps a dictionary
# of list(string) keyed by sub-role name.
ATTR: primary-messages
ATTRID: 4
ATTRTYPE: AT_NLIST(AT_STRING)
# AT_STRING = 5
ATTRVAL: 5
ATTRVIZ: 3
ATTRDESC::eod
The names of the messages for which this interface is primary
eod

ATTR: secondary-messages
ATTRID: 5
ATTRTYPE: AT_NLIST(AT_STRING)
# AT_STRING = 5
ATTRVIZ: 3
ATTRVAL: 5
ATTRDESC::eod
The names of the messages for which this interface is secondary
eod

ATTR: messages
ATTRID: 6
ATTRTYPE: AT_NLIST(AT_OBJ(ScpMessageDesc))
# 1<<16 | 4
ATTRVAL: 65540
ATTRVIZ: 3
ATTRDESC:: eod
The actual message structures for the primary messages
in this interface.
eod

ATTR: desc
ATTRID: 7
ATTRTYPE: AT_STRING
ATTRDESC:: eod
Provides a description for the role.
eod

ATTR: classes
ATTRID: 8
ATTRTYPE: AT_NLIST(AT_OBJ(ClassDesc))
# 1<<16 | 1
ATTRVAL: 65537
ATTRVIZ: 3
ATTRDESC:: eod
The primary classes defined in this interface.
eod

ATTR: secondary-classes
ATTRID: 9
ATTRTYPE: AT_NLIST(AT_STRING)
# AT_STRING = 5
ATTRVAL: 5
ATTRVIZ: 3
ATTRDESC:: eod
The names of the secondary classes used in this interface.
This will not last, since we really need the classes per
sub-role.
eod

ATTR: subrole-list
ATTRID: 10
ATTRTYPE: AT_NLIST(AT_OBJ(SubRoleDesc))
# 1<<16 | 22
ATTRVAL: 65558
ATTRDESC:: eod
Lists objects that describe the subroles available within a
role. Those objects detail which SCP messages and which schema
objects are available with each subrole.
eod

ATTR: constraints
ATTRID: 11
ATTRTYPE: AT_OBJ(ClassDesc)
ATTRVAL: 1
ATTRVIZ: 3
ATTRDESC:: eod
Displays the constraint structure for this role.
eod

ATTR: license
ATTRID: 12
ATTRTYPE: AT_STRING
ATTRDESC:: eod
Displays the license key that must be present for this role to be
available.
eod

ATTR: imp-module
ATTRID: 13
ATTRTYPE: AT_STRING
ATTRDEFVAL: builtin
ATTRVIZ: 3
ATTRDESC:: eod
Displays the path name of a file that provides implementation of
either the message handlers for the primary messages or the
authorization of the secondary messages.  The file suffix is
used to determine the way that its contents are interpreted.
The literal string 'builtin' indicates that the module
implementing this interface is a built in module for the
CCM server.
eod

ATTR: mode
ATTRID: 14
ATTRTYPE: AT_ENUMSTR(local, regional, both)
ATTRDEFVAL: both
ATTRDESC:: eod
Displays the CCM server mode that makes this role available.
eod

ATTR: requires
ATTRID: 15
ATTRTYPE: AT_NLIST(AT_STRING)
ATTRVIZ: 3
ATTRDESC:: eod
Lists module names that this interface requires.  This attribute
allows us to specify which other modules are required for a
given interface to run.
eod

ATTR: type
ATTRID: 16
ATTRTYPE: AT_ENUMSTR(role, module, interface)
ATTRVIZ: 3
ATTRDESC:: eod
Displays the type of the interface.  Lets this specification indicate
whether this is a general interface, or a more specific
authorization-only role or implementation-only module.
eod

#
# the RemoteRequestStatus class
#
CLASS: RemoteRequestStatus
CLASSID: 20
CLASSPCV: 5.0.0
CLASSNAME: 7
CLASSDESC:: eod
Describes an error status detected when performing multiple server
actions as part of handling a single request. The status object is
used to capture all errors encountered by the message handler.
Messages with mixed results, where some portion of the request
succeeds and other portions fail, return a list of these
RemoteRequestStatus objects to describe the secondary failures, and
a partial success status code.
eod

ATTR: server
ATTRID: 1
#ATTRTYPE: AT_OBJREF(CCMCluster)
ATTRTYPE: AT_OID
DEPRECATED: 7.1.0
ATTRVIZ: 1
ATTRDESC:: eod
This attribute is deprecated and replaced by cluster-name.

The cluster that encountered this error. When unset,
localhost is implied.
eod

ATTR: error
ATTRID: 2
ATTRTYPE: AT_INT
ATTRDESC:: eod
Provides the value of the 32-bit error code that describes
this error. This is interpreted as an areturn_t using the
AX_* macros and names.
eod

ATTR: status
ATTRID: 3
ATTRTYPE: AT_INT
DEPRECATED: 7.1.0
ATTRVIZ: 1
ATTRDESC:: eod
The SCP message status code.

This attribute is deprecated.
eod

ATTR: statstr
ATTRID: 4
ATTRTYPE: AT_STRING
ATTRDESC:: eod
Returns a text string describing this error. This string
may be specified to override the standard text associated
with this error code.
eod

ATTR: exception-list
ATTRID: 5
ATTRTYPE: AT_NLIST(AT_OBJ(ConsistencyDetail))
ATTRDESC:: eod
Lists the  ConsistencyDetail objects that describe any
attribute-level errors associated with this error.
eod

ATTR: message-name
ATTRID: 6
ATTRTYPE: AT_STRING
ATTRDESC:: eod
Names the SCP response message that may have triggered
this error.
eod

# New attributes added for Money Train
ATTR: cluster-name
ATTRID: 7
ATTRTYPE: AT_STRING
ATTRDESC:: eod
Names the cluster that encountered this error. When unset,
localhost is implied.
eod

ATTR: server-type
ATTRID: 8
ATTRTYPE: AT_INT
ATTRDESC:: eod
Displays the class ID representing the server on this cluster that
encountered this error.
eod

ATTR: error-time
ATTRID: 9
ATTRTYPE: AT_DATE
ATTRDESC:: eod
Displays the date/time stamp when this error occurred.
eod

# the RemoteRequestStatus class

#
# the Node class
#
CLASS: Node
CLASSID: 21
CLASSDESC:: eod
Manages node relationships in ordered trees of ScpObj
objects. Data in this class is transient and should not be
persisted to the datastore. The OID of the Node is the OID
of the contained (or referenced) ScpObj, masked with a transient
bit. This class is used in conjunction with the GetTreePage and
related Scp messages.
eod

ATTR: object
ATTRID: 1
ATTRTYPE: AT_OBJ
ATTRDESC:: eod
Identifies the ScpObj that this node contains.  This is
optional, as the Node's OID can be converted into the OID
of a referenced ScpObj, but for many trees it will be more
convenient simply to embed the object here.
eod

ATTR: depth
ATTRID: 2
ATTRTYPE: AT_INT
ATTRDESC:: eod
Computes the depth of the specified node, where the root node
has depth 0.
eod

ATTR: parent
ATTRID: 3
ATTRTYPE: AT_OBJREF(Node)
ATTRDESC:: eod
Designates the OID of the node that is the parent of this node.
eod

ATTR: child-order
ATTRID: 4
ATTRTYPE: AT_INT
ATTRDESC:: eod
Gives the index of this child node in its parent's children.
An index of 0 indicates that this is the first child of
the parent node, while an index of parent.child-count-1
indicates that this is the last child of the parent node.
eod

ATTR: child-count
ATTRID: 5
ATTRTYPE: AT_INT
ATTRDEFVAL: 0
ATTRDESC:: eod
Counts the children of this node in the full tree.
eod

ATTR: expansion-state
ATTRID: 6
ATTRTYPE: AT_ENUMINT(expanded=1,collapsed=2)
ATTRDESC:: eod
If set, indicates how to display the specified node:

   1  expanded
   2  collapsed

If unset, the node's expansion is determined by
the default depth of the containing tree.
eod

ATTR: display-only
ATTRID: 7
ATTRTYPE: AT_BOOL
ATTRDESC:: eod
Determines whether the specified node is included for display
only.

If set to true, this node is included for display only, and
should not be presented as an editable or navigable link.

Use a display-only node to provide context for normal nodes;
for example for constrained administrators.
eod

ATTR: has-children
ATTRID: 8
ATTRTYPE: AT_BOOL
ATTRDESC:: eod
Tells whether the specified node has children, which may or may not
be displayed as part of the current tree page.

This node is only set for trees for which the child-count attribute
is not set.  If unset, this attribute should be ignored, that is,
its value should not be presumed to be either true or false.
eod

ATTR: is-first-child
ATTRID: 9
ATTRTYPE: AT_BOOL
ATTRDEFVAL: FALSE
ATTRDESC:: eod
Tells whether the specified node is the first ordered child of
its parent.  This determination is based on the entire list of
siblings, whether or not all of the siblings are displayed as
part of the current tree page.

This node is only set for trees for which the child-order attribute
is not set.
eod

ATTR: is-last-child
ATTRID: 10
ATTRTYPE: AT_BOOL
ATTRDEFVAL: FALSE
ATTRDESC:: eod
Tells whether the specified node is the last ordered child of
its parent.  This determination is based on the entire list of
siblings, whether or not all of the siblings are displayed as
part of the current tree page.

This node is only set for trees for which the child-order attribute
is not set.
eod


# end of Node class


CLASS: SubRoleDesc
CLASSID: 22
CLASSVIZ: 3
CLASSDESC:: eod
Associates an administrator with an authorization subrole.
This class includes information about the server control
protocol (SCP) messages that administrators can send and
the schema classes they can view and modify. The subrole
may only be available if some license requirement is met.
eod

ATTR: name
ATTRID: 1
ATTRTYPE: AT_STRING
ATTRDESC:: eod
Designates the subrole name.
eod

ATTR: desc
ATTRID: 2
ATTRTYPE: AT_STRING
ATTRDESC:: eod
Describes a sub-role.
eod

ATTR: messages
ATTRID: 3
ATTRTYPE: AT_NLIST(AT_STRING)
ATTRVIZ: 1
ATTRDESC:: eod
The messages that are allowed with this subrole (in addition to
the core messages for the interface/role).
eod

ATTR: read-classes
ATTRID: 4
ATTRTYPE: AT_NLIST(AT_STRING)
ATTRVIZ: 1
ATTRDESC:: eod
The object classes that can be read by this subrole.

eod
ATTR: write-classes
ATTRID: 5
ATTRTYPE: AT_NLIST(AT_STRING)
ATTRVIZ: 1
ATTRDESC:: eod
The object classes that can be written by this subrole.

eod
ATTR: class-filters
ATTRID: 6
ATTRTYPE: AT_NDICT(AT_STRING, AT_EXPR)
ATTRVIZ: 1
ATTRDESC:: eod
A dictionary, keyed by class name of the filter constraints
for this role.  We might instead use the ScpClass description
as well, depending on how many distinct per-class attributes
there are for authorization roles.
eod

ATTR: msg-list
ATTRID: 7
ATTRTYPE: AT_NLIST(AT_OBJ(ScpMessageDesc))
ATTRDESC:: eod
Lists objects describing the SCP messages that this role is
authorized to send.
eod

ATTR: class-list
ATTRID: 8
ATTRTYPE: AT_NLIST(AT_OBJ(ClassDesc))
ATTRDESC:: eod
A list of objects describing the schema classes that this role is
authorized to read and/or modify.
eod

ATTR: license
ATTRID: 9
ATTRTYPE: AT_STRING
ATTRDESC:: eod
Identifies the license that must be present and valid to use
a subrole.
eod

#
# OptionDefinitionSet
#

CLASS: OptionDefinitionSet
CLASSID: 23
CLASSNAME: 1
CLASSVIZ: 5
CLASSPCV: 7.0.0
CLASSDESC:: eod
Contains sets of DHCP option definitions. Define one set
for DHCPv4, and another set for DHCPv6. Option definitions
override a server's corresponding built-in definitions.
Also use this class for vendor option definition sets.
You can have as many vendor option definition sets as required.
eod

ATTR: name
ATTRID: 1
ATTRTYPE: AT_STRING
ATTRFLAGS: AF_REQUIRED, AF_UNIQUE
ATTRDESC:: eod
Designates the name of this option definition set.
eod

ATTR: children
ATTRID: 2
ATTRTYPE: AT_NLIST(AT_OBJ(AttrDesc))
# 1<<16 | 2
ATTRVAL: 65538
ATTRFLAGS: AF_JAVADOC
ATTRVIZ: 3
ATTRDESC:: eod
Provides a set of attribute descriptions that define each option
in this option definition set.
eod

ATTR: desc
ATTRID: 3
ATTRTYPE: AT_STRING
ATTRDESC:: eod
Describes this option definition set.
eod

ATTR: parent
ATTRID: 4
ATTRTYPE: AT_STRING
ATTRVIZ: 1
ATTRDESC:: eod
Names the OptionDefinitionSet to which this set belongs.
Currently unused, intended to allow a hierarchy of multiple sets.
eod

ATTR: id-range
ATTRID: 5
ATTRTYPE: AT_ENUMINT(one-byte=1, two-bytes=2, four-bytes=4)
ATTRFLAGS: AF_REQUIRED
ATTRDESC:: eod
Specifies the byte size of the type identifiers for all children
in this set:
   1  one byte
   2  two bytes
   4  four bytes
eod

ATTR: vendor-option-string
ATTRID: 6
ATTRTYPE: AT_STRING
ATTRDESC:: eod
Contains the vendor class identifier string provided by the DHCP
client device vendor in DHCPv4 option-60. The DHCP server uses this
string to identify the DHCP client device and return appropriate
vendor specific option data.
The server ignores this attribute for DHCPv6.
eod

ATTR: vendor-option-enterprise-id
ATTRID: 7
ATTRTYPE: AT_INT
ATTRDESC:: eod
The enterprise identifier.
If defined, contains definitions for any option with AT_VENDOR_OPTS
or AT_VENDOR_CLASS type, such as
   DHCPv6 id 16
   DHCPv6 id 17
   DHCPv4 id 124
   DHCPv4 id 125
This attribute is required for a DHCPv6 vendor option.
This attribute optionally can be set in combination with the
vendor-option-string for a DHCPv4 vendor option.
eod

ATTR: flags
ATTRID: 8
ATTRTYPE: AT_FLAGSINT( builtin=1, customized=2, vendor=3 )
ATTRFLAGS: AF_TRANSIENT
ATTRDESC:: eod
The flags controlling the behavior of this object.
eod


#
# end OptionDefinitionSet class
#

CLASS: ScpMsgErrorDesc
CLASSID: 24
CLASSPCV: 7.0.0
CLASSVIZ: 3
CLASSDESC:: eod
Provides a description of a given error message and general
status codes.  The expected use is that a message
definition (from an mspec file) would contain an errors () clause
like:
   request Msg () ->
               ()
     errors (
       /**
	* Longer description of what is going on with
	* error code 1.  Perhaps using multiple sentences.
	*/
       1: "Short description of error code 1.";

       /**
	* Longer description of what is going on with
	* status GENERAL_ERROR.
	*/
       MS_GENERAL_ERROR: "Short description of GENERAL ERROR
         status code.";
     );
eod

ATTR: code
ATTRID: 1
ATTRTYPE: AT_INT
ATTRDESC:: eod
The error code that is being described.
eod

ATTR: status
ATTRID: 2
ATTRTYPE: AT_INT
ATTRDESC:: eod
The status code that is being described.
eod

ATTR: one-liner
ATTRID: 3
ATTRTYPE: AT_STRING
ATTRDESC:: eod
The one-line description of the error, suitable for printing
in an user-interface.
eod

ATTR: description
ATTRID: 4
ATTRTYPE: AT_STRING
ATTRDESC:: eod
Fully describes this error.
eod


CLASS: ChangeSetFilter
CLASSID: 25
CLASSPCV: 7.0.0
CLASSDESC:: eod
A filter used to limit the set of entries returned by the CCM
server when querying the administration Change Logs in all
datastores.
eod

ATTR: class-name
ATTRID: 1
ATTRTYPE: AT_STRING
ATTRDESC:: eod
The class of objects to be displayed in this filtered view
of the Change Logs.
When unset, no filtering is applied by class name.
eod

ATTR: object-name
ATTRID: 2
ATTRTYPE: AT_STRING
ATTRDESC:: eod
The name of objects to be displayed in this filtered view
of the Change Logs.
When unset, no filtering is applied by object name.
eod

ATTR: start-date
ATTRID: 3
ATTRTYPE: AT_DATE
ATTRDESC:: eod
The earliest date of change entries to be displayed in this
filtered view of the Change Logs.
When unset, no filtering is applied by start date.
eod

ATTR: end-date
ATTRID: 4
ATTRTYPE: AT_DATE
ATTRDESC:: eod
Shows the latest date of change entries to display in this
filtered view of the Change Logs. When unset, no filtering
is applied by end date.
eod

ATTR: admin
ATTRID: 5
ATTRTYPE: AT_STRING
ATTRDESC:: eod
Identifies the administrator who initiated change entries displayed
in a filtered view of the Change Logs. When unset, no filtering is
applied by administrator name.
eod

ATTR: oid
ATTRID: 6
ATTRTYPE: AT_OID
ATTRVIZ: 3
ATTRDESC:: eod
Provides the identifier for the object displayed in this filtered
view of the Change Logs. When unset, no filtering is applied by OID.
eod

ATTR: dbid
ATTRID: 7
ATTRTYPE: AT_INT
ATTRVIZ: 3
ATTRDESC:: eod
Provides the identifier for the database with change entries
displayed in this filtered view of the Change Logs. When unset,
no filtering is applied by database ID.
eod

ATTR: server-type
ATTRID: 8
ATTRTYPE: AT_ENUMSTR(DNS, DHCP, TFTP, MCDSVR, TRAMP, CCM, CMTS, CNRAGENT, RIC, SNMP)
ATTRDESC:: eod
Defines the type of server data displayed in this filtered view
of the Change Logs. The supported server types are DHCP, CCM, and
SNMP. When unset, no filtering is applied by server type.
eod

#
# the AttrDetailError class
#
CLASS: AttrErrorDetail
CLASSID: 26
CLASSPCV: 7.1.0
CLASSDESC:: eod
Describes the specific error associated with one or more
attributes in a given object. A list of AttrErrorDetail
objects is embedded in a ConsistencyDetail object to describe
the validation errors associated with the object.
eod

ATTR: error-code
ATTRID: 1
ATTRTYPE: AT_INT
ATTRDESC:: eod
Provides the error code representing this attribute error.
eod

ATTR: error-string
ATTRID: 2
ATTRTYPE: AT_STRING
ATTRDESC:: eod
Provides an optional text description of this error. This string
may be specified to override the standard text associated with
this error code.
eod

ATTR: attr-id-list
ATTRID: 3
ATTRTYPE: AT_NLIST(AT_BYTE)
ATTRDESC:: eod
Lists the object attribute ids that are in error.
eod

ATTR: format-level
ATTRID: 4
ATTRVIZ: 3
ATTRTYPE: AT_INT
ATTRDESC:: eod
The nesting level to apply to the formatted error string
associated with this error.
eod

ATTR: conflict-object
ATTRID: 5
ATTRTYPE: AT_OBJ
ATTRDESC:: eod
Identifies the pre-existing object that created a conflict
with this object.
eod

ATTR: format-classid
ATTRID: 6
ATTRTYPE: AT_SHORT
ATTRDESC:: eod
Associates a classid with a formatted error string.
eod

# end of AttrErrorDetail class

#
# the Counter class
#
CLASS: Counter
CLASSID: 27
CLASSNAME: 1
CLASSPCV: 7.5.0
CLASSDESC:: eod
A simple transient class that associates a counter value
with a label.
eod

ATTR: label
ATTRID: 1
ATTRTYPE: AT_STRING
ATTRFLAGS: AF_TRANSIENT
ATTRDESC:: eod
Assigns a label to this counter value.
eod

ATTR: type
ATTRID: 2
ATTRTYPE: AT_ENUMINT(none=0,Total=1,Scopes=2,Networks=3,Prefixes=4,Links=5,Zones=6,RRs=7,VPNs=8,FailoverPairs=9)
ATTRDEFVAL: none
ATTRFLAGS: AF_TRANSIENT, AF_PRINT_ALT
ATTRDESC:: eod
Assigns a specific type to this counter value.
   0   none
   1   Total
   2   Scopes
   3   Networks
   4   Prefixes
   5   Links
   6   Zones
   7   RRs
   8   VPNs
   9   FailoverPairs
eod

ATTR: value
ATTRID: 3
ATTRTYPE: AT_INT
ATTRFLAGS: AF_TRANSIENT
ATTRDESC:: eod
Provides the count associated with this counter label.
eod

# end of Counter class

#
# the Filter class
#

CLASS: Filter
CLASSID: 28
CLASSVIZ: 5
CLASSPCV: 7.5.0
CLASSDESC:: eod
An object to filter objects based upon attribute contents.
eod

ATTR: classid
ATTRID: 1
ATTRTYPE: AT_INT
ATTRFLAGS: AF_REQUIRED,AF_IMMUTABLE
ATTRDESC:: eod
The class this filter is used for.
eod

ATTR: filter-element-list
ATTRID: 2
ATTRTYPE: AT_NLIST(AT_OBJ(FilterElement))
# 1 << 16 | FilterElement classid
ATTRVAL: <tbd>
ATTRDESC::eod
The attributes used in this filter.
eod

ATTR: description
ATTRID: 3
ATTRTYPE: AT_STRING
ATTRDESC:: eod
An optional descriptive name for this Filter, which
can be used to identify a saved search.
eod

# end of Filter class

#
# the FilterElement class
#

CLASS: FilterElement
CLASSID: 29
CLASSVIZ: 5
CLASSPCV: 7.5.0
CLASSDESC:: eod
The FilterElement describes the type of matching and match
information for an attribute in a class.
eod

ATTR: attrid
ATTRID: 1
ATTRTYPE: AT_INT
ATTRFLAGS: AF_REQUIRED,AF_IMMUTABLE
ATTRDESC:: eod
The attribute id to be used in the match
eod

ATTR: match-type
ATTRID: 2
ATTRTYPE: AT_ENUMINT(RegularExpression=0, IntegerRange=1, IntegerValue=2, IPRange=3, IPAddress=4, IPSubnet=5, IP6Address=6, IP6Prefix=7, DateRange=8, ExactBinary=9)
ATTRFLAGS: AF_REQUIRED
ATTRDESC::eod
Controls the types of matches that can be performed on an
attribute:

   0   RegularExpression
       Match string regular expression. For data types
       other than AT_STRING, the string parsed value is used.

   1   IntegerRange
       Match integer value within specified range.

   2   IntegerValue
       Match integer value.

   3   IPRange
       Match IP address value within specified range.

   4   IPAddress
       Match IP address value.

   5   IPSubnet
       Match IP address or subnet value contained in
       specified subnet.


   6   IP6Address
       Match IPv6 address value.

   7   IP6Prefix
       Match IPv6 address or prefix value contained in
       specified prefix.

   8   DateRange
       Match AT_DATE value within specified range.

   9   ExactBinary
       Match exact binary value.
eod

ATTR: regexp-str
ATTRID: 3
ATTRTYPE: AT_STRING
ATTRDESC::eod
Defines the regular expression to match.
eod

ATTR: int-start
ATTRID: 4
ATTRTYPE: AT_INT
ATTRDESC::eod
Defines the starting value of an integer range match.
eod

ATTR: int-end
ATTRID: 5
ATTRTYPE: AT_INT
ATTRDESC::eod
Defines the ending value of an integer range match.
eod

ATTR: int-val
ATTRID: 6
ATTRTYPE: AT_INT
ATTRDESC::eod
Defines the integer to match.
eod

ATTR: ip-range
ATTRID: 7
ATTRTYPE: AT_IPPAIR
ATTRDESC::eod
Defines the start and end IPv4 addresses for an IPv4 range match.
eod

ATTR: ip-addr
ATTRID: 8
ATTRTYPE: AT_IPADDR
ATTRDESC::eod
Defines the IPv4 address to match.
eod

ATTR: ip-subnet
ATTRID: 9
ATTRTYPE: AT_SUBNET
ATTRDESC::eod
Defines the containing IPv4 subnet address and length to match.
eod

ATTR: ip6-addr
ATTRID: 10
ATTRTYPE: AT_IP6ADDR
ATTRDESC::eod
Defines the IPv6 address to match.
eod

ATTR: ip6-prefix
ATTRID: 11
ATTRTYPE: AT_PREFIX
ATTRDESC::eod
Defines the containing IPv6 prefix address and length to match.
eod

ATTR: date-start
ATTRID: 12
ATTRTYPE: AT_DATE
ATTRDESC::eod
Defines the start date for a date range match.
eod

ATTR: date-end
ATTRID: 13
ATTRTYPE: AT_DATE
ATTRDESC::eod
Defines the end date for a date range match.
eod

ATTR: blob-val
ATTRID: 14
ATTRTYPE: AT_BLOB
ATTRDESC::eod
Defines the binary large object (blob) value to use for an
exact binary match.
eod

# end of FilterElement class

# Utility classes
# test attribute types
CLASS: Test
CLASSROOT: TEST
CLASSID: 40
CLASSNAME: 1
CLASSVIZ: 0
CLASSDESC:: <eod>
Provides a simple means of testing various data types
and relationships.
<eod>

ATTR: name
ATTRID: 1
ATTRHDRNAME: AO_TEST_NAME
ATTRTYPE: AT_STRING
ATTRMCDPATH: name

ATTR: decint
ATTRID: 2
ATTRHDRNAME: AO_TEST_DECINT
ATTRTYPE: AT_INT
ATTRMCDPATH: decint

ATTR: hexint
ATTRID: 3
ATTRHDRNAME: AO_TEST_HEXINT
ATTRTYPE: AT_INT
ATTRMCDPATH: hexint
ATTRFLAGS: AF_PRINT_ALT

ATTR: tf
ATTRID: 4
ATTRHDRNAME: AO_TEST_TF
ATTRTYPE: AT_BOOL
ATTRMCDPATH: tf

ATTR: onoff
ATTRID: 5
ATTRHDRNAME: AO_TEST_ONOFF
ATTRTYPE: AT_BOOL
ATTRMCDPATH: onoff
ATTRFLAGS: AF_PRINT_ALT

ATTR: time
ATTRID: 6
ATTRHDRNAME: AO_TEST_TIME
ATTRTYPE: AT_TIME
ATTRMCDPATH: time

ATTR: addrs
ATTRID: 7
ATTRHDRNAME: AO_TEST_ADDRS
ATTRTYPE: AT_ARRAY(AT_IPADDR)
ATTRMCDPATH: addrs

ATTR: mac
ATTRID: 8
ATTRHDRNAME: AO_TEST_MAC
ATTRTYPE: AT_MACADDR
ATTRMCDPATH: mac

ATTR: records
ATTRID: 9
ATTRHDRNAME: AO_TEST_RECORDS
ATTRTYPE: AT_LISTREF(ResourceRecord)
ATTRMCDPATH: records
ATTRVAL: 1202

ATTR: options
ATTRID: 10
ATTRHDRNAME: AO_TEST_OPTIONS
ATTRTYPE: AT_ARRAY(AT_STRUCT(Option))
ATTRMCDPATH: options
ATTRVAL: 1103

ATTR: enumint
ATTRID: 11
ATTRTYPE: AT_ENUMINT(red=1,blue=3,green=5)
ATTRMCDPATH: enumint
ATTRDEFVAL: green

ATTR: enumstr
ATTRID: 12
ATTRTYPE: AT_ENUMSTR(ldap, tacacs, tacacs+, mcd, remote)
ATTRMCDPATH: enumstr
ATTRDEFVAL: mcd

ATTR: rangeint
ATTRID: 13
ATTRTYPE: AT_RANGEINT(1-255)
ATTRMCDPATH: rangeint
ATTRDEFVAL: 42

ATTR: flags
ATTRID: 14
ATTRTYPE: AT_FLAGSINT(a,b,c)
ATTRMCDPATH: flags
ATTRDEFVAL: a,c

ATTR: dict
ATTRID: 15
ATTRHDRNAME: AO_TEST_DICT
ATTRTYPE: AT_DICT(AT_BOOL)
ATTRMCDPATH: dict

ATTR: hidden-3
ATTRID: 16
ATTRHDRNAME: AO_TEST_HIDDEN_3
ATTRTYPE: AT_INT
ATTRMCDPATH: hidden-3
ATTRVIZ: 3

ATTR: hidden-1
ATTRID: 17
ATTRHDRNAME: AO_TEST_HIDDEN_1
ATTRTYPE: AT_INT
ATTRMCDPATH: hidden-1
ATTRVIZ: 1

ATTR: date
ATTRID: 18
ATTRHDRNAME: AO_TEST_DATE
ATTRTYPE: AT_DATE
ATTRMCDPATH: date

ATTR: rngtim
ATTRID: 19
ATTRHDRNAME: AO_TEST_RANGETIME
ATTRTYPE: AT_RANGETIME(10000-100000)
ATTRMCDPATH: rngtim

ATTR: eb
ATTRID: 20
ATTRHDRNAME: AO_TEST_EB
ATTRTYPE: AT_ENUMBYTE(a, b, c, d=10)
ATTRMCDPATH: tf

# CLASSID RANGE Common configuration classes 50 - 100
#
# These classes (or records) are used by several configuration
# objects

CLASS: AddrSet
CLASSROOT: ADDRSET
CLASSID: 50
CLASSNAME: 1
CLASSNAMEDESC:: eod
The name of the AddrSet object is the FQDN that the list of
addresses are associated with.  The exact semantics of this FQDN
(and the associated addresses) depend on the location of the
AddrSet object.  In the DNS server root hint list, the FQDN is the
name of a root server and the addresses are the interfaces that
that server is listening on.  In the DNS server resolution
exception list, the FQDN is the name of a domain that should use
the exceptional resolution algorithm, and the address list
contains the addresses of the name servers that should be queried
for information about names in the given domain.
eod
CLASSVIZ: 3
CLASSDESC:: eod
More of a record/struct than a class -- used to model a named,
possibly ordered set of IP addresses, such as the servers to query
for a given domain, or addresses of the root servers.
eod

ATTR: name
ATTRID: 1
ATTRHDRNAME: AO_ADDRSET_NAME
ATTRTYPE: AT_DNSNAME
ATTRMCDPATH: name
ATTRVIZ: 5
ATTRDESC:: eod
Designates the address set.  In the case of resolution exceptions,
it names the domain for which Network Registrar has a list of
resolvers.
eod

ATTR: addrs
ATTRID: 2
ATTRHDRNAME: AO_ADDRSET_ADDRS
ATTRTYPE: AT_ARRAY(AT_IPADDR)
ATTRMCDPATH: addrs
ATTRVIZ: 5
ATTRDESC:: eod
Lists addresses in order.
eod

CLASS: ScriptConfig
CLASSROOT: SCRIPTCONF
CLASSID: 51
CLASSNAME: 1
CLASSPCV: 1.0.0
CLASSNAMEDESC:: eod
The name of a ScriptConfig object has no semantic meaning, but it
must be unique in this cluster.  It is used for matching
extensions with extension points.
eod
CLASSVIZ: 5
CLASSDESC:: eod
A DHCP extension script.
eod

ATTR: name
ATTRID: 1
ATTRHDRNAME: AO_SCRIPTCONF_NAME
ATTRTYPE: AT_STRING
ATTRFLAGS: AF_REQUIRED, AF_UNIQUE, AF_IMMUTABLE
ATTRMCDPATH: Name
ATTRVIZ: 5
ATTRDESC:: eod
Designates the script or module. The DHCP server uses
this name to assign scripts or modules to script points.
eod

ATTR: lang
ATTRID: 2
ATTRHDRNAME: AO_SCRIPTCONF_LANG
ATTRTYPE: AT_ENUMSTR(Tcl, Dex)
ATTRMCDPATH: Language
ATTRVIZ: 5
ATTRDESC:: eod
Describes the language in which the script or module is implemented.
'Tcl' indicates that the module is a Tcl script (tcl8.4). 'Dex'
indicates that the module is a shared object with C calling
interfaces.
eod

ATTR: source
ATTRID: 3
ATTRHDRNAME: AO_SCRIPTCONF_SOURCE
ATTRTYPE: AT_STRING
ATTRMCDPATH: Source
ATTRVIZ: 0
ATTRDESC:: eod
This is not used by the server anymore, but remains
so that the ATTRID does not get reused.
eod

ATTR: file
ATTRID: 4
ATTRHDRNAME: AO_SCRIPTCONF_FILE
ATTRTYPE: AT_STRING
ATTRFLAGS: AF_REQUIRED
ATTRMCDPATH: Filename
ATTRVIZ: 5
ATTRDESC:: eod
Provides the filename relative to the directory extensions in the
installation, or as an absolute pathname, but this cannot contain
a sequence of two dots (..).

eod

ATTR: entry
ATTRID: 5
ATTRHDRNAME: AO_SCRIPTCONF_ENTRYPOINT
ATTRTYPE: AT_STRING
ATTRFLAGS: AF_REQUIRED
ATTRMCDPATH: EntryPoint
ATTRVIZ: 5
ATTRDESC:: eod
Identifies the entry point for the module.  This function is
called from any extension point to which this module is bound.
eod

ATTR: init-entry
ATTRID: 6
ATTRHDRNAME: AO_SCRIPTCONF_INITENTRY
ATTRTYPE: AT_STRING
ATTRMCDPATH: InitEntryPoint
ATTRVIZ: 5
ATTRDESC:: eod
Specifies the  name of the init entry point. If  set, the server
calls this function when the server loads the module.

eod

ATTR: init-args
ATTRID: 7
ATTRHDRNAME: AO_SCRIPTCONF_INITARGS
ATTRTYPE: AT_STRING
ATTRMCDPATH: InitEntryPointArgs
ATTRVIZ: 5
ATTRDESC:: eod
Describes the arguments that should be passed to the init-entry
point function. The arguments are passed in the environment
dictionary using the key "Arguments".
eod

#
# The java class to call
#

ATTR: java-class
ATTRID: 8
ATTRHDRNAME: AO_SCRIPTCONF_CLASS
ATTRTYPE: AT_STRING
ATTRMCDPATH: ClassName
ATTRVIZ: 1
ATTRDESC:: eod
Could be the java class name for this script, but the server
does not implement java extensions.
eod

ATTR: bytes
ATTRID: 9
ATTRHDRNAME: AO_SCRIPTCONF_BYTES
ATTRTYPE: AT_BLOB
ATTRMCDPATH: CompiledBytes
ATTRVIZ: 0
ATTRDESC:: eod
This is not used by the server anymore, but remains
so that the ATTRID does not get reused.
eod

ATTR: api-version
ATTRID: 10
ATTRTYPE: AT_ENUMINT(current=0, pre-7.0=1)
ATTRFLAGS: AF_PRINT_ALT
ATTRDEFVAL: 0
ATTRVIZ: 3
ATTRDESC:: eod
The api-version with which the script is initialized. This
attribute should only be set if the script fails to
initialize if called with the current version.
eod

#
# biannone 12/5/02
# If you give this a CLASSKEY, (which I don't think it needs
# unless you change the naming format in mcd), you'll need to
# update ao_class_get_mcd_key to handle this as special case
# (similar to how ao_class_get_obj_name does).
#
CLASS: Interface
CLASSROOT: INTERFACE
CLASSID: 52
CLASSNAME: 1
CLASSPCV: 1.0.0
CLASSDEPRECATED: 7.0.0
CLASSNAMEDESC:: eod
The name of an Interface object is either the literal string
'default', or its addr and mask values in <address>/<bits> format.
The interface named 'default' is used to provide default values to
auto-discovered interfaces that do not have any configuration
information.  The names of the other interfaces do not have
semantic meaning -- the DHCP server looks at the values for the
addr and mask attributes to determine the IP address and netmask.
eod
CLASSVIZ: 5
CLASSDESC:: eod
The general description of a server interface.
heavily biased by the DHCP interface configuration.
eod

ATTR: addr
ATTRID: 1
ATTRHDRNAME: AO_INTERFACE_IPADDR
ATTRTYPE: AT_IPADDR
ATTRMCDPATH: IPAddress
ATTRVIZ: 5
ATTRDESC:: eod
Specifies the IP address of the interface.
eod

ATTR: mask
ATTRID: 2
ATTRHDRNAME: AO_INTERFACE_NETMASK
ATTRTYPE: AT_MASK
ATTRMCDPATH: NetMask
ATTRVIZ: 5
ATTRDESC:: eod
Specifies the mask of network number bits in the address.
eod

ATTR: type
ATTRID: 3
ATTRHDRNAME: AO_INTERFACE_TYPE
ATTRTYPE: AT_ENUMINT(DHCP, DNS)
ATTRMCDPATH: type
ATTRFLAGS: AF_PRINT_ALT
ATTRVIZ: 3
ATTRDESC:: eod
Determines the type of server (DHCP or DNS) that uses this interface
description.
eod

ATTR: dhcp-port
ATTRID: 13
ATTRHDRNAME: AO_INTERFACE_DHCPPORT
ATTRTYPE: AT_INT
ATTRMCDPATH: DHCPPort
ATTRFEAT: type == DHCP
ATTRVIZ: 3
ATTRDESC:: eod
The port number that the DHCP server should use for this interface.
eod

ATTR: dns-port
ATTRID: 14
ATTRHDRNAME: AO_INTERFACE_DNSPORT
ATTRTYPE: AT_INT
ATTRMCDPATH: DNSPort
ATTRFEAT: type == DHCP
ATTRVIZ: 3

ATTR: ping-port
ATTRID: 15
ATTRHDRNAME: AO_INTERFACE_PINGPORT
ATTRTYPE: AT_INT
ATTRMCDPATH: PingPort
ATTRFEAT: type == DHCP
ATTRVIZ: 3

ATTR: client-port
ATTRID: 16
ATTRHDRNAME: AO_INTERFACE_CLIENTPORT
ATTRTYPE: AT_INT
ATTRMCDPATH: ClientPort
ATTRFEAT: type == DHCP
ATTRVIZ: 3

ATTR: relay-port
ATTRID: 17
ATTRHDRNAME: AO_INTERFACE_RELAYPORT
ATTRTYPE: AT_INT
ATTRMCDPATH: RelayPort
ATTRFEAT: type == DHCP
ATTRVIZ: 3

ATTR: min-buffer-size
ATTRID: 18
ATTRHDRNAME: AO_INTERFACE_MINIMUMSOCKETBUFFERSIZE
ATTRTYPE: AT_INT
ATTRDEFVAL: 16384
ATTRMCDPATH: MinimumSocketBufferSize
ATTRFEAT: type == DHCP
ATTRVIZ: 3

ATTR: ignore
ATTRID: 19
ATTRHDRNAME: AO_INTERFACE_IGNORE
ATTRTYPE: AT_BOOL
ATTRFLAGS: AF_FEATURE
ATTRMCDPATH: Ignore
ATTRVIZ: 5
ATTRDESC:: eod
Indicates that the server should ignore this interface.
You can use this property to temporarily disable a
specific interface in a list of interfaces.
eod

ATTR: dhcp-failover-port
ATTRID: 20
ATTRHDRNAME: AO_INTERFACE_FAILOVER_PORT
ATTRTYPE: AT_INT
ATTRMCDPATH: DHCPFailoverPort
ATTRDEFVAL: 647
ATTRFEAT: type == DHCP
ATTRVIZ: 1
ATTRDESC:: eod
Deprecated in favor of attributes on the DHCP server object.
eod

ATTR: dhcp-failover-remote-port
ATTRID: 21
ATTRHDRNAME: AO_INTERFACE_FAILOVER_REMOTE_PORT
ATTRTYPE: AT_INT
ATTRMCDPATH: DHCPFailoverRemotePort
ATTRFEAT: type == DHCP
ATTRVIZ: 1
ATTRDESC:: eod
Deprecated in favor of attributes on the DHCP server object.
eod


CLASS: DbConfig
CLASSROOT: DBCONFIG
CLASSID: 53
CLASSVIZ: 3
CLASSDESC:: eod
db config object: contains config information for a server's
private database - probably a sleepycat database.
eod

ATTR: flags
ATTRID: 1
ATTRHDRNAME: AO_DBCONFIG_FLAGS
ATTRTYPE: AT_INT
ATTRVIZ: 3
ATTRDESC:: eod
Misc. flags.
eod

ATTR: server-name
ATTRID: 2
ATTRHDRNAME: AO_DBCONFIG_SERVER_NAME
ATTRTYPE: AT_STRING
ATTRVIZ: 3
ATTRDESC:: eod
A printable string naming the server that created this config.
record.
eod

ATTR: version
ATTRID: 3
ATTRHDRNAME: AO_DBCONFIG_VERSION
ATTRTYPE: AT_VERSION
ATTRVIZ: 3
ATTRDESC:: eod
The version of this config record. Interpret this as two bytes of
major version (high), and two bytes of minor version (low).
eod

ATTR: server-version
ATTRID: 4
ATTRHDRNAME: AO_DBCONFIG_SERVER_VERSION
ATTRTYPE: AT_PCV
ATTRVIZ: 3
ATTRDESC:: eod
The 'compatibility' version of the server that created this
record; this comes from product_get_compatibility_version().
eod

ATTR: product-version
ATTRID: 5
ATTRHDRNAME: AO_DBCONFIG_PRODUCT_VERSION
ATTRTYPE: AT_STRING
ATTRVIZ: 3
ATTRDESC:: eod
A printable string form of the product version that created
this record; this comes from product_get_vers_string().
eod

ATTR: build
ATTRID: 6
ATTRHDRNAME: AO_DBCONFIG_BUILD
ATTRTYPE: AT_STRING
ATTRVIZ: 3
ATTRDESC:: eod
A printable string the describes the build date and source; this
comes from program_get_build_string().
eod

ATTR: created
ATTRID: 7
ATTRHDRNAME: AO_DBCONFIG_CREATED
ATTRTYPE: AT_DATE
ATTRVIZ: 3
ATTRDESC:: eod
eod

ATTR: modified
ATTRID: 8
ATTRHDRNAME: AO_DBCONFIG_MODIFIED
ATTRTYPE: AT_DATE
ATTRVIZ: 3
ATTRDESC:: eod
eod

ATTR: dbsn
ATTRID: 10
ATTRHDRNAME: AO_DBCONFIG_DBSN
ATTRTYPE: AT_INT
ATTRVIZ: 5
ATTRDESC:: eod
Displays the highest value DBSN in the database.
eod

ATTR: next-oid
ATTRID: 11
ATTRHDRNAME: AO_DBCONFIG_NEXT_OID
ATTRTYPE: AT_INT
ATTRVIZ: 5
ATTRDESC:: eod
eod

ATTR: indexes
ATTRID: 12
ATTRHDRNAME: AO_DBCONFIG_INDEXES
ATTRTYPE: AT_NLIST(AT_PACK(BSB))
# AT_PACK = 36
ATTRVAL: 36
ATTRVIZ: 5
ATTRDESC:: eod
Displays the array of flags:8, classid:16, attrid: 8 describing the
indexes that this database provides.
eod

ATTR: db-version
ATTRID: 13
ATTRHDRNAME: AO_DBCONFIG_DB_VERSION
ATTRTYPE: AT_STRING
ATTRVIZ: 3
ATTRDESC:: eod
A printable string the describes the database version
comes from db_version().
eod

ATTR: next-taskid
ATTRID: 14
ATTRTYPE: AT_INT
ATTRVIZ: 5
ATTRDESC:: eod
eod

ATTR: dbsn-low
ATTRID: 15
ATTRHDRNAME: AO_DBCONFIG_DBSN_LOW
ATTRTYPE: AT_INT
ATTRVIZ: 5
ATTRDESC:: eod
Displays the lowest value DBSN in the database.
eod


#
# end of DBCONFIG class
#

CLASS: Key
CLASSROOT: KEY
CLASSID: 54
CLASSPCV: 4.0.0
CLASSNAME: 1
CLASSDESC:: eod
A credential, used in features like DNS TSIG.
eod

ATTR: name
ATTRHDRNAME: AO_KEY_NAME
ATTRID: 1
ATTRTYPE: AT_DNSNAME
ATTRFLAGS: AF_UNIQUE, AF_REQUIRED
ATTRVIZ: 3
ATTRDESC:: eod
The name of this key.
eod

ATTR: secret
ATTRHDRNAME: AO_KEY_SECRET
ATTRID: 2
ATTRFLAGS: AF_REQUIRED
ATTRTYPE: AT_KEY
ATTRDESC:: eod
A base64 encoded string used for transaction authentication.
eod

ATTR: algorithm
ATTRHDRNAME: AO_KEY_ALGORITHM
ATTRID: 3
ATTRTYPE: AT_ENUMSTR(hmac-md5)
ATTRDEFVAL: hmac-md5
ATTRDESC:: eod
The algorithm that this key is used with.  Currently we only
support hmac-md5.
eod

ATTR: security-type
ATTRHDRNAME: AO_KEY_SECURITY_TYPE
ATTRID: 4
ATTRTYPE: AT_ENUMSTR(TSIG)
ATTRDEFVAL: TSIG
ATTRDESC:: eod
The type of security that this key is going to be used for.
Currently we only support TSIG keys.
eod

ATTR: time-skew
ATTRHDRNAME: AO_KEY_TIME_SKEW
ATTRID: 5
ATTRTYPE: AT_RANGETIME(1-3600)
ATTRDEFVAL: 300
ATTRDESC:: eod
The time stamp fudge factor (amount that the time values can
differ).
eod
ATTR: id
ATTRID: 6
ATTRTYPE: AT_INT
ATTRVIZ: 5
ATTRDESC:: eod
Displays an integer id for the key.
eod

CLASS: Expression
CLASSID: 55
# the name does not have to exist, remove this if the semantics
# for CLASSNAME are an implied AF_REQUIRED.
CLASSNAME: 8
CLASSPCV: 4.0.0
CLASSDESC:: eod
A parse node object for an expression.  This expression can have an
arbitrarily deep tree of sub-expressions, stored in its args list.
As a hack, perhaps necessary, to support literal values, you can
also store a literal typed value in the val and type attributes
eod
ATTR: op
ATTRTYPE: AT_STRING
ATTRID: 1
ATTRDESC:: eod
The operation for this node.  Currently an unrestricted string,
but should probably become an enum as we pin down the accepted
operators in the expression language.
eod

ATTR: args
ATTRTYPE: AT_NLIST(AT_OBJ(Expression))
# 1<<16 | 55
ATTRVAL: 65591
ATTRID: 2
ATTRDESC:: eod
The list of sub-expressions that this operation is applied to.
These expressions will be evaluated, and their values will
eod

ATTR: arg-signature
ATTRTYPE: AT_STRING
ATTRID: 3
ATTRVIZ: 1
ATTRDESC:: eod
The optional type signature for the argument list.  Not yet
defined, and not yet sure that a string is the best approach, but
an early evaluator implementation could use a string such as 'iii'
to eval and validate the args list as having exactly three integer
values.
eod

ATTR: val
ATTRTYPE: AT_BLOB
ATTRID: 4
ATTRDESC:: eod
The literal value, in raw form, for this expression.  Currently
used for literal, var and funcall nodes, and should only contain
constant values.  The var and funcall nodes store the variable or
function name (or index) in this value.
eod

ATTR: type
ATTRTYPE: AT_INT
ATTRID: 5
ATTRDESC:: eod
The type of the literal value, encoded as an ao_typeid_t.  Use
ScpAttrType to map from string to integer type ids.
eod

ATTR: error-val
ATTRTYPE: AT_BLOB
ATTRID: 6
ATTRDESC:: eod
The literal value to be used if evaluation throws an exception.
eod

ATTR: error-type
ATTRTYPE: AT_INT
ATTRID: 7
ATTRDESC:: eod
The type of the literal value to be used in the face of errors.
eod

ATTR: name
ATTRTYPE: AT_STRING
ATTRID: 8
ATTRDESC:: eod
The name of the expression, used if we start managing persistent,
named expressions.
eod

CLASS: ACL
CLASSID: 56
CLASSNAME: 1
CLASSPCV: 4.0.0
CLASSDESC:: eod
Defines a DNS Access Control List (ACL).
eod

ATTR: name
ATTRTYPE: AT_STRING
ATTRID: 1
ATTRFLAGS: AF_UNIQUE, AF_REQUIRED
ATTRVIZ: 3
ATTRDESC:: eod
The name of the ACL.
eod

ATTR: match-list
ATTRTYPE: AT_AMELST
ATTRID: 2
ATTRDESC:: eod
Displays a comma-separated list of match elements, which
can consist of IP node or subnet addresses, TSIG keys,
or ACLs. You can also use the following reserved words as
elements in a match list:

   any
   none
   localhost
   localnets

To specify more than one element in the match list, enclose
the list in quotation marks; for example:

   "192.168.2.1, localhost"

Use the object name to reference another ACL or TSIG key. A TSIG
key must also be preceded by the keyword <<b>>key<</b>>;
for example,

    key mykey.

You must specify subnet addresses in address/mask format.
Use an exclamation point (!)to negate an entry in the
list; for example,

   "!192.168.3.0/24, !youracl"

Note: You can define the name reference to an ACL in the
match list before you actually create the ACL. But the ACL must
exist before you start or reload the DNS server. If the DNS server
cannot resolve an ACL name reference on either the DNS server
object or a zone object, it will flag the error and will not start.
eod

CLASS: AddressMatchElement
CLASSROOT: AME
CLASSID: 57
CLASSPCV: 4.0.0
CLASSDESC:: eod
Defines a DNS Address Match element, stored in an ACL.
The usage follows BIND conventions. See the BIND 9
documentation for acl and address_match_element.
eod

ATTR: type
ATTRID: 1
ATTRTYPE: AT_ENUMINT(addr=3, net=4, acl=5, key=6, list=7, ipv6=8)
ATTRDESC:: eod
Displays the type of this address match term (element):
   3  addr - match an explicit IP address
   4  net -  match any address in the given subnet
   5  acl -  use a named ACL for further matching
   6  key -  require the named key
   7  list - use an embedded list of address match terms (elements)
   8  ipv6 - match an explicit IPv6 address or subnet
eod

ATTR: negated
ATTRID: 2
ATTRTYPE: AT_BOOL
ATTRDEFVAL: false
ATTRDESC:: eod
Is this term negated?
eod

ATTR: addr
ATTRID: 3
ATTRTYPE: AT_IPADDR
ATTRDESC:: eod
If the type is 'addr', specifies the IP address to use
for the match.
eod

ATTR: net
ATTRID: 4
ATTRTYPE: AT_IPNET
ATTRDESC:: eod
If the type is 'net', specifies the subnet to use for the match.
eod

ATTR: acl
ATTRID: 5
ATTRTYPE: AT_NAMEREF(ACL)
ATTRVAL: 56
ATTRDESC:: eod
If the type is 'acl', specifies the name of the ACL to use for
further matching.
eod

ATTR: key
ATTRID: 6
ATTRTYPE: AT_NAMEREF(Key)
ATTRVAL: 54
ATTRDESC:: eod
If the type is 'key', specifies the name of the TSIG key
to require.
eod

ATTR: list
ATTRID: 7
ATTRTYPE: AT_AMELST
ATTRDESC:: eod
If the type is 'list', specifies the nested list of address
match elements.
eod

ATTR: ipv6
ATTRID: 8
ATTRTYPE: AT_PREFIX
ATTRDESC:: eod
If the type has been set to ipv6, specifies the  IPv6 address
or subnet to use for the match.
eod


# The license class in 7.0 contains the FLEXlm license attributes
# necessary for CNR.
CLASS: License
CLASSID: 58
CLASSNAME: 1
CLASSPCV: 1.0.0
CLASSDESC:: eod
A Network Registrar product license.  As of CNR 7.0, this licensing
scheme was changed from our own proprietary mechanism to now use
the FLEXlm license mechanism.
eod

ATTR: key
ATTRID: 1
ATTRTYPE: AT_STRING
ATTRFLAGS: AF_UNIQUE, AF_REQUIRED
ATTRDESC:: eod
Displays the actual FLEXlm key (signature).
eod

ATTR: type
ATTRID: 2
ATTRTYPE: AT_STRING
ATTRDESC:: eod
Describes what kind of key it is: whether it is one that
Network Registrar's key generator created or that another system
created.  Currently, the only supported type is a key generated
by Network Registrar.
eod

ATTR: key-type
ATTRID: 3
ATTRTYPE: AT_ENUMINT(local-cluster=1, regional-cluster=2, addrspace=3, router=4, ipv4-node=5, ipv6-node=6, ip-node=7, ip-node-sme=8)
ATTRFLAGS: AF_PRINT_ALT
ATTRDESC:: eod
Defines the type of access the license provides:
   7  ip-node
eod

ATTR: expiration
ATTRID: 4
ATTRTYPE: AT_DATE
ATTRDESC:: eod
Displays the date the key expires.
eod

ATTR: node-count
ATTRID: 5
ATTRTYPE: AT_RANGEINT(0-2147483647)
ATTRDESC:: eod
Displays the node count associated with the key.
eod

ATTR: eval
ATTRID: 6
ATTRTYPE: AT_BOOL
ATTRDESC:: eod
Indicates that the key is an evaluation key.
eod

ATTR: comments
ATTRID: 7
ATTRTYPE: AT_NLIST(AT_STRING)
# AT_STRING = 5
ATTRVAL: 5
ATTRDESC:: eod
Contains a list of strings that were comments in the product.licenses
file. These are maintained so that they can be written to the file,
when the licenses are put back into it.
eod

ATTR: valid
ATTRID: 8
ATTRTYPE: AT_BOOL
ATTRDESC:: eod
Indicates that the license object is valid.
eod

ATTR: version
ATTRID: 9
ATTRTYPE: AT_STRING
ATTRDESC:: eod
Displays the Network Registrar version number.
eod

ATTR: flexlm-license
ATTRID: 10
ATTRTYPE: AT_STRING
ATTRVIZ: 3
ATTRDESC:: eod
Displays the actual FLEXlm license contents.
eod

# end of License class

CLASS: UpdateRule
CLASSID: 59
CLASSPCV: 7.0.0
CLASSDESC:: eod
Defines the rule object used for DNS update policies.
eod

ATTR: action
ATTRID: 1
ATTRTYPE: AT_ENUMINT(grant=1, deny=2)
ATTRFLAGS: AF_PRINT_ALT
ATTRDESC:: eod
Determines whether to allow updates that match a specified rule:
   1  grant    allows updates
   2  deny     disallows updates
eod

ATTR: acl
ATTRID: 2
ATTRTYPE: AT_AMELST
ATTRDESC:: eod
Displays the access control list for this rule.
eod

ATTR: keyword
ATTRID: 3
ATTRTYPE: AT_ENUMINT(name=1, wildcard=2, subdomain=3)
ATTRFLAGS: AF_PRINT_ALT
ATTRDESC:: eod
Identifies the type of check performed on update RRs:
   1  name
   2  wildcard
   3  subdomain
eod
ATTR: value
ATTRID: 4
ATTRTYPE: AT_STRING
ATTRDESC:: eod
Specifies the type of name that can be updated.
eod

ATTR: rr-types
ATTRID: 5
ATTRTYPE: AT_NLIST(AT_BLOB)
ATTRDESC:: eod
Specifies one or more record types to which this rule applies.
Record types can also be negated; for example, !A,!TXT.
eod

# end of UpdateRule class
CLASS: UpdatePolicy
CLASSID: 60
CLASSNAME: 1
CLASSPCV: 7.0.0
CLASSDESC:: eod
Defines a DNS Update Policy object used to control updates to
primary zones.
eod

ATTR: name
ATTRID: 1
ATTRTYPE: AT_STRING
ATTRFLAGS: AF_REQUIRED, AF_UNIQUE, AF_IMMUTABLE
ATTRDESC:: eod
Specifies the name of the Update Policy.
eod


ATTR: rules
ATTRID: 2
ATTRTYPE: AT_NLIST(AT_RULE)
ATTRDESC:: eod
Lists rules that make up the update policy. Each rule has the
following syntax:
	<action> <acl-list> <keyword> <value> <rr-list>

action:   Can be grant or deny.
	      grant - will allow an update if the rest of the rule
                  matches.
          deny  - will deny an update if the rest of the rule
                  matches.

acl-list: A list of one or more ip addresses, network addresses,
          keys and/or named acl references. Note key names must be
          prefixed with "key " (i.e. "key key.example" ).

keyword:  Can be name, subdomain or wildcard.
 	      name - used to specify a specific RR.
	      subdomain - used to specify a subdomain name.
	      wildcard - used to specify a name with wildcard
          characters.

value:    The name, sudomain or wildcard value associated with the
          specified keyword. Note that all values specified are
          relative to the zone in which they are applied.
          Therefore it is not necessary to add the zone name to
          the end of the value.
          The supported wildcard characters are:
          *     Will match zero or more characters. For example,
                the pattern dhcp-* matches all strings with the
                dhcp- prefix including the string dhcp-.
          ?     Will match a single character. For example, the
                pattern zone?.com matches zone1.com, zone2.com,
                etc but does not match zone.com
          [...] Will match any characters listed within the
                brackets. For example, you can provide a range
                such as 0-9 or a-z. If the pattern also includes
                the - character, make it the first character in
                the list (i.e. dhcp[-a-z]*)

rr-types: A comma delimited list of RR types for this rule. Each RR
	  type can also be negated using the exclamation point
          (i.e. !A,!TXT). You can also specify all types the an
          asterisk (*).
eod
# end of UpdatePolicy class

#
# the Link class
#

CLASS: Link
CLASSID: 61
CLASSNAME: 1
CLASSPCV: 7.0.0
CLASSDESC:: eod
This object represents a physical network link. Multiple logical IP
networks may be running concurrently on the same link.
eod

ATTR: name
ATTRID: 1
ATTRTYPE: AT_STRING
ATTRFLAGS: AF_REQUIRED,AF_UNIQUE,AF_IMMUTABLE
ATTRDESC:: eod
Provides user-assigned name for the link.
eod

ATTR: description
ATTRID: 2
ATTRTYPE: AT_STRING
ATTRDESC:: eod
Describes the link.
eod

ATTR: refcount
ATTRID: 3
ATTRTYPE: AT_INT
ATTRVIZ: 3
ATTRDESC:: eod
Identifies the number of prefixes associated with this link.
eod

ATTR: policy
ATTRID: 4
ATTRTYPE: AT_NAMEREF(Policy)
ATTRVAL: 1102
ATTRDEFVAL: default
ATTRDESC:: eod
Refers to a shared policy used when replying to clients.
eod

ATTR: embedded-policy
ATTRID: 5
ATTRTYPE: AT_OBJ(Policy)
ATTRDESC:: eod
Refers to a policy embedded within a single specific link object
used when replying to clients.
eod

ATTR: vpn-id
ATTRID: 6
ATTRTYPE: AT_INT
ATTRFLAGS: AF_REFERENCE, AF_IMMUTABLE, AF_INITIALIZE
# Encode attribute 4 of Vpn(1127) as 4<<16 + 1127 == 263271
ATTRVAL: 263271
ATTRDEFVAL: 0
ATTRDESC:: eod
Identifies the VPN that contains the link.
eod

ATTR: owner
ATTRID: 7
ATTRTYPE: AT_NAMEREF(CCMOwner)
ATTRVIZ: 1
ATTRVAL: 1416
ATTRDESC:: eod
Identifies the owner of this link, referenced by name. Owners
can be used to limit administrative access by owner.

(Support for this attribute is deferred beyond 7.0).
eod

ATTR: region
ATTRID: 8
ATTRTYPE: AT_NAMEREF(CCMRegion)
ATTRVIZ: 1
ATTRVAL: 1425
ATTRDESC:: eod
Identifies the region for this link, referenced by name. Regions
can be used to limit administrative access by region.

(Support for this attribute is deferred beyond 7.0).
eod

ATTR: prefix-list
ATTRID: 9
ATTRTYPE: AT_NLIST(AT_OBJ(Prefix))
ATTRVAL: 1141
ATTRFLAGS: AF_TRANSIENT
ATTRDESC:: eod
Lists the prefixes to be associated with the link. This
attribute is used to add or modify the link and its prefixes
in a single database action. All objects must be valid, or none will
be accepted. The associated prefixes will be stored separately,
and will not be returned in the parent link object.
eod

ATTR: template-root-prefix
ATTRID: 10
ATTRTYPE: AT_PREFIX
ATTRFLAGS: AF_TRANSIENT
ATTRDESC:: eod
Identifies the root prefix address for prefixes associated with
the link. This attribute is used when processing a link template
that defines associated prefixes.
eod

ATTR: local-cluster
ATTRID: 11
#ATTRTYPE: AT_OBJREF(CCMFailoverPair|CCMCluster)
ATTRTYPE: AT_OID
ATTRDESC:: eod
Identifies the local DHCP cluster or failover pair
for this regional link.
eod

ATTR: free-address-config
ATTRID: 12
ATTRTYPE: AT_NAMEREF(AddrTrapConfig)
ATTRVAL: 1146
ATTRDESC:: eod
Identifies which trap captures unexpected free address events
on this Link.

If this attribute is not configured, the server looks for
the v6-default-free-address-config on the DHCPServer object.
eod

# end of Link class


#
# the ServerAgentArgs class provides access to the trampoline's
# server information that is used when the server process is
# started.
#

CLASS: ServerAgentArgs
CLASSID: 70
CLASSNAME: 1
CLASSPCV: 8.0.0
CLASSDESC:: eod
This object represents information used by the server agent for each
server process (except CCM). In order to affect a change, the server
agent must typically be restarted.

The name attribute is returned as a transient, read-only value.
To retrieve an object of this class, you must specify the class-id.

Only the enabled and load_args (constructed from nlogs, logsize,
other-log-args) attributes are actually written back to MCD.

Note that config_path, state_path, and hostname have no attributes
as these are not presently used by any server.
eod

ATTR: name
ATTRID: 1
ATTRTYPE: AT_STRING
ATTRFLAGS: AF_TRANSIENT,AF_IMMUTABLE
ATTRDESC:: eod
Identifies the server using the short CNR server name (i.e., DHCP,
DNS, SNMP, ...).
eod

ATTR: class-id
ATTRID: 2
ATTRTYPE: AT_SHORT
ATTRFLAGS: AF_REQUIRED,AF_UNIQUE,AF_IMMUTABLE
ATTRVIZ: 3
ATTRDESC:: eod
Identifies the class-id for the server.
eod

ATTR: enabled
ATTRID: 3
ATTRTYPE: AT_BOOL
ATTRDEFVAL: false
ATTRDESC:: eod
Controls whether the server is started by the server agent.
eod

ATTR: nlogs
ATTRID: 4
ATTRTYPE: AT_RANGEINT(2-100)
ATTRDESC:: eod
Controls the number of logs files maintained by the server.
eod

ATTR: logsize
ATTRID: 5
ATTRTYPE: AT_RANGEINT(10000-500000000)
ATTRDESC:: eod
Controls the size limit, in bytes, of a server's log file. If
the current log file exceeds this size, the log files are
rolled and a new log file is opened.
eod

ATTR: other-load-args
ATTRID: 6
ATTRTYPE: AT_STRING
ATTRDESC:: eod
Identifies arguments, other than nlogs and logsize, passed to
the server when it is started.
eod

ATTR: load-path
ATTRID: 7
ATTRMCDPATH: load_path
ATTRTYPE: AT_STRING
ATTRFLAGS: AF_TRANSIENT,AF_IMMUTABLE
ATTRVIZ: 3
ATTRDESC:: eod
Identifies the load path for the server (usually the same as
the name, though lower cased).
eod

ATTR: mcp-path
ATTRID: 8
ATTRMCDPATH: mcp_path
ATTRTYPE: AT_STRING
ATTRFLAGS: AF_TRANSIENT,AF_IMMUTABLE
ATTRVIZ: 3
ATTRDESC:: eod
Identifies the MCP path for the server (used for MCP messages).
eod

ATTR: ordinal
ATTRID: 9
ATTRTYPE: AT_INT
ATTRFLAGS: AF_TRANSIENT,AF_IMMUTABLE
ATTRVIZ: 3
ATTRDESC:: eod
Identifies the server agent ordinal number for the server.
eod

ATTR: child-process
ATTRID: 10
ATTRMCDPATH: child_process
ATTRTYPE: AT_BOOL
ATTRFLAGS: AF_TRANSIENT,AF_IMMUTABLE
ATTRDEFVAL: false
ATTRVIZ: 3
ATTRDESC:: eod
Identifies whether the server is a mainlib process or not.
If FALSE, this is a mainlib process.
eod

ATTR: child-stdout
ATTRID: 11
ATTRMCDPATH: child_stdout
ATTRTYPE: AT_STRING
ATTRFLAGS: AF_TRANSIENT,AF_IMMUTABLE
ATTRVIZ: 3
ATTRDESC:: eod
Identifies the name of the stdout file for a child process.
eod

ATTR: environment-list
ATTRID: 12
ATTRMCDPATH: environment_list
ATTRTYPE: AT_STRING
ATTRFLAGS: AF_TRANSIENT,AF_IMMUTABLE
ATTRVIZ: 3
ATTRDESC:: eod
Identifies the environment variables set for a child process.
eod

ATTR: load-args
ATTRID: 13
ATTRMCDPATH: load_args
ATTRTYPE: AT_STRING
ATTRFLAGS: AF_TRANSIENT
ATTRVIZ: 1
ATTRDESC:: eod
Internally used for handling the load_args. This attribute is never
returned and ignored if set.
eod

# end of ServerAgentArgs class


#
# DNS 'foreign' server object
#

CLASS: ForeignServer
CLASSROOT: DNS_FS
CLASSID: 100
CLASSPCV: 1.0.0
CLASSNAMEDESC:: eod
Defines a ForeignServer object. The name of the ForeignServer
object encodes its IP address and netmask, and is of the form
<ipaddr>[/<bits>].
Although the ForeignServer object has addr and mask attributes,
the value of these attributes is directly linked to the name of
the object, and changing them will rename the object.  The DNS
server uses the name, rather than the addr and mask attributes
to determine the IP address and netmask.
eod
CLASSVIZ: 5
CLASSNAME: 5
CLASSDESC:: eod
Defines a foreign (remote) DNS server, either exactly
by address, or more generally by subnet.
eod

ATTR: multirec
ATTRID: 1
ATTRHDRNAME: AO_DNS_FS_MULTIREC
ATTRTYPE: AT_BOOL
ATTRFLAGS: AF_FEATURE, AF_REQUIRED
ATTRDEFVAL: false
ATTRMCDPATH: axfr-multirec-flag
ATTRVIZ: 5
ATTRDESC:: eod
Indicates whether or not a foreign server can be sent zone
transfers (AXFR) with multiple records in one TCP "packet." Older
DNS servers will crash when receiving such transfers, despite
being allowed by the protocol specification.
eod

ATTR: ixfr
ATTRID: 2
ATTRHDRNAME: AO_DNS_FS_DOIXFR
ATTRTYPE: AT_BOOL
ATTRFLAGS: AF_FEATURE, AF_REQUIRED
ATTRDEFVAL: false
ATTRMCDPATH: do-ixfr-flag
ATTRVIZ: 5
ATTRDESC:: eod
Indicates whether or not a foreign server supports incremental
transfer and should be queried for incremental (IXFR) before full
(AXFR) when asking for zone transfers. Although unwittingly setting
this to true is generally harmless, doing so may result in
additional transactions to accomplish a zone transfer.
eod

ATTR: addr
ATTRID: 3
ATTRHDRNAME: AO_DNS_FS_ADDRESS
ATTRTYPE: AT_IPADDR
ATTRMCDPATH: address
ATTRVIZ: 3
ATTRDESC:: eod
The address of the server or network to which this information
applies.
eod

ATTR: mask
ATTRID: 4
ATTRHDRNAME: AO_DNS_FS_MASK
ATTRTYPE: AT_RANGEINT(0-32)
ATTRMCDPATH: mask
ATTRVIZ: 3
ATTRDESC:: eod
Specifies the number of significant bits in the addr attribute.
eod

ATTR: name
ATTRID: 5
ATTRTYPE: AT_STRING
ATTRVIZ: 2
ATTRFLAGS: AF_IMMUTABLE
ATTRDESC:: eod
Displays the string form of the address and mask, which is used
as the name of the object containing the remote configuration.
eod

ATTR: key
ATTRID: 6
ATTRTYPE: AT_DNSNAME
ATTRVIZ: 5
ATTRDESC:: eod
Specifies which key to use when communicating with the remote DNS
server.
eod


#
# THE SerialMapping class ONLY LIVES IN "STATE".  HOW ABOUT AN
# AF_STATE FLAG?
#
CLASS: SerialMapping
CLASSROOT: DNS_SERMAP
CLASSID: 101
CLASSNAMEDESC:: eod
The names of these objects encode the serial number they represent
in the form SN%08X.
eod
CLASSVIZ: 1
CLASSDESC:: eod
A mapping of serial number to RR Table generations numbers and
timestamps.  Maintained by the server in MCD state area.
eod

ATTR: serial-time
ATTRID: 1
ATTRHDRNAME: AO_DNS_SERMAP_TIME
ATTRTYPE: AT_DATE
ATTRFLAGS: AF_REQUIRED
ATTRMCDPATH: serial-time
ATTRDESC:: eod
The date and time when this serial number was realized.
eod

ATTR: min-config-gen
ATTRID: 2
ATTRHDRNAME: AO_DNS_SERMAP_MINCONFGEN
ATTRTYPE: AT_INT
ATTRFLAGS: AF_REQUIRED
ATTRMCDPATH: min-config-gen
ATTRDESC:: eod
Lowest generation number of MCD Config RR table holding changes
associated with this serial number.
eod

ATTR: max-config-gen
ATTRID: 3
ATTRHDRNAME: AO_DNS_SERMAP_MAXCONFGEN
ATTRTYPE: AT_INT
ATTRFLAGS: AF_REQUIRED
ATTRMCDPATH: max-config-gen
ATTRDESC:: eod
Highest generation number of MCD Config RR table holding changes
associated with this serial number.
eod

ATTR: min-state-gen
ATTRID: 4
ATTRHDRNAME: AO_DNS_SERMAP_MINSTATEGEN
ATTRTYPE: AT_INT
ATTRFLAGS: AF_REQUIRED
ATTRMCDPATH: min-state-gen
ATTRDESC:: eod
Lowest generation number of MCD State RR table holding changes
associated with this serial number.
eod

ATTR: max-state-gen
ATTRID: 5
ATTRHDRNAME: AO_DNS_SERMAP_MAXSTATEGEN
ATTRTYPE: AT_INT
ATTRFLAGS: AF_REQUIRED
ATTRMCDPATH: max-state-gen
ATTRDESC:: eod
Highest generation number of MCD State RR table holding changes
associated with this serial number.
eod

ATTR: serial-change-count
ATTRID: 6
ATTRHDRNAME: AO_DNS_SERMAP_CHANGECNT
ATTRTYPE: AT_INT
ATTRFLAGS: AF_REQUIRED
ATTRMCDPATH: serial-change-count
ATTRDESC:: eod
Number of change records between this serial number and the
previous one.
eod


CLASS: ResourceLock
CLASSROOT: RESOURCELOCK
CLASSID: 102
CLASSVIZ: 3
CLASSNAME: 1
CLASSDESC:: eod
Creates a lock, and store it in MCD, on a specified resource.
eod

ATTR: username
ATTRID: 1
ATTRHDRNAME: AO_RESOURCELOCK_USERNAME
ATTRTYPE: AT_STRING
ATTRMCDPATH: username
ATTRVIZ: 5
ATTRDESC:: eod
Displays the ID of the originator of the lock.
eod

ATTR: hostname
ATTRID: 2
ATTRHDRNAME: AO_RESOURCELOCK_HOSTNAME
ATTRTYPE: AT_STRING
ATTRMCDPATH: hostname
ATTRVIZ: 5
ATTRDESC:: eod
Displays the Host ID of the originator of the lock.
eod

ATTR: pid
ATTRID: 3
ATTRHDRNAME: AO_RESOURCELOCK_PID
ATTRTYPE: AT_INT
ATTRMCDPATH: pid
ATTRVIZ: 5
ATTRDESC:: eod
Displays the Process ID of the lock originator.
eod

ATTR: role
ATTRID: 4
ATTRHDRNAME: AO_RESOURCELOCK_ROLE
ATTRTYPE: AT_INT
ATTRMCDPATH: role
ATTRVIZ: 5
ATTRDESC:: eod
Displays the Administrative Title of the lock originator.
For example, RootAdmin or WebUI Admin.
eod

ATTR: timestamp
ATTRID: 5
ATTRHDRNAME: AO_RESOURCELOCK_TIMESTAMP
ATTRTYPE: AT_INT
ATTRMCDPATH: timestamp
ATTRVIZ: 5
ATTRDESC:: eod
Displays the time the lock was created.
eod

# CLASSID RANGE SCP Message classes 300 - 500
#
# older version (CNR 5.0) SCP Protocol Message Classes
#
#

CLASS: SCPMessage
CLASSROOT: SCPMESSAGE
CLASSID: 300
CLASSNAME: 3
CLASSVIZ: 0
CLASSPCV: 1.0.0
CLASSDEPRECATED: 4.0.0
CLASSDESC:: eod
The SCPMessage class is used to describe messages that are sent
between processes which are using the CNR Server Control
Protocol. This is the generic message class.
This class is no longer used.  The Message(6) class is used
to describe the current SCP messages and the ScpMessageDesc(4)
class is used to describe the type of a specific message.
eod
ATTR: msgid
ATTRID: 1
ATTRHDRNAME: AO_SCPMESSAGE_MSGID
ATTRTYPE: AT_INT
ATTRMCDPATH: msgid

ATTR: type
ATTRID: 2
ATTRHDRNAME: AO_SCPMESSAGE_TYPE
ATTRTYPE: AT_ENUMINT(none=0, request=1, response=2, error=10)
ATTRMCDPATH: type
ATTRFLAGS: AF_PRINT_ALT

ATTR: name
ATTRID: 3
ATTRHDRNAME: AO_SCPMESSAGE_NAME
ATTRTYPE: AT_STRING
ATTRMCDPATH: name

ATTR: sequence
ATTRID: 4
ATTRHDRNAME: AO_SCPMESSAGE_SEQUENCE
ATTRTYPE: AT_INT
ATTRMCDPATH: sequence

ATTR: strval
ATTRID: 5
ATTRHDRNAME: AO_SCPMESSAGE_STRVAL
ATTRTYPE: AT_STRING
ATTRMCDPATH: strval

ATTR: intval
ATTRID: 6
ATTRHDRNAME: AO_SCPMESSAGE_INTVAL
ATTRTYPE: AT_INT
ATTRMCDPATH: intval

ATTR: oidval
ATTRID: 7
ATTRHDRNAME: AO_SCPMESSAGE_OIDVAL
ATTRTYPE: AT_OID
ATTRMCDPATH: oidval

ATTR: status-str
ATTRID: 8
ATTRHDRNAME: AO_SCPMESSAGE_STATUS_STRING
ATTRTYPE: AT_STRING
ATTRMCDPATH: status-str

ATTR: status
ATTRID: 9
ATTRHDRNAME: AO_SCPMESSAGE_STATUS
ATTRTYPE: AT_INT
ATTRMCDPATH: status

ATTR: xid
ATTRID: 10
ATTRHDRNAME: AO_SCPMESSAGE_XID
ATTRTYPE: AT_INT
ATTRMCDPATH: xid

ATTR: strdict
ATTRID: 11
ATTRHDRNAME: AO_SCPMESSAGE_STRDICT
ATTRTYPE: AT_DICT(AT_STRING)
ATTRMCDPATH: strdict

ATTR: ipval
ATTRID: 12
ATTRHDRNAME: AO_SCPMESSAGE_IPVAL
ATTRTYPE: AT_IPADDR

CLASS: SCPSESSION
CLASSID: 303
CLASSROOT: SCPSESSION
CLASSVIZ: 1

#
# the role of this end of a connection (client or server)
#
ATTR: role
ATTRID: 1
ATTRHDRNAME: AO_SCPSESSION_ROLE
ATTRTYPE: AT_INT
ATTRMCDPATH: role
ATTRDESC:: eod
eod

#
# the security method in use
#
ATTR: security
ATTRID: 2
ATTRHDRNAME: AO_SCPSESSION_SECURITY
ATTRTYPE: AT_INT
ATTRMCDPATH: security
ATTRDESC:: eod
eod

#
# the status of this session
#
ATTR: status
ATTRID: 3
ATTRHDRNAME: AO_SCPSESSION_STATUS
ATTRTYPE: AT_INT
ATTRMCDPATH: status
ATTRDESC:: eod
eod

#
# the access that's been granted to the client
#
ATTR: access
ATTRID: 4
ATTRHDRNAME: AO_SCPSESSION_ACCESS
ATTRTYPE: AT_INT
ATTRMCDPATH: access
ATTRDESC:: eod
eod

#
# the on-the-wire format that's being used
#
ATTR: format
ATTRID: 5
ATTRHDRNAME: AO_SCPSESSION_FORMAT
ATTRTYPE: AT_INT
ATTRMCDPATH: format
ATTRDESC:: eod
eod

#
# the server's version
#
ATTR: server-version
ATTRID: 6
ATTRHDRNAME: AO_SCPSESSION_SERVER_VERSION
ATTRTYPE: AT_INT
ATTRMCDPATH: server-version
ATTRDESC:: eod
eod

#
# the client's version
#
ATTR: client-version
ATTRID: 7
ATTRHDRNAME: AO_SCPSESSION_CLIENT_VERSION
ATTRTYPE: AT_INT
ATTRMCDPATH: client-version
ATTRDESC:: eod
eod

#
# the server's id string
#
ATTR: server-id
ATTRID: 8
ATTRHDRNAME: AO_SCPSESSION_SERVER_ID
ATTRTYPE: AT_STRING
ATTRMCDPATH: server-id
ATTRDESC:: eod
eod

#
# the client's id string
#
ATTR: client-id
ATTRID: 9
ATTRHDRNAME: AO_SCPSESSION_CLIENT_ID
ATTRTYPE: AT_STRING
ATTRMCDPATH: client-id
ATTRDESC:: eod
eod

#
# the client user-name
#
ATTR: user-name
ATTRID: 10
ATTRHDRNAME: AO_SCPSESSION_USER_NAME
ATTRTYPE: AT_STRING
ATTRMCDPATH: user-name
ATTRDESC:: eod
eod

#
# the hostname of the other end of the connection
#
ATTR: peer-name
ATTRID: 11
ATTRHDRNAME: AO_SCPSESSION_PEER_NAME
ATTRTYPE: AT_STRING
ATTRMCDPATH: peer-name
ATTRDESC:: eod
eod

#
# the IP address of the other end of the connection
#
ATTR: peer-address
ATTRID: 12
ATTRHDRNAME: AO_SCPSESSION_PEER_ADDRESS
ATTRTYPE: AT_IPADDR
ATTRMCDPATH: peer-address

#
# CLASSID RANGE Common database classes 1000 - 1099
#

CLASS: Cluster
CLASSROOT: CLUSTER
CLASSID: 1000
CLASSNAME: 1
CLASSVIZ: 3
CLASSDESC:: eod
The cluster object for pre-6.0 user interfaces.  The
description of a cluster has moved to the CCMCluster and
CCMServer objects which are used by the 6.0 and later
user interfaces and management clients.
eod

ATTR: name
ATTRID: 1
ATTRHDRNAME: AO_CLUSTER_NAME
ATTRTYPE: AT_STRING
ATTRMCDPATH: name
ATTRDESC:: eod
The name of this cluster.
eod

CLASS: Admin
CLASSROOT: ADMIN
CLASSID: 1001
CLASSNAME: 1
CLASSNAMEDESC:: eod
The name of the Admin object is the name of the administrator.
eod

CLASSVIZ: 5
CLASSPCV: 1.0.0
CLASSDESC:: eod
An administrator for the cluster.
eod

ATTR: name
ATTRID: 1
ATTRTYPE: AT_STRING
ATTRFLAGS: AF_REQUIRED, AF_UNIQUE
ATTRMCDPATH: name
ATTRVIZ: 3
ATTRDESC:: eod
The name of this administrator.
eod

ATTR: password
ATTRID: 2
ATTRTYPE: AT_CLEARTEXT
ATTRFLAGS: AF_TRANSIENT
ATTRMCDPATH: password
ATTRVIZ: 5
ATTRVAL: 6
ATTRDESC:: eod
Temporarily stores the cleartext password for this
administrator that is used to create the password-secret.
eod

ATTR: groups
ATTRID: 3
ATTRTYPE: AT_NLIST(AT_STRING)
# AT_STRING = 5
ATTRVAL: 5
ATTRDESC:: eod
Lists the names of groups to which this administrator belongs.
eod

ATTR: superuser
ATTRID: 4
ATTRTYPE: AT_BOOL
ATTRDESC:: eod
Indicates whether this administrator is a superuser.
eod

ATTR: nrcmd-flags
ATTRID: 5
ATTRTYPE: AT_ENUMINT(limited=1, full=2)
ATTRFLAGS: AF_PRINT_ALT
ATTRVIZ: 1
DEPRECATED: 7.0
ATTRDESC:: eod
For conversion from nrcmd-based admin access in pre-6.0
releases.  What sort of nrcmd access does this administrator
have.  This value will be mapped into the pre-defined
local cluster administrative roles.
eod

ATTR: password-secret
ATTRID: 6
ATTRTYPE: AT_SECRET
ATTRVIZ: 3
ATTRVAL: 2
ATTRDESC:: eod
The secret object that contains the password for this admin.
eod

ATTR: temp-password
ATTRID: 7
ATTRTYPE: AT_CLEARTEXT
ATTRFLAGS: AF_TRANSIENT
ATTRVIZ: 3
ATTRDESC:: eod
Stores the cleartext password associated with a
temporary local superuser admin.
eod

# CLASSID 1002 - Trap
CLASS: Trap
CLASSROOT: TRAP
CLASSID: 1002
CLASSNAME: 1
CLASSVIZ: 5
CLASSPCV: 1.0.0
CLASSDEPRECATED: 7.0.0
CLASSDESC:: eod
The SNMP trap configuration object.
eod

# Trap ATTRID 1-10: standard
ATTR: name
ATTRID: 1
ATTRHDRNAME: AO_TRAP_NAME
ATTRTYPE: AT_STRING
ATTRFLAGS: AF_INITIALIZE
ATTRDEFVAL: trap
ATTRMCDPATH: Name
ATTRVIZ: 3
ATTRDESC:: eod
The name of this trap object
eod

# Trap ATTRID 11-50: features (mostly flags for individual trap
# types)
ATTR: server-start
ATTRID: 11
ATTRHDRNAME: AO_TRAP_SERVERSTART
ATTRTYPE: AT_BOOL
ATTRFLAGS: AF_FEATURE, AF_INITIALIZE
ATTRDEFVAL: true
ATTRMCDPATH: ServerStart
ATTRVIZ: 5
ATTRDESC:: eod
Sends a trap when a server starts.
eod

ATTR: server-stop
ATTRID: 12
ATTRHDRNAME: AO_TRAP_SERVERSTOP
ATTRTYPE: AT_BOOL
ATTRFLAGS: AF_FEATURE, AF_INITIALIZE
ATTRDEFVAL: true
ATTRMCDPATH: ServerStop
ATTRVIZ: 5
ATTRDESC:: eod
Sends a trap when a server stops normally.
eod

ATTR: free-address-low
ATTRID: 13
ATTRHDRNAME: AO_TRAP_FREEADDRESSLOW
ATTRTYPE: AT_BOOL
ATTRFLAGS: AF_FEATURE, AF_INITIALIZE
ATTRDEFVAL: true
ATTRMCDPATH: FreeAddressLow
ATTRVIZ: 5
ATTRDESC:: eod
Sends a trap when free addresses are below the low threshold.
eod

ATTR: free-address-high
ATTRID: 14
ATTRHDRNAME: AO_TRAP_FREEADDRESSHIGH
ATTRTYPE: AT_BOOL
ATTRFLAGS: AF_FEATURE, AF_INITIALIZE
ATTRDEFVAL: true
ATTRMCDPATH: FreeAddressHigh
ATTRVIZ: 5
ATTRDESC:: eod
Sends a trap when free addresses are above the high threshold.
eod

ATTR: dns-queue-too-big
ATTRID: 15
ATTRHDRNAME: AO_TRAP_DNSQUEUETOOBIG
ATTRTYPE: AT_BOOL
ATTRFLAGS: AF_FEATURE, AF_INITIALIZE
ATTRDEFVAL: true
ATTRMCDPATH: DnsQueueTooBig
ATTRVIZ: 5
ATTRDESC:: eod
Sends a trap when the DHCP queue of DNS messages becomes too large.
eod

ATTR: other-server-not-responding
ATTRID: 16
ATTRHDRNAME: AO_TRAP_OTHERSERVERNOTRESPONDING
ATTRTYPE: AT_BOOL
ATTRFLAGS: AF_FEATURE, AF_INITIALIZE
ATTRDEFVAL: true
ATTRMCDPATH: OtherServerNotResponding
ATTRVIZ: 5
ATTRDESC:: eod
Sends a trap when another server is not responding.
eod

ATTR: other-server-responding
ATTRID: 17
ATTRHDRNAME: AO_TRAP_OTHERSERVERRESPONDING
ATTRTYPE: AT_BOOL
ATTRFLAGS: AF_FEATURE, AF_INITIALIZE
ATTRDEFVAL: true
ATTRMCDPATH: OtherServerResponding
ATTRVIZ: 5
ATTRDESC:: eod
Sends a trap when another server is responding again.
eod

ATTR: duplicate-address
ATTRID: 18
ATTRHDRNAME: AO_TRAP_DUPLICATEADDRESS
ATTRTYPE: AT_BOOL
ATTRFLAGS: AF_FEATURE, AF_INITIALIZE
ATTRDEFVAL: true
ATTRMCDPATH: DuplicateAddress
ATTRVIZ: 5
ATTRDESC:: eod
Sends a trap when a duplicate IP address is detected on a link.
eod

ATTR: address-conflict
ATTRID: 19
ATTRHDRNAME: AO_TRAP_ADDRESSCONFLICT
ATTRTYPE: AT_BOOL
ATTRFLAGS: AF_FEATURE, AF_INITIALIZE
ATTRDEFVAL: true
ATTRMCDPATH: AddressConflict
ATTRVIZ: 5
ATTRDESC:: eod
Sends a trap when a duplicate IP address is detected.
eod

ATTR: dhcp-failover-config-mismatch
ATTRID: 20
ATTRHDRNAME: AO_TRAP_DHCPFAILOVERCONFIGMISMATCH
ATTRTYPE: AT_BOOL
ATTRFLAGS: AF_FEATURE, AF_INITIALIZE
ATTRDEFVAL: true
ATTRMCDPATH: DhcpFailoverConfigMismatch
ATTRVIZ: 5
ATTRDESC:: eod
Sends a trap when DHCP detects a configuration mismatch with its
failover partner.
eod

# Trap ATTRID 51-99: properties
ATTR: free-address-low-threshold
ATTRID: 51
ATTRHDRNAME: AO_TRAP_FREEADDRESSLOWTHRESHOLD
ATTRTYPE: AT_STRING
ATTRFLAGS: AF_INITIALIZE
ATTRDEFVAL: 20%
ATTRMCDPATH: FreeAddressLowThreshold
ATTRVIZ: 5
ATTRDESC:: eod
Specifies the number, or the percentage, of free addresses
that triggers a free-address-low trap and reF-enables the
free-address trap.
eod

ATTR: free-address-high-threshold
ATTRID: 52
ATTRHDRNAME: AO_TRAP_FREEADDRESSHIGHTHRESHOLD
ATTRTYPE: AT_STRING
ATTRFLAGS: AF_INITIALIZE
ATTRDEFVAL: 20%
ATTRMCDPATH: FreeAddressHighThreshold
ATTRVIZ: 5
ATTRDESC:: eod
Specifies the number, or the percentage, of free addresses
that triggers a free-address-high trap and re-enables the free-address
trap.
eod

# CLASSID 1003 - TrapRecipient
CLASS: TrapRecipient
CLASSROOT: TRAPRECIPIENT
CLASSID: 1003
CLASSNAME: 1
CLASSVIZ: 5
CLASSPCV: 1.0.0
CLASSDESC:: eod
Specifies the SNMP trap recipient configuration object.
eod

ATTR: name
ATTRID: 1
ATTRHDRNAME: AO_TRAPRECIPIENT_NAME
ATTRTYPE: AT_STRING
ATTRFLAGS: AF_REQUIRED,AF_UNIQUE
ATTRMCDPATH: Name
ATTRVIZ: 3
ATTRDESC:: eod
Specifies the name of this trap recipient.
eod

ATTR: ip-addr
ATTRID: 2
ATTRHDRNAME: AO_TRAPRECIPIENT_IPADDR
ATTRTYPE: AT_IPADDR
ATTRMCDPATH: IPAddr
ATTRDESC:: eod
Specifies the IP address of this trap recipient.
eod

ATTR: community
ATTRID: 3
ATTRHDRNAME: AO_TRAPRECIPIENT_COMMUNITY
ATTRTYPE: AT_STRING
ATTRMCDPATH: Community
ATTRDESC:: eod
The SNMP community string of this trap recipient
eod

ATTR: port-number
ATTRID: 4
ATTRHDRNAME: AO_TRAPRECIPIENT_PORT
ATTRTYPE: AT_INT
ATTRDEFVAL: 162
ATTRMCDPATH: PortNumber
ATTRDESC:: eod
The optional IP port number of this trap recipient
eod

ATTR: agent-addr
ATTRID: 5
ATTRTYPE: AT_IPADDR
ATTRDESC:: eod
An IP address to use as the source agent-address in traps sent to
this recipient.
eod

CLASS: OSInterface
CLASSID: 1004
CLASSNAME: 3
CLASSPCV: 7.0.0
CLASSDESC:: eod
The description of a network interface reported by the operating
system on a machine that is running CNR.
eod

ATTR: address
ATTRID: 1
ATTRTYPE: AT_IPNET
ATTRDESC:: eod
Specifies the IPv4 address of the interface and its netmask.
eod

ATTR: flags
ATTRID: 2
ATTRTYPE: AT_FLAGSINT(zero-broadcast=1,virtual=2,no-multicast=3,receive-only=4,pseudo=5)
ATTRDESC:: eod
Various flags for the interface:
  zero-broadcast - set if interface should use the all-0's
                   host address for broadcast packets (IPv4)
  virtual        - set if a virtual interface (IPv4)
  no-multicast   - set if interface cannot use multicast (IPv6)
  receive-only   - set if interface can only receive packets (IPv6)
  pseudo         - set if a pseudo interface (IPv6)
eod
ATTR: name
ATTRID: 3
ATTRTYPE: AT_STRING
ATTRDESC:: eod
A name for the interface, based on the device name
(e.g. '/dev/le'), or an IP address.
eod

ATTR: index
ATTRID: 4
ATTRTYPE: AT_INT
ATTRDESC:: eod
An OS-specific index number for this interface.
eod

ATTR: ip6address
ATTRID: 5
ATTRTYPE: AT_IP6NET
ATTRDESC:: eod
Specifies the IPv6 address and prefix length in use on this
interface.
eod



# CLASSID RANGE DHCP classes 1100 - 1199
#
# D H C P Server
# DHCP SERVER
#

CLASS: DHCPServer
CLASSROOT: DHCPSERVER
CLASSID: 1100
CLASSNAME: 1
CLASSNAMEDESC:: eod
In Network Registrar, there is only one DHCP server per cluster,
and DHCP servers are not referenced by name.
eod
CLASSVIZ: 5
CLASSPCV: 1.0.0
CLASSDESC:: eod
The global configuration attributes for the DHCP server.
eod

ATTR: name
ATTRID: 1
ATTRHDRNAME: AO_DHCPSERVER_NAME
ATTRTYPE: AT_STRING
ATTRMCDPATH: name
ATTRDEFVAL: DHCP
ATTRVIZ: 3
ATTRDESC:: eod
The name of this server.
eod
# from mcdconfig

ATTR: initial-background-timer-sleep-time
ATTRID: 3
ATTRHDRNAME: AO_DHCPSERVER_INITIALBACKGROUNDTIMERSLEEPTIME
ATTRTYPE: AT_INT
ATTRMCDPATH: InitialBackgroundTimerSleepTime
ATTRDEFVAL: 5
ATTRVIZ: 3
ATTRDESC:: eod
Specifies the length of time the background timer thread will
sleep at server startup time.
eod

ATTR: max-dhcp-requests
ATTRID: 4
ATTRHDRNAME: AO_DHCPSERVER_MAXDHCPREQ
ATTRTYPE: AT_INT
ATTRFLAGS: AF_REQUIRED
ATTRDEFVAL: 500
ATTRMCDPATH: MaximumNumberOfDhcpRequests
ATTRVIZ: 5
ATTRDESC:: eod
Controls the number of buffers that the DHCP server allocates
for receiving client requests.

When you enable failover, allocate at least 150 buffers. Up to
1500 buffers might be reasonable for high capacity
installations.

Caution: Increasing the number of buffers can degrade
performance. Cisco recommends using the default value
in most situations. When buffer size exceeds capacity, a burst
of DHCP activity can clog the server with requests that become
stale before they are processed. This increases the processing
load and might severely degrade performance as clients try to
obtain a new lease. A lower buffer setting throttles requests
and avoids wasted processing on requests that would otherwise be
stale.

When using LDAP client lookups, buffers should not exceed the
LDAP lookup queue size defined by the total number of LDAP
connections and the maximum number of requests allowed for each
connection. Set the LDAP queue size to match the LDAP servers
capacity to service client lookups.
eod

ATTR: max-dhcp-responses
ATTRID: 5
ATTRHDRNAME: AO_DHCPSERVER_MAXDHCPRESP
ATTRTYPE: AT_INT
ATTRFLAGS: AF_REQUIRED
ATTRDEFVAL: 1000
ATTRMCDPATH: MaximumNumberOfDhcpResponses
ATTRVIZ: 5
ATTRDESC:: eod
Controls the number of buffers that the DHCP server allocates
for responses to client requests. The server ignores this
value if max-dhcp-requests is higher, or other configuration
options such as failover require that the value be set higher
than configured.
eod

ATTR: max-ping-packets
ATTRID: 6
ATTRHDRNAME: AO_DHCPSERVER_MAXIMUMNUMBEROFPINGPACKETS
ATTRTYPE: AT_INT
ATTRMCDPATH: MaximumNumberOfPingPackets
ATTRVIZ: 5
ATTRDEFVAL: 500
ATTRDESC:: eod
Sets the number of buffers the server allocated for sending and
receiving ICMP ping messages. See the scope 'ping-clients'
command.
eod

ATTR: min-client-packet-size
ATTRID: 7
ATTRHDRNAME: AO_DHCPSERVER_MINIMUMCLIENTPACKETSIZE
ATTRTYPE: AT_INT
ATTRDEFVAL: 576
ATTRMCDPATH: MinimumClientPacketSize
ATTRVIZ: 3
ATTRDESC:: eod
Sets the minimum packet size to return to the client.
eod

ATTR: num-ping-threads
ATTRID: 8
ATTRHDRNAME: AO_DHCPSERVER_NUMBEROFPINGSERVERTHREADS
ATTRTYPE: AT_INT
ATTRMCDPATH: NumberOfPingServerThreads
ATTRVIZ: 1
DEPRECATED: 4.0

ATTR: old-states-to-keep
ATTRID: 9
ATTRHDRNAME: AO_DHCPSERVER_OLDSTATESTOKEEP
ATTRTYPE: AT_INT
ATTRMCDPATH: OldStatesToKeep
ATTRVIZ: 1

ATTR: ping-thread-heap-size
ATTRID: 10
ATTRHDRNAME: AO_DHCPSERVER_PINGSERVERTHREADHEAPSIZE
ATTRTYPE: AT_INT
ATTRMCDPATH: PingServerThreadHeapSize
ATTRVIZ: 1
DEPRECATED: 4.0

ATTR: timer-thread-heap-size
ATTRID: 11
ATTRHDRNAME: AO_DHCPSERVER_TIMERQUEUETHREADHEAPSIZE
ATTRTYPE: AT_INT
ATTRMCDPATH: TimerQueueThreadHeapSize
ATTRVIZ: 3
ATTRDESC:: eod
Controls the heap size that the DHCP server allocates for
threads servicing the timer queue.
eod

ATTR: udp-packet-size
ATTRID: 12
ATTRHDRNAME: AO_DHCPSERVER_UDPPACKETSIZE
ATTRTYPE: AT_INT
ATTRMCDPATH: UDPPacketSize
ATTRDEFVAL: 1536
ATTRVIZ: 3
ATTRDESC:: eod
Controls the UDP packet size to be used by the server.
eod

ATTR: ping-queue-timeout-factor
ATTRID: 13
ATTRHDRNAME: AO_DHCPSERVER_PINGQUEUETIMEOUTFACTOR
ATTRTYPE: AT_INT
ATTRMCDPATH: PingQueueTimeoutFactor
ATTRFLAGS: AF_INITIALIZE
ATTRDEFVAL: 2
ATTRVIZ: 3
ATTRDESC:: eod
(NT 3.51 only) The number of scope ping timeouts that the server
will wait for until it decides that an address is not in use.  In
each scope there is a ping timeout number, which is the number of
milliseconds that the ping subsystem waits for a response.
eod

ATTR: max-dns-packets
ATTRID: 14
ATTRHDRNAME: AO_DHCPSERVER_MAXIMUMNUMBEROFDNSPACKETS
ATTRTYPE: AT_INT
ATTRFLAGS: AF_REQUIRED
ATTRMCDPATH: MaximumNumberOfDnsPackets
ATTRDEFVAL: 500
ATTRVIZ: 1
DEPRECATED: 7.0
ATTRDESC:: eod
Controls the number of the buffers that the DHCP server allocates
for sending dynamic updates to the DNS server.
eod

ATTR: dyndns-packet-size
ATTRID: 15
ATTRHDRNAME: AO_DHCPSERVER_DYNAMICDNSPACKETSIZE
ATTRTYPE: AT_INT
ATTRFLAGS: AF_REQUIRED
ATTRMCDPATH: DynamicDnsPacketSize
ATTRDEFVAL: 512
ATTRVIZ: 3
ATTRDESC:: eod
Controls the size of the packets that the DHCP server uses for
dynamic updates to a DNS server.  Do not change this value unless
instructed by Technical Support.
eod

ATTR: max-dns-retries
ATTRID: 16
ATTRHDRNAME: AO_DHCPSERVER_MAXIMUMDNSRETRIES
ATTRTYPE: AT_INT
ATTRFLAGS: AF_REQUIRED
ATTRMCDPATH: MaximumDnsRetries
ATTRDEFVAL: 3
ATTRVIZ: 5
ATTRDESC:: eod
Controls the number of times that the DHCP server can try to
send dynamic updates to a DNS server.
eod

ATTR: max-dns-renaming-retries
ATTRID: 17
ATTRHDRNAME: AO_DHCPSERVER_MAXIMUMDNSRENAMINGRETRIES
ATTRTYPE: AT_INT
ATTRFLAGS: AF_REQUIRED
ATTRMCDPATH: MaximumDnsRenamingRetries
ATTRDEFVAL: 3
ATTRVIZ: 5
ATTRDESC:: eod
Controls the number of times that the DHCP server can attempt
adding a host into DNS, even if the DHCP server detects that the
hostname is already present in DNS.  The DHCP server attempts
to modify the hostname in order to resolve a conflict on each
failed update.
eod

ATTR: dns-timeout
ATTRID: 18
ATTRHDRNAME: AO_DHCPSERVER_DNSTIMEOUT
ATTRTYPE: AT_INT
ATTRFLAGS: AF_REQUIRED
ATTRMCDPATH: DnsTimeout
ATTRDEFVAL: 60000
ATTRVIZ: 5
ATTRDESC:: eod
Controls the number of milliseconds that the DHCP server waits
for a response before retrying dynamic DNS requests.
eod

ATTR: max-dns-ttl
ATTRID: 19
ATTRHDRNAME: AO_DHCPSERVER_MAXIMUMDNSRECORDTTL
ATTRTYPE: AT_INT
ATTRFLAGS: AF_REQUIRED
ATTRMCDPATH: MaximumDnsRecordTTL
ATTRDEFVAL: 86400
ATTRVIZ: 5
ATTRDESC:: eod
Sets the time to live (TTL) ceiling, in seconds, for DNS records
added through dynamic updates. When the DHCP server adds a DNS
record, it uses a TTL of the minimum of either this ceiling or one
third the lease time.
eod

ATTR: use-mac-address-to-host-table
ATTRID: 20
ATTRHDRNAME: AO_DHCPSERVER_MACADDRESSTOHOSTTABLE
ATTRTYPE: AT_BOOL
ATTRMCDPATH: MACAddressToHostTable
ATTRFLAGS: AF_INITIALIZE
ATTRDEFVAL: 0
ATTRVIZ: 3

ATTR: one-shot-grace-interval
ATTRID: 21
ATTRHDRNAME: AO_DHCPSERVER_ONESHOTGRACEINTERVAL
ATTRTYPE: AT_INT
ATTRMCDPATH: OneShotGraceInterval
ATTRVIZ: 1
DEPRECATED: 7.1
ATTRDESC:: eod
Sets the grace interval within which a client can come back with
a request for a one-shot lease.
eod

ATTR: mac-address-only
ATTRID: 22
ATTRHDRNAME: AO_DHCPSERVER_USEMACADDRESSONLY
ATTRTYPE: AT_BOOL
ATTRFLAGS: AF_FEATURE, AF_INITIALIZE
ATTRMCDPATH: UseMACAddressOnly
ATTRDEFVAL: false
ATTRVIZ: 5
ATTRDESC:: eod

Controls whether the DHCP server uses the clients MAC
address as the only client identifier. The standard behavior,
as specified in RFC 2132, is to use the client-id option (if it
is present) as the unique client identifier. Default is false
(disable).

CAUTION: Use this attribute with care. When enabled, it
precludes a MAC address from getting multiple IP addresses per
network. It forces the server to use a Client-Identifier (CID)
created from the MAC address instead of the RFC described
client-id contained in the request. This can preclude newer
devices that take multiple IP addresses. Enabling, or later
disabling, this attribute can also have an operational impact.
Clients that originally obtain addresses through a client-id
cannot renew them once they are assigned attributes based on
a MAC address.

eod
ATTR: one-lease-per-client
ATTRID: 23
ATTRHDRNAME: AO_DHCPSERVER_ONELEASEPERCLIENT
ATTRTYPE: AT_ENUMINT(disabled=0, last-client-preferred=1, first-client-preferred=2)
ATTRFLAGS: AF_PRINT_ALT
ATTRDEFVAL: 0
ATTRMCDPATH: OneLeasePerClient
ATTRVIZ: 5
ATTRDESC:: eod
Controls whether the DHCP server releases other leases a client
might have on other LAN segments on this server.

   0   disabled
   1   last-client-preferred
   2   first-client-preferred

Within one LAN segment, the DHCP server never allocates more
than one DHCPv4 address to a single client. Across multiple
independent network LAN segments, however, a single client
might have one address allocated on several networks.

In an enterprise environment this might happen when a laptop
user travels from building to building, causing no particular
problems. In a service provider context, this might happen when
an unapproved user attempts to clone the MAC address of a
legitimate subscriber, causing a theft of service.

The one-lease-per-client feature limits a single client to one
lease over all of the networks configured on the DHCP server.
This limit only affects a client's ability to have concurrent
leases to different IP addresses on more than one network at
a time on the DHCP server.

In the last-client-preferred approach, the client with the most
recent lease is given preference, and any other leases held by
the same client are released.

In the first-client-preferred approach, the first lease that a
particular client receives from the DHCP server is the only
lease that client is allowed.  In the event that the client
moves, the first lease must be made available (perhaps by a
force-available command or by letting it expire) before the
client is allowed to lease another IP address on a different
network.

Caution: Use the first-client-preferred approach with great
care, since manual intervention might be required to ensure
proper operation.

Both forms of one-lease-per-client require additional bookkeeping
overhead beyond that normally done in the DHCP server.
eod
ATTR: client-class
ATTRID: 24
ATTRHDRNAME: AO_DHCPSERVER_CLIENTCLASSENABLED
ATTRTYPE: AT_BOOL
ATTRFLAGS: AF_FEATURE, AF_INITIALIZE
ATTRDEFVAL: false
ATTRMCDPATH: ClientClassEnabled
ATTRVIZ: 5
ATTRDESC:: eod
Controls how the DHCP server uses the client and client-class
configuration objects to affect request processing. Default is
false (disabled).

eod
ATTR: import-mode
ATTRID: 25
ATTRHDRNAME: AO_DHCPSERVER_IMPORTMODE
ATTRTYPE: AT_BOOL
ATTRFLAGS: AF_FEATURE, AF_INITIALIZE
ATTRDEFVAL: false
ATTRMCDPATH: ImportMode
ATTRVIZ: 5
ATTRDESC:: eod

Controls whether the DHCP server recognizes only packets
generated from the import leases command, ignoring all
others. Default is false (disable).

Use this attribute to update your DHCP server, preventing
clients from receiving addresses during this period.

eod

ATTR: timeout-retry-delay
ATTRID: 26
ATTRHDRNAME: AO_DHCPSERVER_TIMEOUTRETRYDELAYPERIOD
ATTRTYPE: AT_TIME
ATTRMCDPATH: TimeoutRetryDelayPeriod
ATTRDEFVAL: 10
ATTRVIZ: 3
ATTRDESC:: eod
If a lease has timed out but no response buffers are available to
process it immediately, the lease will be re-queued for this number
of seconds.
eod

ATTR: log-settings
ATTRID: 27
ATTRHDRNAME: AO_DHCPSERVER_VERBOSELOGGING
ATTRTYPE: AT_FLAGSINT( default=1, incoming-packets=2, missing-options=3, incoming-packet-detail=4, outgoing-packet-detail=5, unknown-criteria=6, dns-update-detail=7, client-detail=8, client-criteria-processing=9, failover-detail=10, ldap-query-detail=11, ldap-update-detail=12, ldap-create-detail=13, leasequery=14, dropped-waiting-packets=15, no-success-messages=16, no-dropped-dhcp-packets=17, no-dropped-bootp-packets=18, no-failover-activity=19, activity-summary=20, no-invalid-packets=21, no-reduce-logging-when-busy=22, no-timeouts=23, minimal-config-info=24, no-failover-conflict=25, atul-detail=26, v6-lease-detail=27 )
ATTRDEFVAL: default,incoming-packets,missing-options
ATTRMCDPATH: VerboseLogging
ATTRVIZ: 5
ATTRDESC:: eod
Determines which events to log in the log files. Default flags are
default, incoming-packets, and missing-options.

Logging additional detail about events can help analyze a problem.
However, leaving detailed logging enabled for a long period
can fill up the log files.

Possible flags are:
  default
    The default gives a low level of logging in several parts of
    the DHCP server.  If you unconfigure the default, even this
    logging will not appear.
  missing-options
    This setting (on by default) will cause a message to be logged
    whenever an option requested by a DHCP client has not been
    configured in a policy and therefore cannot be supplied by the
    DHCP server.
  incoming-packets
    This setting (on by default) will cause a single line message
    to be logged for every incoming packet.  This is especially
    useful when initially configuring a DHCP server or a BOOTP
    relay, in that an immediate positive indication exists that
    the DHCP server is receiving packets.
  incoming-packet-detail
    This setting will cause the contents of every DHCP packet
    received by the DHCP server to be interpreted in a human
    readable way and printed in the log file.  This enables the
    built-in DHCP packet sniffer for input packets.  The log files
    will fill up (and turn over) very rapidly when this setting is
    enabled.  This setting also causes a significant performance
    impact on the DHCP server and should not be left enabled as a
    matter of course.
  outgoing-packet-detail
    This setting will cause the contents of every DHCP packet
    transmitted by the DHCP server to be interpreted in a human
    readable way and printed in the log file.  This enables the
    built-in DHCP packet sniffer for output packets.  The log files
    will fill up (and turn over) very rapidly when this setting is
    enabled.  This setting also causes a significant performance
    impact on the DHCP server and should not be left enabled as a
    matter of course.
  client-detail
    This setting will cause a single line to be logged at the
    conclusion of every client-class client lookup operation.  This
    line will show the composite of the data found for the client
    as well as the data that found in the client's client-class.
    It is useful when setting up a client-class configuration and
    for debugging problems in client-class processing.
  client-criteria-processing
    This setting will cause a log message to be output whenever a
    scope is examined to find an available lease or whenever a
    scope is examined to determine if a lease is still acceptable
    for a client who already has one.  It can be very useful when
    configuring or debugging client-class scope criteria
    processing.  It causes moderate amount of information to be
    logged and should not be left enabled as a matter of course.
  unknown-criteria
    This setting will cause a single line log message to appear
    whenever a client entry is found which specifies selection
    criteria that is not found in any scope appropriate for that
    client's current network location.
  dns-update-detail
    This setting causes the server to log a message as it sends
    each dns update and as it receives replies to update messages.
  ldap-query-detail
    This setting will cause log messages to appear whenever the
    dhcp server initiates a query to LDAP server, receives response
    and retrieves result or error messages.
  ldap-update-detail
    This setting will cause log messages to appear whenever the
    dhcp server initiates an update lease state to LDAP server,
    receives response and retrieves result or error messages.
  ldap-create-detail
    This setting will cause log messages to appear whenever the
    dhcp server initiates an lease state entry create to LDAP
    server, receives response and retrieves result or error
    messages.
  leasequery
    This setting will cause log messages to appear when leasequery
    packets are processed without internal errors and result in
    an ACK or a NAK.
  dropped-waiting-packets
    If the value of max-waiting-packets is non-zero packets may
    be dropped if the queue length for any IP address exceeds the
    value of max-waiting-packets.  If dropped-waiting-packets
    is set, the server will log a message whenever it drops a
    waiting packet from the queue for an IP address.
  no-success-messages
    This setting will cause the single line message that is
    normally logged for every successful outgoing DHCP response
    packet to not appear.  It affects logging only for successful
    outgoing DHCP response packets.
  no-dropped-dhcp-packets
    This setting will cause a single line message normally logged
    for every DHCP packet that is dropped due to DHCP
    configuration to not appear.  (See no-invalid-packets for
    messages associated with packets dropped because they are
    invalid.)
  no-dropped-bootp-packets
    This setting will cause the single line message normally
    logged for every BOOTP packet that is dropped to not appear.
  no-failover-activity
    This setting will cause normal activity and some warning
    messages logged for failover to not appear.  Serious error
    log messages will continue to appear independent of this
    log-setting.
  activity-summary
    This setting will cause a summary message to appear every 5
    minutes.  It is useful when many of the no-xxx log settings
    are enabled, to give some idea of the activity in the server
    without imposing the load required for a log message
    corresponding to each DHCP message.  The time period for
    these messages can be configured with the DHCP server
    property activity-summary-interval.
  no-invalid-packets
    This setting will cause a single line message normally logged
    for every DHCP packet that is dropped due being invalid to
    not appear.  (See no-dropped-dhcp-packets for messages
    associated with packets dropped due to DHCP server
    configuration.)
  no-reduce-logging-when-busy
    Normally, the DHCP server will reduce logging when it becomes
    very busy (i.e., when it has used over 2/3 of the available
    receive buffers (itself a configurable value)).  It will set
    no-success-messages, no-dropped-dhcp-packets,
    no-dropped-bootp-packets, no-failover-activity,
    no-invalid-packets, and clear everything else except
    activity-summary.  If no-reduce-logging-activity is set, then
    the server will not do this.  It will restore the previous
    settings when the server becomes unbusy (i.e., when it has
    used only 1/3 of the available receive buffers).
  no-timeouts
    This setting will cause messages associated with timeout
    of leases or offers not to appear in the log file.
  minimal-config-info
    This setting will reduce the number of configuration messages
    printed when the server starts or reloads.  In particular,
    it will not log a message for every scope.
  no-failover-conflict
    This setting will cause conflicts between failover partners
    to not be logged.
  atul-detail
    This setting causes the server to log messages when ATUL
    messages are received and processed.
  v6-lease-detail
    This setting causes the server to log individual messages
    regarding DHCPv6 leasing activity (in addition to or in
    place of a single message per client transaction depending
    on no-success-messages, or client timeout event depending on
    no-timeouts).
eod

ATTR: min-working-set-size
ATTRID: 28
ATTRHDRNAME: AO_DHCPSERVER_MINWORKINGSETSIZE
ATTRTYPE: AT_INT
ATTRMCDPATH: MinWorkingSetSize
ATTRDEFVAL: 1000000
ATTRVIZ: 3
ATTRDESC:: eod
For NT platforms, defines the server's minimum working set size.
eod

ATTR: max-working-set-size
ATTRID: 29
ATTRHDRNAME: AO_DHCPSERVER_MAXWORKINGSETSIZE
ATTRTYPE: AT_INT
ATTRMCDPATH: MaxWorkingSetSize
ATTRDEFVAL: 4000000
ATTRVIZ: 3
ATTRDESC:: eod
For NT platforms, defines the server's maximum working set size.
eod

ATTR: scope-selection-tags
ATTRID: 30
ATTRHDRNAME: AO_DHCPSERVER_ATTRIBUTES
ATTRTYPE: AT_SET(AT_STRING)
ATTRMCDPATH: attributes
ATTRVIZ: 1
DEPRECATED: 5.0
ATTRDESC:: eod
Deprecated in CNR 6.1

The list of scope selection tags associated with this scope. In
this context the term tags refers to a named entity that is used
to control matching client and client-class entries with candidate
scopes.
eod
ATTR: clients
ATTRID: 31
ATTRHDRNAME: AO_DHCPSERVER_CLIENTS
ATTRTYPE: AT_LISTREF(ClientEntry)
ATTRMCDPATH: clients
ATTRVAL: 1106
ATTRVIZ: 0
ATTRDESC:: eod
There is no reference from the DHCP server to its clients
eod

ATTR: clientclasses
ATTRID: 32
ATTRHDRNAME: AO_DHCPSERVER_CLIENTCLASSES
ATTRTYPE: AT_LISTREF(ClientEntry)
ATTRMCDPATH: clientclasses
ATTRVAL: 1106
ATTRVIZ: 0
ATTRDESC:: eod
There is no reference from the DHCP server to its client-classes.
eod

ATTR: scopes
ATTRID: 33
ATTRHDRNAME: AO_DHCPSERVER_SCOPES
ATTRTYPE: AT_LISTREF(Scope)
ATTRMCDPATH: scopes
ATTRVAL: 1101
ATTRVIZ: 0
ATTRDESC:: eod
There is no reference from the DHCP server to its scopes.
eod

ATTR: policies
ATTRID: 34
ATTRHDRNAME: AO_DHCPSERVER_POLICIES
ATTRTYPE: AT_LISTREF(Policy)
ATTRMCDPATH: policies
ATTRVAL: 1102
ATTRVIZ: 0
ATTRDESC:: eod
There is no reference from the DHCP server to its policies.
eod

ATTR: interfaces
ATTRID: 35
ATTRHDRNAME: AO_DHCPSERVER_INTERFACES
ATTRTYPE: AT_ARRAY(AT_STRUCT(Interface))
ATTRFLAGS: AF_NOTREE
ATTRMCDPATH: interfaces
ATTRVAL: 1104
ATTRVIZ: 1
DEPRECATED: 7.0
ATTRDESC:: eod
Maintains the list of interfaces used by the server.
eod

ATTR: scriptpoints
ATTRID: 36
ATTRHDRNAME: AO_DHCPSERVER_SCRIPT_POINTS
ATTRTYPE: AT_STRUCT(DHCPScriptPoints)
ATTRMCDPATH: scriptpoints
ATTRVAL: 1109
ATTRVIZ: 1
ATTRDESC:: eom
The sub-structure specifying which extension modules should be
called at each extension point.
eom

ATTR: hardware-unicast
ATTRID: 37
ATTRHDRNAME: AO_DHCPSERVER_USEHARDWAREUNICAST
ATTRTYPE: AT_BOOL
ATTRFLAGS: AF_FEATURE, AF_INITIALIZE
ATTRDEFVAL: true
ATTRMCDPATH: UseHardwareUnicast
ATTRVIZ: 5
ATTRDESC:: eod
Controls whether the DHCP server sends unicast rather
than broadcast responses when a client indicates that it can
accept a unicast.

Note: This attribute is only available on these
operating systems: Solaris, Windows 2000, and Windows NT.

eod

ATTR: discover-interfaces
ATTRID: 38
ATTRHDRNAME: AO_DHCPSERVER_DISCOVERINTERFACES
ATTRTYPE: AT_BOOL
ATTRFLAGS: AF_FEATURE, AF_INITIALIZE
ATTRDEFVAL: true
ATTRMCDPATH: DiscoverInterfaces
ATTRVIZ: 1
DEPRECATED: 7.0
ATTRDESC:: eod
In previous versions, this caused the DHCP server to find all the
interface cards on the host and process DHCP requests that it
receives from any of them. It will, however, only offer addresses
to requests from subnets in which you have defined a valid scope
with available addresses. If you do not enable this feature, the
DHCP server only uses its list of configured interfaces.
The server now always discovers interfaces, and configures all (if
no dhcp-interfaces are configured) or only those that match a
configured dhcp-interface.
eod

ATTR: log-unknown-criteria
ATTRID: 39
ATTRHDRNAME: AO_DHCPSERVER_LOG_UNKNOWN_CRITERIA
ATTRTYPE: AT_BOOL
ATTRFLAGS: AF_FEATURE, AF_INITIALIZE
ATTRDEFVAL: true
ATTRMCDPATH: LogUnknownCriteria
ATTRVIZ: 1
ATTRDESC:: eod
Deprecated: use 'log-settings'
eod

ATTR: extension-trace-level
ATTRID: 40
ATTRHDRNAME: AO_DHCPSERVER_SCRIPT_TRACE_LEVEL
ATTRTYPE: AT_INT
ATTRFLAGS: AF_INITIALIZE
ATTRDEFVAL: 0
ATTRMCDPATH: ScriptTraceLevel
ATTRVIZ: 5
ATTRDESC:: eod
Sets the value of the extension trace level for every
request object. Default is 0.

The range is from 0 through 3, with 0 being very little tracing
and 3 the highest amount of tracing.

eod

ATTR: drop-packet-on-extension-failure
ATTRID: 41
ATTRHDRNAME: AO_DHCPSERVER_DROP_PACKET_ON_SCRIPT_FAILURE
ATTRTYPE: AT_BOOL
ATTRFLAGS: AF_FEATURE, AF_INITIALIZE
ATTRDEFVAL: true
ATTRMCDPATH: DropPacketOnScriptFailure
ATTRVIZ: 5
ATTRDESC:: eod
Causes the server to drop a packet (if possible) when it
encounters an extension failure. Default is true (enable).
eod

ATTR: use-ldap-client-data
ATTRID: 44
ATTRHDRNAME: AO_DHCPSERVER_USELDAPCLIENTDATA
ATTRTYPE: AT_BOOL
ATTRFLAGS: AF_FEATURE, AF_INITIALIZE
ATTRDEFVAL: false
ATTRMCDPATH: UseLdapForClientData
ATTRVIZ: 5
ATTRDESC:: eod
Controls whether the DHCP server attempts to read client-entry
data using the configuration supplied by the 'ldap'
command. Default is false (disable).
eod

ATTR: fallback-to-local-client-data
ATTRID: 43
ATTRHDRNAME: AO_DHCPSERVER_FALLBACKTOLOCALCLIENTDATA
ATTRTYPE: AT_BOOL
ATTRFLAGS: AF_FEATURE, AF_INITIALIZE
ATTRDEFVAL: false
ATTRMCDPATH: FallbackToLocalClientData
ATTRVIZ: 3
ATTRDESC:: eod
If the server attempts to use LDAP to read client-entry data but
doesn't find any data, the server can try to read the local
database instead.
eod

ATTR: continue-without-client-data
ATTRID: 42
ATTRHDRNAME: AO_DHCPSERVER_CONTINUEWITHOUTCLIENTDATA
ATTRTYPE: AT_BOOL
ATTRFLAGS: AF_FEATURE, AF_INITIALIZE
ATTRDEFVAL: true
ATTRMCDPATH: ContinueWithoutClientData
ATTRVIZ: 3
ATTRDESC:: eod
If the server does not find any client-entry data for a client,
and no default client-entry is specified, the server will continue
to process the client's request if this attribute is TRUE.
eod

ATTR: update-dns-for-bootp
ATTRID: 45
ATTRHDRNAME: AO_DHCPSERVER_UPDATEDNSFORBOOTP
ATTRTYPE: AT_BOOL
ATTRFLAGS: AF_FEATURE, AF_INITIALIZE
ATTRDEFVAL: true
ATTRMCDPATH: UpdateDnsForBootp
ATTRVIZ: 5
ATTRDESC:: eod
If the server is replying to a BOOTP request, and is offering a
lease from a Scope which is configured to perform DNS updates, it
will check this property before beginning the DNS update. This
feature allows an administrator to prevent DNS updates for BOOTP
clients, while allowing updates for DHCP clients.
eod

ATTR: flush-events
ATTRID: 46
ATTRHDRNAME: AO_DHCPSERVER_FLUSHEVENTS
ATTRTYPE: AT_BOOL
ATTRMCDPATH: FlushEvents
ATTRVIZ: 3
ATTRDESC:: eod
It may be necessary to flush the persistant database of pending
DNS and LDAP update events. This should only be used under the
direction of Technical Support.
eod

ATTR: reservations-override-criteria
ATTRID: 47
ATTRHDRNAME: AO_DHCPSERVER_RESERVATIONSOVERRIDECRITERIA
ATTRTYPE: AT_BOOL
ATTRMCDPATH: ReservationsIgnoreCriteria
ATTRVIZ: 1
ATTRDESC:: eod
The server will not honor any reservation that is on a scope
whose selection-tags do not match the selection-criteria (or do
match the selection-criteria-excluded) of a particular client or
its client-class.  If this behavior is found to be incorrect for
some cases, then this boolean value may be set to true.  It should
only be used under the direction of Customer Support.
eod

ATTR: use-one-shot-heaps-for-requests
ATTRID: 48
ATTRHDRNAME: AO_DHCPSERVER_USEONESHOTHEAPSFORREQUESTS
ATTRTYPE: AT_BOOL
ATTRMCDPATH: UseOneShotHeapsForRequests
ATTRVIZ: 1
ATTRDESC:: eod
The server will, by default, use one-shot heaps for memory
allocated for DHCP requests.  If this parameter appears in the
configuration (it does not by default), and its value is false
(i.e., 0), then the server will not use one-shot heaps for DHCP
requests.  If one-shot heaps are not used and if C extensions are
used, there will be memory leaks.
eod

ATTR: use-one-shot-heaps-for-responses
ATTRID: 49
ATTRHDRNAME: AO_DHCPSERVER_USEONESHOTHEAPSFORRESPONSES
ATTRTYPE: AT_BOOL
ATTRMCDPATH: UseOneShotHeapsForResponses
ATTRVIZ: 1
ATTRDESC:: eod
The server will, by default, use one-shot heaps for memory
allocated for DHCP responses.  If this parameter appears in the
configuration (it does not by default), and its value is false
(i.e., 0), then the server will not use one-shot heaps for DHCP
responses.  If one-shot heaps are not used and if C extensions are
used, there will be memory leaks.
eod

ATTR: disable-ldap-warnings
ATTRID: 50
ATTRHDRNAME: AO_DHCPSERVER_DISABLE_LDAP_WARNINGS
ATTRTYPE: AT_BOOL
ATTRMCDPATH: disable-ldap-warnings
ATTRVIZ: 3
ATTRDESC:: eod
This feature turns off some LDAP configuration warnings which
aren't useful if LDAP features are not being used.
eod

ATTR: ldap-mode
ATTRID: 51
ATTRHDRNAME: AO_DHCPSERVER_LDAP_MODE
ATTRMCDPATH: ldap-mode
ATTRTYPE: AT_ENUMINT(round-robin=1, failover=2)
ATTRVIZ: 5
ATTRDESC:: eod
Determines the preference for using LDAP servers if
multiple LDAP servers are configured. No default.

This attribute has two possible values:

   1  round-robin-The DHCP server ignores LDAP server
      preferences. It treats all LDAP servers (those configured
      to handle client queries and those configured to accept
      lease-state updates) equally.

   2  failover-The DHCP server uses the active LDAP server with
      the lowest preference. If the preferred server loses its
      connection or fails, the DHCP server uses the next LDAP
      server in preference order. The DHCP server uses servers
      with equal preference in round-robin order.
eod

ATTR: save-relay-agent-data
ATTRID: 52
ATTRHDRNAME: AO_DHCPSERVER_SAVE_RELAY_DATA
ATTRTYPE: AT_BOOL
ATTRMCDPATH: save-relay-agent-data
ATTRVIZ: 1
DEPRECATED: 7.0
ATTRDESC:: eod
In previous versions, this parameter controlled whether the DHCP
server would save the relay agent data for a particular IP
address in the lease state database.  It now has no purpose,
because the relay agent data (if any) is always saved in the
lease state database.  Setting or clearing this parameter now has
no effect, but it still exists so as to not break existing
configuration scripts.
eod


ATTR: keep-relay-data-current
ATTRID: 53
ATTRHDRNAME: AO_DHCPSERVER_KEEP_RELAY_DATA_CURRENT
ATTRTYPE: AT_BOOL
ATTRMCDPATH: keep-relay-data-current
ATTRVIZ: 3
ATTRDESC:: eod
Determines whether DHCP relay-agent option data is cleared when
leases expire or are released.
eod

ATTR: max-dns-requests
ATTRID: 54
ATTRHDRNAME: AO_DHCPSERVER_MAXDNSREQUESTS
ATTRTYPE: AT_INT
ATTRFLAGS: AF_REQUIRED
ATTRMCDPATH: max-dns-requests
ATTRDEFVAL: 20
ATTRVIZ: 3
ATTRDESC:: eod
Sets the limit on the number of simultaneous DNS updates that the
DHCP server will make to any single DNS server. Too many
simultaneous DNS updates can lead to unnecessary retries,
and adversely effect DNS update performance. A setting of '0'
means 'no limit'.
eod

ATTR: use-release-grace-period
ATTRID: 55
ATTRHDRNAME: AO_DHCPSERVER_USE_RELEASE_GRACE_PERIOD
ATTRTYPE: AT_BOOL
ATTRFLAGS: AF_FEATURE
ATTRMCDPATH: use-release-grace-period
ATTRVIZ: 1
DEPRECATED: 7.1
ATTRDESC:: eod
Controls whether the server's global default is to delay the effect
of RELEASE messages from clients. If this global switch is set,
all RELEASE messages will be delayed by a Policy's 'release-grace-
period' attribute.  During the grace period, the client's lease
won't be made available for any other client.
eod

ATTR: allow-release-grace-period
ATTRID: 56
ATTRHDRNAME: AO_DHCPSERVER_ALLOW_RELEASE_GRACE_PERIOD
ATTRTYPE: AT_BOOL
ATTRFLAGS: AF_FEATURE, AF_INITIALIZE
ATTRMCDPATH: allow-release-grace-period
ATTRDEFVAL: true
ATTRVIZ: 1
DEPRECATED: 7.1
ATTRDESC:: eod
This global switch determines whether the
'use-release-grace-period' features will affect release
processing. If this is disabled, the 'use-release-grace-period'
settings on the server, scopes, and individual clients will be
ignored.
eod

ATTR: ignore-icmp-errors
ATTRID: 57
ATTRHDRNAME: AO_DHCPSERVER_IGNORE_ICMP_ERRORS
ATTRTYPE: AT_BOOL
ATTRFLAGS: AF_FEATURE, AF_INITIALIZE
ATTRMCDPATH: ignore-icmp-errors
ATTRDEFVAL: true
ATTRVIZ: 5
ATTRDESC:: eod
Controls how the DHCP server handles ICMP ECHO (ping-before-
offer) requests. Default is true (enable).

If you enable this attribute and configure the DHCP server to
to send ICMP ECHO requests, the server makes unavailable any
address for which it receives an ECHO reply within its
configured timeout period.

If you disable this attribute, the DHCP server also treats
ICMP DEST_UNREACHABLE and TTL_EXPIRED error messages that it
receives after sending ICMP ECHO requests as grounds for making
an address unavailable.

eod

ATTR: defer-lease-extensions
ATTRID: 58
ATTRHDRNAME: AO_DHCPSERVER_DEFER_LEASE_EXTENSIONS
ATTRTYPE: AT_BOOL
ATTRMCDPATH: defer-lease-extensions
ATTRFLAGS: AF_INITIALIZE
ATTRDEFVAL: true
ATTRVIZ: 5
ATTRDESC:: eod
Determines whether the DHCP server can defer extending leases
to their full lease expiration time.

If enabled (true), the DHCP server can defer extending the lease
expiration time. Rather than give the client the full configured
lease time, the server instead gives the client the remaining 
time on the existing lease, improving server performance and 
throughput. The DHCP server typically defers extending the lease
if the client renews early; that is, before the client's lease 
renewal time (T1) elapses.

If enabled, the DHCP server can save committing the lease to 
disk and updating its failover partner with an extended lease 
expiration time.

If disabled, the DHCP server always attempts to extend the 
lease expiration time. However, there may be conditions 
that prevent the server from extending the lease for the full 
configured lease time; for example, failover protocol restrictions.
eod

ATTR: last-transaction-time-granularity
ATTRID: 59
ATTRHDRNAME: AO_DHCPSERVER_LAST_TRANSACTION_TIME_GRANULARITY
ATTRTYPE: AT_TIME
ATTRMCDPATH: last-transaction-time-granularity
ATTRDEFVAL: 60
ATTRVIZ: 5
ATTRDESC:: eod
Sets the time, in seconds, to guarantee that the last
transaction time is accurate. Default is 60s.

Do not set this lower than the default of 60 seconds. For
optimal performance, set it to a value that is greater than half
of your lease interval.

By default the server maintains an accurate record of the time
when it last interacted with a DHCP client concerning a given
lease.  This setting provides a control on how accurate that time
is guaranteed to be.  A setting of 300 seconds, for instance,
would allow the server to avoid database updates whose sole
purpose is to update a last transaction time that is less than 5
minutes in the past.

eod
ATTR: cisco-dhcp-proxy
ATTRID: 60
ATTRHDRNAME: AO_DHCPSERVER_SOURCE_ADDRESS_FOR_GIADDR
ATTRTYPE: AT_BOOL
ATTRMCDPATH: source-address-for-giaddr
ATTRFLAGS: AF_INITIALIZE
ATTRDEFVAL: false
ATTRVIZ: 3
ATTRDESC:: eod
To accommodate some DHCP Proxy implementations which do not
correctly fill in the giaddr field in INIT-REBOOT and DISCOVER
packets, enabling this attribute will cause the DHCP server to use
the source address of the packet, if it is non-zero, in lieu of
the giaddr field.
eod

ATTR: defer-lease-extensions-on-retry
ATTRID: 61
ATTRHDRNAME: AO_DHCPSERVER_DEFER_LEASE_EXTENSIONS_ON_RETRY
ATTRTYPE: AT_BOOL
ATTRMCDPATH: defer-lease-extensions-on-retry
ATTRFLAGS: AF_INITIALIZE
ATTRDEFVAL: true
ATTRVIZ: 1
DEPRECATED: 7.0
ATTRDESC:: eod
Controls how the DHCP server handles a client request to
renew an expired lease.  Default is true (enabled).

If enabled, a DHCP client which renews an expired lease by
less than the smaller of 30 seconds or its configured renew time
does not have its lease extended to the full lease time.
The client instead receives a lease corresponding to the
remaining time on its existing lease. This prevents unnecessary
database activity if the server has already responded to an
initial request, but the client has resent it due to a retry
timeout.

eod

ATTR: max-pending-events
ATTRID: 62
ATTRHDRNAME: AO_DHCPSERVER_MAX_PENDING_EVENTS
ATTRTYPE: AT_INT
ATTRMCDPATH: max-pending-events
ATTRFLAGS: AF_INITIALIZE
ATTRDEFVAL: 40000
ATTRVIZ: 3
ATTRDESC:: eod
Sets the maximum number of events that can be queued.
eod

ATTR: report-time-as-GMT
ATTRID: 63
ATTRHDRNAME: AO_REPORT_TIME_AS_GMT
ATTRTYPE: AT_BOOL
ATTRMCDPATH: report-time-as-GMT
ATTRFLAGS: AF_INITIALIZE
ATTRDEFVAL: false
ATTRVIZ: 3
ATTRDESC:: eod
Normally times reported in the DHCP logs are expressed in local
time.  For backward compatibility with older versions of the
server, setting this attribute will cause times to be reported in
GMT.
eod

ATTR: failover-main-server
ATTRID: 64
ATTRHDRNAME: AO_DHCPSERVER_FAILOVER_MAIN_SERVER
ATTRTYPE: AT_STRING
ATTRMCDPATH: failover-main-server
ATTRVIZ: 1
DEPRECATED: 7.0
ATTRDESC:: eod
The DNS name of the main server associated with this lan
segment.  If this DNS name resolves to the IP address of the
current server, then this server will operate as the main server
for this scope.  It is an error if both the main and backup
server names resolve to the IP addresses which reside on the
same server.  If the backup-server-name is the distinguished
name "local" or is not configured on this scope or in the
server-wide default, then this server is considered to be the
main server for this scope.  Configuring either a
main-server-name or a backup-server-name will enable failover.
eod

ATTR: failover-backup-server
ATTRID: 65
ATTRHDRNAME: AO_DHCPSERVER_FAILOVER_BACKUP_SERVER
ATTRTYPE: AT_STRING
ATTRMCDPATH: failover-backup-server
ATTRVIZ: 1
DEPRECATED: 7.0
ATTRDESC:: eod
The DNS name of the backup server associated with this lan
segment.  If this DNS name resolves to the IP address of the
current server, then this server will operate as the backup
server for this scope.  It is an error if both the main and
backup server names resolve to the IP addresses which reside on
the same server.  If the main-server-name is the distinguished
name "local" or is not configured in either this scope or the
server-wide default, then this server is considered to be the
backup server for this scope.  Configuring either a
main-server-name or a backup-server-name will enable failover.
eod

ATTR: failover-backup-percentage
ATTRID: 66
ATTRHDRNAME: AO_DHCPSERVER_FAILOVER_BACKUP_PERCENTAGE
ATTRTYPE: AT_INT
ATTRFLAGS: AF_INITIALIZE
ATTRDEFVAL: 10
ATTRMCDPATH: failover-backup-percentage
ATTRVIZ: 1
DEPRECATED: 7.0
ATTRDESC:: eod
The percentage of available addresses that the main server
should send to the backup server.  It must be defined for in
the main server.  If it is defined in a backup server, it is
ignored (to enable copying of configurations).
eod

ATTR: failover-maximum-client-lead-time
ATTRID: 67
ATTRHDRNAME: AO_DHCPSERVER_FAILOVER_MCLT
ATTRTYPE: AT_TIME
ATTRFLAGS: AF_INITIALIZE
ATTRDEFVAL: 3600
ATTRMCDPATH: failover-mclt
ATTRVIZ: 1
DEPRECATED: 7.0
ATTRDESC:: eod
This is maximum client lead time, in seconds.  The "MCLT" controls
how much ahead of the backup server the client's lease expiration
can be.  It must be defined for the scope in the main and backup
servers.  Both the main and backup must be configured with
identical values for proper operation.
eod

ATTR: failover-lease-period-factor
ATTRID: 68
ATTRHDRNAME: AO_DHCPSERVER_FAILOVER_LEASE_PERIOD_MULTIPLE
ATTRTYPE: AT_INT100
ATTRFLAGS: AF_INITIALIZE
ATTRDEFVAL: 1.50
ATTRMCDPATH: failover-lease-period-factor
ATTRVIZ: 1
DEPRECATED: 7.0
ATTRDESC:: eod
The multiple of the desired lease period used to update the
backup server when the main server informs it of a new DHCP
client lease period.  A value of 1.00 would be the same as
the lease period that the main would like to give the DHCP
client.  A value of 2.00 would be twice the lease period the
main would like to give the client.  The lease-period-factor
controls how much ahead of the client the backup server's
idea of the lease expiration can be.  The larger this value,
the more the main is independent of the operation of the
backup and the less performance impact the failover protocol
has on the main server performance.  However, the larger
this value, the longer the backup will have to wait to time
out an expired lease and re-use it for a different client in
the event that the main fails and the backup takes over all
DHCP functions.  This attribute must be defined in the
main server.  If it is defined in a backup server, it is
ignored (to enable copying of configurations).
eod

ATTR: failover-use-safe-period
ATTRID: 69
ATTRHDRNAME: AO_DHCPSERVER_FAILOVER_USE_SAFE_PERIOD
ATTRTYPE: AT_BOOL
ATTRFLAGS: AF_FEATURE, AF_INITIALIZE
ATTRMCDPATH: failover-use-safe-period
ATTRDEFVAL: false
ATTRVIZ: 1
DEPRECATED: 7.0
ATTRDESC:: eod
If use-safe-period is disabled, then a server will never go into
PARTNER-DOWN state without an operator command.  It must be
defined for the scope in the main server.  If it is
defined in a backup server, it is ignored (to enable copying of
configurations).
eod

ATTR: failover-safe-period
ATTRID: 70
ATTRHDRNAME: AO_DHCPSERVER_FAILOVER_SAFE_PERIOD
ATTRTYPE: AT_TIME
ATTRFLAGS: AF_INITIALIZE
ATTRDEFVAL: 86400
ATTRMCDPATH: failover-safe-period
ATTRVIZ: 1
DEPRECATED: 7.0
ATTRDESC:: eod
This is the safe period, in seconds.  It does not have to be
the same on both main and backup servers.  It only has meaning if
use-safe-period is enabled.  It must be defined for the scope in
the main server.  If it is defined in a backup server, it is
ignored (to enable copying of configurations).
eod

ATTR: failover-recover
ATTRID: 71
ATTRHDRNAME: AO_DHCPSERVER_FAILOVER_RECOVER
ATTRTYPE: AT_DATE
ATTRMCDPATH: failover-recover
ATTRFLAGS: AF_INITIALIZE
ATTRDEFVAL: 0
ATTRVIZ: 5
ATTRDESC:: eod


With failover enabled, sets the time at which the server
is initialized and goes into RECOVER state. No default.

If failover-recover is non-zero, and the server has no
record of a previous failover state in its stable storage,
then the server assumes that it was previously operational
but lost all of its stable storage.

The time value in the failover-recover parameter represents
a time equal to or later than the last known time the server
could have been operational.  The server attempts to refresh
its information from its failover partner by entering RECOVER
state and requesting a complete update of all binding
information.

Time values for this attribute can be in hours (for example,
-2h two hours ago) or month day hour:minute[:second] year.
Use the local time of the nrcmd process.

Formats for the date are:

-<num><value>
  where <num> is a decimal number and <value> is one of 's', 'm',
  'h', 'd', 'w', in which 's' is seconds, 'm' is minutes, 'h' is
  hours, 'd' is days and 'w' is weeks.
<month> <day> <hour>:<minute>[:<second>] <year>
  where <month> is the name or first three letters of the name of
  the month, <hour> is the hour on a 24- hour clock, and <year> is
  the fully-specified year or a two-digit representation in which
  98 = 1998, 99 = 1999 and all other two digit values XX = 20XX.

eod
ATTR: failover-persist-lease-data-on-partner-ack
ATTRID: 72
ATTRHDRNAME: AO_DHCPSERVER_FAILOVER_WRITE_MCD_ON_LEASE_DATA_ACK
ATTRTYPE: AT_BOOL
ATTRMCDPATH: failover-persist-lease-data-on-partner-ack
ATTRFLAGS: AF_INITIALIZE
ATTRDEFVAL: true
ATTRVIZ: 1
DEPRECATED: 7.0
ATTRDESC:: eod
Normally, the main server will update MCD whenever the backup
server ACK's it with what the backup knows.  Disabling this
capability will speed up the main server, with the downside that
after restart of the main server it won't know what the backup
knows, and may offer all clients one lease period with a renew
time of the current time plus the MCLT.
eod

ATTR: failover
ATTRID: 73
ATTRHDRNAME: AO_DHCPSERVER_FAILOVER
ATTRTYPE: AT_BOOL
ATTRFLAGS: AF_PRINT_ALT
ATTRMCDPATH: failover
ATTRDEFVAL: true
ATTRVIZ: 3
ATTRDESC:: eod
If enabled (the default), the failover configuration information
will be processed.  If not enabled, the failover configuration
(if any) will not be processed (and any errors in that
configuration will not be reported).
eod

ATTR: failover-poll-interval
ATTRID: 74
ATTRHDRNAME: AO_DHCPSERVER_FAILOVER_POLL_INTERVAL
ATTRTYPE: AT_TIME
ATTRFLAGS: AF_PRINT_ALT, AF_INITIALIZE
ATTRMCDPATH: failover-poll-interval
ATTRDEFVAL: 15
ATTRVIZ: 5
ATTRDESC:: eod
With failover enabled, controls the space of time, in seconds,
that elapses between polls of failover partners to confirm
network connectivity. Default is 15s.

eod

ATTR: failover-poll-timeout
ATTRID: 75
ATTRHDRNAME: AO_DHCPSERVER_FAILOVER_POLL_TIMEOUT
ATTRTYPE: AT_TIME
ATTRFLAGS: AF_PRINT_ALT, AF_INITIALIZE
ATTRMCDPATH: failover-poll-timeout
ATTRDEFVAL: 60
ATTRVIZ: 5
ATTRDESC:: eod
With failover enabled, defines the space of time, in seconds,
after which a poll between partners times out. Default is 60s.

This attribute signals that the partners cannot communicate
due to lost network connectivity. The partners then change their
operational states appropriately.

eod

ATTR: failover-startup-period
ATTRID: 76
ATTRHDRNAME: AO_DHCPSERVER_FAILOVER_STARTUP_PERIOD
ATTRTYPE: AT_TIME
ATTRFLAGS: AF_PRINT_ALT, AF_INITIALIZE
ATTRMCDPATH: failover-startup-period
ATTRDEFVAL: 10
ATTRVIZ: 3
ATTRDESC:: eod
The duration of the 'startup-period'. Each time the server starts,
it will attempt to contact its failover partners for startup-period
seconds. the server will wait for the entire startup-period before
accepting DHCP requests for any scopes whose DHCP failover partner
can't be contacted.
eod

ATTR: failover-timer-period
ATTRID: 77
ATTRHDRNAME: AO_DHCPSERVER_FAILOVER_TIMER_PERIOD
ATTRTYPE: AT_TIME
ATTRFLAGS: AF_PRINT_ALT, AF_INITIALIZE
ATTRMCDPATH: failover-timer-period
ATTRDEFVAL: 60
ATTRVIZ: 3
ATTRDESC:: eod
This configurable is the period of a timer used by failover
processing in the DHCP server.
eod

ATTR: failover-server-port
ATTRID: 78
ATTRHDRNAME: AO_DHCPSERVER_FAILOVER_SERVER_PORT
ATTRTYPE: AT_INT
ATTRMCDPATH: failover-server-port
ATTRFLAGS: AF_INITIALIZE
ATTRDEFVAL: 647
ATTRVIZ: 3
ATTRDESC:: eod
The port assigned to the DHCP failover protocol.
eod

ATTR: failover-remote-port
ATTRID: 79
ATTRHDRNAME: AO_DHCPSERVER_FAILOVER_REMOTE_PORT
ATTRTYPE: AT_INT
ATTRMCDPATH: failover-remote-port
ATTRFLAGS: AF_INITIALIZE
ATTRDEFVAL: 647
ATTRVIZ: 3
ATTRDESC:: eod
If a single machine is running two DHCP processes, this attribute
can be set to a different port than the failover-server-port to
allow the two processes to act as failover partners.
eod

ATTR: failover-dynamic-bootp-backup-percentage
ATTRID: 80
ATTRHDRNAME: AO_DHCPSERVER_FAILOVER_DYNAMIC_BOOTP_BACKUP_PERCENTAGE
ATTRTYPE: AT_INT
ATTRMCDPATH: failover-dynamic-bootp-backup-percentage
ATTRVIZ: 1
DEPRECATED: 7.0
ATTRDESC:: eod
The percentage of available addresses that the main server
should send to the backup server for scopes on which dynamic
BOOTP has been enabled.  If defined, it must be defined on
the main server.  If it is defined in a backup server, it is
ignored (to enable copying of configurations).  If it is not
defined at all or the value is 0, the
"failover-backup-percentage" will be used instead.  This
parameter is separate from "failover-backup-percentage"
because if dynamic BOOTP is enabled on a scope, a server
will never, even in PARTNER-DOWN state, grant leases on
addresses that are available to the other server because
they can never safely be assumed to be available again.
The MCLT has no meaning for dynamic BOOTP leases.
eod
ATTR: failover-update-retry-time
ATTRID: 81
ATTRHDRNAME: AO_DHCPSERVER_FAILOVER_UPDATE_RETRY_TIME
ATTRTYPE: AT_INT
ATTRMCDPATH: failover-update-retry-time
ATTRFLAGS: AF_INITIALIZE
ATTRDEFVAL: 10
ATTRVIZ: 3
ATTRDESC:: eod
The time in seconds that a DHCPBNDUPD should wait before retrying.
eod

ATTR: failover-control-retry-time
ATTRID: 82
ATTRHDRNAME: AO_DHCPSERVER_FAILOVER_CONTROL_RETRY_TIME
ATTRTYPE: AT_INT
ATTRMCDPATH: failover-control-retry-time
ATTRFLAGS: AF_INITIALIZE
ATTRDEFVAL: 30
ATTRVIZ: 3
ATTRDESC:: eod
The time in seconds that a DHCPUPDREQ or DHCPPOOLREQ should wait
before retrying.
eod

ATTR: failover-update-retry-count
ATTRID: 83
ATTRHDRNAME: AO_DHCPSERVER_FAILOVER_UPDATE_RETRY_COUNT
ATTRTYPE: AT_INT
ATTRMCDPATH: failover-update-retry-count
ATTRFLAGS: AF_INITIALIZE
ATTRDEFVAL: 2
ATTRVIZ: 3
ATTRDESC:: eod
The number of times a DHCPBNDUPD message should retry before
giving up.
eod

ATTR: failover-control-retry-count
ATTRID: 84
ATTRHDRNAME: AO_DHCPSERVER_FAILOVER_CONTROL_RETRY_COUNT
ATTRTYPE: AT_INT
ATTRMCDPATH: failover-control-retry-count
ATTRFLAGS: AF_INITIALIZE
ATTRDEFVAL: 10
ATTRVIZ: 3
ATTRDESC:: eod
The number of times a DHCPUPDREQ or DHCPPOOLREQ message
should retry before giving up.
eod


ATTR: failover-pending-available-scan-timer-periods
ATTRID: 85
ATTRHDRNAME: AO_DHCPSERVER_FAILOVER_PENDING_AVAILABLE_SCAN_TIMER_PERIODS
ATTRTYPE: AT_INT
ATTRMCDPATH: failover-pending-available-scan-timer-periods
ATTRFLAGS: AF_INITIALIZE
ATTRDEFVAL: 2
ATTRVIZ: 3
ATTRDESC:: eod
The number of failover-timer-periods to wait when in partner-down
state between running a scan of all pending-available leases to
see if perhaps they may now be set available.
eod

ATTR: failover-unacked-lease-scan-timer-periods
ATTRID: 86
ATTRHDRNAME: AO_DHCPSERVER_FAILOVER_UNACKED_LEASE_SCAN_TIMER_PERIODS
ATTRTYPE: AT_INT
ATTRMCDPATH: failover-unacked-lease-scan-timer-periods
ATTRFLAGS: AF_INITIALIZE
ATTRDEFVAL: 10
ATTRVIZ: 3
ATTRDESC:: eod
The number of failover-timer-periods to wait when in normal
state between running a scan of all unacked leases to
try again to get them acked.
eod

ATTR: failover-allow-ack-on-update
ATTRID: 87
ATTRHDRNAME: AO_DHCPSERVER_FAILOVER_ALLOW_ACK_ON_UPDATE
ATTRTYPE: AT_BOOL
ATTRMCDPATH: failover-allow-ack-on-update
ATTRFLAGS: AF_INITIALIZE
ATTRDEFVAL: true
ATTRVIZ: 3
ATTRDESC:: eod
If this parameter is defined and it is false (i.e., == 0),
the DHCP server will not transmit ACK's for DHCPBNDUPD messages.
Failover will not work in these cases, and this parameter is
only for debugging purposes.
eod

ATTR: failover-send-batch-updates
ATTRID: 88
ATTRHDRNAME: AO_DHCPSERVER_FAILOVER_SEND_BATCH_UPDATES
ATTRTYPE: AT_BOOL
ATTRFLAGS: AF_PRINT_ALT, AF_INITIALIZE
ATTRMCDPATH: failover-send-batch-updates
ATTRDEFVAL: true
ATTRVIZ: 3
ATTRDESC:: eod
Controls whether this server should send messages containing
updates for multiple leases (when appropriate) to partner servers.
eod

ATTR: failover-skip-ack-on-update
ATTRID: 89
ATTRHDRNAME: AO_DHCPSERVER_FAILOVER_SKIP_ACK_ON_UPDATE
ATTRTYPE: AT_INT
ATTRMCDPATH: failover-skip-ack-on-update
ATTRFLAGS: AF_INITIALIZE
ATTRDEFVAL: 0
ATTRVIZ: 3
ATTRDESC:: eod
If this parameter is defined and it is non-zero and
failover-allow-ack-on-update is false, then every
failover-skip-ack-on-update acks will be ignored, but the
other ones will be sent.  Useful for checking out the retry
logic.  Do not use this in regular operation.
eod

ATTR: failover-use-only-partner-time-for-client
ATTRID: 90
ATTRHDRNAME: AO_DHCPSERVER_FAILOVER_USE_ONLY_PARTNER_TIME_FOR_CLIENT
ATTRTYPE: AT_BOOL
ATTRMCDPATH: failover-use-only-partner-time-for-client
ATTRFLAGS: AF_INITIALIZE
ATTRDEFVAL: false
ATTRVIZ: 3
ATTRDESC:: eod
If this parameter is undefined or it is false (i.e., == 0),
then the server will use the maximum of the time the partner
has acked to this server and the time this server has acked
to the partner when calculating the lease time for a DHCP client.
If this parameter is defined and it is true (i.e., = 1), then
the server will only use the time that partner has acked to
this server when calculating the lease times for a DHCP client.
eod
ATTR: failover-pool-request-scan-timer-periods
ATTRID: 91
ATTRHDRNAME: AO_DHCPSERVER_FAILOVER_POOL_REQUEST_SCAN_TIMER_PERIODS
ATTRTYPE: AT_INT
ATTRMCDPATH: failover-pool-request-scan-timer-periods
ATTRFLAGS: AF_INITIALIZE
ATTRDEFVAL: 60
ATTRVIZ: 3
ATTRDESC:: eod
A backup server asks its main partner to check whether available
leases should be transferred to it. This configurable sets the
number of failover-timer-periods that the backup waits between
such requests.
eod

ATTR: failover-allow-automatic-full-recovery
ATTRID: 92
ATTRHDRNAME: AO_DHCPSERVER_FAILOVER_ALLOW_AUTOMATIC_FULL_RECOVERY
ATTRTYPE: AT_BOOL
ATTRMCDPATH: failover-allow-automatic-full-recovery
ATTRFLAGS: AF_INITIALIZE
ATTRDEFVAL: true
ATTRVIZ: 3
ATTRDESC:: eod
If this parameter is undefined or it is true, the
server will do a full recover if it notices that the
other server has communicated with it before and yet
it has no record of ever having been run before.
eod

ATTR: failover-skip-pending-available-if-no-partner
ATTRID: 93
ATTRHDRNAME: AO_DHCPSERVER_FAILOVER_SKIP_PENDING_AVAILABLE_IF_NO_PARTNER
ATTRTYPE: AT_BOOL
ATTRMCDPATH: failover-skip-pending-available-if-no-partner
ATTRFLAGS: AF_INITIALIZE
ATTRDEFVAL: true
ATTRVIZ: 3
ATTRDESC:: eod
If this parameter is undefined or it is true, the
server will check to see if the client for a lease was created
after this server went into partner down, and if it was and the
server has not communicated with its partner since it went into
partner down, then it will not place the lease in pending-available
state when it otherwise could be placed into available state.
eod

ATTR: failover-allow-update-with-earlier-time
ATTRID: 94
ATTRHDRNAME: AO_DHCPSERVER_FAILOVER_ALLOW_UPDATE_WITH_EARLIER_TIME
ATTRTYPE: AT_BOOL
ATTRMCDPATH: failover-allow-update-with-earlier-time
ATTRFLAGS: AF_INITIALIZE
ATTRDEFVAL: true
ATTRVIZ: 1
DEPRECATED: 7.0
ATTRDESC:: eod
If this parameter is undefined or it is true, the
server will accept a failover update from its partner with
a client last transaction time prior to that recorded in the
server's state if that update is leased and the server's state
is expired, pending-available, available or other-available and
if the state serial number in the update is the partner's and the
state serial number in this server's lease belongs to this
server.  It will also accept an update if the update's state is
expired and this server's state is disconnected, available or
other available and the state serial number conditions mentioned
above are met.
eod

ATTR: echo-relay-agent-option
ATTRID: 95
ATTRHDRNAME: AO_DHCPSERVER_ECHO_RELAY_AGENT_OPTION
ATTRTYPE: AT_BOOL
ATTRMCDPATH: EnableRelayAgentOption
ATTRFLAGS: AF_INITIALIZE
ATTRDEFVAL: true
ATTRVIZ: 3
ATTRDESC:: eod
If this is 'true', the dhcp server will echo the contents of any
relay agent information options back to their senders.
eod

ATTR: avoid-dns-retry-on-renew
ATTRID: 96
ATTRHDRNAME: AO_DHCPSERVER_AVOID_DNS_RETRY_ON_RENEW
ATTRTYPE: AT_BOOL
ATTRMCDPATH: avoid-dns-retry-on-renew
ATTRFLAGS: AF_INITIALIZE
ATTRDEFVAL: true
ATTRVIZ: 1
DEPRECATED: 7.0
ATTRDESC:: eod
If this is 'true', the dhcp server will not retry a dynamic dns
update when a client renews its lease, if an update is already in
progress.
eod

ATTR: use-eventservice-for-mcd
ATTRID: 97
ATTRHDRNAME: AO_DHCPSERVER_USE_EVENTSERVICE_FOR_MCD
ATTRTYPE: AT_BOOL
ATTRMCDPATH: use-eventservice-for-mcd
#ATTRDEFVAL: false
ATTRVIZ: 1
ATTRDESC:: eod
If this is 'true', the dhcp server will write lease state data to
the MCD database asynchronously.
eod

ATTR: mcd-max-count-per-sync
ATTRID: 98
ATTRHDRNAME: AO_DHCPSERVER_MCD_MAX_COUNT_PER_SYNC
ATTRTYPE: AT_INT
ATTRMCDPATH: mcd-max-count-per-sync
ATTRFLAGS: AF_INITIALIZE
ATTRDEFVAL: 30
ATTRVIZ: 1
ATTRDESC:: eod
The maximum number of lease-state updates that will be written to
the DHCP database in a single transaction.
eod

ATTR: mcd-max-wait-per-sync
ATTRID: 99
ATTRHDRNAME: AO_DHCPSERVER_MCD_MAX_WAIT_PER_SYNC
ATTRTYPE: AT_INT
ATTRMCDPATH: mcd-max-wait-per-sync
ATTRFLAGS: AF_INITIALIZE
ATTRDEFVAL: 5
ATTRVIZ: 1
ATTRDESC:: eod
The maximum number of seconds that the DHCP server will wait before
writing a transaction to the DHCP database.
eod

ATTR: docsis-version-id-missing
ATTRID: 100
ATTRHDRNAME: AO_DHCPSERVER_DOCSIS_VERSION_ID_MISSING
ATTRTYPE: AT_STRING
ATTRMCDPATH: docsis-version-id-missing
ATTRVIZ: 5
ATTRDESC:: eod
Sets the string value (maximum 255 characters) to substitute
for the %@docsis-vers% variable in the policy command boot-
file attribute. No default.

DOCSIS devices must provide their version id
(for example, "docsis1.0") in the vendor-class-id option.
The server substitutes the DOCSIS version id as the
value of the boot-file option. If the vendor
class-id option is missing, or is not syntactically correct,
the server uses the docsis-version-id-missing attribute
for the boot-file option.

This substitution occurs if the DHCP request packet does not
contain a vendor-class-id option or the option does not contain
a DOCSIS version ID.

eod

ATTR: save-vendor-class-id
ATTRID: 101
ATTRHDRNAME: AO_DHCPSERVER_SAVE_VENDOR_CLASS_ID
ATTRTYPE: AT_BOOL
ATTRMCDPATH: save-vendor-class-id
ATTRFLAGS: AF_INITIALIZE
ATTRDEFVAL: false
ATTRVIZ: 5
ATTRDESC:: eod
Determines whether to store the vendor=class-id, as
furnished in a dhcp request option 60, as part of the lease
record in either ldap, mcd or both.
eod

ATTR: event-store-thread-heap-size
ATTRID: 102
ATTRHDRNAME: AO_DHCPSERVER_EVENT_STORE_THREAD_HEAP_SIZE
ATTRTYPE: AT_INT
ATTRMCDPATH: event-store-thread-heap-size
ATTRFLAGS: AF_INITIALIZE
ATTRDEFVAL: 8192
ATTRVIZ: 3
ATTRDESC:: eod
Heap size for the event store's background thread.
eod

ATTR: event-store-sync-interval
ATTRID: 103
ATTRHDRNAME: AO_DHCPSERVER_EVENT_STORE_SYNC_INTERVAL
ATTRTYPE: AT_MSTIME
ATTRMCDPATH: event-store-sync-interval
ATTRFLAGS: AF_INITIALIZE
ATTRDEFVAL: 110
ATTRVIZ: 3
ATTRDESC:: eod
Timeout (in millisecs) between sync of the event store's current
logfile.
eod

ATTR: event-store-root-directory
ATTRID: 104
ATTRHDRNAME: AO_DHCPSERVER_EVENT_STORE_ROOT_DIRECTORY
ATTRTYPE: AT_STRING
ATTRMCDPATH: event-store-root-directory
ATTRFLAGS: AF_INITIALIZE
ATTRDEFVAL: dhcpeventstore
ATTRVIZ: 3
ATTRDESC:: eod
The eventstore will use write its logfiles into this subdirectory
of the installation's data directory.
eod

ATTR: event-store-max-file-size
ATTRID: 105
ATTRHDRNAME: AO_DHCPSERVER_EVENT_STORE_MAX_FILE_SIZE
ATTRTYPE: AT_INT
ATTRMCDPATH: event-store-max-file-size
ATTRFLAGS: AF_INITIALIZE
ATTRDEFVAL: 524288
ATTRVIZ: 3
ATTRDESC:: eod
The maximum size (in bytes) of each event store logfile.
eod

ATTR: event-store-max-items-to-roll
ATTRID: 106
ATTRHDRNAME: AO_DHCPSERVER_EVENT_STORE_MAX_ITEMS_TO_ROLL
ATTRTYPE: AT_INT
ATTRMCDPATH: event-store-max-items-to-roll
ATTRFLAGS: AF_INITIALIZE
ATTRDEFVAL: 25
ATTRVIZ: 3
ATTRDESC:: eod
The maximum number of items to roll forward (during a single sync
cycle) from an old eventstore logfile.
eod

ATTR: event-store-roll-percentage
ATTRID: 107
ATTRHDRNAME: AO_DHCPSERVER_EVENT_STORE_ROLL_PERCENT
ATTRTYPE: AT_INT100
ATTRMCDPATH: event-store-roll-percentage
ATTRFLAGS: AF_INITIALIZE
ATTRDEFVAL: 20
ATTRVIZ: 3
ATTRDESC:: eod
An old logfile becomes a candidate to be rolled up when its
percentage of live entries reaches this level.
eod

ATTR: get-subnet-mask-from-policy
ATTRID: 108
ATTRHDRNAME: AO_DHCPSERVER_GET_SUBNET_MASK_FROM_POLICY
ATTRTYPE: AT_BOOL
ATTRMCDPATH: get-subnet-mask-from-policy
ATTRFLAGS: AF_INITIALIZE
ATTRDEFVAL: false
ATTRVIZ: 5
ATTRDESC:: eod
Controls whether the DHCP server searches all relevant
policies for a subnet mask option to construct a response
to a client. Default is false (disable).

Normally, the DHCP server retains the subnet mask configured
in the scope containing the base being granted to the DHCP
client.

eod

ATTR: save-lease-renewal-time
ATTRID: 109
ATTRHDRNAME: AO_DHCPSERVER_SAVE_LEASE_RENEWAL_TIME
ATTRTYPE: AT_BOOL
ATTRMCDPATH: save-lease-renewal-time
ATTRFLAGS: AF_INITIALIZE
ATTRDEFVAL: false
ATTRVIZ: 1
ATTRDESC:: eod
Controls whether to store the expected lease renewal time
as part of the lease state information in the server database.
Default false (disable).

If true (enable), the server saves the lease renewal time in
persistent memory.  The lease renewal time determines the least
amount of time that must elapse before a client can request a
lease renewal.
eod

ATTR: force-dns-updates
ATTRID: 110
ATTRHDRNAME: AO_DHCPSERVER_FORCE_DNS_UPDATES
ATTRTYPE: AT_BOOL
ATTRMCDPATH: force-dns-updates
ATTRFLAGS: AF_INITIALIZE
ATTRDEFVAL: false
ATTRVIZ: 5
ATTRDESC:: eod

Controls whether the DHCP server retries a DNS update
whenever a client renews its lease, even if it appears
to the server that the update was already completed
successfully. Default is false (disable).

This attribute uses one of the following values:

   forward DnsUpdateConfig object (if configured)

   reverse DnsUpdateConfig object (if configured)

   the default (or where appropriate the server configured
   value or default value).
eod

ATTR: use-client-fqdn-first
ATTRID: 111
ATTRHDRNAME: AO_DHCPSERVER_USE_CLIENT_FQDN_FIRST
ATTRTYPE: AT_BOOL
ATTRMCDPATH: use-client-fqdn-first
ATTRFLAGS: AF_INITIALIZE
ATTRDEFVAL: true
ATTRVIZ: 5
ATTRDESC:: eod
Controls whether the DHCP server looks at the client-FQDN option
on incoming packets first, before looking at the 'hostname'
option.  Default is true (enable).

If true and the client-FQDN option specifies a hostname, the
server uses that hostname.

If the client-FQDN option is not present in the incoming packet,
the server uses the hostname from the 'hostname' option.

If false, the server also uses the hostname from the
'hostname' option.

eod

ATTR: use-host-name
ATTRID: 112
ATTRHDRNAME: AO_DHCPSERVER_USE_HOST_NAME
ATTRTYPE: AT_BOOL
ATTRMCDPATH: use-host-name
ATTRFLAGS: AF_INITIALIZE
ATTRDEFVAL: true
ATTRVIZ: 5
ATTRDESC:: eod
Specifies whether the server looks at  the 'hostname' option
for the hostname. Default is true (enable).

If true, the server obtains the hostname from the 'hostname'
option.

If false, the server does not obtain the hostname from this
option. This is useful if the client is sending unexpected or
junk characters.

eod

ATTR: use-client-fqdn
ATTRID: 113
ATTRHDRNAME: AO_DHCPSERVER_USE_CLIENT_FQDN
ATTRTYPE: AT_BOOL
ATTRMCDPATH: use-client-fqdn
ATTRFLAGS: AF_INITIALIZE
ATTRDEFVAL: true
ATTRVIZ: 5
ATTRDESC:: eod
Controls whether the server examines the client-FQDN option
for the hostname. Default is true (enable).

If true, the server ignores any characters after the first dot (.)
because the domain is determined from the scope.

If false, the server does not determine the hostname using this.
This is useful if the client is sending unexpected or junk
characters.
eod

ATTR: return-client-fqdn-if-given
ATTRID: 114
ATTRHDRNAME: AO_DHCPSERVER_RETURN_CLIENT_FQDN_IF_GIVEN
ATTRTYPE: AT_BOOL
ATTRMCDPATH: return-client-fqdn-if-given
ATTRFLAGS: AF_INITIALIZE
ATTRDEFVAL: false
ATTRVIZ: 3
ATTRDESC:: eod
Controls whether the system returns the client-FQDN option
in the outgoing client packet if the incoming packet contains
the FQDN option.

eod


ATTR: return-client-fqdn-if-asked
ATTRID: 115
ATTRHDRNAME: AO_DHCPSERVER_RETURN_CLIENT_FQDN_IF_ASKED
ATTRTYPE: AT_BOOL
ATTRMCDPATH: return-client-fqdn-if-asked
ATTRFLAGS: AF_INITIALIZE
ATTRDEFVAL: true
ATTRVIZ: 5
ATTRDESC:: eod
Controls whether the system returns the client FQDN option
in the outgoing packet to the client if the incoming packet
contains the FQDN option. Default false (disable).

If true (enable), the option flags are always set to 0x3
and the RCODE1 and RCODE2 to 255. Any string contained in the
incoming packet is returned, even if the use-client-fqdn
attribute is disabled and regardless of the actual FQDN.

eod

ATTR: max-waiting-packets
ATTRID: 116
ATTRHDRNAME: AO_DHCPSERVER_MAX_WAITING_PACKETS
ATTRTYPE: AT_INT
ATTRMCDPATH: max-waiting-packets
ATTRDEFVAL: 6
ATTRVIZ: 5
ATTRDESC:: eod
Sets the maximum number of packets that can wait for a
particular IP address.

The server queues only the most recently received n packets
(of an address) for processing. If an additional packet
associated with that address arrives and n packets are already
queued, the server drops the oldest packet and queues the new
one. It also drops duplicate packets (whose XID, client ID, and
MAC address are the same as one already queued).

A value of 0 indicates that there is no maximum queue length,
and all packets are processed.

Dropped packets are logged if the log setting
dropped-waiting-packets is set. It is off by default.

eod

ATTR: sms-network-discovery
ATTRID: 117
ATTRHDRNAME: AO_DHCPSERVER_SMS_NETWORK_DISCOVERY
ATTRTYPE: AT_INT
ATTRMCDPATH: sms-network-discovery
ATTRFLAGS: AF_INITIALIZE
ATTRDEFVAL: 0
ATTRVIZ: 5
ATTRDESC:: eod
Determines whether the DHCP server generates SMS network
discovery records.

If this attribute is set to 0, you disable SMS network
discovery. If it is set to 1, you enable discovery.

Use this attribute in conjunction with the dhcp updateSMS
command.

eod

ATTR: sms-library-path
ATTRID: 118
ATTRHDRNAME: AO_DHCPSERVER_SMS_LIBRARY_PATH
ATTRTYPE: AT_STRING
ATTRMCDPATH: sms-library-path
ATTRVIZ: 5
ATTRDESC:: eod
Overrides the internal default value for the SMS.dll.  Default
is an empty string.

If the string is empty, the system defaults to the internal
server default of smsrsgen.dll.

If the string is not empty, its value overrides the internal
SMS library name, smsrsgen.dll. If the system path does not include
the location of the SMS dll, you should provide the absolute path
of the dll.

eod

ATTR: sms-site-code
ATTRID: 119
ATTRHDRNAME: AO_DHCPSERVER_SMS_SITE_CODE
ATTRTYPE: AT_STRING
ATTRMCDPATH: sms-site-code
ATTRVIZ: 5
ATTRDESC:: eod
Specifies the site code name of the SMS server that receives
discovery records when you use the updateSMS keyword.

For proper functioning, make sure that you initialize this
attribute to the appropriate site code.

The default value is an empty string, but this prohibits data
discovery to complete successfully. So, you must provide the
site code.
eod

ATTR: sms-lease-interval
ATTRID: 120
ATTRHDRNAME: AO_DHCPSERVER_SMS_LEASE_INTERVAL
ATTRTYPE: AT_INT
ATTRMCDPATH: sms-lease-interval
ATTRFLAGS: AF_INITIALIZE
ATTRDEFVAL: 1100
ATTRVIZ: 5
ATTRDESC:: eod
Sets the amount of time, in milliseconds, that the DHCP server
waits between sending addresses to the System Management Server
(SMS) when executing updateSms command.
eod

ATTR: max-lease-state-events
ATTRID: 121
ATTRHDRNAME: AO_DHCPSERVER_MAX_LEASE_STATE_EVENTS
ATTRTYPE: AT_INT
ATTRMCDPATH: max-lease-state-events
#ATTRDEFVAL: 1000
ATTRVIZ: 3
ATTRDESC:: eod
The maximum number of lease-state updates that can be pending. The
server may be offered a client load that exceeds the throughput of
the underlying state database. Once it reaches this limit it will
slow its responses to clients until the pending lease-state data
has been written to the database.
eod

ATTR: always-flush-logs
ATTRID: 122
ATTRHDRNAME: AO_DHCPSERVER_ALWAYS_FLUSH_LOGS
ATTRTYPE: AT_INT
ATTRMCDPATH: always-flush-logs
#ATTRDEFVAL: 1
ATTRVIZ: 3
ATTRDESC:: eod
Controls whether the server flushes every log message synchronously
or not. Setting this param to '0' (FALSE) should reduce the
overhead of logging and improve overall performance.
eod

ATTR: map-user-class-id
ATTRID: 123
ATTRHDRNAME: AO_DHCPSERVER_MAP_USER_CLASS_ID
ATTRTYPE: AT_ENUMINT(none=0, map-as-tag=1, map-as-class=2, append-to-tags=3)
ATTRMCDPATH: map-user-class-id
ATTRDEFVAL: 0
ATTRVIZ: 5
ATTRDESC:: eod
Controls how the server uses the user-class-id option. Values are:

   0  none             Ignores the user class-id(default)

   1  map-as-tag       Maps the user-class-id to selection-tags

   2  map-as-class     Maps user-class-id directly to a
                       client-class name

   3  append-to-tags   Appends the user-class-id to the
                       selection-tags
eod

ATTR: append-user-class-id-to-selection-tag
ATTRID: 124
ATTRHDRNAME: AO_DHCPSERVER_APPEND_USER_CLASS_ID_TO_SELECTION_TAG
ATTRTYPE: AT_BOOL
ATTRMCDPATH: append-user-class-id-to-selection-tag
ATTRDEFVAL: true
ATTRVIZ: 1
DEPRECATED: 7.0
ATTRDESC:: eod
This property specifies whether the user-class-id should be
appended to an existing selection-tag or ignored. This value is
meaningful only if the map-user-class-id property is set to map to
selection-tag (i.e, map-user-class-id has a value of 1).
eod

ATTR: skip-client-lookup
ATTRID: 125
ATTRHDRNAME: AO_DHCPSERVER_SKIP_CLIENT_LOOKUP
ATTRTYPE: AT_BOOL
ATTRMCDPATH: skip-client-lookup
ATTRFLAGS: AF_INITIALIZE
ATTRDEFVAL: false
ATTRVIZ: 5
ATTRDESC:: eod
Determines whether the DHCP server looks up the client entry
in the database to do client-class processing. This value
can be examined as well as changed in a script at the
pre-client-lookup extension point. Default false
(disable).

If true, the server skips the client entry.
eod

ATTR: use-new-state-db
ATTRID: 126
ATTRHDRNAME: AO_DHCPSERVER_USE_NEW_STATE_DB
ATTRTYPE: AT_BOOL
ATTRMCDPATH: use-new-state-db
#ATTRDEFVAL: true
ATTRVIZ: 1
ATTRDESC:: eod
Controls whether the dhcp server will use the fastest database
available for lease state.
eod

ATTR: state-db-cache-size
ATTRID: 127
ATTRHDRNAME: AO_DHCPSERVER_STATE_DB_CACHE_SIZE
ATTRTYPE: AT_INT
ATTRMCDPATH: state-db-cache-size
#ATTRDEFVAL: 10000000
ATTRVIZ: 3
ATTRDESC:: eod
The new state database maintains a memory cache of
'state-db-cache-chunks' chunks of this size. That is, the memory
footprint of the database cache is the _product_ of these two
settings.
eod

ATTR: state-db-cache-chunks
ATTRID: 128
ATTRHDRNAME: AO_DHCPSERVER_STATE_DB_CACHE_CHUNKS
ATTRTYPE: AT_INT
ATTRMCDPATH: state-db-cache-chunks
#ATTRDEFVAL: 1
ATTRVIZ: 3
ATTRDESC:: eod
The new state database maintains a memory cache of
'state-db-cache-chunks' chunks of 'state-db-cache-size' size.
That is, the memory footprint of the database cache is the
_product_ of these two settings.
eod

ATTR: state-db-trans-interval
ATTRID: 129
ATTRHDRNAME: AO_DHCPSERVER_STATE_TRANS_INTERVAL
ATTRTYPE: AT_MSTIME
ATTRMCDPATH: state-db-trans-interval
#ATTRDEFVAL: 10
ATTRVIZ: 3
ATTRDESC:: eod
The interval at which pending state database transactions will be
committed, in milliseconds.
eod

ATTR: state-db-checkpoint-interval
ATTRID: 130
ATTRHDRNAME: AO_DHCPSERVER_STATE_CHECKPT_INTERVAL
ATTRTYPE: AT_TIME
ATTRMCDPATH: state-db-checkpoint-interval
ATTRDEFVAL: 60
ATTRVIZ: 3
ATTRDESC:: eod
The interval at which the new state database will checkpoint, in
seconds.
eod

ATTR: collect-performance-statistics
ATTRID: 131
ATTRHDRNAME: AO_DHCPSERVER_COLLECT_PERFORMANCE_STATS
ATTRTYPE: AT_BOOL
ATTRMCDPATH: CollectPerformanceStats
ATTRDEFVAL: false
ATTRVIZ: 5
ATTRDESC:: eod
Controls whether the DHCP server collects statistics for
performance monitoring.
eod

ATTR: state-db-use-client-hints
ATTRID: 132
ATTRHDRNAME: AO_DHCPSERVER_STATE_DB_CLIENT_HINTS
ATTRTYPE: AT_BOOL
ATTRMCDPATH: state-db-use-client-hints
#ATTRDEFVAL: false
ATTRVIZ: 1
DEPRECATED: 6.1
ATTRDESC:: eod
Deprecated in CNR 6.1
Controls whether the dhcp server includes and maintains a
database of clients in addition to the database of lease state.
eod

ATTR: state-db-logfile-size
ATTRID: 133
ATTRHDRNAME: AO_DHCPSERVER_STATE_DB_LOGFILE_SIZE
ATTRTYPE: AT_INT
ATTRMCDPATH: state-db-logfile-size
#ATTRDEFVAL: 0
ATTRVIZ: 3
ATTRDESC:: eod
The size of each log file that the underlying database will create,
in bytes. The database's default is currently 10MB.
eod

ATTR: state-db-log-buffer-size
ATTRID: 134
ATTRHDRNAME: AO_DHCPSERVER_STATE_DB_LOG_BUFFER_SIZE
ATTRTYPE: AT_INT
ATTRMCDPATH: state-db-log-buffer-size
#ATTRDEFVAL: 0
ATTRVIZ: 3
ATTRDESC:: eod
The size, in bytes, of the database's internal buffer between
database updates and the logfile. The database's default is
currently 32KB.
eod

ATTR: inhibit-busy-optimization
ATTRID: 135
ATTRHDRNAME: AO_DHCPSERVER_INHIBIT_BUSY_OPTIMIZATION
ATTRTYPE: AT_BOOL
ATTRMCDPATH: inhibit-busy-optimization
ATTRDEFVAL: false
ATTRVIZ: 5
ATTRDESC:: eod

Controls whether the server uses optimization to recover from
periods of congestion. Default false (disable).

By default, the DHCP server determines that it is heavily loaded
when the number of request packets reaches two-thirds of the
total allocated. The server logs a message and attempts to
recover from the congestion by performing several optimizations.
For example, it relaxes the requirement to keep the clients
last transaction time updated to the granularity specified by
the last-transaction-time-granularity attribute.

When the number of request packets drops to one-third of the
total allocated, the server logs a message and returns to
normal operation. If you enable the inhibit-busy-optimization
attribute, the server does not use the optimizations or log the
messages when it gets congested.


eod

ATTR: drop-old-packets
ATTRID: 136
ATTRHDRNAME: AO_DHCPSERVER_DROP_OLD_PACKETS
ATTRTYPE: AT_INT
ATTRMCDPATH: drop-old-packets
ATTRDEFVAL: 4
ATTRVIZ: 5
ATTRDESC:: eod
Sets the time, in seconds, that a packet can age and still be
processed.

The server attempts to read as many packets as possible from
the UDP input queue, and then process them quickly.  If the
server is very busy, it can sometimes become flooded with
packets. This could delay processing some packets.

In the DHCP protocol, however, some clients automatically
retry packets that have not been processed in a few seconds
--so allowing the server to process packets that are
older than a small number of seconds.  This can increase
congestion without providing any real value for the clients.

The drop-old-packets parameter is the number of seconds that
a packet can age and still be processed by the DHCP server.
If a packet is more than the value of drop-old-packets old
when processed by the DHCP server, the server drops the packet.
eod

ATTR: activity-summary-interval
ATTRID: 137
ATTRHDRNAME: AO_DHCPSERVER_ACTIVITY_SUMMARY_PERIOD
ATTRTYPE: AT_TIME
ATTRMCDPATH: activity-summary-interval
ATTRDEFVAL: 300
ATTRVIZ: 5
ATTRDESC:: eod
Sets the time that elapses between activity summary log
messages. You must also enable the activity-summary setting
in log-settings.

eod
ATTR: mcd-blobs-per-bulk-read
ATTRID: 138
ATTRHDRNAME: AO_DHCPSERVER_MCD_BLOBS_PER_BULK_READ
ATTRTYPE: AT_RANGEINT(1-2500)
ATTRMCDPATH: mcd-blobs-per-bulk-read
#ATTRDEFVAL: 256
ATTRVIZ: 5
ATTRDESC:: eod
Determines the number of binary large objects (blobs) in a bulk
read. Default 256.  Range, 1 to 2500.

Use this attribute to tune DHCP start and reload times.
Generally, a higher value will result in faster server start and
reload time, at the cost of using more memory.

eod

ATTR: policy-count
ATTRID: 139
ATTRHDRNAME: AO_DHCPSERVER_POLICY_COUNT
ATTRTYPE: AT_INT
ATTRMCDPATH: policy-count
ATTRFLAGS: AF_IMMUTABLE, AF_INITIALIZE
ATTRDEFVAL: 0
ATTRVIZ: 1
ATTRDESC:: eod
The number of policies configured in the server.
This is a read-only attribute.
eod

ATTR: scope-count
ATTRID: 140
ATTRHDRNAME: AO_DHCPSERVER_SCOPE_COUNT
ATTRTYPE: AT_INT
ATTRMCDPATH: scope-count
ATTRFLAGS: AF_IMMUTABLE, AF_INITIALIZE
ATTRDEFVAL: 0
ATTRVIZ: 1
ATTRDESC:: eod
The number of scopes configured in the server.
This is a read-only attribute.
eod

ATTR: lease-count
ATTRID: 141
ATTRHDRNAME: AO_DHCPSERVER_LEASE_COUNT
ATTRTYPE: AT_INT
ATTRMCDPATH: lease-count
ATTRFLAGS: AF_IMMUTABLE, AF_INITIALIZE
ATTRDEFVAL: 0
ATTRVIZ: 1
ATTRDESC:: eod
The number of leases configured in the server.
This is a read-only attribute.
eod

ATTR: reservation-count
ATTRID: 142
ATTRHDRNAME: AO_DHCPSERVER_RESERVATION_COUNT
ATTRTYPE: AT_INT
ATTRMCDPATH: reservation-count
ATTRFLAGS: AF_IMMUTABLE, AF_INITIALIZE
ATTRDEFVAL: 0
ATTRVIZ: 1
ATTRDESC:: eod
The number of reservations configured in the server.
This is a read-only attribute.
eod

ATTR: failover-bulking
ATTRID: 143
ATTRHDRNAME: AO_DHCPSERVER_FAILOVER_BULKING
ATTRTYPE: AT_BOOL
ATTRMCDPATH: failover-bulking
ATTRDEFVAL: true
ATTRVIZ: 5
ATTRDESC:: eod
With failover enabled, controls whether a failover BIND update
(BNDUPD) contains multiple lease state updates. Default true
(enable).

This attribute affects only the lease state updates that a DHCP
client generates.

eod

ATTR: state-db-log-purge-interval
ATTRID: 144
ATTRHDRNAME: AO_DHCPSERVER_DB_LOG_PURGE_INTERVAL
ATTRTYPE: AT_TIME
ATTRMCDPATH: state-db-log-purge-interval
ATTRDEFVAL: 1800
ATTRVIZ: 3
ATTRDESC:: eod
The interval at which the new state database will check for and
purge unneeded db log files, in seconds.
eod

ATTR: ignore-requests-for-other-servers
ATTRID: 145
ATTRHDRNAME: AO_DHCPSERVER_IGNORE_REQUEST_FOR_OTHER_SERVER
ATTRTYPE: AT_BOOL
ATTRMCDPATH: ignore-requests-for-other-servers
ATTRVIZ: 5
ATTRDESC:: eod

Controls whether to prevent the normal DHCP server
response to client requests for other servers.  No
default.

Normally, if the DHCP server detects a client requesting a lease
from another server for an address that this server is
configured to control, it sets the lease to unavailable. Some
clients, however, might send request packets with bad server ID
options--rather than packets actually directed to other
servers--that the server wrongly interprets as an unavailable
address. Enabling this attribute prevents this.

eod
ATTR: cnr-5-0-upgraded
ATTRID: 146
ATTRHDRNAME: AO_DHCPSERVER_CNR_5_0_UPGRADED
ATTRTYPE: AT_DATE
ATTRMCDPATH: cnr-5-0-upgraded
ATTRVIZ: 5
ATTRDESC:: eod
Indicates whether the DHCP server was upgraded from 3.5 to 5.0.
Read-only.
eod

ATTR: scp-port
ATTRID: 147
ATTRHDRNAME: AO_DHCPSERVER_SCP_PORT
ATTRTYPE: AT_RANGEINT(0-65535)
ATTRMCDPATH: scp-port
ATTRVIZ: 3
ATTRDESC:: eod
Specifies the scp port number to be used. If the requested port
number is in use, the server will select an alternate number to
use.
eod

ATTR: use-dns-update-prereqs
ATTRID: 150
ATTRHDRNAME: AO_DHCPSERVER_USE_DNS_PREREQS
ATTRTYPE: AT_BOOL
ATTRDEFVAL: true
ATTRMCDPATH: use-dns-update-prereqs
ATTRDESC:: eod
Controls whether the DHCP server adds prerequisites to DNS
update messages.  Default true (enable).

If true, the DHCP server includes prerequisites in DNS update
messages to make sure the client is using the domain name,
before it is updated with the current lease (IP
address).

If false, the DHCP server assumes the requesting client is
entitled to the domain name.  In this case, it does not include
prerequisites in the DNS update message, and associates the client
lease with that domain name.

Note: The DHCP server always adds prerequisites to the DNS
update message while adding a new domain name record on behalf
of a client acquiring a new lease and removing the domain name
record when a client releases its lease or the lease expires.
eod

ATTR: leasequery-reserved-lease-time
ATTRID: 151
ATTRHDRNAME: AO_DHCPSERVER_LEASEQUERY_RESERVED_LEASE_TIME
ATTRTYPE: AT_INT
ATTRMCDPATH: leasequery-reserved-lease-time
ATTRDEFVAL: 31536000
ATTRVIZ: 3
ATTRDESC:: eod
The leasequery reserved lease time is the dhcp-lease-time
option for a reserved lease that has never been leased.
eod

ATTR: delete-orphaned-leases
ATTRID: 152
ATTRHDRNAME: AO_DHCPSERVER_DELETE_ORPHANED_LEASES
ATTRTYPE: AT_BOOL
ATTRDEFVAL: false
ATTRMCDPATH: delete-orphaned-leases
ATTRVIZ: 5
ATTRDESC:: eod
Controls how the DHCP server handles orphaned leases.
Default is false (disabled).

A lease is orphaned if:

--It does not match a range or reservation in a configured scope, or
--If it appears in the lease state database with a VPN ID that does
  not match a VPN in the database.

If this is attribute is true, the server deletes orphaned leases
when the server next reloads. This ensures that the lease state
database has no old, unconfigured leases in it, but it also may
cause the total loss of lease state information due to a mistake
in configuration.

If this attribute is false, the server ignores the entries in
the lease state database. If the lease was orphaned due to a
configuration mistake, then when you when you correct the
mistake, the DHCP server can use the lease.

Whether true or false, the server cannot use the lease.

eod
ATTR: vpn-communication
ATTRID: 153
ATTRHDRNAME: AO_DHCPSERVER_VPN_COMMUNICATION
ATTRTYPE: AT_BOOL
ATTRDEFVAL: true
ATTRMCDPATH: vpn-communication
ATTRVIZ: 5
ATTRDESC:: eod
Controls the ability of the DHCP server to communicate with
clients that are on a different VPN from the server. Default
is true (enable).

If true, the server communicates with DHCP clients residing on
a different VPN by using an enhanced DHCP Relay Agent capability.
This enhanced DHCP Relay Agent capability is indicated by the
appearance of the server-id-override sub-option in
the relay agent information option (Option 82).
eod

ATTR: client-cache-count
ATTRID: 154
ATTRHDRNAME: AO_DHCPSERVER_CLIENT_CACHE_COUNT
ATTRTYPE: AT_INT
ATTRMCDPATH: client-cache-count
ATTRDEFVAL: 1000
ATTRVIZ: 5
ATTRDESC:: eod
Specifies the maximum number of clients in the client cache.
The DHCP server allocates the amount at startup and frees
it at shutdown. If you set the value to 0, you disable client
caching and the server must use persistent storage to process a
DHCPREQUEST.

eod
ATTR: client-cache-ttl
ATTRID: 155
ATTRHDRNAME: AO_DHCPSERVER_CLIENT_CACHE_TTL
ATTRTYPE: AT_TIME
ATTRMCDPATH: client-cache-ttl
ATTRDEFVAL: 10
ATTRVIZ: 5
ATTRDESC:: eod
Sets the maximum time-to-live in seconds for a client in
cache. The DHCP server discards the entries in memory after
this period.

eod
ATTR: delete-orphaned-subnets
ATTRID: 156
ATTRHDRNAME: AO_DHCPSERVER_DELETE_ORPHANED_SUBNETS
ATTRTYPE: AT_BOOL
ATTRDEFVAL: false
ATTRMCDPATH: delete-orphaned-subnets
ATTRVIZ: 5
ATTRDESC:: eod
Controls how the DHCP server handles information about an
orphaned subnet; that is, whether it keeps the entry in its
database or deletes it. Default is false (disable).

As the DHCP server starts up, it tries to locate the
parent VPN and DHCP address block of each DHCP subnet. If a
subnet refers to a VPN that is no longer configured, or if
the server cannot locate a parent DHCP address block that
contains the subnet, the server uses this attribute
to decide.

eod

ATTR: ip-history
ATTRID: 157
ATTRHDRNAME: AO_DHCPSERVER_SAVE_IP_HISTORY
ATTRTYPE: AT_BOOL
ATTRDEFVAL: false
ATTRFLAGS: AF_FEATURE
ATTRMCDPATH: ip-history
ATTRDESC:: eod
Enables the lease history database. Default is false (disable).

eod

ATTR: ip-history-dir
ATTRID: 158
ATTRHDRNAME: AO_DHCPSERVER_IP_HISTORY_DIR
ATTRTYPE: AT_STRING
ATTRMCDPATH: ip-history-dir
ATTRVIZ: 1
DEPRECATED: 6.1
ATTRDESC:: eod
deprecated in cnr 6.1

Specifies the directory in which the lease history database
should be kept. If you enable the lease history feature, we
recommend that you place its database on a different disk
partition from the server's lease state database. This reduces
competition for disk access and free disk space.
eod
ATTR: ip-history-key
ATTRID: 159
ATTRHDRNAME: AO_DHCPSERVER_IP_HISTORY_KEY
ATTRTYPE: AT_INT
ATTRDEFVAL: 51
ATTRMCDPATH: ip-history-key
ATTRVIZ: 1
DEPRECATED: 6.1
ATTRDESC:: eod
deprecated in cnr 6.1

Specifies the shared memory key id for systems where the DB
subsystem requires an explicit shared memory key.  (Currently Sys5
based UNIX systems, such as Solaris).
eod

ATTR: max-lease-expirations
ATTRID: 160
ATTRHDRNAME: AO_DHCPSERVER_MAX_LEASE_EXPIRATIONS
ATTRTYPE: AT_INT
ATTRMCDPATH: max-lease-expirations
ATTRVIZ: 3
ATTRDEFVAL: 100
ATTRDESC:: eod
The maximum number of leases that will be allowed to expire in a
single timer queue interval.
eod

ATTR: addr-blocks-use-lan-segments
ATTRID: 161
ATTRHDRNAME: AO_DHCPSERVER_BLOCKS_USE_LANSEGMENTS
ATTRTYPE: AT_BOOL
ATTRMCDPATH: addr-blocks-use-lan-segments
ATTRVIZ: 5
ATTRDEFVAL: false
ATTRDESC:: eod
Controls whether DHCP subnet-allocation uses the lan-segment
attribute when it is configured on address-blocks.

eod

ATTR: addr-blocks-use-client-affinity
ATTRID: 162
ATTRHDRNAME: AO_DHCPSERVER_BLOCKS_USE_AFFINITY
ATTRTYPE: AT_BOOL
ATTRMCDPATH: addr-blocks-use-client-affinity
ATTRVIZ: 5
ATTRDEFVAL: true
ATTRDESC:: eod
Controls whether the DHCP server allocates subnets to clients
using address-blocks that the clients have already used.

If you set this attribute to false, the server allocates subnets
from any suitable block (based on other selection data in client
messages.
eod

ATTR: addr-blocks-use-selection-tags
ATTRID: 163
ATTRHDRNAME: AO_DHCPSERVER_BLOCKS_USE_TAGS
ATTRTYPE: AT_BOOL
ATTRMCDPATH: addr-blocks-use-selection-tags
ATTRVIZ: 5
ATTRDEFVAL: true
ATTRDESC:: eod
Controls whether the server compares subnet name data on an
incoming subnet-allocation request with the selection tag of each
address-block.  A block is only considered if the two match.

eod

ATTR: addr-blocks-default-selection-tags
ATTRID: 164
ATTRHDRNAME: AO_DHCPSERVER_BLOCKS_DEFAULT_TAGS
ATTRTYPE: AT_ARRAY(AT_STRING)
ATTRMCDPATH: addr-blocks-default-selection-tags
ATTRVIZ: 5
ATTRDESC:: eod
Associates a default selection tag (or list of tags) with incoming
subnet-allocation requests that do not contain any subnet name
data.

eod

# special attr for use in diagnosing CSCdw17069
ATTR: timeout-auto-debug-duration
ATTRID: 165
ATTRHDRNAME: AO_DHCPSERVER_TIMEOUT_DEBUG_TIME
ATTRTYPE: AT_TIME
ATTRVIZ: 3
ATTRMCDPATH: timeout-auto-debug-duration
ATTRDESC:: eod
If auto-debug is activated by a premature lease expiration,
it will remain active for this duration, and then
the debug tracing will shut itself off. A value of zero
disables the auto-debug tracing.
eod

ATTR: client-class-lookup-id
ATTRID: 166
ATTRHDRNAME: AO_DHCPSERVER_CLIENT_CLASS_LOOKUP_ID
ATTRTYPE: AT_EXPR
ATTRMCDPATH: client-class-lookup-id
ATTRVIZ: 5
ATTRDESC:: eod
Specifies the expression used to determine a client-class solely
on data contained in an incoming DHCP client request.
The expression must return a string with the name of a currently
configured client-class, otherwise it must return the string
'<none>'. Any return that is not a string containing the name
of a currently configured client-class or '<none>' is considered
an error.
eod

ATTR: expression-trace-level
ATTRID: 167
ATTRHDRNAME: AO_DHCPSERVER_EXPRESSION_TRACE_LEVEL
ATTRTYPE: AT_INT
ATTRDEFVAL: 2
ATTRMCDPATH: expression-trace-level
ATTRVIZ: 5
ATTRDESC:: eod
Sets the trace level to use when executing DHCP expressions.
ptional, default 2.

The range is from 0 through 6, with 0 being no tracing and 6 the
highest amount of tracing:

0-No tracing
1-Failures, including those protected by (try ...)
2-Total failure retries (with trace level = 6 for retry)
3-Function calls and returns
4-Function arguments evaluated
5-Print function arguments
6-Datatype conversions (everything)

Setting this attribute to any level other than 0, 1, or 2
imposes a considerable performance penalty.

The setting of 1 only traces when there is a failure in an
expression. The default setting of 2 re-executes
evaluating an expression that fails at the outermost level
with the expression-trace-level=10 for the duration of the
re-execution, to provide maximum debugging assistance.


eod

ATTR: state-db-lock-count
ATTRID: 168
ATTRHDRNAME: AO_DHCPSERVER_STATE_DB_LOCK_COUNT
ATTRTYPE: AT_INT
ATTRMCDPATH: state-db-lock-count
ATTRDEFVAL: 15000
ATTRVIZ: 3
ATTRDESC:: eod
The maximum number of state database transaction locks available.
Sometimes, particularly when processing a new failover
configuration with very large scopes (>65K leases) the number of
leases per database transaction can grow well beyond the default
of 15000, but the state-db-max-trans-count (default 5000) will
limit this. Set debug G=1 and reload the server to see the high
water mark for locks used.
eod

ATTR: state-db-max-commit-time
ATTRID: 169
ATTRHDRNAME: AO_DHCPSERVER_STATE_DB_MAX_COMMIT_TIME
ATTRTYPE: AT_INT
ATTRMCDPATH: state-db-max-commit-time
#ATTRDEFVAL: 60
ATTRVIZ: 3
ATTRDESC:: eod
A time in seconds within which the state database background
thread must perform a database write or a trigger will be set.
If three such triggers are set together with no intervening writes,
the DHCP server will abort.
eod

ATTR: renewal-inhibition-max-time
ATTRID: 170
ATTRTYPE: AT_TIME
ATTRMCDPATH: renewal-inhibition-max-time
ATTRDEFVAL: 60
ATTRVIZ: 3
ATTRDESC:: eod
When inhibit-renews or inhibit-renews-at-reboot is enabled, the
server uses this time interval to distinguish between client
messages which should be rejected, and retries or retransmissions
which should not be inhibited.
eod

ATTR: ignore-cnr-echo
ATTRID: 171
ATTRTYPE: AT_BOOL
ATTRMCDPATH: ignore-cnr-echo
ATTRDEFVAL: false
ATTRVIZ: 3
ATTRDESC:: eod
This parameter causes the server to ignore the user-class option
value used by test clients.
eod

ATTR: state-db-max-trans-count
ATTRID: 172
ATTRHDRNAME: AO_DHCPSERVER_STATE_DB_MAX_TRANS_COUNT
ATTRTYPE: AT_INT
ATTRMCDPATH: state-db-max-trans-count
#ATTRDEFVAL: 5000
ATTRVIZ: 3
ATTRDESC:: eod
The maximum number of data items allowed within one transaction
in the lease state database.
eod

ATTR: state-db-no-trans-interval
ATTRID: 173
ATTRHDRNAME: AO_DHCPSERVER_STATE_DB_NO_TRANS_INTERVAL
ATTRTYPE: AT_INT
ATTRMCDPATH: state-db-no-trans-interval
#ATTRDEFVAL: 100
ATTRVIZ: 3
ATTRDESC:: eod
When the number of data items exceeds this count, the state
database write thread will not wait the state-db-trans-interval
number of milliseconds before writing the next batch of updates.
Default 100.
eod

ATTR: dynamic-dns-tsig
ATTRID: 174
ATTRTYPE: AT_ENUMINT(enable-fwd-and-rev=1,disable-fwd-and-rev=2,enable-fwd-only=3,enable-rev-only=4)
ATTRDEFVAL: disable-fwd-and-rev
ATTRFLAGS: AF_PRINT_ALT
ATTRMCDPATH: dynamic-dns-tsig
ATTRVIZ: 1
DEPRECATED: 7.0
ATTRDESC:: eod
This attribute controls whether TSIG is used for DNS updates for
leases from this server.

If set to 'enable-fwd-and-rev' or 'disable-fwd-and-rev' tsig will
or will not be used for both forward and reverse zone updates,
respectively.

If set to 'enable-fwd-only' or 'enable-rev-only', tsig will
be used for forward or reverse updates alone, respectively.
eod

ATTR: dynamic-dns-fwd-key
ATTRID: 175
ATTRTYPE: AT_DNSNAME
ATTRMCDPATH: ddns-fwd-key
ATTRVIZ: 1
DEPRECATED: 7.0
ATTRDESC:: eod
Server wide security key to process all forward zone dynamic DNS
updates for those DNS Update Configurations that don't explicitly
specify a key.
Note: If set, all forward zone dynamic DNS updates must be secured
as there is no way to unset it for a specific DNS Update
Configuration.
eod

ATTR: dynamic-dns-rev-key
ATTRID: 176
ATTRTYPE: AT_DNSNAME
ATTRMCDPATH: ddns-rev-key
ATTRVIZ: 1
DEPRECATED: 7.0
ATTRDESC:: eod
Server wide security key to process all reverse zone dynamic DNS
updates for those DNS Update Configurations that don't explicitly
specify a key.

Note: If set, all reverse zone dynamic DNS updates must be secured
as there is no way to unset it for a specific DNS Update
Configuration.
eod

ATTR: state-db-average-time-percentage
ATTRID: 177
ATTRHDRNAME: AO_DHCPSERVER_STATE_DB_AVERAGE_TIME_PERCENTAGE
ATTRTYPE: AT_INT
ATTRMCDPATH: state-db-average-time-percentage
ATTRDEFVAL: 0
ATTRVIZ: 3
ATTRDESC:: eod
This attribute controls the state database operation time
statistics.  If the value of this attribute is zero, no
time statistics are kept for the state database.  If this
value is non-zero, it does two things.  First, it enables
timing (at a gross 1 second granularity) of state database
operations.  Second, it controls the weight the most recent
value has in the running average.  A number of 10 is a
reasonable starting point to use when enabling this capablity.
By default it not enabled.
eod

ATTR: state-db-limit-load
ATTRID: 178
ATTRHDRNAME: AO_DHCPSERVER_STATE_DB_LIMIT_LOAD
ATTRTYPE: AT_BOOL
ATTRMCDPATH: state-db-limit-load
ATTRDEFVAL: true
ATTRVIZ: 3
ATTRDESC:: eod
Controls whether the load on the state database manager is
limited or let to run at the fastest data rate possible.
By default the parameter is unset, but the server does limit
the load.
eod

ATTR: process-lease-count-limit
ATTRID: 179
ATTRHDRNAME: AO_DHCPSERVER_PROCESS_LEASE_COUNT_LIMIT
ATTRTYPE: AT_INT
ATTRMCDPATH: process-lease-count-limit
ATTRDEFVAL: 10
ATTRVIZ: 3
ATTRDESC:: eod
Controls the number of recursive calls allowed upon the stack
when processing multiple leases from a single response.  Used
primarily in failover.  A value too large causes the stack to
overflow.
eod

ATTR: defer-lease-extensions-for-changed-times
ATTRID: 180
ATTRHDRNAME: AO_DHCPSERVER_DEFER_LEASE_EXTENSIONS_FOR_CHANGED_TIMES
ATTRTYPE: AT_BOOL
ATTRMCDPATH: state-db-defer-lease-extensions-for-changed-times
ATTRDEFVAL: true
ATTRVIZ: 1
DEPRECATED: 7.0
ATTRDESC:: eod
If set to false, will cause the server to not defer lease
extensions for leases whose lease times were recalculated for
failover.  By default it is unset, but the server allows defer
lease extensions for failover leases.
eod


ATTR: validate-client-name-as-mac
ATTRID: 181
ATTRHDRNAME: AO_DHCPSERVER_VALIDATE_CLIENT_NAME_AS_MAC
ATTRTYPE: AT_BOOL
ATTRMCDPATH: validate-client-name-as-mac
ATTRDEFVAL: false
ATTRVIZ: 5
ATTRDESC:: eod
Controls whether the Network Registrar user interfaces require
that the name of client entries is valid MAC address (or the
literal string 'default').  Default is false (disable).

If true, the user interfaces convert the name to the canonical
MAC address format: 1,6,xx:xx:xx:xx:xx:xx.  The DHCP server uses
this as the default client entry lookup key.

If false, the user interfaces allow creating client
entries with arbitrary names, which could match the lookup
keys generated from the client-lookup-id expression.
eod

ATTR: expression-configuration-trace-level
ATTRID: 182
ATTRHDRNAME: AO_DHCPSERVER_EXPRESSION_CONFIGURATION_TRACE_LEVEL
ATTRTYPE: AT_INT
ATTRDEFVAL: 2
ATTRMCDPATH: expression-configuration-trace-level
ATTRVIZ: 5
ATTRDESC:: eod
Sets the trace level to use when configuring DHCP expressions.
Default is 2 (failure retry).

The range is from 0 through 6, with 0 being the lowest amount
of tracing and 6 the highest:

   0  No additional tracing
   1  No additional tracing
   2  Failure retry
   3  Function definitions
   4  Function arguments
   5  Variable lookups and literal details
   6  Everything

Setting a high expression-configuration-trace-level imposes no
performance penalty, since expressions are configured only
when you restart the server.

eod
ATTR: upgrade-unavailable-timeout
ATTRID: 183
ATTRHDRNAME: AO_DHCPSERVER_UPGRADE_UNAVAILABLE_TIMEOUT
ATTRTYPE: AT_TIME
ATTRDEFVAL: 86400
ATTRMCDPATH: ungrade-unavailable-timeout
ATTRVIZ: 5
ATTRDESC:: eod
Controls the time given to a lease in the database that has no
expiration; that is, it became unavailable prior to
installing Network Registrar. The DHCP server uses the
upgrade-unavailable-timeout for the expiration time of the
unavailable lease. Default is 86400 seconds (1 day).

eod

ATTR: leasequery-max-scan
ATTRID: 184
ATTRHDRNAME: AO_DHCPSERVER_LEASEQUERY_MAX_SCAN
ATTRTYPE: AT_INT
ATTRDEFVAL: 5000
ATTRVIZ: 3
ATTRDESC:: eod
Determines the number of leases that leasequery processing
scans before waiting a millisecond to allow other activity
to access the network on which it is working.  Default is
5000.

A smaller number increases the processing speed for leasequery
requests for non-existent MAC addresses at the cost of locking
out regular DHCP requests for a longer period of time.
eod

ATTR: initial-environment-dictionary
ATTRID: 185
ATTRHDRNAME: AO_DHCPSERVER_INITIAL_ENVIRONMENT_DICTIONARY
ATTRTYPE: AT_STRING
ATTRVIZ: 5
ATTRDESC:: eod
Contains attribute-value pairs that initialize all environment
dictionaries used within the DHCP server.  Use these attribute-value
pairs to configure extensions or expressions without having to
re-write the executable code in the extension or expression.
The string must have the format:
"attribute1=value1,attribute2=value2, ... ,attributen=valuen"
eod

ATTR: synthesize-reverse-zone
ATTRID: 186
ATTRTYPE: AT_BOOL
ATTRFLAGS: AF_FEATURE
ATTRDEFVAL: true
ATTRHDRNAME: AO_DHCPSERVER_SYNTHESIZE_REVERSE_ZONE
ATTRMCDPATH: synthesize-reverse-zone
ATTRVIZ: 5
ATTRDESC:: eod
Controls whether the DHCP server automatically generates the
name of the reverse zone (in-addr.arpa or ip6.arpa) that receives
PTR records updates.  Default is true (enable).

If true, you are not required to configure an explicit 
dns-reverse-zone-name in the DNS update configuration. Instead, the
DHCP server uses the IP address of each lease and the dns-host-bytes 
attribute of the scope or the reverse-zone-prefix-length attribute 
of the prefix to synthesize the reverse zone name for each update. 

The server trims the specified host bytes from the low-order
bytes of the address, and turns the remaining bytes into a zone
name of the form '.b.a.in-addr.arpa.' The host-bytes
low-order bytes of the address are used to form the hostname
within that zone. Similarly, the prefix length is used to
form the 'ip6.arpa' zone name, and the low-order bytes are used
to form the hostname.
eod

ATTR: trim-host-name
ATTRID: 187
ATTRTYPE: AT_BOOL
ATTRFLAGS: AF_FEATURE
ATTRDEFVAL: true
ATTRHDRNAME: AO_DHCPSERVER_TRIM_HOST_NAME
ATTRMCDPATH: trim-host-name
ATTRVIZ: 5
ATTRDESC:: eod
Controls whether or not DHCP server trims the hostname string
to the first period (or dot) character (used to update DDNS
records and to return host-name-option to clients). Default,
true (enable).

If true, the hostname is truncated before the period.

If false, the DHCP server retains the period characters in the
hostname.

eod

ATTR: report-active-buffers
ATTRID: 188
ATTRTYPE: AT_ENUMINT(disabled=0,enabled=1,busy-activity-report=2,activity-report=3)
ATTRFLAGS: AF_PRINT_ALT
ATTRDEFVAL: disabled
ATTRVIZ: 3
ATTRDESC:: eod
Controls whether or not the server reports on active request
buffers when it is stopped. Buffers that are in-use when the
server is stopped may indicate that buffers are not available for
use in responding to clients.  If busy-activity-report is set,
there will be a summary of active buffers whenever the activity
summary log message is output and the server has used up more than
2/3 of its available request buffers.  If activity-report is set,
then every activity summary log will contain a summary of active
buffers.
eod

ATTR: map-radius-class
ATTRID: 189
ATTRTYPE: AT_ENUMINT(none=0, map-as-tag=1, map-as-class=2, append-to-tags=3)
ATTRMCDPATH: map-radius-class
ATTRDEFVAL: 0
ATTRVIZ: 5
ATTRDESC:: eod
Controls how to map the radius attribute, if present,
in the client request relay-agent option:

   0  none             Ignores the radius class name default

   1  map-as-tag       Maps the radius class to selection-tags

   2  map-as-class     Maps the radius class  directly to a
                       client-class name

   3  append-to-tags   Appends the radius class to the
                       selection-tags
eod

ATTR: priority-address-allocation
ATTRID: 190
ATTRTYPE: AT_BOOL
ATTRFLAGS: AF_FEATURE
ATTRDEFVAL: false
ATTRHDRNAME: AO_DHCPSERVER_PRIORITY_ADDRESS_ALLOCATION
ATTRMCDPATH: priority-address-allocation
ATTRVIZ: 5
ATTRDESC:: eod
Controls address allocation among scopes in the same network and
within an individual scope as well.

When enabled, any scope without an explicit setting for
allocation-priority is configured with an allocation-priority
equal to the network number of the scope.  Similarly, any scope
without an explicit setting for allocate-first-available
is considered enabled.

Explicit settings for either of these scope attributes override
the priority-address-allocation set for that scope.

This attribute gives the administrator a way to change address
allocation in a server wide manner without having to separately
configure each scope.

eod

ATTR: equal-priority-most-available
ATTRID: 191
ATTRTYPE: AT_BOOL
ATTRFLAGS: AF_FEATURE
ATTRDEFVAL: false
ATTRHDRNAME: AO_DHCPSERVER_EQUAL_PRIORITY_MOST_AVAILABLE
ATTRMCDPATH: equal-priority-most-available
ATTRVIZ: 5
ATTRDESC:: eod
Controls address allocation among scopes in the same network.
This attribute determines how the DHCP server allocates an
address to a new client when multiple scopes have the same
nonzero allocation priority. Default is false (disable).

If disabled, the server uses the scope with the fewest available
addresses to allocate an address to a new client (if not in a
limitation list).

If enabled, the server uses the scope with the most available
addresses to allocate an address to a new client
(if not in a limitation list).

In either case, if a client is in a limitation list,
among those scopes of the same priority, the one that contains
other clients in the same list is always used.


eod
ATTR: collect-addr-util-duration
ATTRID: 192
#ATTRTYPE: AT_RANGETIME(0h-72h)
ATTRTYPE: AT_RANGETIME(0-259200)
ATTRFLAGS:
ATTRDEFVAL: 0h
ATTRMCDPATH: collect-addr-util-duration
ATTRDESC:: eod

Sets the maximum period, in hours, that the DHCP server
maintains address utilization data.

To disable collecting address utilization data, unset
this attribute or give it a value of 0.

Use this attribute, with the collect-addr-util-interval
attribute, to determine the frequency that the server
uses to take snapshots of the data and to set the length of
time the DHCP server maintains the data. Together these attributes
have an impact on memory usage because each snapshot of data is
68 bytes.

For example, if you have 10 scopes and you set
collect-addr-util-duration is set to 24h and
collect-addr-util-interval to 1h, memory used by the DHCP
server to maintain address utilization data is 24 times 68 bytes
for each scope; that is, 10x24x68 or 16KB.

eod
ATTR: collect-addr-util-interval
ATTRID: 193
#ATTRTYPE: AT_RANGETIME(5m-24h)
ATTRTYPE: AT_RANGETIME(300-86400)
ATTRFLAGS:
ATTRDEFVAL: 15m
ATTRMCDPATH: collect-addr-util-interval
ATTRDESC:: eod
Sets the frequency, in minutes or hours, that the DHCP
server uses to take snapshot views of address utilization data.

If collect-addr-util-duration is not configured, or set
to 0, the DHCP server ignores the collect-addr-util-interval.

Use this attribute, with the collect-addr-util-duration
attribute, to determine the frequency that the server uses to
take snapshots of the data and the length of time the DHCP server
maintains the data. Together these attributes affect memory
usage because each snapshot of data is 68 bytes.

For example, if you have 10 scopes and you set
collect-addr-util-duration to 24h and collect-addr-util-interval
to 1h, memory used by the DHCP erver to maintain address
utilization data is 24 times 68 bytesfor each scope; that is,
10x24x68 or 16KB.
eod
ATTR: state-db-use-debug-log
ATTRID: 194
ATTRTYPE: AT_BOOL
ATTRVIZ: 3
ATTRDEFVAL: false
ATTRDESC:: eod
If enabled, the DHCP server will open a file called
dhcp_db_errs.txt and use it as the low-level database error log
file.
eod

ATTR: ip-history-max-age
ATTRID: 195
ATTRTYPE: AT_TIME
ATTRDEFVAL: 4w
ATTRDESC:: eod
If ip-history is enabled, determines how long IP records are
kept in the database. Default is 4w.

The server accumulates database records over time as lease
bindings change. The ip-history-max-age attribute establishes
a limit on the age of thehistory records kept in the database.
The server periodically examines the lease history records,
establishes an age threshold based on this parameter, and
deletes any records that represent bindings that end before
the threshold. The history records are trimmed by default once
a day, at 3:00 a.m. local time.
eod

ATTR: ip-history-trim-interval
ATTRID: 196
ATTRTYPE: AT_TIME
ATTRVIZ: 3
ATTRDEFVAL: 86400
ATTRDESC:: eod
If this is not zero and is greater then 1 day (86400 seconds),
the server will round this value up to an integral number of days,
and execute history-trimming at 3am at that interval.
If this is not zero and is less than 1 day (86400 seconds), the
server will schedule history trimming at this interval from the
latest reload of the server (generally, history trimming at
more often that 1 day intervals is not recommended).
If this is zero, the server will not perform history trimming --
and if ip-history is enabled, the history database will continue
to grow without bound.
eod

ATTR: ip-history-detail
ATTRID: 197
ATTRTYPE: AT_BOOL
ATTRDEFVAL: false
ATTRDESC:: eod
Controls whether to record detailed data for the IP
history database. Default is false (disable).
eod

ATTR: ignore-cisco-options
ATTRID: 198
ATTRTYPE: AT_NLIST(AT_STRING)
ATTRVIZ: 5
ATTRDESC:: eod
Skips processing the Cisco-specific DHCP options specified
by name in the comma-separated list.  No default.

Allowable option names are vpn-id (185), cisco-vpn-id (221),
and subnet-alloc (220). Use this attribute only if
clients use the options for other purposes.
eod

ATTR: failover-load-balancing-backup-pct
ATTRID: 199
ATTRTYPE: AT_PERCENT
ATTRDEFVAL: 0
ATTRVIZ: 1
DEPRECATED: 7.0
ATTRDESC:: eod
The percentage of the clients the backup server is to service
while in normal communication with the main server. If greater
than 0, this enables failover load balancing (see RFC 3074). It
must be defined for the main server, and is ignored on the backup
server (to enable copying of configurations). Default is 0
(disables failover load balancing).
eod

ATTR: collect-sample-counters
ATTRID: 200
ATTRTYPE: AT_BOOL
ATTRFLAGS: AF_FEATURE
ATTRDEFVAL: false
ATTRDESC:: eod
Controls whether the DHCP server collects activity statistics
counters independently of the log-settings attribute flag.

If false, this attribute is disabled.

If true, this attribute enables collecting activity
statistics.

Note: These activity statistics counters are also enabled,
if you enable 'activity-summary'
logging is enabled (see 'log-settings').
eod

ATTR: udp-send-packet-size
ATTRID: 201
ATTRHDRNAME: AO_DHCPSERVER_UDPSENDPACKETSIZE
ATTRTYPE: AT_INT
ATTRMCDPATH: UDPSendPacketSize
ATTRDEFVAL: 1400
ATTRVIZ: 3
ATTRDESC:: eod
Limits the maximum size of UDP packets sent by the server.
Specified size includes the IP and UDP headers. Must be less than
or equal to the UDPPacketSize attribute.
eod

ATTR: traps-enabled
ATTRID: 202
ATTRTYPE: AT_FLAGSINT(all=1,server-start=2,server-stop=3,free-address-low=4,free-address-high=5,dns-queue-size=6,other-server-down=7,other-server-up=8,duplicate-address=9,address-conflict=10,failover-config-error=11,free-address6-low=12,free-address6-high=13,duplicate-address6=14,duplicate-prefix6=15)
ATTRDESC:: eod
Determines the traps that this server is configured to send.
   1  all
      Sends notifications for all server events.

   2  server-start
      Sends notifications whenever the server is started or
      reinitialized.

   3  server-stop
      Sends notifications whenever the server is stopped.

   4  free-address-low
      Sends notifications when the number of free IP addresses
      becomes less than or equal to the low threshold.

   5  free-address-high
      Sends notifications when the number of free IP addresses
      exceeds the high threshold after having previously
      triggered the free-address-low trap.

   6  dns-queue-size
      Sends notifications when the DHCP servers DNS queue
      fills and the DHCP server stops processing requests.

   7  other-server-down
      Sends notifications when another server (DHCP, DNS, or
      LDAP) stops responding to this DHCP server.

   8  other-server-up
      Sends notifications when another server (DHCP, DNS, or
      LDAP) responds after having been unresponsive.

   9  duplicate-address
      Sends notifications whenever a duplicate IP address is
      detected.

   10 address-conflict
      Sends notifications when an address conflict with another
      DHCP server is detected.

   11 failover-config-error
      Notifies when a configuration mismatch between DHCP
      failover partners occurs.

   12 free-address-low
      Sends notifications when the number of free IPv6 addresses
      becomes less than or equal to the low threshold.

   13 free-address-high
      Sends notifications when the number of free IPv6 addresses
      exceeds the high threshold after having previously
      triggered the free-address-low6 trap.

   14 duplicate-address6
      Sends notifications whenever a duplicate IPv6 address is
      detected.

   15 duplicate-prefix6
      Sends notifications whenever a duplicate prefix is
      detected.

No default.
eod

ATTR: server-port
ATTRID: 203
ATTRTYPE: AT_RANGEINT(1-65535)
ATTRVIZ: 3
ATTRDEFVAL: 67
ATTRDESC:: eod
The default port number that the DHCP server should listen on.
eod

ATTR: client-port
ATTRID: 204
ATTRTYPE: AT_RANGEINT(1-65535)
ATTRVIZ: 3
ATTRDEFVAL: 68
ATTRDESC:: eod
The default port used as the destination for packets sent to
DHCP clients.
eod

ATTR: relay-port
ATTRID: 205
ATTRTYPE: AT_RANGEINT(1-65535)
ATTRVIZ: 3
ATTRDEFVAL: 67
ATTRDESC:: eod
The default port used as the destination for packets sent to
DHCP relay-agents.
eod

ATTR: v6-server-port
ATTRID: 206
ATTRTYPE: AT_RANGEINT(1-65535)
ATTRVIZ: 3
ATTRDEFVAL: 547
ATTRDESC:: eod
The default port number that the DHCP server should listen
on for DHCPv6 messages.
eod

ATTR: v6-client-port
ATTRID: 207
ATTRTYPE: AT_RANGEINT(0-65535)
ATTRVIZ: 3
ATTRDEFVAL: 546
ATTRDESC:: eod
The default port used as the destination for packets sent
to DHCPv6 clients.

If 0, the server will use the client's source port. Note that
Reconfigure messages (unicast to the client) will fail as the
server will attempt to use port 0.
eod

ATTR: v6-relay-port
ATTRID: 208
ATTRTYPE: AT_RANGEINT(0-65535)
ATTRVIZ: 3
ATTRDEFVAL: 547
ATTRDESC:: eod
The default port used as the destination for packets sent
to DHCPv6 relay-agents.

If 0, the server will use the relay-agent's source port. Note
that Reconfigure messages (sent via the relay) will fail as
the server will attempt to use port 0.
eod

ATTR: dns-port
ATTRID: 209
ATTRTYPE: AT_RANGEINT(1-65535)
ATTRVIZ: 3
ATTRDEFVAL: 53
ATTRDESC:: eod
The port to which DNS updates and queries are sent.
eod

ATTR: min-socket-buffer-size
ATTRID: 210
ATTRTYPE: AT_RANGEINT(1-1000000)
ATTRDEFVAL: 32768
ATTRVIZ: 3
ATTRDESC:: eod
The default socket receive and send buffer size. This
controls the amount of buffering done by the kernel.
eod

ATTR: multicast-addresses
ATTRID: 211
ATTRTYPE: AT_NLIST(AT_IP6ADDR)
ATTRDEFVAL: ff02::1:2,ff05::1:3
ATTRDESC:: eod
Controls the default multicast addresses that are enabled
on interfaces. The address ff02::1:2 is required if any
DHCPv6 clients are directly connected to the link associated
with an interface. The address ff05::1:3 is the default
multicast address that relay agents use to relay DHCPv6
requests.
eod

ATTR: atul-port
ATTRID: 212
ATTRTYPE: AT_RANGEINT(1-65535)
ATTRDEFVAL: 7543
ATTRDESC:: eod
If configured, enables the DHCP server to listen for incoming
ATUL queries on this UDP port.
eod

ATTR: v6-client-class-lookup-id
ATTRID: 213
ATTRTYPE: AT_EXPR
ATTRDESC:: eod
Defines the expression used to assign a client-class based
solely on data contained in an incoming DHCPv6 client request.
No default.

The expression must return a string that is the name of a
currently configured client-class; otherwise, the expression
must return the string '<none>'. Any return that is not a string
containing the name of a currently configured client-class or
'<none>' is considered an error.
eod

ATTR: max-client-lookups
ATTRID: 214
ATTRTYPE: AT_RANGEINT(1-5)
ATTRVIZ: 3
ATTRDEFVAL: 2
ATTRDESC:: eod
The maximum number times that the client entry data base (either
internal in MCD or external in LDAP) will be queried to look up
a DHCP client.  A client-class must specify a client-lookup-id
for a new and different client-specifier in order to get more than
one lookup to take place.
eod

ATTR: dhcp-support
ATTRID: 215
ATTRTYPE: AT_ENUMINT(v4-only=1, v6-only=2, both=3)
ATTRDEFVAL: both
ATTRFLAGS: AF_PRINT_ALT
ATTRVIZ: 3
ATTRDESC:: eod
Determines which DHCP protocol or protocols the DHCP server uses.

   1  v4-only     The server supports only DHCPv4 (DHCPv6
                  interfaces and configuration information
                  are ignored).
   2  v6-only     The server supports only DHCPv6 (DHCPv4
                  interfaces and configuration information
                  are ignored).
   3  both        The server supports both DHCPv4 and DHCPv6.
                  Default.
The server's configuration and the system's network interface
support impacts what will actually be used.
eod

ATTR: server-duid
ATTRID: 216
ATTRTYPE: AT_BLOB
ATTRVIZ: 3
ATTRDESC:: eod
The server's explicitly configured DUID. The default is to use a
value generated by the server. Normally, this attribute is not
configured and the server's generated value is used.
eod

ATTR: atul-support
ATTRID: 217
ATTRTYPE: AT_BOOL
ATTRFLAGS: AF_PRINT_ALT
ATTRDEFVAL: false
ATTRDESC:: eod
Enables DHCP support for the ATUL query protocol. The atul-port
parameter configures the port number to use to listen for
ATUL queries.
eod

ATTR: map-radius-pool-name
ATTRID: 218
ATTRTYPE: AT_ENUMINT(none=0, map-as-tag=1, map-as-class=2, append-to-tags=3)
ATTRDEFVAL: 0
ATTRDESC:: eod
Controls use of the radius framed-pool attribute, if present,
in a client relay-agent option.

   0  none             Ignores the framed-pool attribute

   1  map-as-tag       Maps the framed-pool attribute to
                       selection-tags

   2  map-as-class     Maps framed-pool attribute directly to a
                       client-class name

   3  append-to-tags   Appends the user-class-id to the
                       selection-tags
eod

# The following attribute is not supported in Twister but will be
# in a future release. It is not deprecated; just not yet used!
ATTR: one-client-per-vpn
ATTRID: 219
ATTRTYPE: AT_BOOL
ATTRFLAGS: AF_PRINT_ALT
ATTRDEFVAL: false
ATTRVIZ: 1
ATTRDESC:: eod
This attribute controls whether a DHCPv6 client is treated as
unique per link or per VPN.
If disabled (the default), a client is considered unique to a link
rather than to a VPN. This improves performance, at the cost of
memory.
eod

ATTR: max-client-leases
ATTRID: 220
ATTRTYPE: AT_RANGEINT(1-65535)
ATTRDEFVAL: 50
ATTRDESC:: eod
Sets the maximum number of leases, regardless of state or whether
reserved or not, that the server can associate with a DHCPv6
client. A DHCPv6 lease is always associated with a client; if it
is not, it is deleted.

This setting is to prevent a client from using lots of leases
(such as by issuing many requests with different IAID values). It
is not intended to limit the number of active leases a client may
have.

While 1 can be configured as the minimum for backwards
compatibility, the server uses a minium of 2 to allow for a
client that usually only has a single lease to be renumbered or
moved to a different prefix on the link.

This limit is not applied when existing leases are loaded from
the lease state database during server start-up.
eod

ATTR: optimize-cnr-ha-dns
ATTRID: 221
ATTRTYPE: AT_BOOL
ATTRVIZ: 3
ATTRDEFVAL: FALSE
ATTRDESC:: eod
This parameter should be used only if the DHCP server is sending
dynamic dns update to a CNR implementation of HA-DNS server pair.
If set to TRUE, DHCP server will attempt to coordinate and reduce
latency while failing over between the CNR implementation of
HA-DNS servers.  This parameter should be set to FALSE if the CNR
DHCP server is configured to send dynamic dns updates to a non-CNR
(BIND, etc) implementation of DNS server.
eod

ATTR: ha-dns-failover-timeout
ATTRID: 222
ATTRTYPE: AT_RANGEINT(30-120)
ATTRDEFVAL: 30
ATTRDESC:: eod

Sets the maximum time period in seconds that the DHCP server
waits for replies from a DNS server before failing over to its
partner. Default is 30s.

To use this attribute, first configure your DHCP server to
perform HA DNS updates.

If DHCP is configured for HA-DNS updates, dns-timeout parameters
are set to fit max-dns-retries within ha-dns-failover-timeout.
For example, with a default ha-dns-failover-timeout value of
30 seconds and and max-dns-retries of 3, dns-timeout is set to
6 seconds, so that after 3 retry attempts and an
ha-dns-failover-timeout, the DHCP server failovers. The DHCP
server uses a minimum limit value for a dns-timeout of 2 seconds
and dns-retries of 1.

eod
ATTR: ha-dns-probe-timeout
ATTRID: 223
ATTRTYPE: AT_RANGEINT(2-20)
ATTRDEFVAL: 2
ATTRVIZ: 3
ATTRDESC:: eod
If cnr-ha-dns is enabled, DHCP server will use this timer to
coordinate and reduce latency in failing over between HA-DNS
servers, when HA-DNS servers are in COMMUNICATION-INTERRUPTED
state or SYNCHRONIZING.
eod

ATTR: ha-dns-probe-retry
ATTRID: 224
ATTRTYPE: AT_RANGEINT(1-5)
ATTRDEFVAL: 1
ATTRVIZ: 3
ATTRDESC:: eod
If cnr-ha-dns is enabled, DHCP server will use this retry count and
ha-dns-probe-timeout to coordinate and reduce latency in failing
over between HA-DNS servers, when HA-DNS servers are in
COMMUNICATION-INTERRUPTED state or SYNCHRONIZING.
eod

ATTR: default-free-address-config
ATTRID: 225
ATTRTYPE: AT_NAMEREF(AddrTrapConfig)
ATTRVAL: 1146
ATTRDESC:: eod
Specifies the default SNMP free-address trap configuration object
for the server. All scopes that are not individually configured
use this default free-address value.
eod

ATTR: v6-udp-packet-size
ATTRID: 226
ATTRTYPE: AT_INT
ATTRDEFVAL: 0
ATTRVIZ: 3
ATTRDESC:: eod
Controls the UDP packet size for DHCPv6 requests and responses
used by the server. If this value is unset or less than
udp-packet-size, udp-packet-size is used.
eod

ATTR: leasequery-respond-other-available
ATTRID: 227
ATTRTYPE: AT_BOOL
ATTRDEFVAL: FALSE
ATTRVIZ: 3
ATTRDESC:: eod
Controls leasequery response under certain specific
conditions.  If the server is in NORMAL failover state, and
the lease is in other-available state, and the secs field in
the packet is zero (indicating that this is not a
retransmission), then this DHCP server will not respond to
the leasequery response, since the other server may well
have leased the lease and not yet communicated that fact to
this server.
eod

ATTR: leasequery-delay-backup-response
ATTRID: 228
ATTRTYPE: AT_RANGEINT(0-1000)
ATTRDEFVAL: 500
ATTRVIZ: 3
ATTRDESC:: eod
Controls leasequery response under certain specific
conditions.  If a leasequery request is received and the
server is in NORMAL failover state, and the data in the
server indicates that the other failover server was the one
to most recently interact with the DHCP client, and the secs
field in the packet is zero (indicating that this is not a
retransmission), then this DHCP server will delay its
response by the number of milliseconds configured in the
attribute.
eod

ATTR: min-dns-ttl
ATTRID: 229
ATTRTYPE: AT_TIME
ATTRDEFVAL: 600
ATTRDESC:: eod
Minimum value for time to live (TTL) in seconds, for DNS records
added through dynamic updates.  When the DHCP server adds a DNS
record, the TTL value will be min-dns-ttl if one third the lease
time is less than the min-dns-ttl value.
eod

ATTR: client-requested-min-lease-time
ATTRID: 230
ATTRTYPE: AT_TIME
ATTRDEFVAL: 0
ATTRVIZ: 3
ATTRDESC:: eod
Minimum value of client-requested DHCPv4 lease time in seconds.

Some DHCP clients do not respond well when given lease times
shorter than 5 minutes (300 seconds). This attribute enforces
the minimum lease time that the server will hand out to any
client that requests a time shorter than this value.
This attribute is disabled by default (has a zero value).
eod

ATTR: enhanced-sample-counters
ATTRID: 231
ATTRTYPE: AT_BOOL
ATTRFLAGS: AF_FEATURE
ATTRDEFVAL: true
ATTRDESC:: eod
Enables collection of enhanced statistics counters by the DHCP
server, which are then available with DHCP server statistics.
The enhanced counters provide more detailed information, but
cost the server some performance to maintain. Currently, this
enables collecting milliseconds ACK/Reply latencies (instead
of second based) and scope aggregation data (even if not
explicitly configured).
eod

ATTR: reconfigure-timeout
ATTRID: 232
ATTRTYPE: AT_TIME
ATTRDEFVAL: 2
ATTRVIZ: 3
ATTRDESC:: eod
Controls the DHCPv6 (RFC 3315) REC_TIMEOUT value (initial
reconfigure timeout). Default value is 2 seconds.
eod

ATTR: reconfigure-attempts
ATTRID: 233
ATTRTYPE: AT_INT
ATTRDEFVAL: 8
ATTRVIZ: 3
ATTRDESC:: eod
Controls the DHCPv6 (RFC 3315) REC_MAX_RC value (maximum
reconfigure attempts). Default value is 8 attempts.
eod

ATTR: unit-of-work-max-count
ATTRID: 234
ATTRTYPE: AT_RANGEINT(1000-20000)
ATTRDEFVAL: 5000
ATTRVIZ: 3
ATTRDESC:: eod
The maximum number of leases the server will examine before
interrupting a unit-of-work limited task.  In no case will
the server process a request for more than 2 seconds.
eod

ATTR: leasequery
ATTRID: 235
ATTRTYPE: AT_BOOL
ATTRFLAGS: AF_FEATURE
ATTRDEFVAL: true
ATTRVIZ: 3
ATTRDESC:: eod
Controls the processing of DHCPv4 and DHCPv6 Leasequery
requests and messages.  Enabled by default.  If disabled,
DHCPv6 Leasequery messages will receive NotAllowed error
codes.
eod

ATTR: inform
ATTRID: 236
ATTRTYPE: AT_ENUMINT(current-class=1, saved-class=2, drop=3)
ATTRDEFVAL: current-class
ATTRFLAGS: AF_PRINT_ALT
ATTRVIZ: 3
ATTRDESC:: eod
Controls the processing of DHCPINFORM packets. There are three
styles of processing:

   1  current-class The client-class used to satisfy any requests for
		    options is the client-class currently associated with
                    this DHCPINFORM request.

   2  saved-class   The client-class used to satisfy any requests for
                    options is the client-class saved during the last
		    non-DHCPINFORM request.

   3  drop          All DHCPINFORM packets are dropped.
eod

ATTR: v6-default-free-address-config
ATTRID: 237
ATTRTYPE: AT_NAMEREF(AddrTrapConfig)
ATTRVAL: 1146
ATTRDESC:: eod
Specifies the default SNMP v6 free-address trap configuration object
for the server. All Prefixes and Links that are not individually
configured use this default free-address value.
eod

# end D H C P Server
# end of DHCP Server
# end DHCP
#

# S c o p e
# S C O P E


CLASS: Scope
CLASSROOT: SCOPE
CLASSID: 1101
CLASSNAME: 1
CLASSNAMEDESC:: eod
The names of Scope objects are arbitrarily chosen by the user, and
must be unique.  There is no semantic value associated with the
name.
eod
CLASSVIZ: 5
CLASSPCV: 1.0.0
CLASSDESC:: eod
A DHCP Scope object. A scope defines a set of dynamic address
pools on a subnet that share its configuration attributes. A scope
can also contain reserved addresses on the specified subnet that
should use the configuration.
eod

ATTR: name
ATTRID: 1
ATTRHDRNAME: AO_SCOPE_NAME
ATTRTYPE: AT_STRING
ATTRFLAGS: AF_REQUIRED, AF_UNIQUE
ATTRMCDPATH: Name
ATTRVIZ: 3
ATTRDESC:: eod
The name of the scope object.
eod

ATTR: addr
ATTRID: 2
ATTRHDRNAME: AO_SCOPE_NETADDR
ATTRTYPE: AT_IPADDR
ATTRMCDPATH: IPAddr
ATTRVIZ: 1
DEPRECATED: 7.0
ATTRDESC:: eod
Displays the address of the subnet for which the scope contains
IP addresses
eod

ATTR: mask
ATTRID: 3
ATTRHDRNAME: AO_SCOPE_NETMASK
ATTRTYPE: AT_MASK
ATTRMCDPATH: NetMask
ATTRVIZ: 1
DEPRECATED: 7.0
ATTRDESC:: eod
The subnet mask associated with the scope's network address.
eod

ATTR: ranges
ATTRID: 4
ATTRHDRNAME: AO_SCOPE_RANGES
ATTRTYPE: AT_DICT(AT_BLOB)
#ATTRTYPE: AT_DICT(AT_STRING)
ATTRFLAGS: AF_NOTREE
ATTRMCDPATH: ranges
ATTRVIZ: 1
DEPRECATED: 7.0
ATTRDESC:: eod
The ranges of addresses that are available for leasing to clients.
Ranges are manipulated with the addRange and removeRange
configuration commands.
eod

ATTR: policy
ATTRID: 5
ATTRHDRNAME: AO_SCOPE_POLICY
ATTRTYPE: AT_NAMEREF(Policy)
ATTRVAL: 1102
ATTRFLAGS: AF_REQUIRED
ATTRMCDPATH: Policy
ATTRDEFVAL: default
ATTRVIZ: 5
ATTRDESC:: eod
Identifies the name of the policy associated with this scope. Default
is the default policy.  This means that the scope uses all the
properties set in the default policy (including the lease time),
unless you specifically reset a property.
eod

ATTR: primary-scope
ATTRID: 6
ATTRHDRNAME: AO_SCOPE_PRIMARYSCOPE
ATTRTYPE: AT_NAMEREF(Scope)
ATTRVAL: 1101
ATTRMCDPATH: PrimaryScope
ATTRVIZ: 1
DEPRECATED: 7.0
ATTRDESC:: eod
The name of this scope's primary scope (if this is a secondary
scope).  You need to specify a primary scope if you have multiple
logical subnets on the same physical network segment, and if you
allow DHCP to offer addresses from any of the subnets.  The
'scope <scopename> unset primary-scope' command can be used to
remove the primary-scope relationship.
eod

ATTR: primary-addr
ATTRID: 7
ATTRHDRNAME: AO_SCOPE_PRIMARYSCOPEADDR
ATTRTYPE: AT_IPADDR
ATTRMCDPATH: PrimaryIPAddr
ATTRVIZ: 1
DEPRECATED: 7.0
ATTRDESC:: eod
The ip address of this scope's primary scope (if this is a
secondary scope).
eod

ATTR: primary-mask
ATTRID: 8
ATTRHDRNAME: AO_SCOPE_PRIMARYSCOPEMASK
ATTRTYPE: AT_IPADDR
ATTRMCDPATH: PrimaryNetMask
ATTRVIZ: 1
DEPRECATED: 7.0
ATTRDESC:: eod
The subnet mask of this scope's primary scope (if this is a
secondary scope).
eod

ATTR: NetworkId
ATTRID: 9
ATTRHDRNAME: AO_SCOPE_NETWORKID
ATTRTYPE: AT_INT
ATTRMCDPATH: NetworkId
ATTRVIZ: 1
DEPRECATED: 7.0
ATTRDESC:: eod
Not used currently.
eod

ATTR: ping-timeout
ATTRID: 10
ATTRHDRNAME: AO_SCOPE_PINGTIMEOUT
ATTRTYPE: AT_INT
ATTRMCDPATH: PingTimeout
ATTRDEFVAL: 300
ATTRVIZ: 5
ATTRFEAT: 11
ATTRDESC:: eod
Sets the number of milliseconds the DHCP server waits for ping
responses.  If you make this value too large, you  slow down
the lease offering processes. If you make this value too small,
you reduce the effectiveness of pinging addresses before
offering them. Three hundred milliseconds (the default value) is
often the best choice.

eod

ATTR: ping-clients
ATTRID: 11
ATTRHDRNAME: AO_SCOPE_PINGCLIENTS
ATTRTYPE: AT_BOOL
ATTRFLAGS: AF_FEATURE
ATTRDEFVAL: false
ATTRMCDPATH: PingClients
ATTRVIZ: 5
ATTRDESC:: eod
Controls whether the server should attempt to ping an address
before offering a lease. If enabled (true), this attribute also
indicates a ping timeout.
eod

ATTR: dns-server-addr
ATTRID: 12
ATTRHDRNAME: AO_SCOPE_DNSSERVERADDRESS
ATTRTYPE: AT_IPADDR
ATTRMCDPATH: DnsServerAddress
ATTRVIZ: 1
DEPRECATED: 7.0
ATTRFEAT: 16
ATTRDESC:: eod
The address of the primary DNS server for the zone into which the
server should add A records.
eod

ATTR: dns-zone-name
ATTRID: 13
ATTRHDRNAME: AO_SCOPE_DNSZONENAME
ATTRTYPE: AT_STRING
ATTRMCDPATH: DnsZoneName
ATTRVIZ: 1
DEPRECATED: 7.0
ATTRFEAT: 16
ATTRDESC:: eod
The name of the DNS zone to which a DHCP client's host name
should be added (A record).
eod

ATTR: dns-reverse-zone-name
ATTRID: 14
ATTRHDRNAME: AO_SCOPE_DNSREVERSEZONENAME
ATTRTYPE: AT_STRING
ATTRMCDPATH: DnsReverseZoneName
ATTRVIZ: 1
DEPRECATED: 7.0
ATTRFEAT: 16
ATTRDESC:: eod
The name of the reverse (in-addr.arpa) zone that is updated with
PTR records.

If a scope is configured with a reverse zone name string, DHCP
will always use it. Alternately, if synthesize-reverse-zone is
enabled and a scope does not have a dns-reverse-zone-name, DHCP
server will use the lease IP address and scope's dns-host-bytes to
automatically generate a reverse zone name for Dynamic DNS update.
eod

ATTR: synthetic-name-stem
ATTRID: 15
ATTRHDRNAME: AO_SCOPE_DNSSYNTHETICNAMESTEM
ATTRTYPE: AT_STRING
ATTRMCDPATH: DnsSyntheticNameStem
ATTRVIZ: 1
DEPRECATED: 7.0
ATTRFEAT: 17
ATTRDESC:: eod
The stem of the default host name to use if clients do not
supply host names.
eod

ATTR: dynamic-dns
ATTRID: 16
ATTRHDRNAME: AO_SCOPE_DNSUPDATE
ATTRTYPE: AT_ENUMBYTE(update-none=0, update-all=1, update-fwd-only=2, update-rev-only=3)
ATTRFLAGS: AF_FEATURE, AF_PRINT_ALT
ATTRDEFVAL: update-none
ATTRMCDPATH: DnsUpdate
ATTRVIZ: 1
DEPRECATED: 7.0
ATTRDESC:: eod
Controls whether the DHCP server should attempt to update a DNS
server with name and address information from leases that are
granted to requesting clients.
eod

ATTR: synthesize-name
ATTRID: 17
ATTRHDRNAME: AO_SCOPE_DNSSYNTHESIZENAME
ATTRTYPE: AT_BOOL
ATTRFLAGS: AF_FEATURE, AF_INITIALIZE
ATTRDEFVAL: false
ATTRMCDPATH: DnsSynthesizeName
ATTRVIZ: 1
DEPRECATED: 7.0
ATTRDESC:: eod
Controls whether the DHCP server automatically creates DNS host
names for DHCP clients who do not provide names. The server
can synthesize unique names for clients based on the 'synthetic
name stem' attribute.
eod

ATTR: update-dns-first
ATTRID: 18
ATTRHDRNAME: AO_SCOPE_DNSUPDATEFIRST
ATTRTYPE: AT_BOOL
ATTRFLAGS: AF_FEATURE, AF_INITIALIZE
ATTRDEFVAL: false
ATTRMCDPATH: DnsUpdateFirst
ATTRVIZ: 1
DEPRECATED: 7.0
ATTRFEAT: 16
ATTRDESC:: eod
Controls whether the DNS server is updated before a lease is granted.
eod

ATTR: dns-host-bytes
ATTRID: 19
ATTRHDRNAME: AO_SCOPE_DNSNUMBEROFHOSTBYTES
ATTRTYPE: AT_RANGEINT(1-4)
ATTRMCDPATH: DnsNumberOfHostBytes
ATTRVIZ: 5
ATTRFEAT: 16
ATTRDESC:: eod

Tells DHCP how many bytes in a lease IP address to use when forming
in-addr.arpa names. The server forms names in the in-addr zone by
prepending dns-host-bytes of IP address (in reverse order) to the
reverse zone name. If unset, the server synthesizes an appropriate
value based on the scope's subnet size.
eod

# deprecated - not used in cnr 5+
ATTR: available-lease-hint-size
ATTRID: 20
ATTRHDRNAME: AO_SCOPE_AVAILABLELEASEHINTSIZE
ATTRTYPE: AT_INT
ATTRMCDPATH: AvailableLeaseHintSize
DEPRECATED: 2.0
ATTRVIZ: 1

ATTR: bootp
ATTRID: 21
ATTRHDRNAME: AO_SCOPE_ALLOWBOOTP
ATTRTYPE: AT_BOOL
ATTRFLAGS: AF_FEATURE
ATTRDEFVAL: false
ATTRMCDPATH: AllowBootp
ATTRVIZ: 5
ATTRDESC:: eod
Controls whether the server accepts BOOTP requests. If you want
clients to always receive the same addresses, you must reserve
IP addresses for all your BOOTP clients.
eod


ATTR: dynamic-bootp
ATTRID: 22
ATTRHDRNAME: AO_SCOPE_ALLOWDYNAMICBOOTP
ATTRTYPE: AT_BOOL
ATTRFLAGS: AF_FEATURE
ATTRDEFVAL: false
ATTRMCDPATH: AllowDynamicBootp
ATTRVIZ: 5
ATTRFEAT: 21
ATTRDESC:: eod
Controls whether the server will accept dynamic BOOTP
requests for this scope.  Dynamic BOOTP requests are BOOTP requests
that do not match a reservation, but could be satisfied from the
available lease pool. To use this feature you must also enable
bootp.
eod

ATTR: allow-lease-time-override
ATTRID: 23
ATTRHDRNAME: AO_SCOPE_ALLOWLEASETIMEOVERRIDE
ATTRTYPE: AT_BOOL
ATTRFLAGS: AF_FEATURE
ATTRMCDPATH: AllowLeaseTimeOverride
ATTRVIZ: 1
ATTRDESC:: eod
NA - this is actually a Policy attribute, not a Scope attribute.
eod

ATTR: SelectionMask
ATTRID: 24
ATTRHDRNAME: AO_SCOPE_SELECTIONMASK
ATTRTYPE: AT_INT
ATTRMCDPATH: SelectionMask
ATTRVIZ: 0
ATTRDESC:: eod
No longer used.
eod

ATTR: bootp-reply-options
ATTRID: 25
ATTRHDRNAME: AO_SCOPE_BOOTPREPLYPARAMETERS
# null terminated blob
ATTRTYPE: AT_STRING
ATTRMCDPATH: BootpReplyParameters
ATTRVIZ: 1
DEPRECATED: 6.0
ATTRDESC:: eod
Deprecated, and no longer significant to the server.  The
specification of which options should be sent back to BOOTP
(and force to DHCP) requests is now provided on a per-policy
basis.  These attributes are 16 and 17 on the Policy object
(dhcp-reply-options and bootp-reply-options).
eod

#
# DEPRECATED - don't use this, use 'reservation-list' instead
#
ATTR: ReservationList
ATTRID: 26
ATTRHDRNAME: AO_SCOPE_RESERVATIONLISTXXX
ATTRTYPE: AT_LISTREF(Reservation)
ATTRMCDPATH: ReservationList
DEPRECATED: 2.0
ATTRVAL: 1107
ATTRVIZ: 0
ATTRDESC:: eod
Don't use this, use 'reservation-list' instead.
eod

ATTR: reservations-override-leases
ATTRID: 27
ATTRHDRNAME: AO_SCOPE_RESERVATIONS_OVERRIDE_LEASES
ATTRTYPE: AT_BOOL
ATTRFLAGS: AF_FEATURE
ATTRDEFVAL: false
ATTRMCDPATH: ReservationsOverrideLeases
ATTRVIZ: 3
ATTRDESC:: eod
Controls the server's behavior if it finds a reservation for an
ip address which is leased to a different client. If this is
enabled, the server will delete the existing lease binding.
eod

ATTR: reservations-configure-leases
ATTRID: 28
ATTRHDRNAME: AO_SCOPE_RESERVATIONS_CONFIGURE_LEASES
ATTRTYPE: AT_BOOL
ATTRFLAGS: AF_FEATURE
ATTRDEFVAL: true
ATTRMCDPATH: ReservationsConfigureLeases
ATTRVIZ: 3
ATTRDESC:: eod
Controls whether to configures a reservation even if the IP
address that it refers to is not present in any range. The
reservation will be configured only if the ip address is valid
on the scope's ip subnet.
eod

ATTR: LeaseList
ATTRID: 29
ATTRHDRNAME: AO_SCOPE_LEASELIST
ATTRTYPE: AT_LISTREF(Lease)
ATTRMCDPATH: LeaseList
ATTRVAL: 1108
ATTRVIZ: 0
ATTRDESC:: eod
There is no direct reference from a Scope object to its leases.
eod

# ATTR 30 not used
# ATTR 31 has been deprecated
ATTR: inverse-dns-addr
ATTRID: 31
ATTRHDRNAME: AO_SCOPE_DNSREVERSESERVERADDRESS
ATTRTYPE: AT_IPADDR
ATTRVIZ: 1
DEPRECATED: 7.0
ATTRDESC:: eod
The address of the DNS server that should be updated with inverse
(in-addr.arpa) information.
eod

ATTR: selection-tags
ATTRID: 32
ATTRHDRNAME: AO_SCOPE_SELECTION_CRITERIA
ATTRTYPE: AT_ARRAY(AT_STRING)
ATTRMCDPATH: SelectionCriteria
ATTRVIZ: 1
DEPRECATED: 7.0
ATTRDESC:: eod
Lists selection criteria associated with a scope. The scope compares
client selection criteria to this list to determine whether the
client can obtain a lease from the scope.

eod

ATTR: renew-only
ATTRID: 33
ATTRHDRNAME: AO_SCOPE_AVAILABLE_CLOSED
ATTRTYPE: AT_BOOL
ATTRFLAGS: AF_FEATURE
ATTRMCDPATH: AvailableClosed
ATTRVIZ: 5
ATTRDESC:: eod
Controls whether to allow existing clients to reacquire their
leases, but not offer any leases to new clients.  Note that a
renew-only scope does not change the client associated with any
of its leases (other than to allow a client, currently using what
the server believes is an available IP address, to continue using
the address).
eod

ATTR: renew-only-reservations
ATTRID: 34
ATTRHDRNAME: AO_SCOPE_AVAILABLE_CLOSED_RESERVATIONS
ATTRTYPE: AT_BOOL
ATTRFLAGS: AF_FEATURE
ATTRMCDPATH: AvailableClosedReservations
ATTRVIZ: 3
ATTRDESC:: eod
Controls the renew-only capability for clients with reservations.
If this is not set (the default), the clients with reservations
will always be allowed to acquire leases in this scope.  If this
is set, then even clients with reservations will be required to
renew a lease that appeared available to the server before being
allowed to use it.
eod

ATTR: renew-only-expire-time
ATTRID: 35
ATTRHDRNAME: AO_SCOPE_AVAILABLE_CLOSED_EXPIRETIME
ATTRTYPE: AT_DATE
ATTRMCDPATH: AvailableClosedExpireTime
ATTRVIZ: 3
ATTRDESC:: eod
If this time is set, then both renew-only and
renew-only-reservations will stop being true once
the renew-only-expire time has passed.
eod

ATTR: deactivated
ATTRID: 36
ATTRHDRNAME: AO_SCOPE_DEACTIVATED
ATTRTYPE: AT_BOOL
ATTRFLAGS: AF_FEATURE
ATTRMCDPATH: Deactivated
ATTRVIZ: 5
ATTRDESC:: eod
Controls whether a scope extends leases to any clients. A deactivated
scope does not extend leases to any clients. It treats all addresses
in its ranges as if they were individually deactivated.
eod

ATTR: dns-rev-server-addr
ATTRID: 37
ATTRHDRNAME: AO_SCOPE_DNSREVSERVERADDRESS
ATTRTYPE: AT_IPADDR
ATTRMCDPATH: DnsReverseServerAddress
ATTRVIZ: 1
DEPRECATED: 7.0
ATTRFEAT: 16
ATTRDESC:: eod
The address of the primary DNS server for the zone into which the
server should add PTR records.
eod

ATTR: dhcp
ATTRID: 38
ATTRHDRNAME: AO_SCOPE_ALLOWDHCP
ATTRTYPE: AT_BOOL
ATTRFLAGS: AF_FEATURE
ATTRDEFVAL: true
ATTRMCDPATH: AllowDhcp
ATTRVIZ: 5
ATTRDESC:: eod
Controls whether the DHCP server accepts DHCP requests for this
scope. Disable DHCP if you want a scope to use BOOTP exclusively
or you want to deactivate the scope temporarily.
eod

ATTR: update-dns-for-bootp
ATTRID: 39
ATTRHDRNAME: AO_SCOPE_UPDATEDNSFORBOOTP
ATTRTYPE: AT_BOOL
ATTRFLAGS: AF_FEATURE
ATTRMCDPATH: UpdateDnsForBootp
ATTRVIZ: 1
DEPRECATED: 7.0
ATTRDESC:: eod
If the server is replying to a BOOTP request, and is offering a
lease from a Scope which is configured to perform DNS updates, it
will check this property before beginning the DNS update. This
feature allows an administrator to prevent DNS updates for BOOTP
clients, while allowing updates for DHCP clients.
'Update-dns-for-bootp' can be controlled globally with the 'server'
command; that global command can be overridden by individual Scopes
as necessary.
eod

ATTR: use-release-grace-period
ATTRID: 40
ATTRHDRNAME: AO_SCOPE_USE_RELEASE_GRACE_PERIOD
ATTRTYPE: AT_BOOL
ATTRFLAGS: AF_FEATURE
ATTRMCDPATH: use-release-grace-period
ATTRDEFVAL: false
ATTRVIZ: 1
DEPRECATED: 7.1
ATTRDESC:: eod
Controls whether the scope default is to delay the effect
of RELEASE messages from clients. If this switch is set,
all RELEASE messages for leases in this scope will be delayed
by a Policy's 'release-grace-period' attribute.  During the grace
period, the client's lease won't be made available for any other
client.
eod

ATTR: failover-main-server
ATTRID: 45
ATTRHDRNAME: AO_SCOPE_FAILOVER_MAIN_SERVER
ATTRTYPE: AT_STRING
ATTRMCDPATH: failover-main-server
ATTRVIZ: 1
DEPRECATED: 7.0
ATTRDESC:: eod
The DNS name of the main server associated with this lan
segment.  If this DNS name resolves to the IP address of the
current server, then this server will operate as the main server
for this scope.  It is an error if both the main and backup
server names resolve to the IP addresses which reside on the
same server.  If the backup-server-name is the distinguished
name "local" or is not configured on this scope or in the
server-wide default, then this server is considered to be the
main server for this scope.  Configuring either a
main-server-name or a backup-server-name will enable failover.
eod

ATTR: failover-backup-server
ATTRID: 46
ATTRHDRNAME: AO_SCOPE_FAILOVER_BACKUP_SERVER
ATTRTYPE: AT_STRING
ATTRMCDPATH: failover-backup-server
ATTRVIZ: 1
DEPRECATED: 7.0
ATTRDESC:: eod
The DNS name of the backup server associated with this lan
segment.  If this DNS name resolves to the IP address of the
current server, then this server will operate as the backup
server for this scope.  It is an error if both the main and
backup server names resolve to the IP addresses which reside on
the same server.  If the main-server-name is the distinguished
name "local" or is not configured in either this scope or the
server-wide default, then this server is considered to be the
backup server for this scope.  Configuring either a
main-server-name or a backup-server-name will enable failover.
eod

ATTR: old-failover-backup-percentage
ATTRID: 47
ATTRHDRNAME: AO_SCOPE_FAILOVER_BACKUP_PERCENTAGE
ATTRTYPE: AT_INT
ATTRMCDPATH: failover-backup-percentage
ATTRVIZ: 1
DEPRECATED: 7.0
ATTRDESC:: eod
This was originally added to the data dictionary intending that
it would be the scope parameter that would allow a user to
configure the failover-backup-percentage.  However, in the
initial release it was not turned on, but rather made visibility
1.  It was given a default of 10, and so despite its visibility
it ended up in many scopes in the field in real configurations.
Now, when we want to really use it, it cannot simply be made
visibility 5, since it exists in those existing databases.  The
way we want to use it, if it exists, then it will override the
the globally configured value.  So we deprecate this MCD path,
and change the name of the attribute from
failover-backup-percentage to old-failover-backup-percentage, so
we can reuse the attribute name of failover-backup-percentage
with a new attribute/parameter that has a different (and new) MCD
path.
eod

ATTR: failover-maximum-client-lead-time
ATTRID: 48
ATTRHDRNAME: AO_SCOPE_FAILOVER_MCLT
ATTRTYPE: AT_TIME
ATTRFLAGS: AF_INITIALIZE
ATTRDEFVAL: 3600
ATTRMCDPATH: failover-mclt
ATTRVIZ: 1
DEPRECATED: 7.0
ATTRDESC:: eod
This is maximum client lead time, in seconds.  The "MCLT" controls
how much ahead of the backup server the client's lease expiration
can be.  It must be defined for the scope in the main and backup
servers.  Both the main and backup must be configured with
identical values for proper operation.
eod

ATTR: failover-lease-period-factor
ATTRID: 49
ATTRHDRNAME: AO_SCOPE_FAILOVER_LEASE_PERIOD_MULTIPLE
ATTRTYPE: AT_INT100
ATTRFLAGS: AF_INITIALIZE
ATTRDEFVAL: 1.50
ATTRMCDPATH: failover-lease-period-factor
ATTRVIZ: 1
DEPRECATED: 7.0
ATTRDESC:: eod
The multiple of the desired lease period used to update the backup
server when the main server informs it of a new DHCP client lease
period.  A value of 1.00 would be the same as the lease period that
the main would like to give the DHCP client.  A value of 2.00
would be twice the lease period the main would like to give the
client.  The lease-period-factor controls how much ahead of the
client the backup server's idea of the lease expiration can be.
The larger this value, the more the main is independent of the
operation of the backup and the less performance impact the
failover protocol has on the main server performance.  However,
the larger this value, the longer the backup will have to wait to
time out an expired lease and re-use it for a different client in
the event that the main fails and the backup takes over all DHCP
functions.  This attribute must be defined in the scope in the
main server.  If it is defined in a backup server, it is ignored
(to enable copying of configurations).
eod

ATTR: failover-use-safe-period
ATTRID: 50
ATTRHDRNAME: AO_SCOPE_FAILOVER_USE_SAFE_PERIOD
ATTRTYPE: AT_BOOL
ATTRFLAGS: AF_FEATURE, AF_INITIALIZE
ATTRMCDPATH: failover-use-safe-period
ATTRDEFVAL: false
ATTRVIZ: 1
DEPRECATED: 7.0
ATTRDESC:: eod
If use-safe-period is disabled, then a server will never go into
PARTNER-DOWN state without an operator command.  It must be
defined for the scope in the main server.  If it is
defined in a backup server, it is ignored (to enable copying of
configurations).
eod

ATTR: failover-safe-period
ATTRID: 51
ATTRHDRNAME: AO_SCOPE_FAILOVER_SAFE_PERIOD
ATTRTYPE: AT_TIME
ATTRFLAGS: AF_INITIALIZE
ATTRDEFVAL: 3600
ATTRMCDPATH: failover-safe-period
ATTRVIZ: 1
DEPRECATED: 7.0
ATTRDESC:: eod
This is the safe period, in seconds.  It does not have to be
the same on both main and backup servers.  It only has meaning if
use-safe-period is enabled.  It must be defined for the scope in
the main server.  If it is defined in a backup server, it is
ignored (to enable copying of configurations).
eod

ATTR: failover-recover
ATTRID: 52
ATTRHDRNAME: AO_SCOPE_FAILOVER_RECOVER
ATTRTYPE: AT_BOOL
ATTRFLAGS: AF_INITIALIZE
ATTRMCDPATH: failover-recover
ATTRDEFVAL: false
ATTRVIZ: 1
DEPRECATED: 7.0
ATTRDESC:: eod
If recover is disabled, then the server will perform
initialization (if there is any state), and then will go into
RECOVER state.  This state assumes that the other server was
running, and attempts to refresh its state from that of the
other server.
This should be deprecated even it we wanted it to be
something other than viz 1, because it makes no sense
for part of a server to be set to recover.
eod

ATTR: failover-persist-lease-data-on-partner-ack
ATTRID: 53
ATTRHDRNAME: AO_SCOPE_FAILOVER_WRITE_MCD_ON_LEASE_DATA_ACK
ATTRTYPE: AT_BOOL
ATTRFLAGS: AF_INITIALIZE
ATTRMCDPATH: failover-persist-lease-data-on-partner-ack
ATTRDEFVAL: true
ATTRVIZ: 1
DEPRECATED: 7.0
ATTRDESC:: eod
Normally, the main server will update MCD whenever the backup
server ACK's it with what the backup knows.  Disabling this
capability will speed up the main server, with the downside that
after restart of the main server it won't know what the backup
knows, and may offer all clients one lease period with a renew
time of the current time plus the MCLT.
eod

ATTR: failover
ATTRID: 54
ATTRHDRNAME: AO_SCOPE_FAILOVER
ATTRTYPE: AT_ENUMINT(scope-enabled=1,scope-disabled=2,use-server-settings=3)
ATTRFLAGS: AF_PRINT_ALT, AF_INITIALIZE
ATTRMCDPATH: failover
ATTRDEFVAL: use-server-settings
ATTRVIZ: 1
DEPRECATED: 7.0
ATTRDESC:: eod
If set to scope-enabled, this scope will engage in failover as it
has been configured to do so.  If set to use the server's
settings, then it will be configured according to the server's
global failover parameters.  If set to scope-disabled, this scope
will not engage in failover at all.
eod

# Scope ATTRID 55-58: trap features and properties
ATTR: trap-free-address-low
ATTRID: 55
ATTRHDRNAME: AO_SCOPE_TRAP_FREEADDRESSLOW
ATTRTYPE: AT_BOOL
ATTRFLAGS: AF_FEATURE
ATTRMCDPATH: TrapFreeAddressLow
ATTRVIZ: 1
DEPRECATED: 6.0
ATTRDESC:: eod
Send trap on FreeAddress below low threshold.

eod

ATTR: trap-free-address-high
ATTRID: 56
ATTRHDRNAME: AO_SCOPE_TRAP_FREEADDRESSHIGH
ATTRTYPE: AT_BOOL
ATTRFLAGS: AF_FEATURE
ATTRMCDPATH: TrapFreeAddressHigh
ATTRVIZ: 1
DEPRECATED: 6.0
ATTRDESC:: eod
Send trap on FreeAddress above high threshold.

eod

ATTR: trap-free-address-low-threshold
ATTRID: 57
ATTRHDRNAME: AO_SCOPE_TRAP_FREEADDRESSLOWTHRESHOLD
ATTRTYPE: AT_STRING
ATTRMCDPATH: TrapFreeAddressLowThreshold
ATTRVIZ: 1
DEPRECATED: 6.0
ATTRDESC:: eod
A number, or (if terminated with a %) percentage, of addresses free
at which point the free-address trap is generated
eod

ATTR: trap-free-address-high-threshold
ATTRID: 58
ATTRHDRNAME: AO_SCOPE_TRAP_FREEADDRESSHIGHTHRESHOLD
ATTRTYPE: AT_STRING
ATTRMCDPATH: TrapFreeAddressHighThreshold
ATTRVIZ: 1
DEPRECATED: 6.0
ATTRDESC:: eod
A number, or (if terminated with a %) percentage, of addresses free
at which point a free-address-high trap is generated and the
free-address trap is re-enabled.
eod

ATTR: embedded-policy
ATTRID: 59
ATTRHDRNAME: AO_SCOPE_EMBEDDED_POLICY
ATTRTYPE: AT_OBJ(Policy)
ATTRMCDPATH: embedded-policy
ATTRVIZ: 5
ATTRDESC:: eod
Displays the embedded policy for a scope.

eod

ATTR: failover-backup-percentage
ATTRID: 60
ATTRHDRNAME: AO_SCOPE_NEW_FAILOVER_BACKUP_PERCENTAGE
ATTRTYPE: AT_INT
ATTRMCDPATH: failover-new-backup-percentage
ATTRVIZ: 1
DEPRECATED: 7.0
ATTRDESC:: eod
Determines the percentage of available addresses that the main
server should send to the backup server.  If defined for a scope,
it must be defined for the scope on the main server.  If defined
on a backup server, it is ignored (to enable copying of
configurations).

If defined, the value of this scope attribute overrides the
server defined values for failover-backup-percentage
and failover-dynamic-bootp-backup-percentage. Thus, the value
defined here is the value that  used for this scope,
whether or not this scope supports dynamic-bootp.

If  defined as zero (0), then no addresses are sent to the
backup server.  Since zero is a significant value, once
defined, you must unset this attribute for the scope to use the
server-wide default values for failover-backup-percentage or
failover-dynamic-bootp-backup-percentage.
eod

#
# DEPRECATED - this is the pre-6.0 reservation list attr
#
ATTR: reservation-dictionary
ATTRID: 61
ATTRHDRNAME: AO_SCOPE_RESERVATIONDICT
ATTRTYPE: AT_DICT(AT_BLOB)
#ATTRTYPE: AT_DICT(AT_STRING)
ATTRFLAGS: AF_NOTREE
ATTRMCDPATH: reservation-list
DEPRECATED: 4.0
ATTRVIZ: 0
ATTRDESC:: eod
This is the pre-6.0 reservation list attr.
eod

ATTR: lease-count
ATTRID: 62
ATTRHDRNAME: AO_SCOPE_LEASE_COUNT
ATTRTYPE: AT_INT
ATTRMCDPATH: lease-count
ATTRVIZ: 3
ATTRDESC:: eod
Number of leases configured in a scope. This is a read-only
attribute.
eod

ATTR: reservation-count
ATTRID: 63
ATTRHDRNAME: AO_SCOPE_RESERVATION_COUNT
ATTRTYPE: AT_INT
ATTRMCDPATH: reservation-count
ATTRVIZ: 3
ATTRDESC:: eod
Number of reservations configured in a scope. This is a read-only
attribute.
eod

ATTR: version
ATTRID: 64
ATTRHDRNAME: AO_SCOPE_VERSION
ATTRTYPE: AT_INT
ATTRMCDPATH: version
ATTRVIZ: 3
ATTRDESC:: eod
The internal version number of the scope data blob.
eod

ATTR: secondary-scope-list
ATTRID: 65
ATTRHDRNAME: AO_SCOPE_SECONDARY_SCOPE_LIST
ATTRTYPE: AT_ARRAY(AT_STRING)
ATTRMCDPATH: secondary-scope-list
DEPRECATED: 7.0
ATTRVIZ: 1
ATTRDESC:: eod
A list of the names of the scopes for which this scope is the
primary scope.
eod

ATTR: lan-segment
ATTRID: 66
ATTRHDRNAME: AO_SCOPE_LAN_SEGMENT
ATTRTYPE: AT_STRING
ATTRMCDPATH: lan-segment
ATTRVIZ: 1
DEPRECATED: 7.0
ATTRDESC:: eod
This has been deprecated, but might come back someday.
10/23/01 kkinnear
A string representing the lan segment within which this scope
resides.  This scope will become part of a 'Network' which will
contain all of the other scopes which have a matching lan-segment
attribute.  This overrides the value for primary-scope,
primary-addr, and primary-mask.  It also overrides the implict
association of any other scope which has an identical network
number and subnet mask.  This scope will only aggregate together
with other scopes which have an identical lan-segment property.
A value which is the null string is equivalent to being unset.
eod

ATTR: use-dns-update-prereqs
ATTRID: 67
ATTRHDRNAME: AO_SCOPE_USE_DNS_PREREQS
ATTRTYPE: AT_BOOL
ATTRVIZ: 1
DEPRECATED: 7.0
ATTRDEFVAL: true
ATTRDESC:: eod
DEPRECATED - not currently implemented for scope class
By default, the DHCP server uses prerequisites in its DNS update
messages when it is performing DNS updates on behalf of clients. If
this parameter is 'false', the server will not include
prerequisites when performing updates for leases from this scope.
Without them, the last client who uses a given domain name will be
associated with that name, even if another client was already
associated with the name.

eod

ATTR: vpn-id
ATTRID: 68
ATTRHDRNAME: AO_SCOPE_VPN_ID
ATTRTYPE: AT_INT
ATTRFLAGS: AF_REFERENCE, AF_IMMUTABLE, AF_INITIALIZE

# Encode attribute 4 of VPN(1127) as 4<<16 + 1127 == 263271
ATTRVAL: 263271
ATTRDEFVAL: 0
ATTRDESC:: eod
Displays the identifier of the DHCP VPN that contains the addresses
in this scope.  Define this value with  the vpn vpn-name create id
command. Once set, you cannot change this value.
eod

ATTR: subnet
ATTRID: 69
ATTRTYPE: AT_SUBNET
ATTRFLAGS: AF_REQUIRED
ATTRDESC:: eod
The network address of the IP subnet that this scope represents.

eod

# the new (for JackSprat) list of reservations,
ATTR: reservation-list
ATTRID: 70
ATTRTYPE: AT_NLIST(AT_OBJ(Reservation))
# 1<<16 | 1107
ATTRVAL: 66643
ATTRVIZ: 3
ATTRDESC:: eod
The reservations for this Scope.
eod

# the new (for JackSprat) list of ranges
ATTR: range-list
ATTRID: 71
ATTRTYPE: AT_NLIST(AT_OBJ(Range))
# 1<<16 | 1130
ATTRVAL: 66666
ATTRVIZ: 3
ATTRDESC:: eod
The ranges that are part of this Scope.

eod

ATTR: primary-subnet
ATTRID: 72
ATTRTYPE: AT_SUBNET
ATTRDESC:: eod
Determines the subnet address and mask of the primary scope.
Use this attribute when multiple logical IP subnets are present
on the same physical network.

eod

# a reference to a CCMScopeTemplate (with the OID from the CCM
# datastore)
ATTR: scope-template
ATTRID: 73
# ATTRTYPE: AT_OBJREF(CCMScopeTemplate)
ATTRFLAGS: AF_REFERENCE
ATTRTYPE: AT_OID
ATTRVAL: 1426
ATTRVIZ: 1
DEPRECATED: 7.0
ATTRDESC:: eod
The scope template used to create this scope.  May not be
set, even if the scope was created from a template.  If the
template is managed on a remote (regional) cluster, the
OID reference would make no sense.
eod

ATTR: dynamic-dns-fwd-key
ATTRID: 76
ATTRTYPE: AT_DNSNAME
ATTRMCDPATH: ddns-fwd-key
ATTRVIZ: 1
DEPRECATED: 7.0
ATTRDESC:: eod
The TSIG key to be used in processing dynamic DNS updates of
forward zones for all leases that are in a scope.
eod

ATTR: dynamic-dns-rev-key
ATTRID: 77
ATTRTYPE: AT_DNSNAME
ATTRMCDPATH: ddns-rev-key
ATTRVIZ: 1
DEPRECATED: 7.0
ATTRDESC:: eod
The TSIG key to be used in processing dynamic DNS updates of
reverse zones for all leases that are in a scope.
eod

ATTR: dynamic-dns-tsig
ATTRID: 78
ATTRTYPE: AT_ENUMINT(enable-fwd-and-rev=1,disable-fwd-and-rev=2,enable-fwd-only=3,enable-rev-only=4,use-server-settings=5)
ATTRFLAGS: AF_PRINT_ALT
ATTRDEFVAL: use-server-settings
ATTRMCDPATH: dynamic-dns-tsig
ATTRVIZ: 1
DEPRECATED: 7.0
ATTRDESC:: eod
This attribute controls whether TSIG is used for DNS updates for
the scope.

If set to 'enable-fwd-and-rev' or 'disable-fwd-and-rev' TSIG will
be or will not be used for both forward and reverse zone updates
respectively. If set to 'enable-fwd-only' or 'enable-rev-only',
TSIG will be used for forward or reverse updates alone.

A scope level setting, if configured, will override the DHCP server
level attribute value.
eod

ATTR: ignore-declines
ATTRID: 79
ATTRHDRNAME: AO_SCOPE_IGNORE_DECLINES
ATTRTYPE: AT_BOOL
ATTRDEFVAL: false
ATTRMCDPATH: ignore-declines
ATTRVIZ: 5
ATTRDESC:: eod
Determines whether the server reacts to server DHCPDECLINE
messages that refer to one of the scope's IP addresses.

If enabled (true), the DHCP server ignores all declines that
refer to an IP address in this scope.  If disabled, the DHCP server
sets to UNAVAILABLE every IP address referred to in this scope.
Default is false (disabled).
eod

ATTR: allocation-priority
ATTRID: 80
ATTRHDRNAME: AO_SCOPE_ALLOCATION_PRIORITY
ATTRTYPE: AT_INT
ATTRDEFVAL: 0
ATTRVIZ: 5
ATTRDESC:: eod
Assigns an order to scopes for allocating IP addresses. Acceptable
scopes, with the highest allocation priority, grant IP addresses
until the addresses are exhausted.

You can mix scopes with an allocation-priority along with those
without a priority in the same network.  In this case, scopes with
allocation priorities are examined for acceptability before those
scopes with no allocation-priority. Lower numeric values have
higher priorities, but an allocation-priority of 0 (the default) has
no priority.

If this attribute is not set, or is unset or 0, then the
DHCP priority-address-allocation attribute controls the priority
of the scope. If the DHCP priority-address-allocation attribute is
set, and allocation-priority for the scope is unset, then the
allocation-priority for the scope is the network number of the
scope.

If you explicitly set allocation-priority, then, for that scope,
the DHCP setting of priority-address-allocation has no meaning.
eod

ATTR: allocate-first-available
ATTRID: 81
ATTRHDRNAME: AO_SCOPE_ALLOCATE_FIRST_AVAILABLE
ATTRTYPE: AT_BOOL
ATTRDEFVAL: false
ATTRVIZ: 5
ATTRDESC:: eod
Enables you to force the allocation of new IP addresses
from this scope to be the first available IP address;
otherwise, the default of the 'least recently used' IP address is
used.

If this attribute is not set, or is unset, then the DHCP server
attribute priority-address-allocation controls whether
to allocate the first available IP address.

If priority-address-allocation is set, and allocate-first-available
for the scope is unset, then the scope allocates addresses as if
allocate-first-available was set.

If allocate-first-available is enabled or disabled for a scope, then
for that scope the setting of priority-address-allocation has no
meaning.
eod

ATTR: failover-backup-allocation-boundary
ATTRID: 82
ATTRHDRNAME: AO_SCOPE_FAILOVER_BACKUP_ALLOCATION_BOUNDARY
ATTRTYPE: AT_IPADDR
ATTRVIZ: 5
ATTRDESC:: eod
Sets the IP address allocation boundary for a backup server in a
failover relationship.

If the allocate-first-available attribute is set, the backup
server allocates IP addresses in descending order from this
boundary.

If the allocate-first available attribute is unset or set to 0,
the boundary used for allocating addresses is half the
distance between the first and last IP address configured in the
ranges for this scope.  If no IP addresses are available
below this boundary, the first IP address available above this
boundary is used.
eod

# used starting with 6.2 (April 5, 2005)
ATTR: selection-tag-list
ATTRID: 83
ATTRTYPE: AT_NLIST(AT_STRING)
ATTRVAL: 5
ATTRDESC:: eod
Associates a comma-separated list of selection tags with a
scope. The scope compares a client's selection criteria to this
list in order to determine whether the client can obtain a lease
from the scope.
eod

ATTR: free-address-config
ATTRID: 88
ATTRTYPE: AT_NAMEREF(AddrTrapConfig)
ATTRVAL: 1146
ATTRDESC:: eod
Identifies which trap captures unexpected free address events
on this scope.
eod

ATTR: backup-pct
ATTRID: 89
ATTRTYPE: AT_PERCENT
ATTRDESC:: eod
Determines the percentage of available addresses that the main server
sends to the backup server. If you define this value using the
scope command, make sure you define it on the main server. If you
define it on a backup server, it is ignored.

Used with the scope command, the backup-pct attribute overrides
the defined values on the failover pair for backup-pct and
dynamic-bootp-backup-pct. The attribute value defined with the scope
command becomes the value used for this scope, whether or not this
scope supports dynamic-bootp.

If you set the value to zero (0), the backup server receives no
addresses. Since 0 is a significant value, once you set this value,
you must unset it for the scope to use the failover pair's values for
backup-pct or dynamic-bootp-backup-pct.

Note: If the failover pair is configured to use load balancing, the
backup-pct is ignored and 50% is used.

eod

ATTR: description
ATTRID: 90
ATTRTYPE: AT_STRING
ATTRDESC:: eod
Describes the scope.
eod

# end of SCOPE

# P o l i c y
# POLICY
# P O L I C Y


CLASS: Policy
CLASSROOT: POLICY
CLASSID: 1102
CLASSNAME: 1
CLASSNAMEDESC:: eod
The names of Policy objects are arbitrarily chosen by the user, and
must be unique.  There are two distinguished Policy objects, named
'default' and 'system_default_policy'.  If a Scope is created
without specifying a Policy, it will be given the Policy named
'default'. All Policy objects implicitly inherit the option values
specified in the Policy 'system_default_policy'.
eod
CLASSVIZ: 5
CLASSPCV: 1.0.0
CLASSDESC:: eod
A DHCP Policy object. The policy defines the set of DHCP Options
and server policy settings that should be applied when granting a
lease.
eod

ATTR: name
ATTRID: 1
ATTRHDRNAME: AO_POLICY_NAME
ATTRTYPE: AT_STRING
ATTRFLAGS: AF_IMMUTABLE, AF_REQUIRED, AF_UNIQUE
ATTRMCDPATH: name
ATTRVIZ: 3
ATTRDESC:: eod
The name of the policy. Scopes, client-entries, and client-classes
refer to policies by name.
eod

ATTR: offer-timeout
ATTRID: 2
ATTRHDRNAME: AO_POLICY_OFFERTIMEOUT
ATTRTYPE: AT_TIME
ATTRMCDPATH: OfferTimeout
ATTRVIZ: 5
ATTRDEFVAL: 120
ATTRDESC:: eod
Instructs the server to wait a specified amount of time when it
has offered a lease to a client, but the offer is not yet accepted.
At the end of the specified time interval, the server makes the
lease available again.

eod

ATTR: grace-period
ATTRID: 3
ATTRHDRNAME: AO_POLICY_GRACEPERIOD
ATTRTYPE: AT_TIME
ATTRMCDPATH: GracePeriod
ATTRVIZ: 5
ATTRDEFVAL: 300
ATTRDESC:: eod
Defines the length of time between the expiration of a lease
and the time it is made available for reassignment.

eod

ATTR: server-lease-time
ATTRID: 4
ATTRHDRNAME: AO_POLICY_SERVERLEASETIME
ATTRTYPE: AT_TIME
ATTRMCDPATH: ServerLeaseTime
ATTRVIZ: 5
ATTRFEAT: 5
ATTRDESC:: eod
Tells the server how long a lease is valid.  For more frequent
communication with a client, you might have the server consider
leases as leased for a longer period than the client considers them.

This also provides more lease-time stability. This value is not used
unless it is longer than the lease time in the dhcp-lease-time option
found through the normal traversal of policies.

eod

ATTR: split-lease-times
ATTRID: 5
ATTRHDRNAME: AO_POLICY_USESERVERLEASETIME
ATTRTYPE: AT_BOOL
ATTRFLAGS: AF_FEATURE
ATTRDEFVAL: false
ATTRMCDPATH: UseServerLeaseTime
ATTRVIZ: 5
ATTRDESC:: eod
Specifies a value that the DHCP server might use internally to
affect lease times.

If enabled, the DHCP server still offers clients lease times that
reflect the configured lease-time option from the appropriate
policy; but the server bases its decisions regarding expiration
on the 'server-lease-time' value.
eod

ATTR: permanent-leases
ATTRID: 6
ATTRHDRNAME: AO_POLICY_PERMANENT
ATTRTYPE: AT_BOOL
ATTRFLAGS: AF_FEATURE
ATTRDEFVAL: false
ATTRMCDPATH: IsPermanent
ATTRVIZ: 5
ATTRDESC:: eod
Indicates whether leases using this policy are permanently granted
to requesting clients. If leases are permanently granted, the server
ignores the configured dhcp-lease-time option value and uses the
maximum lease time.
eod

ATTR: allow-lease-time-override
ATTRID: 7
ATTRHDRNAME: AO_POLICY_ALLOWLEASETIMEOVERRIDE
ATTRTYPE: AT_BOOL
ATTRFLAGS: AF_FEATURE
ATTRDEFVAL: false
ATTRMCDPATH: AllowLeaseTimeOverride
ATTRVIZ: 5
ATTRDESC:: eod
Gives the server control over the lease period.  Although a client
can request a specific lease time, the server need not honor the
request if this attribute is set to false (the default).

Even if set to true, clients can request only lease times that are
shorter than those configured for the server.

eod

ATTR: mcns
ATTRID: 8
ATTRHDRNAME: AO_POLICY_MCNSENABLED
ATTRTYPE: AT_BOOL
ATTRFLAGS: AF_FEATURE
ATTRDEFVAL: false
ATTRMCDPATH: MCNSEnabled
ATTRVIZ: 1
DEPRECATED: 6.0.0
ATTRDESC:: eod
This feature controls the use of a group of MCNS-compatible
extensions.
eod

ATTR: mcns-next-server
ATTRID: 9
ATTRHDRNAME: AO_POLICY_MCNSNEXTSERVER
ATTRTYPE: AT_IPADDR
ATTRMCDPATH: MCNSNextServer
ATTRFEAT: 8
ATTRVIZ: 1
DEPRECATED: 6.0.0
ATTRDESC:: eod
The IP address of the MCNS 'next-server', which will be placed in
the 'siaddr' field of the server's replies.
eod

ATTR: mcns-security-server
ATTRID: 10
ATTRHDRNAME: AO_POLICY_MCNSSECURITYSERVER
ATTRTYPE: AT_IPADDR
ATTRMCDPATH: MCNSSecurityServer
ATTRFEAT: 8
ATTRVIZ: 1
DEPRECATED: 6.0.0
ATTRDESC:: eod
The IP address of an MCNS security server, which will be returned
in the MCNS_SECURITY_SERVER dhcp option.
eod

ATTR: mcns-bootfile
ATTRID: 11
ATTRHDRNAME: AO_POLICY_MCNSBOOTFILE
ATTRTYPE: AT_STRING
ATTRMCDPATH: MCNSBootFile
ATTRFEAT: 8
ATTRVIZ: 1
DEPRECATED: 6.0.0
ATTRDESC:: eod
The name of the bootfile to specify when in MCNS-compatible mode.
eod

ATTR: mcns-options
ATTRID: 12
ATTRHDRNAME: AO_POLICY_MCNSOPTIONS
ATTRTYPE: AT_ARRAY(AT_INT)
# until we agree on this storage, the tree representation is a
# string of bytes, and must be handled separately
ATTRFLAGS: AF_NOTREE
ATTRMCDPATH: MCNSOptions
ATTRFEAT: 8
ATTRVIZ: 1
DEPRECATED: 6.0.0
ATTRDESC:: eod
A list of dhcp option numbers which should be returned in
MCNS-mode.
eod

ATTR: packet-siaddr
ATTRID: 13
ATTRHDRNAME: AO_POLICY_SIADDR
ATTRMCDPATH: packet-siaddr
ATTRTYPE: AT_IPADDR
ATTRVIZ: 5
ATTRDESC:: eod
Identifies the IP address of the next server in the client boot
process. For example, this might be the address of a TFTP server
used by BOOTP clients. The server returns this address in the
'siaddr' field of its replies.
eod

ATTR: packet-file-name
ATTRID: 14
ATTRHDRNAME: AO_POLICY_FILE_NAME
ATTRMCDPATH: packet-file-name
ATTRTYPE: AT_STRING
ATTRVIZ: 5
ATTRDESC:: eod
Identifies the boot-file to use in the boot process of a client.
The server returns this file name in the 'file' field of its replies.
The packet-file-name cannot be longer than 128 characters.

eod

ATTR: packet-server-name
ATTRID: 15
ATTRHDRNAME: AO_POLICY_SERVER_NAME
ATTRMCDPATH: packet-server-name
ATTRTYPE: AT_STRING
ATTRVIZ: 5
ATTRDESC:: eod
Identifies the host-name of the server to use in a client's boot
process. The server returns this file name in the 'sname' field
of its replies. The packet-server-name field cannot be longer
than 64 characters.
eod

ATTR: dhcp-reply-options
ATTRID: 16
ATTRHDRNAME: AO_POLICY_DHCP_REPLY_OPTIONS
ATTRMCDPATH: dhcp-reply-options
ATTRTYPE: AT_SET(AT_STRING)
ATTRVIZ: 1
DEPRECATED: 7.0

ATTR: bootp-reply-options
ATTRID: 17
ATTRHDRNAME: AO_POLICY_BOOTP_REPLY_OPTIONS
ATTRMCDPATH: bootp-reply-options
ATTRTYPE: AT_SET(AT_STRING)
ATTRVIZ: 1
DEPRECATED: 7.0

ATTR: release-grace-period
ATTRID: 18
ATTRHDRNAME: AO_POLICY_RELEASE_GRACE_PERIOD
ATTRMCDPATH: release-grace-period
ATTRTYPE: AT_TIME
ATTRVIZ: 3
ATTRDESC:: eod
If non-zero, the DHCP server will consider the lease bound to its
client for the duration of the release-grace-period. When that
period elapses, the lease will be released, and only then will
become available to other clients.
eod

ATTR: options
ATTRID: 21
ATTRHDRNAME: AO_POLICY_OPTIONS
ATTRTYPE: AT_DICT(AT_BLOB)
ATTRFLAGS: AF_NOTREE
ATTRMCDPATH: options
ATTRVIZ: 1
ATTRDESC:: eod
Not used on 6.0 and later.
eod

ATTR: vendoroptions
ATTRID: 22
ATTRHDRNAME: AO_POLICY_VENDOROPTIONS
ATTRTYPE: AT_DICT(AT_STRING)
ATTRFLAGS: AF_NOTREE
ATTRMCDPATH: vendoroptions
ATTRVIZ: 1
DEPRECATED: 7.0

ATTR: vendoroptions-wireformat
ATTRID: 23
ATTRHDRNAME: AO_POLICY_VENDOROPTIONS_WIREFORMAT
ATTRTYPE: AT_DICT(AT_STRING)
ATTRFLAGS: AF_NOTREE
ATTRMCDPATH: vendoroptions-wireformat
ATTRVIZ: 1
DEPRECATED: 7.0

ATTR: allow-client-a-record-update
ATTRID: 24
ATTRHDRNAME: AO_POLICY_ALLOWCLIENTARECORDUPDATE
ATTRTYPE: AT_BOOL
ATTRFLAGS: AF_FEATURE
ATTRDEFVAL: false
ATTRMCDPATH: allow-client-a-record-update
ATTRVIZ: 5
ATTRDESC:: eod
Determines if a client is allowed to update A records.
If the client sets the flags in the FQDN option to indicate that
it wants to do the A record update in the request, and if this
value is TRUE, the server allows the client to do the A record
update; otherwise, based on other server configurations, the server
does the A record update.

eod

ATTR: dhcp-reply-options-number
ATTRID: 25
ATTRHDRNAME: AO_POLICY_DHCP_REPLY_OPTIONS_NUMBER
ATTRMCDPATH: dhcp-reply-options-number
ATTRTYPE: AT_ARRAY(AT_INT)
ATTRVIZ: 1
DEPRECATED: 7.0

ATTR: bootp-reply-options-number
ATTRID: 26
ATTRHDRNAME: AO_POLICY_BOOTP_REPLY_OPTIONS_NUMBER
ATTRMCDPATH: bootp-reply-options-number
ATTRTYPE: AT_ARRAY(AT_INT)
ATTRVIZ: 1
DEPRECATED: 7.0

ATTR: version
ATTRID: 27
ATTRHDRNAME: AO_POLICY_VERSION
ATTRTYPE: AT_INT
ATTRMCDPATH: version
ATTRVIZ: 1
DEPRECATED: 6.0.0

ATTR: allow-dual-zone-dns-update
ATTRID: 28
ATTRHDRNAME: AO_POLICY_ALLOW_DUAL_ZONE_DNS_UPDATE
ATTRTYPE: AT_BOOL
ATTRFLAGS: AF_FEATURE
ATTRDEFVAL: false
ATTRVIZ: 5
ATTRDESC:: eod
Enables DHCP clients to perform DNS updates into two DNS zones.
To support these clients, you can configure the DHCP server to
allow the client to perform an update, but also to perform a DNS
update on the client's behalf.

eod

ATTR: option-list
ATTRID: 29
ATTRHDRNAME: AO_POLICY_OPTION_LIST
ATTRTYPE: AT_NLIST(AT_OBJ(Option))
# 1<<16 | 1131
ATTRVAL: 66667
ATTRVIZ: 3
ATTRDESC:: eod
The list of DHCP options that are part of this policy.
eod

ATTR: limitation-count
ATTRID: 30
ATTRHDRNAME: AO_POLICY_LIMITATIONCOUNT
ATTRTYPE: AT_INT
ATTRMCDPATH: limitation-count
ATTRDESC:: eod
Specifies the maximum number of clients with the same limitation-id
that are allowed to have currently active and valid leases.

eod

ATTR: inhibit-all-renews
ATTRID: 31
ATTRTYPE: AT_BOOL
ATTRDEFVAL: false
ATTRVIZ: 5
ATTRDESC:: eod
Causes the server to reject all renewal requests, forcing the client
to obtain a different address any time it contacts the DHCP server.

eod

ATTR: inhibit-renews-at-reboot
ATTRID: 32
ATTRTYPE: AT_BOOL
ATTRDEFVAL: false
ATTRVIZ: 5
ATTRDESC:: eod
Permits clients to renew their leases, but the server forces
them to obtain new addresses each time they reboot.

eod

ATTR: unavailable-timeout
ATTRID: 33
ATTRHDRNAME: AO_POLICY_UNAVAILABLETIMEOUT
ATTRTYPE: AT_TIME
ATTRDEFVAL: 86400
ATTRVIZ: 5
ATTRDESC:: eod
Permits the server to make a lease unavailable for the time specified
and then to return the lease to available state. If there is no value
configured in the system_default_policy, then the default is
86400 seconds (or 24 hours).

eod

ATTR: giaddr-as-server-id
ATTRID: 34
ATTRTYPE: AT_BOOL
ATTRDEFVAL: false
ATTRVIZ: 5
ATTRDESC:: eod
Enables the DHCP server to set the server-id option on a DHCPOFFER
and a DHCPACK to the giaddr of the incoming packet, instead of the
IP address of the server (the default action).

This causes all unicast renews to be sent to the relay agent instead
of directly to the DHCP server, and so renews arrive at the DHCP
server with option-82 information appended to the packet.

Some relay agents may not support this capability and, in some
complex configurations, the giaddr might not actually be an address
to which the DHCP client can send A unicast packet. In these cases,
the DHCP client cannot renew a lease, and must always perform a
rebind operation (where the DHCP client broadcasts a request instead
of sending a unicast to what it believes is the DHCP server).
eod

ATTR: vendor-options
ATTRID: 35
ATTRTYPE: AT_NLIST(AT_OBJ(Option))
# 1<<16 | 1131
ATTRVAL: 66667
ATTRVIZ: 3
ATTRDESC:: eod
The list of DHCP vendor-specific options that are part of this
policy.
eod

ATTR: v6-options
ATTRID: 36
ATTRTYPE: AT_NLIST(AT_OBJ(Option))
# 1<<16 | 1131
ATTRVAL: 66667
ATTRVIZ: 3
ATTRDESC:: eod
Lists the DHCPv6 options that the server returns to a client as
part of this policy.

This attribute receives special handling during the policy hierarchy
processing when checking the prefix policies (embedded or named)
for the prefixes on a link. Prefixes for the link are processed
in alphabetic (case blind) order. For each prefix, the embedded and
then named policy are checked. Only prefixes to which the client has
access (based on selection tags and other attributes) are checked.

eod

ATTR: v6-vendor-options
ATTRID: 37
ATTRTYPE: AT_NLIST(AT_OBJ(Option))
# 1<<16 | 1131
ATTRVAL: 66667
ATTRVIZ: 3
ATTRDESC:: eod
Lists DHCPv6 vendor-specific options that are part of this
policy.

This attribute has special handling during the policy hierarchy
processing when checking the Prefix policies (embedded or named)
for the Prefixes on a Link. The Prefixes for the Link are
processed in alphabetic (case blind) order. For each Prefix, the
embedded and then named policy are checked. Only Prefixes to which
the client has access (based on selection tags, etc.) are checked.

eod

ATTR: allow-non-temporary-addresses
ATTRID: 38
ATTRTYPE: AT_BOOL
ATTRDEFVAL: true
ATTRDESC:: eod
Determines whether DHCPv6 clients can request non-temporary
(IA_NA) addresses.

The default is to allow clients to request non-temporary addresses.

eod

ATTR: allow-temporary-addresses
ATTRID: 39
ATTRTYPE: AT_BOOL
ATTRDEFVAL: true
ATTRDESC:: eod
Determines whether DHCPv6 clients can request temporary (IA_TA)
addresses.

The default is to allow clients to request temporary addresses.
eod

ATTR: min-preferred-lifetime
ATTRID: 40
ATTRTYPE: AT_TIME
ATTRVIZ: 3
ATTRDESC:: eod
Sets the minimum preferred lifetime for leases to DHCPv6 clients.

The default is the preferred lifetime.
eod

ATTR: preferred-lifetime
ATTRID: 41
ATTRTYPE: AT_TIME
ATTRDEFVAL: 1w
ATTRDESC:: eod
Assigns the default and maximum preferred lifetime for leases to
DHCPv6 client interfaces. Expressed in seconds and relative to
the time the server sent the packet, this attribute sets the
length of time that the address is preferred; that is, its use is
unrestricted. When the preferred lifetime expires, the address
becomes deprecated and its use is restricted.

eod

ATTR: min-valid-lifetime
ATTRID: 42
ATTRTYPE: AT_TIME
ATTRVIZ: 3
ATTRDESC:: eod
Sets the minimum valid lifetime for leases to DHCPv6 clients.

The default is the valid-lifetime.
eod

ATTR: valid-lifetime
ATTRID: 43
ATTRTYPE: AT_TIME
ATTRDEFVAL: 2w
ATTRDESC:: eod
Assigns the default and maximum valid lifetime for leases to
DHCPv6 client interfaces. Expressed in seconds and relative
to the time the server sent the packet, this attribute sets
the length of time that an address remains valid.  When this
period of time expires, the address becomes invalid and
unusable. The valid lifetime must be greater than or equal
to the preferred lifetime.
eod

ATTR: renewal-pct
ATTRID: 44
ATTRTYPE: AT_PERCENT
ATTRVIZ: 3
ATTRDEFVAL: 50%
ATTRDESC:: eod
For DHCPv6, determines the percentage of the preferred 
lifetime at which the client should attempt renewals. Note 
that this percentage is based on the shortest renewable 
preferred lifetime in a binding.

For DHCPv4, the percentage of this policy's lease time to use for
the dhcp-renewal-time option if none is configured.
eod

ATTR: rebind-pct
ATTRID: 45
ATTRTYPE: AT_PERCENT
ATTRVIZ: 3
ATTRDEFVAL: 80%
ATTRDESC:: eod
For DHCPv6, sets the percentage of the preferred lifetime at which
the client should attempt rebinding.  Note that this percentage is
based on the shortest renewal preferred lifetime in a binding.

For DHCPv4, the percentage of this policy's lease time to use for
the dhcp-rebinding-time option is none is configured. Note that the
default value is 87.5% (not 80%) for DHCPv4 if rebind-pct is not
configured.
eod

ATTR: affinity-period
ATTRID: 46
ATTRTYPE: AT_TIME
ATTRDESC:: eod
Associates a lease in the AVAILABLE state with the client that
last held the lease. If the client requests a lease during the
affinity period, it is granted the same lease; that is, unless
renewals are prohibited, then it is explicitly not given the lease.

Because of the vast IPv6 address space and depending on the address
generation technique, it could be millions of years before an
address ever needs reassignment to a different client, and there
is no reason to hold on to this information for that long.

To prohibit renewals enable either the inhibit-all-renews attribute
or the inhibit-renews-at-reboot attribute.
eod

ATTR: allow-rapid-commit
ATTRID: 47
ATTRTYPE: AT_BOOL
ATTRDEFVAL: false
ATTRDESC:: eod
Determines whether DHCPv6 clients can use a Solicit with the
Rapid Commit option to obtain configuration information with
fewer messages. To permit this, make sure that a single DHCP
server is servicing clients.

This attribute has special handling during the policy hierarchy
processing when checking the Prefix policies (embedded or named)
for the Prefixes on a Link. The Prefixes for the Link are
processed in alphabetic (case blind) order. For each Prefix, the
embedded and then named policy are checked. Only Prefixes to which
the client has access (based on selection tags, etc.) are checked:

  - If any of the prefix policies has this attribute set to
    FALSE, Rapid Commit is not allowed.
  - If at least one has it set to TRUE, Rapid Commit is allowed.
  - Otherwise, the remaining policies in the hierarchy are
    checked.

The default is not to allow clients to use Rapid Commit.

eod

ATTR: v6-reply-options
ATTRID: 48
ATTRTYPE: AT_NLIST(AT_OPTIONID6)
ATTRDESC:: eod
Lists the options that should be returned in any
replies to DHCPv6 clients.

This attribute has special handling during the policy hierarchy
processing when checking the Prefix policies (embedded or named)
for the Prefixes on a Link. The Prefixes for the Link are
processed in alphabetic (case blind) order. For each Prefix, the
embedded and then named policy are checked. Only Prefixes to which
the client has access (based on selection tags, etc.) are checked.
eod

ATTR: default-prefix-length
ATTRID: 49
ATTRTYPE: AT_RANGEINT(0-128)
ATTRDEFVAL: 64
ATTRDESC:: eod
For delegation, specifies the default length of the delegated prefix,
if a router (client) does not explicitly request it.

The default length must always be less than or equal to the prefix
length of the prefix range.

eod

ATTR: longest-prefix-length
ATTRID: 50
ATTRTYPE: AT_RANGEINT(0-128)
ATTRVIZ: 3
ATTRDESC:: eod
For prefix delegation, specifies the longest prefix length allowed
for delegated prefixes. If the requesting router (client) requests a
prefix length that is longer than this, this length is used.

The default is the value of the default-prefix-length.

Only used if allow-client-hints is enabled.
eod

ATTR: shortest-prefix-length
ATTRID: 51
ATTRTYPE: AT_RANGEINT(0-128)
ATTRVIZ: 3
ATTRDESC:: eod
For prefix delegation, specifies the shortest prefix length allowed
for delegated prefixes. If the requesting router (client) requests a
prefix length that is shorter than this, this length is used.

The default is the value of the default-prefix-length.

Only used if allow-client-hints is enabled.
eod

ATTR: allow-client-hints
ATTRID: 52
ATTRTYPE: AT_BOOL
ATTRVIZ: 3
ATTRDEFVAL: false
ATTRDESC:: eod
Enables or disables using lifetimes and prefix-lengths that
DHCPv6 clients request in messages.

If allow-client-hints is true, lifetimes and prefix-lengths
requested by the client that are within allowed ranges are
used. This requires configuring the min-preferred-lifetime,
min-valid-lifetime, and/or longest-prefix-length and
shortest-prefix-length.

If allow-client-hints is false, the server's configuration
controls the lifetimes and prefix-lengths used (client
requested values are ignored).
eod

ATTR: forward-dnsupdate
ATTRID: 53
ATTRTYPE: AT_NAMEREF(DnsUpdateConfig)
ATTRVAL: 1145
ATTRDESC:: eod
Specifies the name of the update configuration that determines
which forward zones to include in updates.
eod

ATTR: forward-zone-name
ATTRID: 54
ATTRTYPE: AT_DNSNAME
ATTRDESC:: eod
Designates an optional forward zone for DNS updates.
eod

ATTR: reverse-dnsupdate
ATTRID: 55
ATTRTYPE: AT_NAMEREF(DnsUpdateConfig)
ATTRVAL: 1145
ATTRDESC:: eod
Specifies the name of the update configuration that determines
which reverse zones to include in a DNS update.
eod

ATTR: use-client-id-for-reservations
ATTRID: 56
ATTRTYPE: AT_BOOL
ATTRFLAGS: AF_PRINT_ALT
ATTRDEFVAL: false
ATTRDESC:: eod
Controls how the server database checks for reserved IP
addresses.

By default, the server uses the MAC address of the DHCP client as the
key for its database lookup.  If this attribute is set to true
(enabled), then the server does the check for reserved
addresses using the DHCP client-id, which the client usually sends.

In cases where the DHCP client does not supply the client-id, the
server synthesizes it, and uses that value.
eod

ATTR: v4-reply-options
ATTRID: 57
ATTRTYPE: AT_NLIST(AT_OPTIONID4)
ATTRDESC:: eod
Lists the options the server returns to all DHCPv4 clients, whether
or not the client specifically asks for the option data.
eod

ATTR: v4-bootp-reply-options
ATTRID: 58
ATTRTYPE: AT_NLIST(AT_OPTIONID4)
ATTRDESC:: eod
Lists the options the server returns to all BOOTP clients.
eod

ATTR: reconfigure-via-relay
ATTRID: 59
ATTRTYPE: AT_BOOL
ATTRDEFVAL: FALSE
ATTRDESC:: eod
Controls whether the server should prefer unicasting or
relaying DHCPv6 Reconfigure messages.
If false (the default), the server prefers to unicast
Reconfigure messages if the client has one or more valid
statefully assigned addresses.
If true, the server prefers to send Reconfigure messages
via the relay agent unless no relay agent information is
available.

Note: When you use this attribute, consider that:
    -  In networks where the DCHPv6 server cannot communicate
       directly with its client devicesfor example, where
       firewalls are in placeset this value to true.
    -  The DHCPv6 server does not use embedded and named
       policies configured on a client when it evaluates
       this attribute.
    -  The relay agent cannot be used if the Relay-Forw message
       came from a link-local address.
eod

ATTR: reconfigure
ATTRID: 60
ATTRTYPE: AT_ENUMINT(allow=1, disallow=2, require=3)
ATTRDEFVAL: allow
ATTRFLAGS: AF_PRINT_ALT
ATTRDESC:: eod
Controls DHCPv6 client reconfiguration support:
   1  allow        Allows clients to request reconfiguration
                   support and the server will honor the
                   request (default).
   2  disallow     Allows clients to request reconfiguration
                   support but the server will not honor
                   the clients' request.
   3  require      Requires clients to request reconfiguration
                   support and the server drops client
                   Solicit and Request messages that do not
                   include a Reconfigure-Accept option.

This attribute has special handling during the policy hierarchy
processing when checking the Prefix policies (embedded or named)
for the Prefixes on a Link. The Prefixes for the Link are
processed in alphabetic (case blind) order. For each Prefix, the
embedded and then named policy are checked. Only Prefixes to which
the client has access (based on selection tags, etc.) are checked
as follows:

   - If any of the prefix policies has this attribute set to
   disallow or require, that setting is used.
   - Otherwise, if at least one has it set to allow, Reconfigure
   is allowed.
   - If no prefix policies have this attribute set, the remaining
   policies in the hierarchy are checked.
eod

#
# Warning, this definition is hard-coded in class.c opt_parse
#

CLASS: OldOption
CLASSROOT: OPTION
CLASSID: 1103
CLASSNAME: 1
CLASSVIZ: 0
CLASSPCV: 1.0.0
CLASSDEPRECATED: 7.0.0
CLASSDESC:: eod
A DHCP Option object, containing a specific value for a specific
option. Not currently used.
eod

ATTR: name
ATTRID: 1
ATTRHDRNAME: AO_OPTION_NAME
ATTRTYPE: AT_STRING
ATTRMCDPATH: name
ATTRVIZ: 3

ATTR: number
ATTRID: 2
ATTRHDRNAME: AO_OPTION_NUMBER
ATTRTYPE: AT_INT
ATTRMCDPATH: number

ATTR: type
ATTRID: 3
ATTRHDRNAME: AO_OPTION_TYPE
ATTRTYPE: AT_INT
ATTRMCDPATH: type
ATTRFLAGS: AF_PRINT_HEX

# for now, the value is a string, it should be a parsed blob
ATTR: strval
ATTRID: 4
ATTRHDRNAME: AO_OPTION_STRVAL
ATTRTYPE: AT_STRING
ATTRMCDPATH: strval

# for now, the description of the type as a string
ATTR: typestr
ATTRID: 5
ATTRHDRNAME: AO_OPTION_TYPESTR
ATTRTYPE: AT_STRING
ATTRMCDPATH: typestr

#
# DhcpInterface class - configures interfaces for the DHCP server
#

CLASS: DhcpInterface
CLASSID: 1104
CLASSNAME: 1
CLASSNAMEDESC:: eod
eod
CLASSVIZ: 5
CLASSPCV: 7.0.0
CLASSDESC:: eod
A DHCP server interface. When interfaces
are configured, the server default behavior to
discover and bind to all interfaces is disabled.
eod

ATTR: name
ATTRID: 1
ATTRTYPE: AT_STRING
ATTRFLAGS: AF_REQUIRED,AF_UNIQUE, AF_IMMUTABLE
ATTRDESC:: eod
Identifies the interface for DNS server use.
eod

ATTR: address
ATTRID: 2
ATTRTYPE: AT_SUBNET
ATTRDESC:: eod
Specifies the IP address and subnet mask length of one or more
interfaces that the DHCP server should use.
eod

ATTR: ip6address
ATTRID: 3
ATTRTYPE: AT_PREFIX
ATTRDESC:: eod
Specifies the IPv6 address and prefix length of one or more
interfaces that the DHCP server should use.
eod

ATTR: server-port
ATTRID: 4
ATTRTYPE: AT_RANGEINT(1-65535)
ATTRVIZ: 3
ATTRDEFVAL: 67
ATTRDESC:: eod
Specifies the port number that the DHCP server should listen on.
eod

ATTR: client-port
ATTRID: 5
ATTRTYPE: AT_RANGEINT(1-65535)
ATTRVIZ: 3
ATTRDEFVAL: 68
ATTRDESC:: eod
Sets the destination port for packets sent to DHCP clients.
eod

ATTR: relay-port
ATTRID: 6
ATTRTYPE: AT_RANGEINT(1-65535)
ATTRVIZ: 3
ATTRDEFVAL: 67
ATTRDESC:: eod
Sets the port used as the destination for packets sent to DHCP
relay-agents.
eod

ATTR: v6-server-port
ATTRID: 7
ATTRTYPE: AT_RANGEINT(1-65535)
ATTRVIZ: 3
ATTRDEFVAL: 547
ATTRDESC:: eod
Sets the port number that the DHCP server should listen on for
DHCPv6 messages.
eod

ATTR: v6-client-port
ATTRID: 8
ATTRTYPE: AT_RANGEINT(0-65535)
ATTRVIZ: 3
ATTRDEFVAL: 546
ATTRDESC:: eod
Sets the destination port for packets sent to DHCPv6 clients.

If 0, the server will use the client's source port.
eod

ATTR: v6-relay-port
ATTRID: 9
ATTRTYPE: AT_RANGEINT(0-65535)
ATTRVIZ: 3
ATTRDEFVAL: 547
ATTRDESC:: eod
Sets the destination port for packets sent to DHCPv6 relay-agents.

If 0, the server will use the relay-agent's source port.
eod

ATTR: multicast-addresses
ATTRID: 10
ATTRTYPE: AT_NLIST(AT_IP6ADDR)
ATTRDEFVAL: ff02::1:2,ff05::1:3
ATTRDESC:: eod
Enables or disables the specified multicast addresses on DHCP
interfaces. The default multicast addresses are ff02::1:2 and
ff05::1:3.  DHCPv6 requires address ff02::1:2, if any DHCPv6 clients
are directly connected to the link associated with the interface.
The address ff05::1:3 is the default multicast addresses used by
relay agents when relaying DHCPv6 requests.
eod

#
# end of DHCPINTERFACE class
#

CLASS: ScopeAttribute
CLASSROOT: SCOPEATTRIBUTE
CLASSID: 1105
CLASSNAME: 1
CLASSVIZ: 0
CLASSDESC:: eod
Deprecated mapping of attribute name to bit position in a 32 bit
mask
eod

ATTR: name
ATTRID: 1
ATTRHDRNAME: AO_SCOPEATTRIBUTE_NAME
ATTRTYPE: AT_STRING
ATTRMCDPATH: name

ATTR: bitnum
ATTRID: 2
ATTRHDRNAME: AO_SCOPEATTRIBUTE_BITNUM
ATTRTYPE: AT_INT
ATTRMCDPATH: bitnum

CLASS: Reservation
CLASSROOT: RESERVATION
CLASSID: 1107
CLASSNAME: 2
CLASSNAMEDESC:: eod
There is no semantic meaning to the name of a Reservation.
Currently, the ip address is used, but these could be duplicated
in VPNs, so there is no uniqueness requirement.
eod
CLASSVIZ: 5
CLASSPCV: 1.0.0
CLASSDESC:: eod
A DHCP lease reservation. A reservation is used to assign a given
client a specific address.

eod

ATTR: mac
ATTRID: 1
ATTRHDRNAME: AO_RESERVATION_MAC
ATTRTYPE: AT_MACADDR
ATTRMCDPATH: mac
ATTRVIZ: 5
ATTRDESC:: eod
Displays the MAC address of the client for whom the specified
IP address is to be reserved.

eod

ATTR: ipaddr
ATTRID: 2
ATTRHDRNAME: AO_RESERVATION_IPADDR
ATTRTYPE: AT_IPADDR
ATTRMCDPATH: ipaddr
ATTRVIZ: 5
ATTRDESC:: eod
Displays an IP address within the network that the scope specifies
and that contains the reservation.
eod

ATTR: vpn-id
ATTRID: 3
ATTRTYPE: AT_INT
ATTRFLAGS: AF_REFERENCE
# Encode attribute 4 of Vpn(1127) as 4<<16 + 1127 == 263271
ATTRVAL: 263271
ATTRDEFVAL: 0
ATTRDESC:: eod
Displays the identifier of the VPN that contains this reservation.

eod

ATTR: include-tags
ATTRID: 4
ATTRTYPE: AT_NLIST(AT_STRING)
# AT_STRING = 5
ATTRVAL: 5
ATTRVIZ: 5
ATTRDESC:: eod
Displays the selection criteria for this reservation.

eod

ATTR: exclude-tags
ATTRID: 5
ATTRTYPE: AT_NLIST(AT_STRING)
# AT_STRING = 5
ATTRVAL: 5
ATTRVIZ: 1
DEPRECATED: 7.0.6
ATTRDESC:: eod
Displays the exclusion criteria for this reservation.

eod

ATTR: client-class
ATTRID: 6
ATTRTYPE: AT_NAMEREF(ClientClass)
ATTRVAL: 1117
ATTRVIZ: 5
ATTRDESC:: eod
Identifies the client-class to use when selecting from among
scopes that might contain a specified reservation.

eod

ATTR: relay-info
ATTRID: 7
ATTRTYPE: AT_OPTION
ATTRVAL: 82
ATTRDESC:: eod
Sets the contents of DHCP option-82 (relay-agent-info) to insert
in a synthesized lease. For leasequery to work with reservations
for static addresses in a cable environment, the relay-agent option
information needs to be configured with the reservation.  If set,
the attribute should contain all the contents of the relay-agent-info
(option-82) to be provided in a synthesized leasequery response for
this reservation.

eod

ATTR: cluster-id
ATTRID: 8
ATTRTYPE: AT_SHORT
ATTRFLAGS: AF_REFERENCE
# Encode attribute 11 of Cluster(1449) as 11<<16 + 1449 == 722345
ATTRVAL: 722345
ATTRVIZ: 1
DEPRECATED: 7.0
ATTRDESC:: eod
Displays the identifier of the cluster containing the authoritative
copy of this reservation.
eod

ATTR: replica-deleted
ATTRID: 9
ATTRTYPE: AT_BYTE
ATTRVIZ: 1
DEPRECATED: 7.0
ATTRDESC:: eod
A marker that the replica propagation code thinks that this
object should be deleted.  This is used rather than removing
the cluster-id value so we can tell when an object has been
created by replica propagation and then should be deleted.
eod

ATTR: device-name
ATTRID: 10
ATTRTYPE: AT_STRING
ATTRDESC:: eod
Displays the name of the device represented by this
reservation object.
eod

ATTR: description
ATTRID: 11
ATTRTYPE: AT_STRING
ATTRDESC:: eod
Describes the device that this reservation object represents.
eod

ATTR: ip6address
ATTRID: 12
ATTRTYPE: AT_IP6NET
ATTRVIZ: 5
ATTRDESC:: eod
Specifies the IPv6 address for the reservation.

eod

ATTR: lookup-key
ATTRID: 13
ATTRTYPE: AT_BLOB
ATTRDESC:: eod
Displays the  sequence of bytes which is the key for this reservation
object.  If this attribute appears in the reservation object, its
value overrides any value in the mac attribute.  The type of this
object is found in the attribute lookup-key-type.
eod

ATTR: lookup-key-type
ATTRID: 14
ATTRTYPE: AT_INT
ATTRVIZ: 3
ATTRDESC:: eod
This is the type (i.e., the AT_xxx type) of the value in the
lookup-key attribute.  It may take on the values of AT_NSTRING,
AT_BLOB, or AT_MACADDR.
eod


# L e a s e
# L E A S E
# Lease

CLASS: Lease
CLASSROOT: LEASE
CLASSID: 1108
CLASSNAME: 15
CLASSNAMEDESC:: eod
The name of a lease object is the IP address that it represents.
eod
CLASSVIZ: 5
CLASSPCV: 1.0.0
CLASSDESC:: eod
A DHCP lease.
eod

ATTR: client-dns-name
ATTRID: 1
ATTRHDRNAME: AO_LEASE_CLIENT_DNS_NAME
ATTRTYPE: AT_STRING
ATTRMCDPATH: client-dns-name
ATTRVIZ: 5
ATTRDESC:: eod
Displays the client DNS name, which the DHCP server attempted
(possibly successfully) to enter into the DNS server for
a specified client.

This attribute is related to the client-host-name, but may not be
identical due to name collisions in the DNS server database.

eod
ATTR: client-mac-addr
ATTRID: 2
ATTRHDRNAME: AO_LEASE_CLIENT_MAC_ADDR
ATTRTYPE: AT_MACADDR
ATTRMCDPATH: client-mac-addr
ATTRVIZ: 5
ATTRDESC:: eod
Displays the MAC address which the client presented to the DHCP
server.
eod

ATTR: client-domain-name
ATTRID: 3
ATTRHDRNAME: AO_LEASE_CLIENT_DOMAIN_NAME
ATTRTYPE: AT_STRING
ATTRMCDPATH: client-domain-name
ATTRVIZ: 5
ATTRDESC:: eod
Displays the domain (if any) to which the client's DNS name belongs.
eod

ATTR: client-old-domain-name
ATTRID: 4
ATTRHDRNAME: AO_LEASE_CLIENT_OLD_DOMAIN_NAME
ATTRTYPE: AT_STRING
ATTRMCDPATH: client-old-domain-name
ATTRVIZ: 3

ATTR: client-host-name
ATTRID: 5
ATTRHDRNAME: AO_LEASE_CLIENT_HOST_NAME
ATTRTYPE: AT_STRING
ATTRMCDPATH: client-host-name
ATTRVIZ: 5
ATTRDESC:: eod
Displays the DNS name that the client requested the DHCP server
to place in the DNS server.
eod

ATTR: client-id
ATTRID: 6
ATTRHDRNAME: AO_LEASE_CLIENT_CLIENT_ID
ATTRTYPE: AT_STRING
ATTRMCDPATH: client-id
ATTRVIZ: 1
# Was really deprecated long ago (CNR 5.0 / PCV 2.0.0?); replaced by client-binary-client-id!
DEPRECATED: 8.0.1
ATTRDESC:: eod
Displays the identifier that the client specifies or the DHCP server
synthesizes for this client (if client-id-created-from-mac-address
is set in the client-flags).
eod

ATTR: client-flags
ATTRID: 7
ATTRHDRNAME: AO_LEASE_CLIENT_FLAGS
ATTRTYPE: AT_FLAGSINT(client-valid=1, client-id-created-from-mac-address=2, client-dns-name-up-to-date=3, client-up-to-date-in-mcd=4, reverse-dns-up-to-date=5, dns-update-pending=9, client-fqdn-present=10, client-updates-name=11, clear-host-name=7, host-name-has-changed=6, domain-name-has-changed=8, use-test-before-update=12, avoid-dns-retry=13, dual-zone-dns-update=14, client-invalid-due-to-macaddress=15, in-limitation-list=16, used-over-limit-client-class=17, synthesized-dns-name=18, reservation-uses-client-id=19, client-id-from-override-id=20, client-id-from-string=21)
ATTRMCDPATH: client-flags
ATTRVIZ: 5
ATTRDESC:: eod
Displays any of the following values associated with the client
lease state:

   2  client-id-created-from-mac-address
      Indicates that the client-id was created for internal use
      from the client supplied MAC address.  It is never
      reported externally if this is true.

   3  client-dns-name-up-to-date
      Indicates that the client-dns-name (A) is actually current
      in the DNS server database.

   5  reverse-dns-up-to-date
      Indicates that the reverse (PTR) DNS entry is current in
      the DNS database.

   9  dns-update-pending
      Indicates that a DNS operation is pending for this client.

   16 in-limitation-list
      Indicates that this lease is presently in a limitation list
      using the limitation-id shown.

These are for internal use only:
  client-valid
  client-fqdn-present
  client-updates-name
  clear-host-name
  host-name-has-changed
  domain-name-has-changed
  use-test-before-update
  avoid-dns-retry
  dual-zone-dns-update
  client-invalid-due-to-macaddress
  used-over-limit-client-class
  synthesize-dns-name
  reservation-uses-client-id
  client-id-from-override-id
  client-id-from-string
eod

ATTR: client-last-name-num
ATTRID: 8
ATTRHDRNAME: AO_LEASE_CLIENT_LAST_NAME_NUM
ATTRTYPE: AT_INT
ATTRMCDPATH: client-last-name-num
ATTRVIZ: 3
ATTRDESC:: eod
If DHCP is updating DNS, and a client specifies a hostname that
conflicts with a hostname already present in the zone, DHCP
uses this number to determine the next name to try.
eod

ATTR: client-last-name-num-len
ATTRID: 9
ATTRHDRNAME: AO_LEASE_CLIENT_LAST_NAME_NUM_LEN
ATTRTYPE: AT_INT
ATTRMCDPATH: client-last-name-num-len
ATTRVIZ: 3
ATTRDESC:: eod

eod
ATTR: client-last-transaction-time
ATTRID: 10
ATTRHDRNAME: AO_LEASE_CLIENT_LAST_TRANS_TIME
ATTRTYPE: AT_DATE
ATTRMCDPATH: client-last-trans-time
ATTRVIZ: 5
ATTRDESC:: eod
Displays the time when the client most recently contacted the
DHCP server.
eod

ATTR: state
ATTRID: 11
ATTRHDRNAME: AO_LEASE_STATE
ATTRTYPE: AT_ENUMINT(available=1, offered=2, leased=3, expired=4, unavailable=5, released=6, other-available=7, pending-available=8)
ATTRMCDPATH: lease-state
ATTRFLAGS: AF_PRINT_ALT
ATTRVIZ: 5
ATTRDESC:: eod
Displays the current state of the lease.

   1  available
      The lease is not currently leased by any client. Any
      client information is from the most recent client to
      lease or be offered this lease.

   2  offered
      The lease is offered to the associated client. In many
      cases, the database is not written with information
      concerning offering a lease to a client since there is
      no requirement to update stable storage with this
      information.

   3  leased
      The lease is currently leased to the client whose
      information appears in the lease.

   4  expired
      The client specified has not renewed the lease, and it
      expired. Upon expiration the DNS information for this
      client was scheduled for removal.

   5  unavailable
      The lease is unavailable.  It was made unavailable because
      of some conflict. A ping attempt might have shown that the
      another client using the, or the DHCP server might have
      detected another DHCP server handing out  this IP address,
      or a DHCP client might have declined the lease. Use
      start-time-of-state to determine when the lease became
      unavailable, and look in the log file around that time to
      determine exactly why the lease became unavailable.

   6  released
      The client specified has released the lease, but the
      server was configured to apply a 'release-grace-period'.
      The lease won't be made available until the
      grace-period expires.

   7  other-available
      Used only when failover is enabled.  A lease in the
      other-available state is available for allocation by the
      other server in the failover pair, but not available for
      allocation by this server.

   8  pending-available
      Used only when failover is enabled.  A lease in the
      pending-available state will be available as soon as
      this server can synchronize its available state with
      the other server.
eod

ATTR: flags
ATTRID: 12
ATTRHDRNAME: AO_LEASE_FLAGS
ATTRTYPE: AT_FLAGSINT(reserved=1, valid=2, deactivated=3, initialized=4, failover-updated=5, not_in_ranges=6, dynamic=7, backup=8 )
ATTRFLAGS: AF_PRINT_ALT
ATTRMCDPATH: lease-flags
ATTRVIZ: 5
ATTRDESC:: eod
Displays flags that describe this lease:

   1  reserved
	  The lease is reserved for some MAC address.  The table
      that relates MAC addresses to leases is in the scope.

   3  deactivated
	  The lease is deactivated, which means that it should
      not be used.  Any client which is using a deactivated
      lease will be NAK'ed on their next renewal.


   7  dynamic
	  Last written by server which knew only about the lease
       because it was created by a send-reservation command.

   8  backup
	  Indicates that the state for this lease was recorded by
       a server whose role was backup with respect to this lease.

For internal use only:
    initialized
    valid
    failover-updated
eod

ATTR: expiration
ATTRID: 13
ATTRHDRNAME: AO_LEASE_EXPIRATION
ATTRTYPE: AT_DATE
ATTRMCDPATH: lease-expiration
ATTRVIZ: 5
ATTRDESC:: eod
Displays the date and time the lease will expire.
eod

ATTR: start-time-of-state
ATTRID: 14
ATTRHDRNAME: AO_LEASE_START_TIME_OF_STATE
ATTRTYPE: AT_DATE
ATTRMCDPATH: lease-start-time-of-state
ATTRVIZ: 5
ATTRDESC:: eod
Displays the time the state changed to its current value.
eod

ATTR: address
ATTRID: 15
ATTRHDRNAME: AO_LEASE_ADDRESS
ATTRTYPE: AT_IPADDR
ATTRMCDPATH: address
ATTRVIZ: 5
ATTRDESC:: eod
Specifies the IP address of the lease.  The address is added at
creation.
eod

ATTR: network-name
ATTRID: 16
ATTRHDRNAME: AO_LEASE_NETWORK_NAME
ATTRTYPE: AT_STRING
ATTRMCDPATH: lease-network-name
ATTRVIZ: 1
# Was really deprecated long ago!
DEPRECATED: 8.0.1
ATTRDESC:: eod
The network name for this lease.
eod

ATTR: version
ATTRID: 17
ATTRHDRNAME: AO_LEASE_VERSION
ATTRTYPE: AT_VERSION
ATTRMCDPATH: version
ATTRVIZ: 3
ATTRDESC:: eod
The internal version number for this lease.
eod

ATTR: client-class-name
ATTRID: 18
ATTRHDRNAME: AO_LEASE_CLIENT_CLASS_NAME
ATTRTYPE: AT_NAMEREF(ClientClass)
ATTRVIZ: 3
ATTRDESC:: eod
Specifies the client-class associated with the client that is
assigned to this lease.
eod

ATTR: relay-agent-circuit-id
ATTRID: 19
ATTRHDRNAME: AO_LEASE_CLIENT_RELAY_AGENT_CIRCUIT_ID
ATTRTYPE: AT_BLOB
ATTRVIZ: 5
ATTRDESC:: eod
Displays the circuit-id sub-option of the DHCP relay-agent
information option 82 from this client.
eod

ATTR: relay-agent-remote-id
ATTRID: 20
ATTRHDRNAME: AO_LEASE_CLIENT_RELAY_AGENT_REMOTE_ID
ATTRTYPE: AT_BLOB
ATTRVIZ: 5
ATTRDESC:: eod
Displays the remote-id sub-option of the DHCP relay-agent
information option 82 from this client.
eod

ATTR: partner-address
ATTRID: 21
ATTRHDRNAME: AO_LEASE_SF_PARTNER_ADDR
ATTRTYPE: AT_IPADDR
ATTRVIZ: 3

# the serial number of this lease's state
ATTR: state-serial
ATTRID: 22
ATTRHDRNAME: AO_LEASE_STATE_SERIAL
ATTRTYPE: AT_INT
ATTRVIZ: 3

# the last xid that was acked by the partner
ATTR: failover-partner-xid
ATTRID: 23
ATTRHDRNAME: AO_LEASE_FAILOVER_PARTNER_XID
ATTRTYPE: AT_INT
DEPRECATED: 7.0
ATTRVIZ: 1

# the last expiration time that the partner has acked
ATTR: partner-expiration-time
ATTRID: 24
ATTRHDRNAME: AO_LEASE_FAILOVER_PARTNER_EXPIRATION
ATTRTYPE: AT_DATE
ATTRVIZ: 3

# the last time that the partner has acked an update
ATTR: failover-partner-last-updated-time
ATTRID: 25
ATTRHDRNAME: AO_LEASE_PARTNER_LAST_UPDATED
ATTRTYPE: AT_DATE
DEPRECATED: 7.0
ATTRVIZ: 1

# the failover partner's address (only used internally by server)
ATTR: failover-partner-address
ATTRID: 26
ATTRHDRNAME: AO_LEASE_FAILOVER_PARTNER_ADDRESS
ATTRTYPE: AT_IPADDR
ATTRVIZ: 3

# the current time at the failover partner
ATTR: failover-partner-time
ATTRID: 27
ATTRHDRNAME: AO_LEASE_FAILOVER_PARTNER_TIME
ATTRTYPE: AT_TIME
DEPRECATED: 7.0
ATTRVIZ: 1
ATTRDESC:: eod
The current time at the failover partner when an update or ack
was sent.
eod

# the current failover state of the network the lease is in
ATTR: failover-state
ATTRID: 28
ATTRHDRNAME: AO_LEASE_FAILOVER_STATE
ATTRTYPE: AT_ENUMINT(none=0, unknown=1, normal=2, interrupted=3, partner-down=4, pot-conflict=5, recover=6, sync=7)
ATTRFLAGS: AF_PRINT_ALT
ATTRVIZ: 3
ATTRDESC:: eod
The current state of the Network that the Lease is in.
eod

# the next expiration time that we want to give the partner
ATTR: next-partner-expiration-time
ATTRID: 29
ATTRHDRNAME: AO_LEASE_FAILOVER_NEXT_PARTNER_EXPIRATION
ATTRTYPE: AT_DATE
ATTRVIZ: 3

# the current server's failover role
ATTR: failover-role
ATTRID: 30
ATTRTYPE: AT_ENUMINT(backup=0, main=1)
ATTRFLAGS: AF_PRINT_ALT
ATTRVIZ: 3
# the failover's own address (only used internally by server)
ATTR: failover-address
ATTRID: 31
ATTRTYPE: AT_IPADDR
ATTRVIZ: 3

ATTR: failover-lease-state
ATTRID: 32
ATTRHDRNAME: AO_LEASE_FAILOVER_LEASE_STATE
ATTRTYPE: AT_ENUMINT(none=0, free=1, active=2, expired=3, released=4, abandoned=5, reset=6, backup=7 )
ATTRMCDPATH: failover_lease-state
ATTRFLAGS: AF_PRINT_ALT
ATTRVIZ: 3
ATTRDESC:: eod
If the lease is not sfuptodate, this is the state that we want
to send to the partner next time we get the chance.
eod

# the longest expiration time that we have ever given this client
ATTR: client-expiration-time
ATTRID: 33
ATTRHDRNAME: AO_LEASE_FAILOVER_CLIENT_EXPIRATION
ATTRTYPE: AT_DATE
ATTRVIZ: 3
ATTRDESC:: eod
The latest time that this server has ever given to this client.
eod

# the longest expiration time that we have acked the failover
# partner
ATTR: acked-to-partner-time
ATTRID: 34
ATTRHDRNAME: AO_LEASE_FAILOVER_ACKED_TO_PARTNER
ATTRTYPE: AT_DATE
ATTRVIZ: 3
ATTRDESC:: eod
The latest time that this server has ever acked to
the failover partner.
eod

# the time this client was first created
ATTR: client-creation-time
ATTRID: 35
ATTRHDRNAME: AO_LEASE_FAILOVER_CLIENT_CREATION_TIME
ATTRTYPE: AT_DATE
ATTRVIZ: 3
ATTRDESC:: eod
The time this client was first created.
eod

ATTR: vendor-class-id
ATTRID: 36
ATTRHDRNAME: AO_LEASE_VENDOR_CLASS_ID
ATTRTYPE: AT_STRING
ATTRVIZ: 5
ATTRDESC:: eod
Displays the vendor-class-id as offered in a DHCP request option 60.
eod

ATTR: lease-renewal-time
ATTRID: 37
ATTRHDRNAME: AO_LEASE_RENEWAL_TIME
ATTRTYPE: AT_DATE
ATTRVIZ: 5
ATTRDESC:: eod
Displays the earliest time the client is expected to issue
a renewal request.
eod

ATTR: client-os-type
ATTRID: 38
ATTRHDRNAME: AO_LEASE_CLIENT_CLIENT_OS_TYPE
ATTRTYPE: AT_STRING
ATTRMCDPATH: client-os-type
ATTRVIZ: 5
ATTRDESC:: eod
Indicates the operating system of the client. This attribute is used
only by the updateSms keyword and has no other purpose. If you
enable failover, the main server transmits this value to the backup
server. The syntax of this attributes value is OS-name major.minor.:
Operating system values are as follows:
   Microsoft Windows NT Server
   Microsoft Windows NT Advanced Server
   Microsoft Windows NT Workstation 4.0
   Microsoft Windows NT Workstation 3.51
   Microsoft Windows 2000 Professional
   Microsoft Windows 95
   Microsoft Windows 9x
   Microsoft Windows for Workgroups
   Microsoft Windows
   Dos
   Netware
   LANMAN Workstation
   LANMAN Server
   OS/2
   MAC OS
eod

ATTR: client-binary-client-id
ATTRID: 39
ATTRHDRNAME: AO_LEASE_CLIENT_BINARY_CID
ATTRTYPE: AT_BLOB
ATTRVIZ: 5
ATTRDESC:: eod
Displays the binary form of the client's client-identifier, if any.
eod

ATTR: vpn-id
ATTRID: 40
ATTRHDRNAME: AO_LEASE_VPN_ID
ATTRTYPE: AT_INT
ATTRFLAGS: AF_REFERENCE
# Encode attribute 4 of VPN(1127) as 4<<16 + 1127 == 263271
ATTRVAL: 263271
ATTRDEFVAL: 0
ATTRDESC:: eod
Displays the identifier of the DHCP VPN that contains this lease.
eod

ATTR: relay-agent-vpn-id
ATTRID: 41
ATTRHDRNAME: AO_LEASE_CLIENT_RELAY_AGENT_VPN_ID
ATTRTYPE: AT_BLOB
ATTRVIZ: 5
ATTRDESC:: eod
Displays the contents of the vpn-id sub-option of the DHCP
relay-agent information option 82 from this client.

This value corresponds to one of two suboption numbers:
If the IANA assigned suboption 181 is present in the packet,
that value is returned; otherwise, if Cisco suboption 151 is
present, that value is returned.
eod

ATTR: relay-agent-subnet-selection
ATTRID: 42
ATTRHDRNAME: AO_LEASE_CLIENT_RELAY_AGENT_SUBNET_SELECTION
ATTRTYPE: AT_IPADDR
ATTRVIZ: 5
ATTRDESC:: eod
Displays the IP address in the subnet selection sub-option
of the DHCP relay-agent information option 82 from this client.

This value corresponds to one of two suboption numbers:
If the IANA assigned suboption  is present in the packet,
that value is returned; otherwise, if  Cisco suboption 150 is
present, that value is returned.
eod

ATTR: relay-agent-option
ATTRID: 43
ATTRHDRNAME: AO_LEASE_CLIENT_RELAY_AGENT_OPTION
ATTRTYPE: AT_OPTION
ATTRVIZ: 5
ATTRVAL: 82
ATTRDESC:: eod
Displays the contents of the relay-agent information option 82
from the most recent client interaction.
eod

ATTR: relay-agent-server-id-override
ATTRID: 44
ATTRHDRNAME: AO_LEASE_CLIENT_RELAY_AGENT_SERVER_ID_OVERRIDE
ATTRTYPE: AT_IPADDR
ATTRVIZ: 5
ATTRDESC:: eod
Displays the IP address in the server-id-override sub-option of the
DHCP relay-agent information option 82 from this client.

This value corresponds to one of two suboption numbers:
If the IANA assigned suboption 182 is present in the packet,
that value is returned; otherwise, if the Cisco suboption 152 is
present, that value is returned.
eod

ATTR: failover-sequence-number
ATTRID: 45
ATTRHDRNAME: AO_LEASE_FAILOVER_SEQUENCE_NUMBER
ATTRTYPE: AT_VERSION
ATTRVIZ: 3
ATTRDESC:: eod
Sequence number of failover object to which this lease belongs.
eod

ATTR: limitation-id
ATTRID: 46
ATTRHDRNAME: AO_LEASE_CLIENT_LIMITATION_ID
ATTRTYPE: AT_BLOB
ATTRVIZ: 5
ATTRDESC:: eod

Displays the value set for a client-class or client limiting the
number of simultaneous active leases a DHCP server can give out
to devices on customer premises.
eod

ATTR: binding-start-time
ATTRID: 47
ATTRTYPE: AT_DATE
ATTRVIZ: 5
ATTRDESC:: eod
Within the DHCP lease database, shows the time at which a
lease binding began.
eod

ATTR: binding-end-time
ATTRID: 48
ATTRTYPE: AT_DATE
ATTRVIZ: 5
ATTRDESC:: eod
Within the DHCPlease database, holds the time at which a
lease binding ended.
eod

ATTR: relay-agent-radius-user
ATTRID: 49
ATTRTYPE: AT_STRING
ATTRDESC:: eod
Displays the contents, if any, of the RADIUS user attribute
contained in the RADIUS attributes suboption of the DHCP relay-agent
information option 82 from this client.
eod

ATTR: relay-agent-radius-pool-name
ATTRID: 50
ATTRTYPE: AT_STRING
ATTRDESC:: eod
Displays the contents, if any, of the RADIUS framed-pool attribute
88 contained in the RADIUS attributes suboption of the DHCP
relay-agent information option 82 from this client.
eod

ATTR: relay-agent-radius-class
ATTRID: 51
ATTRTYPE: AT_STRING
ATTRDESC:: eod
Displays the contents, if any, of the RADIUS class attribute
that was contained in the RADIUS Attributes suboption of the DHCP
relay-agent information option 82 from this client.
eod

ATTR: relay-agent-subscriber-id
ATTRID: 52
ATTRTYPE: AT_STRING
ATTRDESC:: eod
Displays the contents of the subscriber-id suboption of the
relay-agent information option 82 from this client.
eod

ATTR: fwd-dns-update-config-name
ATTRID: 53
ATTRVAL: 1145
ATTRTYPE: AT_NAMEREF(DnsUpdateConfig)
ATTRDESC:: eod
Names the Dns update configuration object  used
to perform dynamic DNS update on a forward zone.
eod

ATTR: rev-dns-update-config-name
ATTRID: 54
ATTRTYPE: AT_NAMEREF(DnsUpdateConfig)
ATTRVAL: 1145
ATTRDESC:: eod
Names the Dns update configuration object used
to perform dynamic DNS update on a reverse zone.
eod

ATTR: reservation-mac-addr
ATTRID: 55
ATTRTYPE: AT_MACADDR
ATTRVIZ: 3
ATTRDESC:: eod
The MAC address of the client for which this lease is reserved.

eod

ATTR: reservation-lookup-key
ATTRID: 56
ATTRTYPE: AT_BLOB
ATTRDESC:: eod
The lookup key with which a reservation for this lease will be
retrieved.

eod

ATTR: reservation-lookup-key-type
ATTRID: 57
ATTRTYPE: AT_INT
ATTRVIZ: 3
ATTRDESC:: eod
The type of the lookup key attribute.

eod

ATTR: client-override-client-id
ATTRID: 58
ATTRTYPE: AT_BLOB
ATTRDESC:: eod
The value of the override-client-id expression for this
client.  If it appears, it is used as the client-id for
this client.

eod

ATTR: failover-pair-name
ATTRID: 59
ATTRTYPE: AT_NAMEREF(CCMFailoverPair)
ATTRVAL: 1414
ATTRVIZ: 3
ATTRDESC:: eod
The name of the failover-pair, if any.

eod

ATTR: user-defined-data
ATTRID: 60
ATTRTYPE: AT_STRING
ATTRDESC:: eod
This string value is associated with the lease in order to allow
customer applications to relate the lease record to other
databases.  It is not used directly by the DHCP server, but may be
read and written by extensions and expressions.

eod

ATTR: relay-agent-device-class
ATTRID: 61
ATTRHDRNAME: AO_LEASE_CLIENT_RELAY_AGENT_DEVICE_CLASS
ATTRTYPE: AT_INT
ATTRDESC:: eod
The contents of the 'device-class' suboption 4 of the relay-agent
information option 82 from this client.
eod

ATTR: relay-agent-auth
ATTRID: 62
ATTRHDRNAME: AO_LEASE_CLIENT_RELAY_AGENT_AUTH
ATTRTYPE: AT_BLOB
ATTRDESC:: eod
The contents of the 'authentication' suboption 8 of the relay-agent
information option 82 from this client.
eod

ATTR: relay-agent-v-i-vendor-class
ATTRID: 63
ATTRHDRNAME: AO_LEASE_CLIENT_RELAY_AGENT_V_I_VENDOR_CLASS
ATTRTYPE: AT_BLOB
ATTRDESC:: eod
The contents of the 'v-i-vendor-class' suboption 9 of the
relay-agent information option 82 from this client.
eod

ATTR: relay-agent-radius-options
ATTRID: 64
ATTRHDRNAME: AO_LEASE_CLIENT_RELAY_AGENT_RADIUS_OPTIONS
ATTRTYPE: AT_BLOB
ATTRDESC:: eod
The contents of the 'radius' suboption 7 of the relay-agent
information option 82 from this client.
This suboption has additional structure that is available on
other attributes of this class.
eod

ATTR: relay-agent-radius-vendor-specific
ATTRID: 65
ATTRTYPE: AT_BLOB
ATTRDESC:: eod
If present, the contents of the RADIUS 'vendor-specific' attribute
26 that was contained in the RADIUS Attributes suboption 7 of the
relay-agent information option 82 from this client.
eod

ATTR: relay-agent-radius-session-timeout
ATTRID: 66
ATTRTYPE: AT_INT
ATTRDESC:: eod
If present, the contents of the RADIUS 'session-timeout' attribute
27 that was contained in the RADIUS Attributes suboption 7 of the
relay-agent information option 82 from this client.
eod

ATTR: relay-agent-radius-v6-pool-name
ATTRID: 67
ATTRTYPE: AT_STRING
ATTRDESC:: eod
If present, the contents of the RADIUS 'v6-pool-name' attribute 100
that was contained in the RADIUS Attributes suboption 7 of the
relay-agent information option 82 from this client.
eod

ATTR: data-source
ATTRID: 68
ATTRTYPE: AT_ENUMINT(unknown=0,main-main=4, backup-main=5, main-backup=6, backup-backup=7)
ATTRFLAGS: AF_PRINT_ALT
ATTRDESC:: eod
Records the original source of the lease data
and the machine from which the data was retrieved.
   0   unknown

   4   main-main
       Indicates the data originated on the  main server and
       was retrieved from the main server.

   5   backup-main
       Indicates the data originated on the backup server and
       was retrieved from the main server.

   6   main-backup
       Indicates the data originated on the main server and
       was retrieved from the backup server.

   7   backup-backup
       Indicates the data originated on the backup server and
       was retrieved from the backup.

When viewing leases with the UI's, you will see all four
values routinely, especially if load-balancing is enabled.
When looking at lease history records, main-main and
backup-backup are the usual values, but in cases where the
lease history poller has determined that some data may be
missing, then main-backup and backup-main can appear as
well.
eod

ATTR: giaddr
ATTRID: 69
ATTRTYPE: AT_IPADDR
ATTRDESC:: eod
If present, the contents of the last received non-zero giaddr
field. This represents the relay agent through which the client
and server last communicated.
eod

ATTR: scope-name
ATTRID: 70
ATTRTYPE: AT_NAMEREF(Scope)
ATTRVAL: 1101
ATTRDESC:: eod
A reference to the scope that contains this lease.
eod

ATTR: client-vendor-class
ATTRID: 71
ATTRTYPE: AT_OPTION
ATTRVAL: 124
ATTRDESC:: eod
The most recently received client vendor class option.
eod

ATTR: client-vendor-info
ATTRID: 72
ATTRTYPE: AT_OPTION
ATTRVAL: 125
ATTRDESC:: eod
The most recently received vendor-specific information
option.
eod

ATTR: dbtxn-seq
ATTRID: 73
ATTRTYPE: AT_INT
ATTRFLAGS: AF_JAVADOC
ATTRVIZ: 3
ATTRDESC:: eod
The database transaction sequence number used by CCM
to record aggregated lease history.
eod

ATTR: dbtxn-generation
ATTRID: 74
ATTRTYPE: AT_INT
ATTRFLAGS: AF_JAVADOC
ATTRVIZ: 3
ATTRDESC:: eod
The generation number for database transaction sequence numbers that
exceed the 32-bit number space.
eod


# End of L e a s e
#        L E A S E
# end Lease
# end LEASE


CLASS: DHCPScriptPoints
CLASSROOT: DHCP_SCRIPT
CLASSID: 1109
CLASSNAMEDESC:: eod
There is one DHCPScriptPoint object per DHCP server object, and
since it is a nested object, it does not have a name.
eod
CLASSVIZ: 5
CLASSPCV: 1.0.0
CLASSDESC:: eod
The DHCP server extension points where a custom extension
script can be attached.
eod

ATTR: post-packet-decode
ATTRID: 1
ATTRHDRNAME: AO_DHCP_SCRIPT_PACKET_PARSED
ATTRTYPE: AT_NAMEREF(ScriptConfig)
ATTRVAL: 51
ATTRMCDPATH: post-packet-decode
ATTRFEAT: 2
ATTRVIZ: 5
ATTRDESC:: eom
Displays the first extension point encountered when a request
arrives.  It immediately follows the decoding of the input packet,
and precedes any processing on the data in the packet.  The
primary activity for an extension at this point is to read
information out of an input packet and do something with it.
Typically, that action might be to re-write the input packet in
some way.
eom

ATTR: pre-packet-encode
ATTRID: 2
ATTRHDRNAME: AO_DHCP_SCRIPT_PRE_PACKET_FORMAT
ATTRTYPE: AT_NAMEREF(ScriptConfig)
ATTRVAL: 51
ATTRMCDPATH: pre-packet-encode
ATTRFEAT: 10
ATTRVIZ: 5
ATTRDESC:: eod
Displays the extension point used to rewrite information in the
response packet about to be sent to the user.  This extension point
comes after the response packet is ready to be encoded into a
packet to be sent to the DHCP client.  Typically, options could
be added at this extension point to the packet.  The packet
can also be dropped at this point, but the DHCP server will
already have recorded its values in its internal database.
eod

ATTR: pre-client-lookup
ATTRID: 3
ATTRHDRNAME: AO_DHCP_SCRIPT_PRE_CLIENT_LOOKUP
ATTRTYPE: AT_NAMEREF(ScriptConfig)
ATTRVAL: 51
ATTRMCDPATH: pre-client-lookup
ATTRFEAT: 4
ATTRVIZ: 5
ATTRDESC:: eod
This extension point only runs for a request if the client-class
processing as been enabled for the server.  The purpose of this
extension point is to allow an extension to perform any or
all of the following:

1.  Modify the client that is looked up during client-class
    processing.
2.  Specify individual data items to override any data items
    found from client entry or the client-class it specifies.
3.  Instruct the server to skip the client lookup altogether.
    In this case, the only client data that will be used is that
    specified in #2, above.
4.  Drop the packet.
eod

ATTR: post-client-lookup
ATTRID: 4
ATTRHDRNAME: AO_DHCP_SCRIPT_POST_CLIENT_LOOKUP
ATTRTYPE: AT_NAMEREF(ScriptConfig)
ATTRVAL: 51
ATTRMCDPATH: post-client-lookup
ATTRFEAT: 5
ATTRVIZ: 5
ATTRDESC:: eod
Examines the results of the entire client-class processing operation,
and takes action based on those results.  The usual actions to take
are to rewrite some of the results, or to drop the packet.

This would also be a place for an extension to place some data
items in the environment dictionary in order to affect the
processing of some extension running at the pre-packet-encode
extension point (where it might load different options into the
response packet or take other actions).
eod

ATTR: post-send-packet
ATTRID: 5
ATTRHDRNAME: AO_DHCP_SCRIPT_POST_SEND_PACKET
ATTRTYPE: AT_NAMEREF(ScriptConfig)
ATTRVAL: 51
ATTRMCDPATH: post-send-packet
ATTRFEAT: 12
ATTRVIZ: 5
ATTRDESC:: eod
This extension point exists so  that information about the
request and response can be used to update an external process or
database.
eod

ATTR: pre-dns-add-forward
ATTRID: 6
ATTRHDRNAME: AO_DHCP_SCRIPT_DNS_PRE_ADD
ATTRTYPE: AT_NAMEREF(ScriptConfig)
ATTRVAL: 51
ATTRMCDPATH: pre-dns-add-forward
ATTRFEAT: 9
ATTRVIZ: 5
ATTRDESC:: eod
This extension point exists to choose the name and affect the DNS
retires during update operations.  It may get called multiple times
for a single DNS update operation.  It has only an environment
dictionary available.
eod

ATTR: check-lease-acceptable
ATTRID: 7
ATTRHDRNAME: AO_DHCP_SCRIPT_POST_NEED_TO_DEACTIVATE
ATTRTYPE: AT_NAMEREF(ScriptConfig)
ATTRVAL: 51
ATTRMCDPATH: check-lease-acceptable
ATTRFEAT: 8
ATTRVIZ: 5
ATTRDESC:: eod
This extension point comes immediately after the server has
determined if it thinks that the current lease is acceptable for
this client.  The extension can examine the results of that
operation, and can cause the routine to return different results
if desired.  It should be used with extreme care, because
incorrect use can cause the server to loop endlessly.
eod

ATTR: post-class-lookup
ATTRID: 8
ATTRHDRNAME: AO_DHCP_SCRIPT_POST_CLASS_LOOKUP
ATTRTYPE: AT_NAMEREF(ScriptConfig)
ATTRVAL: 51
ATTRMCDPATH: post-class-lookup
ATTRFEAT: 3
ATTRVIZ: 5
ATTRDESC:: eod
This extension point comes immediately after the server has
determined the client-class of an incoming DHCP packet by
evaluating the expression configured in the client-class-lookup-id.
eod

ATTR: lease-state-change
ATTRID: 9
ATTRHDRNAME: AO_DHCP_SCRIPT_LEASE_STATE_CHANGE
ATTRTYPE: AT_NAMEREF(ScriptConfig)
ATTRVAL: 51
ATTRMCDPATH: lease-state-change
ATTRFEAT: 7
ATTRVIZ: 5
ATTRDESC:: eod
This extension point is called whenever a lease changes state.
It has a response dictionary, and sometimes a request dictionary.
It can be used to track lease state changes so that leases that
are transitioning from the leased to some other state can be
caught, since they are not typically accompanied by DHCP client
packets.
eod

ATTR: generate-lease
ATTRID: 10
ATTRTYPE: AT_NAMEREF(ScriptConfig)
ATTRVAL: 51
ATTRFEAT: 6
ATTRDESC:: eod
This extension point is called whenever a new lease is being
generated for a DHCPv6 client. The request and response
dictionary are both available. It can be used to generate the
address or prefix to be delegated to the client.
eod

ATTR: environment-destructor
ATTRID: 11
ATTRTYPE: AT_NAMEREF(ScriptConfig)
ATTRVAL: 51
ATTRFEAT: 13
ATTRDESC:: eod
This extension point is called to allow the extension to clean
up any internal context it might have created and stored in the
environment dictionary before the environment dictionary is
deleted. Only the environment dictionary is available.
eod

ATTR: pre-packet-decode
ATTRID: 12
ATTRTYPE: AT_NAMEREF(ScriptConfig)
ATTRVAL: 51
ATTRFEAT: 1
ATTRDESC:: eod
Allows an extension to examine a raw packet and alter it before
decoding and processing. This extension point is called after a
packet is received but before it is decoded.

Note: As the packet has yet to be decoded, most request
dictionary data items are unavailable.
eod

ATTR: post-packet-encode
ATTRID: 13
ATTRTYPE: AT_NAMEREF(ScriptConfig)
ATTRVAL: 51
ATTRFEAT: 11
ATTRDESC:: eod
Allows an extension to examine the raw packet and alter the packet
before it is sent to the client. Network Registrar calls this
extension point after a response packet is encoded but before it is
sent to the client.

Note: If the packet is altered, it only changes what the
client received; the server does not pick up any of the
packet changes in the information it retains about the client.
eod

CLASS: OptDesc
CLASSROOT: OPTDESC
CLASSID: 1110
CLASSNAME: 1
CLASSKEY: 2
CLASSPCV: 1.0.0
CLASSDEPRECATED: 7.0.0
CLASSDESC:: eod
The description of a specific option number.  There is
a more general mechanism that uses the AttrDesc object
to describe general TLV data types.
eod

ATTR: printname
ATTRID: 1
ATTRHDRNAME: AO_OPTDESC_PRINTNAME
ATTRTYPE: AT_STRING
ATTRMCDPATH: printname
ATTRVIZ: 3
ATTRDESC:: eod
The name of this option description.
eod

ATTR: number
ATTRID: 2
ATTRHDRNAME: AO_OPTDESC_NUMBER
ATTRTYPE: AT_INT
ATTRMCDPATH: number
ATTRVIZ: 5
ATTRDESC:: eod
Specifies the number of this option description.
eod

ATTR: type
ATTRID: 3
ATTRHDRNAME: AO_OPTDESC_TYPE
# note: type currently omits OVERLOAD, OT_MESSAGE, OT_REQUEST,
# OT_NODE, OT_IPADDRPAIR, OT_IPNET
# note: this MUST be kept in sync with the option_type enum in
# optiondesc.h !!!
ATTRTYPE: AT_ENUMINT(PAD=0, BOOL, INT, INT_ARRAY, STRING, IPADDR, IPADDR_ARRAY, BYTE, BYTE_ARRAY, WORD, WORD_ARRAY, UINT, UINT_ARRAY)
ATTRMCDPATH: type
ATTRVIZ: 5
ATTRFLAGS: AF_PRINT_ALT
ATTRDESC:: eod
Sets the data type of the option
eod

ATTR: servername
ATTRID: 4
ATTRHDRNAME: AO_OPTDESC_SERVERNAME
ATTRTYPE: AT_STRING
ATTRMCDPATH: servername
ATTRVIZ: 3
ATTRDESC:: eod
The name of the Server
eod

ATTR: factorydefault
ATTRID: 5
ATTRHDRNAME: AO_OPTDESC_FACTORYDEFAULT
ATTRTYPE: AT_STRING
ATTRMCDPATH: factorydefault
ATTRVIZ: 3
ATTRDESC:: eod
A textual description of the option.
eod

ATTR: min
ATTRID: 6
ATTRHDRNAME: AO_OPTDESC_MIN
ATTRTYPE: AT_INT
ATTRMCDPATH: min
ATTRVIZ: 3
ATTRDESC:: eod
The optional minimum integer value or string length of this option.
eod

ATTR: max
ATTRID: 7
ATTRHDRNAME: AO_OPTDESC_MAX
ATTRTYPE: AT_INT
ATTRMCDPATH: max
ATTRVIZ: 3
ATTRDESC:: eod
The optional maximum integer value, or string length of this option.
eod

ATTR: units
ATTRID: 8
ATTRHDRNAME: AO_OPTDESC_UNITS
ATTRTYPE: AT_INT
ATTRMCDPATH: units
ATTRVIZ: 3
ATTRDESC:: eod
The units for display purpose of the integer values.
eod

ATTR: category
ATTRID: 9
ATTRHDRNAME: AO_OPTDESC_CATEGORY
ATTRVIZ: 3
ATTRTYPE: AT_STRING
ATTRMCDPATH: category
ATTRDESC:: eod
The display category for this option.  The 'custom' category is
for user defined options that do not fit in any other category.
eod

ATTR: flags
ATTRID: 10
ATTRHDRNAME: AO_OPTDESC_FLAGS
ATTRTYPE: AT_INT
ATTRMCDPATH: flags
ATTRVIZ: 1
ATTRDESC:: eod
a bitmap
eod

ATTR: internaltype
ATTRID: 11
ATTRHDRNAME: AO_OPTDESC_INTERNALTYPE
ATTRTYPE: AT_INT
ATTRMCDPATH: internaltype
ATTRVIZ: 1
ATTRDESC:: eod
a bitmap
eod

ATTR: desc
ATTRID: 12
ATTRHDRNAME: AO_OPTDESC_DESCRIPTION
ATTRVIZ: 5
ATTRTYPE: AT_STRING
ATTRMCDPATH: desc
ATTRDESC:: eod
Provides a description of the specified option.
eod


CLASS: DhcpEvent
CLASSROOT: DHCPEVENT
CLASSID: 1111
CLASSVIZ: 3
CLASSDESC:: eod
Ask Mark
eod

ATTR: service-handle
ATTRID: 1
ATTRHDRNAME: AO_DHCPEVENT_SERVICE_HANDLE
ATTRTYPE: AT_INT
ATTRMCDPATH: service-handle

ATTR: operation
ATTRID: 2
ATTRHDRNAME: AO_DHCPEVENT_OPERATION
ATTRTYPE: AT_SHORT
ATTRMCDPATH: operation

ATTR: suboperation
ATTRID: 3
ATTRHDRNAME: AO_DHCPEVENT_SUBOPERATION
ATTRTYPE: AT_SHORT
ATTRMCDPATH: suboperation

ATTR: flags
ATTRID: 4
ATTRHDRNAME: AO_DHCPEVENT_FLAGS
ATTRTYPE: AT_INT
ATTRMCDPATH: flags

ATTR: event-id
ATTRID: 5
ATTRHDRNAME: AO_DHCPEVENT_EVENT_ID
ATTRTYPE: AT_INT
ATTRMCDPATH: event-id

ATTR: sequence
ATTRID: 6
ATTRHDRNAME: AO_DHCPEVENT_SEQUENCE
ATTRTYPE: AT_INT
ATTRMCDPATH: sequence

ATTR: blob
ATTRID: 7
ATTRHDRNAME: AO_DHCPEVENT_BLOB
ATTRTYPE: AT_BLOB
ATTRMCDPATH: blob

ATTR: version
ATTRID: 8
ATTRHDRNAME: AO_DHCPEVENT_VERSION
ATTRTYPE: AT_INT
ATTRMCDPATH: version

CLASS: RemoteServer
CLASSROOT: REMOTESERVER
CLASSID: 1112
CLASSVIZ: 5
CLASSNAME: 1
CLASSKEY: 1
CLASSNAMEDESC:: eod
The names of RemoteServer objects have no semantic value, but must
be unique.
eod

CLASSPCV: 1.0.0
CLASSDESC:: eod
A general description for related servers. The server maintains
this information for other servers with which it communicates,
such as an LDAP server.
eod

ATTR: name
ATTRID: 1
ATTRHDRNAME: AO_REMOTESERVER_NAME
ATTRTYPE: AT_STRING
ATTRFLAGS: AF_UNIQUE, AF_REQUIRED
ATTRMCDPATH: name
ATTRDESC:: eod
An arbitrary name used to refer to an individual server.
eod

ATTR: hostname
ATTRID: 2
ATTRHDRNAME: AO_REMOTESERVER_HOSTNAME
ATTRTYPE: AT_STRING
ATTRFLAGS: AF_REQUIRED
ATTRMCDPATH: HostName
ATTRVIZ: 5
ATTRDESC:: eod
Sets the hostname of the server to connect to. LDAP servers require
hostnames.
eod

ATTR: addr
ATTRID: 3
ATTRHDRNAME: AO_REMOTESERVER_ADDRESS
ATTRTYPE: AT_IPADDR
ATTRMCDPATH: ipaddress
ATTRVIZ: 3
ATTRDESC:: eod
The IP address of the server to connect to.
eod

ATTR: port
ATTRID: 4
ATTRHDRNAME: AO_REMOTESERVER_PORT
ATTRTYPE: AT_INT
ATTRMCDPATH: port
ATTRVIZ: 5
ATTRDESC:: eod
Specifies the port on the remote server to connect to.
eod

ATTR: secret
ATTRID: 5
ATTRHDRNAME: AO_REMOTESERVER_SECRET
ATTRTYPE: AT_STRING
ATTRMCDPATH: Secret
ATTRVIZ: 3

ATTR: username
ATTRID: 6
ATTRHDRNAME: AO_REMOTESERVER_USERNAME
ATTRTYPE: AT_STRING
ATTRMCDPATH: username
ATTRVIZ: 5
ATTRDESC:: eod
Designates a user with access to the parts of the directory that DHCP
uses. Because you can configure LDAP servers to allow anonymous
access, this is optional.
eod

ATTR: password
ATTRID: 7
ATTRHDRNAME: AO_REMOTESERVER_PASSWORD
ATTRTYPE: AT_STRING
ATTRMCDPATH: password
ATTRVIZ: 5
ATTRDESC:: eod
Sets the password of a user with access to the parts of the directory
that DHCP uses. Because you can configure LDAP servers to allow
anonymous access, this is optional.
eod

# server flags. SSL is a no-op for now.
ATTR: flags
ATTRID: 8
ATTRHDRNAME: AO_REMOTESERVER_FLAGS
ATTRTYPE: AT_FLAGSINT(USESSL=1, KEEPALLSTATE=2, UPDATERENEWALS=3)
ATTRMCDPATH: flags
ATTRVIZ: 3
ATTRDEFVAL: KEEPALLSTATE,UPDATERENEWALS
ATTRFLAGS: AF_REQUIRED
ATTRFEAT: type=LDAP
ATTRDESC:: eod
Flags that control some aspects of lease-state update processing
which may need to be modified for performance tuning. If
KEEPALLSTATE, the server will update the directory when leases
expire or are released; otherwise it will remove the attributes
that held lease data when leases are freed. If UPDATERENEWALS, the
server will keep ldap attributes up-to-date each time a lease is
renewed; otherwise, it will only update the directory when a lease
is initially leased, and again when the lease becomes available.
eod
# starting point in the directory for queries

ATTR: search-path
ATTRID: 9
ATTRHDRNAME: AO_REMOTESERVER_SEARCHPATH
ATTRTYPE: AT_STRING
ATTRMCDPATH: SearchPath
ATTRVIZ: 5
ATTRFEAT: 16 && type=LDAP
ATTRDESC:: eod
Designates an object in the directory to use as a query
starting-point. Together, the path and the search-scope control the
portion of the directory that the server will search.
eod

# query search scope
ATTR: search-scope
ATTRID: 10
ATTRHDRNAME: AO_REMOTESERVER_SEARCHSCOPE
ATTRTYPE: AT_ENUMINT(BASE=0, ONELEVEL=1, SUBTREE=2)
ATTRMCDPATH: SearchScope
ATTRDEFVAL: 2
ATTRVIZ: 5
ATTRFLAGS: AF_PRINT_ALT, AF_INITIALIZE
ATTRFEAT: 16 && type=LDAP
ATTRDESC:: eod
Controls the comprehensiveness of a search:

If you specify the  scope to be SUBTREE, the server searches all
the children of the searchpath.

If you specify the scope to be ONELEVEL, the server searches only
the immediate children of the base object.

If you specify the scope to be BASE, the server searches only the
base object itself.
eod

# filter string (with %s or %token%) for queries
ATTR: search-filter
ATTRID: 11
ATTRHDRNAME: AO_REMOTESERVER_SEARCHFILTER
ATTRTYPE: AT_STRING
ATTRMCDPATH: Filter
ATTRVIZ: 5
ATTRFEAT: 16 && type=LDAP
ATTRDESC:: eod
Specifies the filter to apply in the client-entry query. The server
formats the client's MAC address using the filter to specify the
object that contains the client-entry data.
eod

# name of attribute to format into query filter string
ATTR: search-attribute
ATTRID: 12
ATTRHDRNAME: AO_REMOTESERVER_SEARCHATTR
ATTRTYPE: AT_STRING
ATTRMCDPATH: searchattribute
ATTRVIZ: 3
ATTRFEAT: 16 && type=LDAP
ATTRDESC:: eod
The dhcp attribute specified by the search-attribute (e.g. the
client's MAC address) will be formatted using the search-filter to
specify the object that contains the client data.
eod
# size of heap for background LDAP client thread

ATTR: threadheapsize
ATTRID: 13
ATTRHDRNAME: AO_REMOTESERVER_THREADHEAPSZ
ATTRTYPE: AT_INT
ATTRFLAGS: AF_INITIALIZE
ATTRMCDPATH: threadheapsize
ATTRDEFVAL: 4096
ATTRVIZ: 3
ATTRFEAT: type=LDAP
ATTRDESC:: eod
Size (in bytes) of the thread heap for each background LDAP client
threads.
eod
# initial msecs wait time for polling LDAP client thread

ATTR: threadwaittime
ATTRID: 14
ATTRHDRNAME: AO_REMOTESERVER_THREADWAITTIME
ATTRTYPE: AT_MSTIME
ATTRFLAGS: AF_INITIALIZE
ATTRDEFVAL: 100
ATTRMCDPATH: threadwaittime
ATTRVIZ: 5
ATTRFEAT: type=LDAP
ATTRDESC:: eod
Sets the number of milliseconds that an LDAP client connection
polls for the results of outstanding queries or updates.
eod

# secs timeout for an individual LDAP transaction
ATTR: timeout
ATTRID: 15
ATTRHDRNAME: AO_REMOTESERVER_TIMEOUT
ATTRTYPE: AT_TIME
ATTRFLAGS: AF_INITIALIZE
ATTRDEFVAL: 10
ATTRMCDPATH: timeout
ATTRVIZ: 5
ATTRFEAT: type=LDAP
ATTRDESC:: eod
Controls the number of seconds the DHCP server waits for a response
to an individual LDAP update or create request. If an LDAP request
times out, the DHCP server resubmits it to other LDAP connections.

Further, if the DHCP server receives no response (that is, a result
for an LDAP update or create) from an LDAP connection for the timeout
seconds, DHCP marks this LDAP connection as 'Inactive' and tears down
the connection, then reconnects.  A timeout value of 10 seconds is a
good value for LDAP create and update operations.

Note: You can configure a separate timeout for LDAP query operations
using the query-timeout attribute.
eod

# can this LDAP server be used for queries?
ATTR: can-query
ATTRID: 16
ATTRHDRNAME: AO_REMOTESERVER_CANQUERY
ATTRTYPE: AT_BOOL
ATTRFLAGS: AF_FEATURE, AF_INITIALIZE
ATTRDEFVAL: false
ATTRMCDPATH: can-query
ATTRVIZ: 5
ATTRFEAT: type=LDAP
ATTRDESC:: eod
Controls whether a particular LDAP server can be used for client
queries. See the query properties: env-dictionary,
query-dictionary, search-attribute, search-filter, search-path,
and search-scope.
eod

# can this LDAP server be used for state updates?
ATTR: can-update
ATTRID: 17
ATTRHDRNAME: AO_REMOTESERVER_CANUPDATE
ATTRTYPE: AT_BOOL
ATTRFLAGS: AF_FEATURE, AF_INITIALIZE
ATTRDEFVAL: false
ATTRMCDPATH: can-update
ATTRVIZ: 5
ATTRFEAT: type=LDAP
ATTRDESC:: eod
Controls whether a particular LDAP server can be used to store
lease state updates. See the update properties: update-dictionary,
update-search-attribute, update-search-filter, update-search-path
update-search-scope.
eod

# limit outstanding requests on a single connection - performance
#    improvement on some LDAP servers
ATTR: limit-requests
ATTRID: 18
ATTRHDRNAME: AO_REMOTESERVER_LIMITREQUESTS
ATTRTYPE: AT_BOOL
ATTRFLAGS: AF_FEATURE, AF_INITIALIZE
ATTRDEFVAL: true
ATTRMCDPATH: limit-requests
ATTRVIZ: 5
ATTRFEAT: type=LDAP
ATTRDESC:: eod
Controls whether there should be a limit on the number of
outstanding queries on each LDAP client connection. See the limit
property: max-requests.
eod

# if LIMITREQUESTS, this is the limit on outstanding
#    queries on a single client connection
ATTR: max-requests
ATTRID: 19
ATTRHDRNAME: AO_REMOTESERVER_MAXREQUESTS
ATTRTYPE: AT_INT
ATTRFLAGS: AF_INITIALIZE
ATTRMCDPATH: maxrequests
ATTRVIZ: 5
ATTRFEAT: 18 && type=LDAP
ATTRDEFVAL: 20
ATTRDESC:: eod
Controls the number of outstanding queries.

If you have set the 'limit-requests' feature to TRUE, any single
LDAP connection will limit the number of outstanding queries to
'max-requests.' You can improve performance by limiting the
number of outstanding queries.
eod
# attempt to reconnect with a downed LDAP server at this interval
#    (in seconds)
ATTR: reactivate-interval
ATTRID: 20
ATTRHDRNAME: AO_REMOTESERVER_REACTIVATETIME
ATTRTYPE: AT_TIME
ATTRFLAGS: AF_INITIALIZE
ATTRDEFVAL: 60
ATTRMCDPATH: ReactivateTimerInterval
ATTRVIZ: 3
ATTRFEAT: type=LDAP
ATTRDESC:: eod
If an LDAP client connection goes down, the dhcp server will wait
this many seconds between reconnection attempts.
eod
# filter to use when processing a referral

ATTR: referral-filter
ATTRID: 21
ATTRHDRNAME: AO_REMOTESERVER_REFERRALFILTER
ATTRTYPE: AT_STRING
ATTRMCDPATH: referral-filter
ATTRVIZ: 5
ATTRFEAT: type=LDAP
ATTRDESC:: eod
In the absence of a distinguished name (DN), controls how a
server formats referral-attr data. In such cases, the server formats
the referral attribute's data with this filter expression to build a
search path that uses the existing search-scope for the LDAP server.
eod
# name of attribute to use when processing a referral

ATTR: referral-attr
ATTRID: 22
ATTRHDRNAME: AO_REMOTESERVER_REFERRALATTR
ATTRTYPE: AT_STRING
ATTRMCDPATH: referral-attr
ATTRVIZ: 5
ATTRFEAT: type=LDAP
ATTRDESC:: eod
Indicates whether an LDAP response is a referral. The referral may
or may not contain the DN for this query. If the DN is present (the
default), the server uses it as the search path, along with a
wildcard search-scope in the query that follows the referral. If not,
the server builds the search path by formatting the data in the
referral attribute with the referral-filter, using the existing
search scope.
eod
# max referrals to process before dropping

ATTR: max-referrals
ATTRID: 23
ATTRHDRNAME: AO_REMOTESERVER_MAXREFERRALS
ATTRTYPE: AT_INT
ATTRDEFVAL: 0
ATTRMCDPATH: max-referrals
ATTRVIZ: 5
ATTRFEAT: type=LDAP
ATTRDESC:: eod
Limits the number of LDAP referrals the server follows when
querying. A value of zero prohibits following referrals.
eod
# number of client connections to make

ATTR: connections
ATTRID: 24
ATTRHDRNAME: AO_REMOTESERVER_CONNECTIONS
ATTRTYPE: AT_INT
ATTRFLAGS: AF_INITIALIZE
ATTRDEFVAL: 1
ATTRMCDPATH: connections
ATTRVIZ: 5
ATTRFEAT: type=LDAP
ATTRDESC:: eod
Determines the number of connections that the server can make to an
LDAP object.

Network Registrar creates one thread for each connection configured
in an LDAP object, and each thread can have a maximum of LDAP
requests associated with its request queue.

This is primarily a performance-tuning attribute. In some cases,
having more than one connection can improve overall throughput.

eod
# preference: allows ordered list of servers for failover

ATTR: preference
ATTRID: 25
ATTRHDRNAME: AO_REMOTESERVER_PREFERENCE
ATTRTYPE: AT_INT
ATTRFLAGS: AF_INITIALIZE
ATTRDEFVAL: 1
ATTRMCDPATH: preference
ATTRVIZ: 5
ATTRFEAT: type=LDAP
ATTRDESC:: eod
Specifies the preference order in which LDAP servers are used.
A positive integer greater than or equal to one. One (1) is the
highest preference value.

eod
# starting point in the directory for pre-update queries

ATTR: update-search-path
ATTRID: 26
ATTRHDRNAME: AO_REMOTESERVER_UPDATESEARCHPATH
ATTRTYPE: AT_STRING
ATTRMCDPATH: ModifySearchPath
ATTRVIZ: 5
ATTRFEAT: 17 && type=LDAP
ATTRDESC:: eod
Determines the starting point for the portion of the directory
containing  LDAP objects for the server to update.
eod
# pre-update query search scope

ATTR: update-search-scope
ATTRID: 27
ATTRHDRNAME: AO_REMOTESERVER_UPDATESEARCHSCOPE
ATTRTYPE: AT_ENUMINT(BASE=0, ONELEVEL=1, SUBTREE=2)
ATTRMCDPATH: update-searchscope
ATTRVIZ: 5
ATTRFLAGS: AF_PRINT_ALT
ATTRFEAT: 17 && type=LDAP
ATTRDESC:: eod
With update-search-path, controls the portion of the directory
that contains the objects to be updated.

The scope can be SUBTREE (includes all children of the
searchpath), ONELEVEL (includes only the immediate children of the
base object), or BASE (includes only the base object itself).
eod
# filter string (with %s or %token%) for pre-update queries
ATTR: update-search-filter
ATTRID: 28
ATTRHDRNAME: AO_REMOTESERVER_UPDATESEARCHFILTER
ATTRTYPE: AT_STRING
ATTRMCDPATH: ModifySearchFilter
ATTRVIZ: 5
ATTRFEAT: 17 && type=LDAP
ATTRDESC:: eod
If the DN of the object to be updated cannot be determined
directly, the DHCP server must issue a query to retrieve the DN.
In that case, the DHCP server uses data in the lease's
'search-attribute,' and formats it using the
'update-search-filter' expression.
eod
# name of lease attribute to format into pre-update query filter
# string

ATTR: update-search-attribute
ATTRID: 29
ATTRHDRNAME: AO_REMOTESERVER_UPDATESEARCHATTR
ATTRTYPE: AT_STRING
ATTRMCDPATH: update-searchattribute
ATTRVIZ: 5
ATTRFEAT: 17 && type=LDAP
ATTRDESC:: eod
If the DN of the object to be updated cannot be determined
directly, the DHCP server must issue a query to retrieve the DN.
In that case, the DHCP server uses data in the lease's
'search-attribute,' and formats it using the
'update-search-filter' expression.
eod
# format string (with tokens or %s), used if DN can be
#    generated directly from state-update data

ATTR: dn-format
ATTRID: 30
ATTRHDRNAME: AO_REMOTESERVER_DNFORMAT
ATTRTYPE: AT_STRING
ATTRMCDPATH: dn-format
ATTRVIZ: 5
ATTRFEAT: 17 && type=LDAP
ATTRDESC:: eod
If the DN of the ldap object that is to be updated can be
constructed from one of the lease's attributes, the specified
dn-attribute will be formatted using the dn-format string to
construct the query filter.
eod

# attribute name to use in the dn-format string
ATTR: dn-attribute
ATTRID: 31
ATTRHDRNAME: AO_REMOTESERVER_DNATTR
ATTRTYPE: AT_STRING
ATTRMCDPATH: dn-attribute
ATTRVIZ: 5
ATTRFEAT: 17 && type=LDAP
ATTRDESC:: eod
Determines how the server constructs the distinguished name (DN)
of the LDAP entry to update or create.

If the server can use one of the lease attributes, it formats the
specified dn-attribute using the dn-format  string to construct
the object filter that specifies the LDAP server to modify.
eod

# dictionary of LDAP attr names to obj attr names
ATTR: query-dictionary
ATTRID: 32
ATTRHDRNAME: AO_REMOTESERVER_QUERYDICT
ATTRTYPE: AT_DICT(AT_STRING)
ATTRMCDPATH: query-dictionary
ATTRVIZ: 5
ATTRFEAT: 16 && type=LDAP
ATTRDESC:: eod
Maps LDAP attributes and DHCP attribute names. The server attempts
to retrieve all LDAP attributes specified in the dictionary. When a
query succeeds, the values for any ldap attributes that it returns
are set in the corresponding client-entry attribute.
eod
# dictionary of LDAP attr names to arbitrary strings

ATTR: env-dictionary
ATTRID: 33
ATTRHDRNAME: AO_REMOTESERVER_ENVDICT
ATTRTYPE: AT_DICT(AT_STRING)
ATTRMCDPATH: env-dictionary
ATTRVIZ: 5
ATTRFEAT: 16 && type=LDAP
ATTRDESC:: eod
Specifies the environment dictionary that allows the server to
retrieve additional LDAP attributes along with client-entry
attributes. If any of these are present in a query's results,
their values are made available to scripts through the request's
environment dictionary. The LDA{ value is keyed by the value in
the LDAP query env-dictionary.
eod
# RemoteServer types
# dictionary of LDAP attr names to obj attr names

ATTR: update-dictionary
ATTRID: 34
ATTRHDRNAME: AO_REMOTESERVER_UPDATEDICT
ATTRTYPE: AT_DICT(AT_STRING)
ATTRMCDPATH: update-dictionary
ATTRVIZ: 5
ATTRFEAT: 17 && type=LDAP
ATTRDESC:: eod
Maps LDAP attributes to DHCP lease attributes.  When an LDAP object
is modified, each LDAP attribute that is present in this dictionary
is set to the value of its corresponding DHCP lease attribute.
eod

ATTR: type
ATTRID: 35
ATTRHDRNAME: AO_REMOTESERVER_TYPE
ATTRTYPE: AT_ENUMINT(LDAP=1, DNS=2, LOG=3)
ATTRMCDPATH: type
ATTRVIZ: 3
ATTRFLAGS: AF_PRINT_ALT
ATTRDESC:: eod
The 'remote server' class is internal right now. This does not need
to be visible.
eod

# can this LDAP server be used for state updates?
ATTR: can-create
ATTRID: 36
ATTRHDRNAME: AO_REMOTESERVER_CANCREATE
ATTRTYPE: AT_BOOL
ATTRFLAGS: AF_FEATURE, AF_INITIALIZE
ATTRDEFVAL: false
ATTRMCDPATH: can-create
ATTRVIZ: 5
ATTRFEAT: type=LDAP
ATTRDESC:: eod
Controls whether a particular LDAP server can create new entries
to use to store lease state updates. See the create properties:
create-dictionary, create-string-dictionary, dn-create-format,
create-object-classes.
eod

# dictionary of LDAP attr names to obj attr names
ATTR: create-dictionary
ATTRID: 37
ATTRHDRNAME: AO_REMOTESERVER_CREATEDICT
ATTRTYPE: AT_DICT(AT_STRING)
ATTRMCDPATH: create-dictionary
ATTRVIZ: 5
ATTRFEAT: 36 && type=LDAP
ATTRDESC:: eod
Maps LDAP attributes to DHCP lease attributes.  If an entry does
not exist and needs to be created, entries in this dictionary
are set to the value of its corresponding DHCP lease attribute.
eod


# format string (with tokens or %s), used if DN can be
#    generated directly from state-update data
ATTR: dn-create-format
ATTRID: 38
ATTRHDRNAME: AO_REMOTESERVER_DNCREATEFORMAT
ATTRTYPE: AT_STRING
ATTRMCDPATH: dn-create-format
ATTRVIZ: 5
ATTRFEAT: 36 && type=LDAP
ATTRDESC:: eod
Provides the distinguished name (DN) for entry creation. A % is
required at the entry level and is replaced by the value of the
dn-attribute. If you can construct the DN of the LDAP object created
from one of the leases attributes,  the server formats the specified
dn-attribute using the dn-format string.
eod

ATTR: create-object-classes
ATTRID: 39
ATTRHDRNAME: AO_REMOTESERVER_DNCREATEOBJECTCLASSES
ATTRTYPE: AT_STRING
ATTRMCDPATH: create-object-classes
ATTRVIZ: 5
ATTRFEAT: 36 && type=LDAP
ATTRDESC:: eod
If can-create is enabled, specifies the object classes from
which a new entry inherits.
eod

# dictionary of LDAP attr names to arbitrary strings
ATTR: create-string-dictionary
ATTRID: 40
ATTRHDRNAME: AO_REMOTESERVER_CREATESTRINGDICT
ATTRTYPE: AT_DICT(AT_STRING)
ATTRMCDPATH: create-string-dictionary
ATTRVIZ: 5
ATTRFEAT: 36 && type=LDAP
ATTRDESC:: eod
Maps LDAP attributes to user specified strings. If an entry does not
exist and needs to be created, entries in this dictionary are set to
the matching string.
eod

ATTR: default-attribute-value
ATTRID: 41
ATTRHDRNAME: AO_REMOTESERVER_DEFAULTATTRIBVALUE
ATTRTYPE: AT_STRING
ATTRDEFVAL: <default>
ATTRMCDPATH: default-attribute-value
ATTRVIZ: 5
ATTRFEAT: 36 && type=LDAP
ATTRDESC:: eod
Provides a default attribute value (a string) to insert in any LDAP
attribute whose associated lease attribute values are not present in
the lease.
eod

ATTR: protocol-version
ATTRID: 42
ATTRHDRNAME: AO_REMOTESERVER_PROTOCOL_VERSION
ATTRTYPE: AT_INT
ATTRFLAGS: AF_INITIALIZE
ATTRDEFVAL: 2
ATTRMCDPATH: protocol-version
ATTRVIZ: 3
ATTRFEAT: type=LDAP
ATTRDESC:: eod
Specifies the LDAP protocol version that Network Registrar should use
when connecting to the LDAP server. By default, Network Registrar
uses LDAP protocol standard version 2 (LDAPv2). To configure
Network Registrar to use LDAPv3, set the protocol-version to 3.

eod

ATTR: query-timeout
ATTRID: 43
ATTRHDRNAME: AO_REMOTESERVER_QUERY_TIMEOUT
ATTRTYPE: AT_TIME
ATTRDEFVAL: 3
ATTRMCDPATH: query-timeout
ATTRVIZ: 5
ATTRFEAT: type=LDAP
ATTRDESC:: eod
Specifies the number of seconds the DHCP server waits for a response
to individual LDAP Query requests. After a query request times out,
the DHCP server will drop the request and not process it again on
another LDAP connection or LDAP Server. A query-timeout value of 3
seconds is a good value.

Note: The timeout attribute configures the timeout for LDAP
Update and Create requests.

eod

ATTR: enabled
ATTRID: 44
ATTRTYPE: AT_BOOL
ATTRDEFVAL: true
ATTRVIZ: 5
ATTRFEAT: type=LDAP
ATTRDESC:: eod
Enables or disables this LDAP remote server.

Prevents DHCP from attempting to use an LDAP server that is
known to be unavailable.
eod

#
#
#

CLASS: EventService
CLASSROOT: EVENTSERVICE
CLASSID: 1113
CLASSVIZ: 3
CLASSNAME: 2
CLASSKEY: 1
CLASSNAMEDESC:: eod
The names of EventService objects are directly associated with the
type of the event service (which is stored in the handle
attribute).
The valid names are the enumerator strings of the handle attribute.
eod
CLASSPCV: 1.0.0
CLASSDESC:: eod
Ask Mark
eod

# printable name
ATTR: print-name
ATTRID: 1
ATTRHDRNAME: AO_EVENTSERVICE_NAME
ATTRTYPE: AT_STRING
ATTRFLAGS: AF_UNIQUE
ATTRMCDPATH: name
ATTRVIZ: 0
ATTRDESC:: eod
eod

# unique 32-bit handle
ATTR: handle
ATTRID: 2
ATTRHDRNAME: AO_EVENTSERVICE_HANDLE
ATTRTYPE: AT_ENUMINT(DNS=1, MCD=2, LDAP=3, MLOG=4, FAILOVER=5, TEST=99)
ATTRFLAGS: AF_IMMUTABLE | AF_PRINT_ALT
ATTRMCDPATH: EventServiceHandle
ATTRVIZ: 5
ATTRDESC:: eod
eod

# on or off
ATTR: enabled
ATTRID: 3
ATTRHDRNAME: AO_EVENTSERVICE_ENABLED
ATTRTYPE: AT_BOOL
ATTRFLAGS: AF_FEATURE, AF_INITIALIZE
ATTRFLAGS: AF_PRINT_ONOFF,AF_FEATURE, AF_INITIALIZE
ATTRDEFVAL: false
ATTRMCDPATH: Enabled
ATTRVIZ: 5
ATTRDESC:: eod
eod

# some Services can run w/multiple threads, drawn from the
#    server-wide pool in the Framework
ATTR: maxthreads
ATTRID: 4
ATTRHDRNAME: AO_EVENTSERVICE_MAXTHREADS
ATTRTYPE: AT_INT
ATTRMCDPATH: MaxThreads
ATTRVIZ: 3
ATTRDESC:: eod
eod

# Services can keep an aging list of packets they've received
#    but not processed: after this limit is reached, the oldest
#    packets will be deleted
ATTR: max-replies
ATTRID: 5
ATTRHDRNAME: AO_EVENTSERVICE_MAXREPLIES
ATTRTYPE: AT_INT
ATTRMCDPATH: maxreplies
ATTRVIZ: 3

# max. retries (usually only for a UDP-based Service)
ATTR: retries
ATTRID: 6
ATTRHDRNAME: AO_EVENTSERVICE_RETRIES
ATTRTYPE: AT_INT
ATTRMCDPATH: retries
ATTRVIZ: 3

# size of buffers for (UDP ?) data packets
ATTR: packet-size
ATTRID: 7
ATTRHDRNAME: AO_EVENTSERVICE_PACKETSIZE
ATTRTYPE: AT_INT
ATTRMCDPATH: packetsize
ATTRVIZ: 3

# limit on the number of Events a Service's threads will process
#    before being returned to the Framework's thread pool
ATTR: worklimit
ATTRID: 8
ATTRHDRNAME: AO_EVENTSERVICE_WORKLIMIT
ATTRTYPE: AT_INT
ATTRMCDPATH: worklimit
ATTRVIZ: 3

# initial (UDP) timeout before a retry.
ATTR: timeout
ATTRID: 9
ATTRHDRNAME: AO_EVENTSERVICE_TIMEOUT
ATTRTYPE: AT_MSTIME
ATTRMCDPATH: timeout
ATTRVIZ: 3

#
# Deprecated in 6.0 use/see remoteservers-list
#

# the RemoteServers that this Service knows about
ATTR: remoteservers
ATTRID: 11
ATTRHDRNAME: AO_EVENTSERVICE_XXXREMOTESERVERS
ATTRTYPE: AT_SET(AT_NAMEREF(RemoteServer))
ATTRMCDPATH: remoteservers
ATTRVAL: 1112
ATTRVIZ: 3

# for LDAP service: should the service persist and retry an update
# Event if one arrives and there are no RemoteServers configured to
# process db updates?
ATTR: retry-updates
ATTRID: 12
ATTRHDRNAME: AO_EVENTSERVICE_RETRY_UPDATES
ATTRTYPE: AT_BOOL
ATTRFLAGS: AF_FEATURE, AF_INITIALIZE
ATTRDEFVAL: false
ATTRMCDPATH: retryupdates
ATTRVIZ: 3

ATTR: max-validating
ATTRID: 13
ATTRHDRNAME: AO_EVENTSERVICE_MAX_VALIDATING
ATTRTYPE: AT_INT
ATTRMCDPATH: maxvalidating
ATTRVIZ: 3
ATTRDESC:: eod
If a service persists its events, it has to validate them
each time it restarts. This limit throttles the number
of simultaneous events any single service will try to
validate simultaneously.
eod

ATTR: enable-persist
ATTRID: 14
ATTRHDRNAME: AO_EVENTSERVICE_ENABLE_PERSIST
ATTRTYPE: AT_BOOL
ATTRFLAGS: AF_FEATURE, AF_INITIALIZE
ATTRDEFVAL: true
ATTRMCDPATH: enablepersist
ATTRVIZ: 3
ATTRDESC:: eod
If false, a service will not persist any Events.
eod

# limit on the number of requests (ie.e. Events) a Service will
# allow to have outstanding at a single RemoteServer
ATTR: max-requests
ATTRID: 15
ATTRHDRNAME: AO_EVENTSERVICE_MAX_REQUESTS
ATTRTYPE: AT_INT
ATTRMCDPATH: max-requests
ATTRVIZ: 3
ATTRDESC:: eod
Apply a global limit on the number of simultaneous outstanding
requests a Service will allow at any one remote server.
eod

# the RemoteServers that this Service knows about
ATTR: remoteservers-list
ATTRID: 16
ATTRTYPE: AT_NLIST(AT_OBJ(RemoteServer))
# 1<<16 | 1112
ATTRVAL: 66648
ATTRMCDPATH: remoteservers
ATTRVIZ: 3


# DNS service blob
CLASS: DnsReq
CLASSROOT: DNSREQ
CLASSID: 1114
CLASSNAME: 1
CLASSVIZ: 3
CLASSDESC:: eod
Ask Mark
eod

ATTR: dnsreq-ttl
ATTRID: 1
ATTRHDRNAME: AO_DNSREQ_TTL
ATTRTYPE: AT_INT
ATTRMCDPATH: dnsreq-ttl

ATTR: dnsreq-client-id
ATTRID: 2
ATTRHDRNAME: AO_DNSREQ_CLIENT_ID
ATTRTYPE: AT_STRING
ATTRMCDPATH: dnsreq-client-id

ATTR: dnsreq-old-hostname
ATTRID: 3
ATTRHDRNAME: AO_DNSREQ_OLD_HOSTNAME
ATTRTYPE: AT_STRING
ATTRMCDPATH: dnsreq-old-hostname

ATTR: dnsreq-old-ip-address
ATTRID: 4
ATTRHDRNAME: AO_DNSREQ_OLD_IP_ADDRESS
ATTRTYPE: AT_IPADDR
ATTRMCDPATH: dnsreq-old-ip-address

ATTR: dnsreq-old-fwd-server
ATTRID: 5
ATTRHDRNAME: AO_DNSREQ_OLD_FWD_SERVER
ATTRTYPE: AT_IPADDR
ATTRMCDPATH: dnsreq-old-fwd-server

ATTR: dnsreq-old-fwd-zone
ATTRID: 6
ATTRHDRNAME: AO_DNSREQ_OLD_FWD_ZONE
ATTRTYPE: AT_STRING
ATTRMCDPATH: dnsreq-old-fwd-zone

ATTR: dnsreq-old-rev-server
ATTRID: 7
ATTRHDRNAME: AO_DNSREQ_OLD_REV_SERVER
ATTRTYPE: AT_IPADDR
ATTRMCDPATH: dnsreq-old-rev-server

ATTR: dnsreq-old-rev-zone
ATTRID: 8
ATTRHDRNAME: AO_DNSREQ_OLD_REV_ZONE
ATTRTYPE: AT_STRING
ATTRMCDPATH: dnsreq-old-rev-zone

ATTR: dnsreq-new-hostname
ATTRID: 9
ATTRHDRNAME: AO_DNSREQ_NEW_HOSTNAME
ATTRTYPE: AT_STRING
ATTRMCDPATH: dnsreq-new-hostname

ATTR: dnsreq-new-ip-address
ATTRID: 10
ATTRHDRNAME: AO_DNSREQ_NEW_IP_ADDRESS
ATTRTYPE: AT_IPADDR
ATTRMCDPATH: dnsreq-new-ip-address

ATTR: dnsreq-new-fwd-server
ATTRID: 11
ATTRHDRNAME: AO_DNSREQ_NEW_FWD_SERVER
ATTRTYPE: AT_IPADDR
ATTRMCDPATH: dnsreq-new-fwd-server

ATTR: dnsreq-new-fwd-zone
ATTRID: 12
ATTRHDRNAME: AO_DNSREQ_NEW_FWD_ZONE
ATTRTYPE: AT_STRING
ATTRMCDPATH: dnsreq-new-fwd-zone

ATTR: dnsreq-new-rev-server
ATTRID: 13
ATTRHDRNAME: AO_DNSREQ_NEW_REV_SERVER
ATTRTYPE: AT_IPADDR
ATTRMCDPATH: dnsreq-new-rev-server

ATTR: dnsreq-new-rev-zone
ATTRID: 14
ATTRHDRNAME: AO_DNSREQ_NEW_REV_ZONE
ATTRTYPE: AT_STRING
ATTRMCDPATH: dnsreq-new-rev-zone

ATTR: dnsreq-old-ip-addr
ATTRID: 15
ATTRHDRNAME: AO_DNSREQ_OLD_IP_ADDR
ATTRTYPE: AT_IPADDR
ATTRMCDPATH: dnsreq-old-ip-addr

ATTR: dnsreq-result-flags
ATTRID: 16
ATTRHDRNAME: AO_DNSREQ_RESULT_FLAGS
ATTRTYPE: AT_FLAGSINT(UPDATED_FWD=1, UPDATED_REV=2)
ATTRMCDPATH: dnsreq-result-flags

ATTR: dnsreq-disambiguated-hostname
ATTRID: 17
ATTRHDRNAME: AO_DNSREQ_DISAMBIGUATED_HOSTNAME
ATTRTYPE: AT_STRING
ATTRMCDPATH: dnsreq-disambiguated-hostname

ATTR: dnsreq-name-num
ATTRID: 18
ATTRHDRNAME: AO_DNSREQ_NAME_NUM
ATTRTYPE: AT_INT
ATTRMCDPATH: dnsreq-name-num

ATTR: dnsreq-last-name-num-len
ATTRID: 19
ATTRHDRNAME: AO_DNSREQ_LAST_NAME_NUM_LEN
ATTRTYPE: AT_INT
ATTRMCDPATH: dnsreq-last-name-num-len

ATTR: dnsreq-result-code
ATTRID: 20
ATTRHDRNAME: AO_DNSREQ_RESULT_CODE
ATTRTYPE: AT_INT
ATTRMCDPATH: dnsreq-result-code

ATTR: old-host-bytes
ATTRID: 21
ATTRHDRNAME: AO_DNSREQ_OLD_HOST_BYTES
ATTRTYPE: AT_INT
ATTRDESC:: eod
eod

ATTR: new-host-bytes
ATTRID: 22
ATTRHDRNAME: AO_DNSREQ_NEW_HOST_BYTES
ATTRTYPE: AT_INT
ATTRDESC:: eod
eod

ATTR: client-class-name
ATTRID: 23
ATTRHDRNAME: AO_DNSREQ_CLIENTCLASS_NAME
ATTRTYPE: AT_STRING
ATTRDESC:: eod
eod

ATTR: client-mac-addr
ATTRID: 24
ATTRHDRNAME: AO_DNSREQ_CLIENT_MACADDR
ATTRTYPE: AT_MACADDR
ATTRDESC:: eod
eod

ATTR: new-vpn-id
ATTRID: 25
ATTRHDRNAME: AO_DNSREQ_NEW_VPN
ATTRTYPE: AT_INT
ATTRFLAGS: AF_REFERENCE
# Encode attribute 4 of Vpn(1127) as 4<<16 + 1127 == 263271
ATTRVAL: 263271
ATTRDEFVAL: 0
ATTRDESC:: eod
eod

ATTR: old-vpn-id
ATTRID: 26
ATTRHDRNAME: AO_DNSREQ_OLD_VPN
ATTRTYPE: AT_INT
ATTRFLAGS: AF_REFERENCE
# Encode attribute 4 of Vpn(1127) as 4<<16 + 1127 == 263271
ATTRVAL: 263271
ATTRDEFVAL: 0
ATTRDESC:: eod
eod

ATTR: tsig-request-key-name
ATTRID: 27
ATTRHDRNAME: AO_DNSREQ_TSIG_KEY_NAME
ATTRTYPE: AT_DNSNAME
ATTRDESC:: eod
eod

ATTR: tsig-request-mac
ATTRID: 28
ATTRHDRNAME: AO_DNSREQ_TSIG_MAC
ATTRTYPE: AT_BLOB
ATTRDESC:: eod
eod

ATTR: tsig-request-mac-size
ATTRID: 29
ATTRHDRNAME: AO_DNSREQ_TSIG_REQUEST_MAC_SIZE
ATTRTYPE: AT_INT
ATTRDESC:: eod
eod

ATTR: dynamic-dns-fwd-key
ATTRID: 30
ATTRHDRNAME: AO_DNSREQ_FWD_KEY
ATTRTYPE: AT_DNSNAME
ATTRDESC:: eod
eod

ATTR: dynamic-dns-rev-key
ATTRID: 31
ATTRHDRNAME: AO_DNSREQ_REV_KEY
ATTRTYPE: AT_DNSNAME
ATTRDESC:: eod
eod

#Attr 33-36 added for ha-dns.
ATTR: dns-backup-server-addr
ATTRID: 33
ATTRHDRNAME: AO_DNSREQ_BACKUP_SERVER_ADDR
ATTRTYPE: AT_IPADDR
ATTRDESC:: eod
eod

ATTR: dns-backup-server-rev-addr
ATTRID: 34
ATTRHDRNAME: AO_DNSREQ_BACKUP_SERVER_REV_ADDR
ATTRTYPE: AT_IPADDR
ATTRDESC:: eod
eod

ATTR: old-dns-backup-server-addr
ATTRID: 35
ATTRHDRNAME: AO_DNSREQ_OLD_BACKUP_SERVER_ADDR
ATTRTYPE: AT_IPADDR
ATTRDESC:: eod
eod

ATTR: old-dns-backup-server-rev-addr
ATTRID: 36
ATTRHDRNAME: AO_DNSREQ_OLD_BACKUP_SERVER_REV_ADDR
ATTRTYPE: AT_IPADDR
ATTRDESC:: eod
eod

ATTR: forward-dnsupdate
ATTRID: 37
ATTRTYPE: AT_STRING
ATTRDESC:: eod
Specifies the forward DNS zone.

eod

ATTR: reverse-dnsupdate
ATTRID: 38
ATTRTYPE: AT_STRING
ATTRDESC:: eod
Specifies the reverse DNS zone.
eod

ATTR: dns-backup-server-fwd-key
ATTRID: 39
ATTRHDRNAME: AO_DNSREQ_BACKUP_SERVER_FWD_KEY
ATTRTYPE: AT_DNSNAME
ATTRDESC:: eod
eod

ATTR: dns-backup-server-rev-key
ATTRID: 40
ATTRHDRNAME: AO_DNSREQ_BACKUP_SERVER_REV_KEY
ATTRTYPE: AT_DNSNAME
ATTRDESC:: eod
eod

ATTR: use-dns-update-prereqs
ATTRID: 41
ATTRTYPE: AT_BOOL
ATTRDESC:: eod
eod

ATTR: flags
ATTRID: 42
ATTRTYPE: AT_FLAGSINT(REV_UPTODATE=1,FWD_UPTODATE=2)
ATTRDESC:: eod
eod


# FAILOVER
# F A I L O V E R

CLASS: DhcpFailover
CLASSROOT: FAILOVER
CLASSID: 1115
CLASSVIZ: 3
CLASSDESC:: eod
Ask Mark
eod

ATTR: server-name
ATTRID: 1
ATTRHDRNAME: AO_FAILOVER_SERVER_NAME
ATTRTYPE: AT_STRING
ATTRMCDPATH: server-name

ATTR: server-ip-addr
ATTRID: 2
ATTRHDRNAME: AO_FAILOVER_SERVER_IP_ADDR
ATTRTYPE: AT_IPADDR
ATTRMCDPATH: server-ip-addr

ATTR: other-server-name
ATTRID: 3
ATTRHDRNAME: AO_FAILOVER_OTHER_SERVER_NAME
ATTRTYPE: AT_STRING
ATTRMCDPATH: other-server-name

ATTR: other-server-addr
ATTRID: 4
ATTRHDRNAME: AO_FAILOVER_OTHER_SERVER_IP_ADDR
ATTRTYPE: AT_IPADDR
ATTRMCDPATH: other-server-addr

ATTR: mclt
ATTRID: 5
ATTRHDRNAME: AO_FAILOVER_MCLT
ATTRTYPE: AT_TIME
ATTRFLAGS: AF_PRINT_ALT
ATTRMCDPATH: mclt

ATTR: state
ATTRID: 6
ATTRHDRNAME: AO_FAILOVER_STATE
ATTRTYPE: AT_INT
ATTRMCDPATH: state

ATTR: other-state
ATTRID: 7
ATTRHDRNAME: AO_FAILOVER_OTHER_STATE
ATTRTYPE: AT_INT
ATTRMCDPATH: other-state

ATTR: version
ATTRID: 8
ATTRHDRNAME: AO_FAILOVER_VERSION
ATTRTYPE: AT_INT
ATTRMCDPATH: version

ATTR: comm-normal
ATTRID: 9
ATTRHDRNAME: AO_FAILOVER_COMM_NORMAL
ATTRTYPE: AT_INT
ATTRMCDPATH: comm-normal
ATTRDESC:: eod
Specifies the state of communications with the specified partner.
eod

ATTR: flags
ATTRID: 10
ATTRHDRNAME: AO_FAILOVER_FLAGS
ATTRTYPE: AT_INT
ATTRMCDPATH: flags
ATTRDESC:: eod
The value of the 'flags' field of a failover protocol message.
eod

ATTR: partner-flags
ATTRID: 11
ATTRHDRNAME: AO_FAILOVER_PARTNER_FLAGS
ATTRTYPE: AT_INT
ATTRMCDPATH: partner-flags
ATTRDESC:: eod
The expected value of the partner's 'flags' field in its failover
protocol messages.
eod

# the current server's failover role
ATTR: failover-role
ATTRID: 12
ATTRHDRNAME: AO_FAILOVER_ROLE
ATTRTYPE: AT_ENUMINT(backup=0, primary=1)
ATTRVIZ: 3
ATTRDESC:: eod
The current server's failover role.
eod

ATTR: start-time-of-state
ATTRID: 13
ATTRHDRNAME: AO_FAILOVER_START_TIME_OF_STATE
ATTRTYPE: AT_DATE
ATTRMCDPATH: start-time-of-state
ATTRVIZ: 3
ATTRDESC:: eod
Displays the date and time the state last changed to
its current value.
eod

ATTR: start-communications-interrupted
ATTRID: 14
ATTRHDRNAME: AO_FAILOVER_START_COMMUNICATIONS_INTERRUPTED
ATTRTYPE: AT_DATE
ATTRMCDPATH: start-communications-interrupted
ATTRVIZ: 3
ATTRDESC:: eod
The time at which communications was last interrupted.
This is not necessarily equal to (and may be later than)
the start-time-of-state if the current state is
COMMUNICATIONS-INTERRUPTED.
eod

ATTR: partner-start-time-of-state
ATTRID: 15
ATTRHDRNAME: AO_FAILOVER_PARTNER_START_TIME_OF_STATE
ATTRTYPE: AT_DATE
ATTRMCDPATH: partner-start-time-of-state
ATTRVIZ: 3
ATTRDESC:: eod
If present, the time at which the partner's state
last changed.
eod

ATTR: time-stamp
ATTRID: 16
ATTRHDRNAME: AO_FAILOVER_TIME_STAMP
ATTRTYPE: AT_DATE
ATTRMCDPATH: time-stamp
ATTRVIZ: 3
ATTRDESC:: eod
The time at which this state was written to MCD.
eod

ATTR: vendor-class-id
ATTRID: 17
ATTRHDRNAME: AO_FAILOVER_VENDOR_CLASS_ID
ATTRTYPE: AT_STRING
ATTRMCDPATH: vendor-class-id
ATTRVIZ: 3
ATTRDESC:: eod
The vendor-id string out of any Option 60, vendor-class-id,
in a packet.
eod


ATTR: communicated-in-current-state
ATTRID: 18
ATTRHDRNAME: AO_FAILOVER_COMMUNICATED_IN_CURRENT_STATE
ATTRTYPE: AT_INT
ATTRMCDPATH: communicated-in-current-state
ATTRDESC:: eod
Indicates whether this failover object has communicated with the
partner since it entered this state.
eod

ATTR: complete-recover
ATTRID: 19
ATTRHDRNAME: AO_FAILOVER_COMPLETE_RECOVER
ATTRTYPE: AT_DATE
ATTRMCDPATH: complete-recover
ATTRDESC:: eod
Indicates whether this failover object is undergoing a complete
recovery.  A value of 0 or missing means no, a non-zero value
means yes, with the non-zero value equal to the last time known
up (for the mclt wait).
eod

ATTR: sequence-number
ATTRID: 20
ATTRHDRNAME: AO_FAILOVER_SEQUENCE_NUMBER
ATTRTYPE: AT_VERSION
ATTRMCDPATH: sequence-number
ATTRVIZ: 3
ATTRDESC:: eod
Unique sequence number, which connects all current and up-to-date
leases that are associated to a failover server. Sequence number
will be maintained by the DHCP server and should not be modified.
eod

ATTR: last-communication-ok-time
ATTRID: 21
ATTRHDRNAME: AO_FAILOVER_LAST_COMMUNICATION_OK_TIME
ATTRTYPE: AT_INT
ATTRMCDPATH: last-communication-ok-time
ATTRVIZ: 3
ATTRDESC:: eod
Most recent time when communications between failover servers was
ok.  This timestamp will be maintained by the DHCP server and
should not be modified.
eod

ATTR: other-server-down-time
ATTRID: 22
ATTRHDRNAME: AO_FAILOVER_OTHER_SERVER_DOWN_TIME
ATTRTYPE: AT_DATE
ATTRMCDPATH: other-server-down-time
ATTRVIZ: 3
ATTRDESC:: eod
The time at which we were told the other server went down.
eod

ATTR: load-balancing-backup-hba
ATTRID: 23
ATTRTYPE: AT_BITARRAY
ATTRVIZ: 3
ATTRDESC:: eod
The load balancing hash bucket assignment for the backup failover
server.
eod


CLASS: DhcpFailoverScopes
CLASSROOT: FAILOVERSCOPES
CLASSID: 1116
CLASSVIZ: 3
CLASSPCV: 1.0.0
CLASSDEPRECATED: 4.0.0
CLASSDESC:: eod
Ask Mark
eod

# a list of the names of the scopes associated with a partner
# server
ATTR: scope-list
ATTRID: 1
ATTRHDRNAME: AO_FAILOVERSCOPES_SCOPE_LIST
ATTRTYPE: AT_ARRAY(AT_STRING)
ATTRMCDPATH: scope-list
ATTRVIZ: 3
ATTRDESC:: eod
A list of the names of the scopes associated with a dhcp failover
partner server.
eod

# C l i e n t C l a s s
# ClientClass

# The ClientClass was a clone of the ClientEntry for storing
# client-class objects until CNR 6.2.  See the ClientEntry class
# description for
#more details.
#As of CNR 6.2, the DHCP server is able to configure ClientClass
#objects directly instead of having to assume that they
#are ClientEntry objects.  So, from now
#on, you don't have to ensure that new attribute id's match in the
#ClientEntry (CE) and ClientClass (CC) objects.
CLASS: ClientClass
CLASSROOT: CC
CLASSID: 1117
CLASSNAME: 8
CLASSVIZ: 5
CLASSPCV: 1.0.0
CLASSDESC:: eod
A client-class description.  A client-class defines the selection
criteria and configuration for a group of clients.
eod

ATTR: client-class-name
ATTRID: 1
ATTRHDRNAME: AO_CC_CLIENT_CLASS_NAME
ATTRTYPE: AT_STRING
ATTRVIZ: 1
DEPRECATED: 7.0
ATTRDESC:: eod
Not used for client-class
eod

ATTR: host-name
ATTRID: 2
ATTRHDRNAME: AO_CC_HOST_NAME
ATTRTYPE: AT_STRING
ATTRVIZ: 5
ATTRDESC:: eod
Specifies the hostname for clients in this client-class.
Network Registrar uses this form of hostname value to signal the
following special handling:

    @host-name-option
       Causes the server to use whatever hostname option the
       client sent. This is the default behavior if there is no
       entry for host-name in either the client or client-class.

    @no-host-name-option
       Causes the server to drop the hostname option that the
       client sent, and not replace it. If you have disabled
       DNS name synthesis, then the client will have no name
       placed into DNS.

    @use-macaddress
       Causes the server to synthesize a host-name for the
       client that is derived from its MAC address, and is thus
       unique. This token is used to ensure that a client has a
       valid name in DNS.

This feature is maintained for compatibility with prior versions.
Additional options for host-name synthesis are provided on the
DNSUpdateConfig object referenced by the policy hierarchy.
eod

ATTR: domain-name
ATTRID: 3
ATTRHDRNAME: AO_CC_DOMAIN_NAME
ATTRTYPE: AT_STRING
ATTRVIZ: 5
ATTRDESC:: eod
Sets the domain name, which must be a zone, for performing DNS
updates. Places the client's A record in this DNS domain.
This feature is maintained for compatibility with prior versions.
Additional options to specify the forward zone are provided on
the client-class's policy (or embedded policy) and its
referenced DNSUpdateConfig objects.
eod

ATTR: policy-name
ATTRID: 4
ATTRHDRNAME: AO_CC_POLICY_NAME
ATTRTYPE: AT_STRING
ATTRVIZ: 5
ATTRDESC:: eod
Names the policy that should be used for this client-class.
eod

ATTR: action
ATTRID: 5
ATTRHDRNAME: AO_CC_ACTION
ATTRTYPE: AT_FLAGSINT(exclude=1,deprecated-one-shot=2,deprecated-use-release-grace-period=3,none=32)
ATTRVIZ: 5
ATTRDESC:: eod
Specifies what action to take with this client-class.  You can
specify exclude, causing the server to ignore all communication
from this client.

If you specify the exclude action in the default client entry,
then any client not specifically registered through the client
command cannot communicate with the server.

The one-shot and use-release-grace-period actions are now
deprecated and ignored; these are available through the policy
inhibit-all-renews and release-grace-period attributes.
eod
ATTR: old-inclusion-mask
ATTRID: 6
ATTRHDRNAME: AO_CC_INCLUSION_MASK
ATTRTYPE: AT_INT
ATTRVIZ: 1
DEPRECATED: 7.0
ATTRDESC:: eod
This attribute is not used.
eod

ATTR: old-exclusion-mask
ATTRID: 7
ATTRHDRNAME: AO_CC_EXCLUSION_MASK
ATTRTYPE: AT_INT
ATTRVIZ: 1
DEPRECATED: 7.0
ATTRDESC:: eod
This attribute is not used.
eod

ATTR: name
ATTRID: 8
ATTRHDRNAME: AO_CC_NAME
ATTRTYPE: AT_STRING
ATTRFLAGS: AF_UNIQUE, AF_JAVADOC
ATTRVIZ: 3
ATTRDESC:: eod
The name of this client-class object.
eod

ATTR: authenticate-until
ATTRID: 9
ATTRHDRNAME: AO_CC_AUTHENTICATION_EXPIRES
ATTRTYPE: AT_DATE
ATTRVIZ: 1
DEPRECATED: 7.0
ATTRDESC:: eod
Sets an authentication expiration date. Formats for the date are:
 +<num><unit>
   Time in the future, where num is a decimal number and unit is
   s, m, h, d, or w for seconds, minutes, hours, days or weeks,
   respectively.
 <month> <day> <hour>:<minute>[:<second>] <year>
   Month, day, 24-hour time, and 2-or-4-digit-year.
   For example:Jun 30 20:00:00 2002. Enter the time that is local
   to the nrcmd process.
 forever
   Does not expire the authentication for this client.
eod

ATTR: authentication-sequence
ATTRID: 10
ATTRHDRNAME: AO_CC_AUTHENTICATION_SEQUENCE
ATTRTYPE: AT_INT
ATTRVIZ: 1
DEPRECATED: 7.0
ATTRDESC:: eod
This attribute is not used.
eod

ATTR: unauthenticated-client-class-name
ATTRID: 11
ATTRHDRNAME: AO_CC_UNAUTHENTICATED_CLIENT_CLASS_NAME
ATTRTYPE: AT_STRING
ATTRVIZ: 5
ATTRDESC:: eod
Names the client-class used if this client is no longer
authenticated.
eod

ATTR: user-defined
ATTRID: 12
ATTRHDRNAME: AO_CC_COOKIE_STR
ATTRTYPE: AT_STRING
ATTRVIZ: 5
ATTRDESC:: eod
Provides an opaque user-defined string that can be set
and queried. This property has no effect on the operation
of the DHCP server.
eod

ATTR: environment-dictionary
ATTRID: 13
ATTRHDRNAME: AO_CC_ENV_DICTIONARY
ATTRTYPE: AT_DICT(AT_STRING)
ATTRVIZ: 1
DEPRECATED: 6.0.0
ATTRDESC:: eod
A set of strings which will be added to the environment dictionary
when a client is recognized to be this in client-class.  When
a client passes through more than one client-class, these attribute
value pairs will remain in the environment dictionary.
eod

ATTR: selection-criteria
ATTRID: 14
ATTRHDRNAME: AO_CC_INCLUSION_CRITERIA
ATTRTYPE: AT_ARRAY(AT_STRING)
ATTRVIZ: 5
ATTRDESC:: eod
Lists the selection tags for this client-class. All the criteria
in this list must appear in the scope/prefix selection tags for a
scope/prefix to be considered acceptable to this client-class.
eod

ATTR: selection-criteria-excluded
ATTRID: 15
ATTRHDRNAME: AO_CC_EXCLUSION_CRITERIA
ATTRTYPE: AT_ARRAY(AT_STRING)
ATTRVIZ: 3
ATTRDESC:: eod
Lists excluded selection tags for this client-class. None of the
criteria in this list may appear in the scope/prefix selection
tags for a scope/prefix to be considered acceptable to this
client-class.
eod

ATTR: version
ATTRID: 16
ATTRHDRNAME: AO_CC_VERSION
ATTRTYPE: AT_INT
ATTRVIZ: 1
DEPRECATED: 6.0.0

ATTR: status
ATTRID: 17
ATTRHDRNAME: AO_CC_STATUS
ATTRTYPE: AT_ENUMINT(success=0, no-results=1, ldap-failure=2)
ATTRVIZ: 1
DEPRECATED: 6.0.0

ATTR: embedded-policy
ATTRID: 18
ATTRHDRNAME: AO_CC_EMBEDDED_POLICY
ATTRTYPE: AT_OBJ(Policy)
ATTRVAL: 1102
ATTRVIZ: 5
ATTRDESC:: eod
Specifies the embedded policy object for this client-class.
eod

ATTR: over-limit-client-class-name
ATTRID: 19
ATTRHDRNAME: AO_CC_OVER_LIMIT_CLIENT_CLASS_NAME
ATTRTYPE: AT_STRING
ATTRMCDPATH: over-limit-client-class-name
ATTRVIZ: 5
ATTRDESC:: eod
Designates the client-class used if this client is over the limit
allowed for the specified limitation-id.

eod

ATTR: limitation-id
ATTRID: 20
ATTRHDRNAME: AO_CC_LIMITATION_ID
ATTRTYPE: AT_EXPR
ATTRMCDPATH: limitation-id
ATTRVIZ: 5
ATTRDESC:: eod
Specifies an expression that evaluates to a binary large object
(blob), or a string that can be used as a blob. The resulting
value groups leases that have a maximum limit on the number of
simultaneous active leases allowed. To configure the limit, use
limitation-count attribute of the policy command. See also
the over-limit-client-class attribute.

eod

ATTR: client-lookup-id
ATTRID: 21
ATTRHDRNAME: AO_CC_CLIENT_LOOKUP_ID
ATTRTYPE: AT_EXPR
ATTRMCDPATH: client-lookup-id
ATTRVIZ: 5
ATTRDESC:: eod
Specifies the key value used to lookup the specified client in the
client database, using an expression that evaluates to a string
or a blob that is a valid string.  The lookup can be local or through
LDAP.

eod

ATTR: reservation-id
ATTRID: 22
ATTRHDRNAME: AO_CC_RESERVATION_ID
ATTRTYPE: AT_EXPR
ATTRMCDPATH: reservation-id
ATTRVIZ: 1
DEPRECATED: 7.0
ATTRDESC:: eod
An expression which evaluates to a string (or a blob which is a
valid string).  The resulting value specifies the key to be used
to lookup any reservations that have been made for this client.

This might have been in CNR 6.0, but while reservations which
did not require mac addresses as the key was a nice idea, there
was nt time to implement it for 6.0.  If we ever do it, this is
the place to put it.  Some of the code is in the server for it,
though not all by any means.
eod

ATTR: max-client-lookups
ATTRID: 23
ATTRHDRNAME: AO_CC_MAX_CLIENT_LOOKUPS
ATTRTYPE: AT_INT
ATTRMCDPATH: max-client-lookups
ATTRVIZ: 1
DEPRECATED: 7.0
ATTRDESC:: eod
An integer which specifies the maximum number of client database
lookups allowed.  Should be a small number (e.g., 2 or so).  The
default value, if none is specified in either the client or
client-class is 1.
eod

ATTR: default-vpn
ATTRID: 24
ATTRTYPE: AT_NAMEREF(VPN)
ATTRVAL: 1127
ATTRVIZ: 5
ATTRDESC:: eod
Determines the VPN to which a client is assigned if the client does
not supply a VPN-ID (or vrf-name) value.
eod

ATTR: override-vpn
ATTRID: 25
ATTRTYPE: AT_NAMEREF(VPN)
ATTRVAL: 1127
ATTRVIZ: 5
ATTRDESC:: eod
Determines the VPN to which a client is assigned regardless
of what the client provides for a VPN-ID (or vrf-name) value.
eod

ATTR: v6-client-lookup-id
ATTRID: 26
ATTRTYPE: AT_EXPR
ATTRDESC:: eod
Specifies the key value used to lookup the DHCPv6 client in the
client database, using an expression that evaluates to a string
or a blob that is a valid string.  The lookup can be local or through
LDAP.

eod

ATTR: override-client-id
ATTRID: 27
ATTRTYPE: AT_EXPR
ATTRDESC:: eod
Specifies the client-identity value for the specified client, using
an expression that evaluates to a binary large object (blob).  The
value that is derived from the expression evaluation replaces any
client-id option value in the incoming packet (though in actual
practice, both values are retained in the lease-state database).
eod

ATTR: add-to-environment-dictionary
ATTRID: 28
ATTRTYPE: AT_STRING
ATTRDESC:: eod
This string contains attribute-value pairs that are added to the
environment dictionary whenever this client-class is associated
with an incoming DHCP request.  You can use these attribute-value
pairs to configure extensions or expressions without having to
re-write the executable code in the extension or expression.  The
string must have the format:
"attribute1=value1,attribute2=value2, ... ,attributen=valuen"
eod

ATTR: v6-override-client-id
ATTRID: 29
ATTRTYPE: AT_EXPR
ATTRDESC:: eod
An expression which evaluates to a blob which is used for the
client-identity value for the current DHCPv6 client.  Conceptually
this value derived from the expression evaluation will replace any
client-id option value in the incoming packet (though in actual
practice, both values are retained in the lease-state database).
eod

# end ClientClass

CLASS: DHCPRelatedServer
CLASSID: 1118
CLASSVIZ: 3
CLASSPCV: 5.0.0
CLASSDESC:: eod
A description of the DHCP server's related servers. The DHCP
server maintains this information for other servers with
which it communicates, such as a failover partner or LDAP server.
eod

ATTR: ipaddr
ATTRID: 1
ATTRTYPE: AT_IPADDR

ATTR: type
ATTRID: 2
ATTRTYPE: AT_ENUMINT(none=0, main=1, backup=2, dns=3, ldap=4)

ATTR: comm-state
ATTRID: 3
ATTRTYPE: AT_ENUMINT(none=0, ok=1, interrupted=2)
ATTRDESC:: eod
Status of communication between the DHCP and remote server.
An 'ok' indicates DHCP server succeeded in communicating to
the remote server. An 'interrupted' indicates DHCP Server was
unsuccessful in communicating to the remote server.
eod

ATTR: requests
ATTRID: 4
ATTRTYPE: AT_INT

ATTR: failover-state
ATTRID: 5
ATTRTYPE: AT_ENUMINT(none=0, startup=1, normal=2, communications-interrupted=3, partner-down=4, potential-conflict=5, recover=6, paused=7, shutdown=8, recover-done=9)

ATTR: partner-failover-state
ATTRID: 6
ATTRTYPE: AT_ENUMINT(none=0, startup=1, normal=2, communications-interrupted=3, partner-down=4, potential-conflict=5, recover=6, paused=7, shutdown=8, recover-done=9)

# xxxRelatedServer
#
# There are several (as of this writing, 3) different
# but related objects, all named x...xRelatedServer.  Since
# there is no sub-classing, we can't formally have common and
# then sub-class specific attributes, but we can do something
# similar with a little care in the attribute definitions.
#
# Attribute ID's less than 20 (decimal) amongst these objects
# are common attributes, and those with attribute ID's of 20
# or greater are object specific attributes.
#
# At present, there are three related objects:
#
# LDAPRelatedServer
# DNSRelatedServer
# FailoverRelatedServer


# LDAPRelatedServer

CLASS: LDAPRelatedServer
CLASSID: 1139
CLASSVIZ: 3
CLASSPCV: 6.0.0
CLASSDESC:: eod
The DHCP server's related servers information that is specific to
LDAP servers.
eod

ATTR: ipaddr
ATTRID: 1
ATTRTYPE: AT_IPADDR
ATTRDESC:: eod
The IP Address for the LDAP server as configured in the DHCP
server.
eod

ATTR: comm-state
ATTRID: 2
ATTRFLAGS: AF_PRINT_ALT
ATTRTYPE: AT_ENUMINT(none=0, ok=1, interrupted=2)
ATTRDESC:: eod
Status of communication between the DHCP and remote server.
An 'ok' indicates DHCP server succeeded in communicating to
the remote server. An 'interrupted' indicates DHCP Server was
unsuccessful in communicating to the remote server.
eod

# leave some attribute space for common parameters of all
# RelatedServers
# see comment titled xxxRelatedServer, above
ATTR: requests
ATTRID: 20
ATTRTYPE: AT_INT

# DNSRelatedServer

CLASS: DNSRelatedServer
CLASSID: 1140
CLASSVIZ: 3
CLASSPCV: 6.0.0
CLASSDESC:: eod
The DHCP server's related servers information that is specific to
DNS servers.
eod

ATTR: ipaddr
ATTRID: 1
ATTRTYPE: AT_IPADDR
ATTRDESC:: eod
The IP Address for the Standalone DNS (or HA-DNS) server as
configured in DHCP server.
eod

ATTR: comm-state
ATTRID: 2
ATTRFLAGS: AF_PRINT_ALT
ATTRTYPE: AT_ENUMINT(none=0, ok=1, interrupted=2)
ATTRDESC:: eod
Status of communication between the DHCP and remote server.
An 'ok' indicates DHCP server succeeded in communicating to
the remote server. An 'interrupted' indicates DHCP Server was
unsuccessful in communicating to the remote server.
eod


# leave some attribute space for common parameters of all
# RelatedServers
# see comment titled xxxRelatedServer, above
ATTR: requests
ATTRID: 20
ATTRTYPE: AT_INT
ATTRDESC:: eod
Number of requests currently outstanding with the remote server.
eod

ATTR: ha-dns-failover-timeout
ATTRTYPE: AT_RANGEINT(30-120)
ATTRID: 22
ATTRDESC:: eod
Sets the maximum number of seconds that the DHCP server waits
for a reply from a DNS server before DHCP fails over to the next
DNS Server to perform a DNS update.
eod

ATTR: ha-dns-probe-timeout
ATTRTYPE: AT_RANGEINT(2-20)
ATTRID: 23
ATTRDESC:: eod
The number of milliseconds the DHCP server will wait for a
ddns-update reply from a DNS server (that's in PROBE state),
before retrying the ddns-update.
eod

ATTR: ha-dns-probe-retry
ATTRTYPE: AT_RANGEINT(1-5)
ATTRID: 24
ATTRDESC:: eod
The number of attempts the DHCP server will retry ddns-update to a
DNS server that's in PROBE state, before switching to use the next
HA-DNS server.
eod

ATTR: max-dns-retries
ATTRTYPE: AT_INT
ATTRID: 25
ATTRDESC:: eod
Sets the number of times the DHCP server retries ddns-update to
a DNS server that is in SEND-UPDATE state, before transitioning
the DNS server to PROBE state.
eod

ATTR: dns-timeout
ATTRTYPE: AT_INT
ATTRID: 26
ATTRDESC:: eod
Sets the time, in milliseconds, that the DHCP server waits for a
response before retrying a DNS update request. Default is
60000 milliseconds (1 minute).

eod

ATTR: optimize-cnr-ha-dns
ATTRID: 27
ATTRTYPE: AT_BOOL
ATTRVIZ: 3
ATTRDEFVAL: FALSE
ATTRDESC:: eod
The configured value for optimize-cnr-ha-dns attribute.

This parameter should be configured only if DHCP server is sending
dynamic dns update to a CNR implementation of HA-DNS server pair.
If set to TRUE, DHCP server will attempt to coordinate and reduce
latency while failing over between the CNR implementation of
HA-DNS servers.  This parameter should be set to FALSE if the CNR
DHCP server is configured to send dynamic dns updates to a non-CNR
(BIND, etc) implementation of DNS server.
eod

ATTR: ha-dns-state
ATTRID: 28
ATTRFLAGS: AF_PRINT_ALT
#This enum should match an_dns.h typedef.
ATTRTYPE: AT_ENUMINT( ha-state-unknown=0, ha-main-normal=1, ha-main-comm-intr=2, ha-main-sync=3, ha-main-partner-down=4, ha-main-in-startup=5, ha-backup-normal=6, ha-backup-comm-intr=7, ha-backup-sync=8, ha-backup-partner-down=9, ha-backup-in-startup=10 )
ATTRDESC:: eod
Current state of HA-DNS Servers pairs (as seen by the DHCP Server)
eod
ATTR: ha-dns-role
ATTRID: 29
ATTRFLAGS: AF_PRINT_ALT
# should match typedef dns_remote_server_type_e in remoteserver.h
ATTRTYPE: AT_ENUMINT(STANDALONE-DNS=0, HA-MAIN=1, HA-BACKUP=2)
ATTRDESC:: eod
Role played by this DNS server.

A DNS server can be a standalone DNS, or HA-Main or HA-Backup if
HA-DNS is in use.
eod

ATTR: dns-server-state
ATTRID: 30
ATTRFLAGS: AF_PRINT_ALT
# should match typedef dns_remote_server_state_e in remoteserver.h
ATTRTYPE: AT_ENUMINT(SEND-UPDATE=0, PROBE=1)
ATTRDESC:: eod
State of the DNS remote server, as seen by the DHCP server.

A SEND-UPDATE state indicates that the DHCP server is currently
sending dynamic-dns updates to the remote DNS server.
A PROBE state indicates that the DHCP server either attempted to
send dynamic-dns updates and was not successful, or hasn't yet
initiated any dynamic-dns update to the remote DNS server.
eod

ATTR: dns-server-flags
ATTRID: 31
ATTRFLAGS: AF_PRINT_ALT
ATTRTYPE: AT_FLAGSINT(all-ha-dns-servers-down=1, both-ha-dns-servers-are-main=2,both-ha-dns-servers-are-backup=3, used-in-ha-pair=4, used-as-standalone=5, init-reply-time=6)
ATTRDESC:: eod
Status flag for the DNS Server based on DHCP configuration and
current state of DNS remote server. The flags could be one or
more of the following:

'all-ha-dns-servers-down' indicates that this DNS Remote server
    is part of a HA-DNS configured and that both the HA-DNS
    servers are currently down.

'both-ha-dns-servers-are-main' indicates that this DNS Remote
    server is part of misconfigured HA-DNS configuration, as
    both the HA-DNS servers configured on the DHCP server are
    acting a HA-DNS Main servers and there isn't a HA-DNS
    Backup server.  Until this configuration error is fixed
    DHCP may not process dynamic dns updates bound to this
    HA-DNS server pair.

'both-ha-dns-servers-are-backup' indicates that this DNS Remote
    server is part of misconfigured HA-DNS configuration, as
    both the HA-DNS servers configured on the DHCP server are
    acting a HA-DNS Backup servers and there isn't a HA-DNS
    Main server.  Until this configuration error is fixed DHCP
    may not process dynamic dns updates bound to this HA-DNS
    server pair.

'used-in-ha-pair' indicates that this DNS Remote Server is
    configured (in the DHCP server) as a HA-DNS server to
    process dynamic dns updates.

'used-as-standalone' indicates that this DNS Remote Server is
    configured (in the DHCP server) as a standalone DNS server
    to process dynamic dns updates.
eod

ATTR: last-reply-received-time
ATTRID: 32
ATTRTYPE: AT_DATE
ATTRDESC:: eod
The time at which the last reply was received from DNS remote
server.
eod

ATTR: last-probe-sent-time
ATTRID: 33
ATTRTYPE: AT_DATE
ATTRDESC:: eod
The time at which the last ddns update request was sent to DNS
remote server. Applicable only if the DNS remote server is in
PROBE state.
eod

ATTR: last-ha-dns-role-switch-time
ATTRID: 34
ATTRTYPE: AT_DATE
ATTRDESC:: eod
The timestamp when the DNS remote server role was switched (HA-DNS
Main to Backup or the reverse), and the switched new HA role is
different from DHCP server's configuration.
eod

ATTR: current-time
ATTRID: 35
ATTRTYPE: AT_DATE
ATTRDESC:: eod
The current time on the server returning this object.
eod

ATTR: last-ha-dns-state
ATTRID: 36
ATTRFLAGS: AF_PRINT_ALT
#This enum should match an_dns.h typedef.
ATTRTYPE: AT_ENUMINT( ha-state-unknown=0, ha-main-normal=1, ha-main-comm-intr=2, ha-main-sync=3, ha-main-partner-down=4, ha-main-in-startup=5, ha-backup-normal=6, ha-backup-comm-intr=7, ha-backup-sync=8, ha-backup-partner-down=9, ha-backup-in-startup=10 )
ATTRDESC:: eod
Last known state of HA-DNS Servers, that's different from
ha-dns-state, pairs (as seen by the DHCP Server until
last-ha-dns-state-change-time).
eod

ATTR: last-ha-dns-state-change-time
ATTRID: 37
ATTRTYPE: AT_DATE
ATTRDESC:: eod
The timestamp when the HA-DNS server transitioned from
last-ha-dns-state to ha-dns-state.
eod

ATTR: probe-polling-event-id
ATTRID: 38
ATTRTYPE: AT_INT
ATTRDESC:: eod
The ddns update event id that's used as a polling event (in PROBE
state).
eod


# FailoverRelatedServer

CLASS: FailoverRelatedServer
CLASSID: 1138
CLASSVIZ: 3
CLASSPCV: 6.0.0
CLASSDESC:: eod
The DHCP server's related servers information that is specific to
a Failover partner.
eod

ATTR: ipaddr
ATTRID: 1
ATTRTYPE: AT_IPADDR
ATTRDESC:: eod
The IP address of the partner server.
eod

ATTR: comm-state
ATTRID: 2
ATTRFLAGS: AF_PRINT_ALT
ATTRTYPE: AT_ENUMINT(none=0, ok=1, interrupted=2)
ATTRDESC:: eod
Status of communication between the DHCP and remote server.
An 'ok' indicates DHCP server succeeded in communicating to
the remote server. An 'interrupted' indicates DHCP Server was
unsuccessful in communicating to the remote server.
eod

# leave some attribute space for common parameters of all
# RelatedServers
# see comment titled xxxRelatedServer, above
ATTR: current-time
ATTRID: 20
ATTRTYPE: AT_DATE
ATTRDESC:: eod
The current time on the server returning this object.
eod

ATTR: maximum-client-lead-time
ATTRID: 21
ATTRTYPE: AT_INT
ATTRDESC:: eod
The current maximum client lead time on this system.
eod

ATTR: our-ipaddr
ATTRID: 22
ATTRTYPE: AT_IPADDR
ATTRDESC:: eod
The IP address of our interface to this partner server.
eod

ATTR: role
ATTRID: 23
ATTRTYPE: AT_ENUMINT(none=0, main=1, backup=2)
ATTRFLAGS: AF_PRINT_ALT
ATTRDESC:: eod
The failover role of the server returning this object.
eod

ATTR: partner-role
ATTRID: 24
ATTRTYPE: AT_ENUMINT(none=0, main=1, backup=2)
ATTRFLAGS: AF_PRINT_ALT
ATTRDESC:: eod
The failover role of the partner of the server returning this
object.
eod

ATTR: state
ATTRID: 25
ATTRTYPE: AT_ENUMINT(none=0, startup=1, normal=2, communications-interrupted=3, partner-down=4, potential-conflict=5, recover=6, paused=7, shutdown=8, recover-done=9)
ATTRFLAGS: AF_PRINT_ALT
ATTRDESC:: eod
The state which this end of the failover relationship is in.
eod

ATTR: partner-state
ATTRID: 26
ATTRTYPE: AT_ENUMINT(none=0, startup=1, normal=2, communications-interrupted=3, partner-down=4, potential-conflict=5, recover=6, paused=7, shutdown=8, recover-done=9)
ATTRFLAGS: AF_PRINT_ALT
ATTRDESC:: eod
The last known state which the partner's end of the failover
relationship is in.
eod

ATTR: start-time-of-state
ATTRID: 27
ATTRTYPE: AT_DATE
ATTRDESC:: eod
The time at which the current failover state began.
eod

ATTR: start-time-of-partner-state
ATTRID: 28
ATTRTYPE: AT_DATE
ATTRDESC:: eod
The time at which the partner's current failover state began.
eod

ATTR: start-of-comm-interrupted
ATTRID: 29
ATTRTYPE: AT_DATE
ATTRDESC:: eod
The time at which this partner most recent went into communications
interrupted state.  This is valid across reloads, while the
start-time-of-state will never have a time earlier than the most
recent server reload.
eod

ATTR: last-comm-ok-time
ATTRID: 30
ATTRTYPE: AT_DATE
ATTRDESC:: eod
The time at which this server last found communications to be ok.
eod

ATTR: sequence-number
ATTRID: 31
ATTRTYPE: AT_VERSION
ATTRDESC:: eod
Sequence number unique across failover objects, if different
from sequence in lease, lease is considered "not up to date"
independent of the sf-up-to-date lease flag.
eod

ATTR: est-end-recover-time
ATTRID: 32
ATTRTYPE: AT_DATE
ATTRDESC:: eod
Valid if update-request-in-progress != none. If it appears,
time at which server will enter recover done if the update
request outstanding is complete then.  If it doesn't appear,
then server will enter recover-done state whenever update-request
is completed.
eod

ATTR: est-partner-end-recover-time
ATTRID: 33
ATTRTYPE: AT_DATE
ATTRDESC:: eod
Only appears if the partner-failover-state is recover.  This is
a prediction of when the partner will time out its MCLT and
finish being in the recover state.  It is only an estimate.
eod

ATTR: safe-period-remaining
ATTRID: 34
ATTRTYPE: AT_TIME
ATTRDESC:: eod
Duration in seconds remaining in safe-period.
If this is != 0, then this server is currently running down a
safe period with respect to its partner.
eod

ATTR: use-other-available
ATTRID: 35
ATTRTYPE: AT_BOOL
ATTRDESC:: eod
If false or unset, then other-available leases cannot be used by
this server.  If true, then other-available leases can be used by
this server.  Valid at all times, but should only be true if state
is PARTNER-DOWN.
eod

ATTR: use-other-available-time
ATTRID: 36
ATTRTYPE: AT_DATE
ATTRDESC:: eod
Appears if current state is PARTNER-DOWN and use-other-available is
not true. Contains the time when use-other-available will go to
true.
eod

ATTR: update-response-in-progress
ATTRID: 37
ATTRTYPE: AT_STRING
ATTRDESC:: eod
Only appears if this server is processing an update response. This
string gives information about the type of and origin of the
response.
eod

ATTR: update-response-percent-complete
ATTRID: 38
ATTRTYPE: AT_INT
ATTRDESC:: eod
Number between 0 and 100.  Only valid if
update-response-outstanding appears. If this appears, it is the
percent complete of the current update response.
eod

ATTR: update-response-start-time
ATTRID: 39
ATTRTYPE: AT_DATE
ATTRDESC:: eod
The time that the update response mentioned in
update-response-in-progress was started.
eod

ATTR: update-response-done-time
ATTRID: 40
ATTRTYPE: AT_DATE
ATTRDESC:: eod
The time that the most recent update response sent an update done
to the partner server.
eod

ATTR: update-request-outstanding
ATTRID: 41
ATTRFLAGS: AF_PRINT_ALT
ATTRTYPE: AT_ENUMINT(none=0, update=1, update-all=2)
ATTRDESC:: eod
If unset or zero, then the server does not have an update request
queued for its partner.  If != 0, then it does have an update
request queued for its failover partner.
eod

ATTR: update-request-start-time
ATTRID: 42
ATTRTYPE: AT_DATE
ATTRDESC:: eod
The time at which the update-request-outstanding update request (if
any) was started.
eod

ATTR: update-request-done-time
ATTRID: 43
ATTRTYPE: AT_DATE
ATTRDESC:: eod
The time at which the last update request (if any)
completed.
eod

ATTR: load-balancing-backup-pct
ATTRID: 44
ATTRTYPE: AT_PERCENT
ATTRDESC:: eod
The current failover load balancing backup percentage. If 0,
failover load balancing is not in use (disabled).
eod

ATTR: load-balancing-local-hba
ATTRID: 45
ATTRTYPE: AT_BITARRAY
ATTRDESC:: eod
The local server's current hash bucket assignment, usually shown
as a range of the hash bucket numbers. See RFC 3074.
eod

ATTR: load-balancing-partner-hba
ATTRID: 46
ATTRTYPE: AT_BITARRAY
ATTRDESC:: eod
The partner server's current hash bucket assignment, usually shown
as a range of the hash bucket numbers. See RFC 3074.
eod

ATTR: load-balancing-processed-requests
ATTRID: 47
ATTRTYPE: AT_INT
ATTRDESC:: eod
The number of requests, subject to load balancing, processed
by the server (i.e., were in the server's hash bucket
assignment). This counter includes only the requests since
the most recent transition to NORMAL state.
eod

ATTR: load-balancing-dropped-requests
ATTRID: 48
ATTRTYPE: AT_INT
ATTRDESC:: eod
The number of requests, subject to load balancing, dropped
by the server (i.e., were not in the server's hash bucket
assignment). This counter includes only the requests since
the most recent transition to NORMAL state.
eod

ATTR: load-balancing-processed-total
ATTRID: 49
ATTRTYPE: AT_INT
ATTRDESC:: eod
The number of requests, subject to load balancing, processed
by the server (i.e., were in the server's hash bucket
assignment). This counter includes the requests since this
server was last started or reloaded.
eod

ATTR: load-balancing-dropped-total
ATTRID: 50
ATTRTYPE: AT_INT
ATTRDESC:: eod
The number of requests, subject to load balancing, dropped
by the server (i.e., were not in the server's hash bucket
assignment). This counter includes the requests since this
server was last started or reloaded.
eod

ATTR: smoothed-time-delta
ATTRID: 51
ATTRTYPE: AT_STIME
ATTRDESC:: eod
The smoothed time difference between the local server and
the partner server. If the local server's time is ahead of
the partner's, the value will be positive. If the local
server's time is behind the partner's, the value will be
negative. When the partners are not in communication, the
last known value is reported.
eod

ATTR: partner-vendor-major-version
ATTRID: 52
ATTRTYPE: AT_INT
ATTRDESC:: eod
This is the major version from the vendor ID from the partner
server.
eod

ATTR: partner-vendor-minor-version
ATTRID: 53
ATTRTYPE: AT_INT
ATTRDESC:: eod
This is the minor version from the vendor ID from the partner
server.
eod

#
# new stats for 7.0 release
#
ATTR: binding-updates-sent
ATTRID: 54
ATTRTYPE: AT_INT
ATTRDESC:: eod
The number of binding updates (BNDUPD) messages sent to
the failover partner.
eod

ATTR: binding-acks-received
ATTRID: 55
ATTRTYPE: AT_INT
ATTRDESC:: eod
The number of binding acknowledgements (BNDACK) messages
received from the failover partner.
eod

ATTR: binding-update-received
ATTRID: 56
ATTRTYPE: AT_INT
ATTRDESC:: eod
The number of binding updates (BNDUPD) messages received
from the failover partner.
eod

ATTR: binding-acks-sent
ATTRID: 57
ATTRTYPE: AT_INT
ATTRDESC:: eod
The number of binding acknowledgements (BNDACK) messages
sent to the failover partner.
eod

# End of xxxRelatedServer definitions.  If you add
# another one, be sure you read the comment above titled
# xxxRelatedServer, and update the list of related server
# object names there.

# L e a s e 6
# L E A S E 6
# Lease6

CLASS: Lease6
CLASSID: 1119
CLASSNAME: 1
CLASSPCV: 7.0.0
CLASSDESC:: eod
A DHCPv6 lease.
eod

ATTR: ip6address
ATTRID: 1
ATTRTYPE: AT_IP6NET
ATTRDESC:: eod
Specifies the IPv6 address, or its prefix, of the lease.
eod

ATTR: prefix-name
ATTRID: 2
ATTRTYPE: AT_NAMEREF(Prefix)
ATTRVAL: 1141
ATTRDESC:: eod
Identifies the prefix that contains this lease.
eod

ATTR: vpn-id
ATTRID: 3
ATTRTYPE: AT_INT
ATTRFLAGS: AF_REFERENCE
# Encode attribute 4 of VPN(1127) as 4<<16 + 1127 == 263271
ATTRVAL: 263271
ATTRDEFVAL: 0
ATTRDESC:: eod
Identifies the DHCP VPN that contains this lease.
eod

ATTR: client-id
ATTRID: 4
ATTRTYPE: AT_BLOB
ATTRDESC:: eod
Displays the DUID of the client for the lease.
eod

ATTR: client-creation-time
ATTRID: 5
ATTRTYPE: AT_DATE
ATTRVIZ: 3
ATTRDESC:: eod
Displays the time this client was first created.
eod

ATTR: client-last-transaction-time
ATTRID: 6
ATTRTYPE: AT_DATE
ATTRDESC:: eod
Displays the time of last client transaction related to this lease.
eod

ATTR: client-class-name
ATTRID: 7
ATTRTYPE: AT_NAMEREF(ClientClass)
ATTRVIZ: 5
ATTRDESC:: eod
Displays the most recently derived class name for the client.
eod

ATTR: client-vendor-class
ATTRID: 8
ATTRTYPE: AT_NLIST(AT_OPTION6)
ATTRVAL: 16
ATTRDESC:: eod
Displays the most recently received client vendor class data. Each
group of data bytes starts with the 4-byte enterprise-number
followed by the vendor-class-data bytes (if any).
eod

ATTR: client-relay-message
ATTRID: 9
ATTRTYPE: AT_MSG6
ATTRDESC:: eod
Displays the most recently received relayed message. This data
includes the complete Relay-Forw message(s) but excludes the client's
message.

eod

ATTR: client-limitation-id
ATTRID: 10
ATTRVIZ: 3
ATTRTYPE: AT_BLOB
ATTRDESC:: eod
Relates leases that have a maximum limit on the number of
simultaneous active addresses allowed. It is defined in the
client-class or client.

eod

ATTR: binding-type
ATTRID: 11
ATTRTYPE: AT_ENUMINT(IA_NA=3, IA_TA=4, IA_PD=25)
ATTRFLAGS: AF_PRINT_ALT
ATTRDESC:: eod
Specifies the type of binding for the lease. The type number matches
the DHCPv6 option number.

eod

ATTR: binding-iaid
ATTRID: 12
ATTRTYPE: AT_INT
ATTRDESC:: eod
The IAID of the binding.

eod

ATTR: creation-time
ATTRID: 13
ATTRTYPE: AT_DATE
ATTRDESC:: eod
Sets the time when the lease was created.

eod

ATTR: start-time-of-state
ATTRID: 14
ATTRTYPE: AT_DATE
ATTRDESC:: eod
Sets the time when the state last changed to its current value.
eod

ATTR: valid-lifetime
ATTRID: 15
ATTRTYPE: AT_DATE
ATTRDESC:: eod
Sets the time at which the address or prefix that was last
communicated to the client is no longer valid.
eod

ATTR: preferred-lifetime
ATTRID: 16
ATTRTYPE: AT_DATE
ATTRDESC:: eod
Sets the time at which the address or prefix that was last
communicated to the client is no longer preferred.
eod

ATTR: binding-renewal-time
ATTRID: 17
ATTRTYPE: AT_DATE
ATTRDESC:: eod
Displays the earliest time when the server requested the client
to issue a Renew request for the binding.
eod

ATTR: binding-rebinding-time
ATTRID: 18
ATTRTYPE: AT_DATE
ATTRDESC:: eod
Displays the earliest time when the server requested the client
to issue a Rebind request for the binding.
eod

ATTR: state-expiration-time
ATTRID: 19
ATTRTYPE: AT_DATE
ATTRDESC:: eod
Determines the earliest time at which the current state is to expire,
resulting in a state transition. Possible transitions are:
     OFFERED to deleted (if not reserved)
     LEASED to EXPIRED
     EXPIRED to AVAILABLE
     RELEASED to AVAILABLE
     AVAILABLE to deleted (if not reserved)
eod

ATTR: state
ATTRID: 20
ATTRTYPE: AT_ENUMINT(available=1, offered=2, leased=3, expired=4, unavailable=5, released=6, revoked=10)
ATTRFLAGS: AF_PRINT_ALT
ATTRDESC:: eod
Displays the current state of the lease:

    1  available
	   The lease is not currently leased by the client.

    2  offered
	   The lease is offered to the client.
	   In many cases, the database is not written with
	   information concerning offering a lease to a client
	   since there is no requirement to update stable
	   storage with this information.

    3  leased
	   The lease is currently leased to the client.

    4  expired
	   The client has not renewed the lease, and it expired and
       will be made available after the grace period expires.

    5  unavailable
	   The lease is unavailable.  It was made unavailable because
       of some conflict.

    6  released
	   The client has released the lease, but the server was
       configured to apply a grace period to the lease.  The
       lease won't be made available until the grace period
       expires.

    10 revoked
	   The lease is no longer usable by the client, but the
       client may still be using it.
eod

ATTR: flags
ATTRID: 21
ATTRTYPE: AT_FLAGSINT(reserved=1, valid=2, deactivated=3, initialized=4, not_in_range=6 )
ATTRFLAGS: AF_PRINT_ALT
ATTRDESC:: eod
Flags for the lease:

    1  reserved
	   The lease is reserved for some client DUID.  The table
       that relates DUID addresses to leases is in the prefix.

    3  deactivated
	   The lease is deactivated, which means that it should not
       be used.  Any client which is using a deactivated lease
       will be told to stop using that address on the next
       renewal.

For internal use only:
    initialized
    valid
    not_in_range
eod

ATTR: client-write-time
ATTRID: 22
ATTRTYPE: AT_DATE
ATTRVIZ: 3
ATTRDESC:: eod
Sets the time when the client was last written to the lease
database.

This is primarily used when loading leases at server startup to
determine which lease contains the latest client and binding
information.

eod

ATTR: client-write-sequence
ATTRID: 23
ATTRTYPE: AT_INT
ATTRVIZ: 3
ATTRDESC:: eod
Contains the sequence number for the last write of the client.

Normally, the write-time attribute is sufficient to determine
the latest client and binding information, however if the
write-time is identical in two leases, the write-seqno is used
to determine if one is newer than the other.
eod

ATTR: binding-start-time
ATTRID: 24
ATTRTYPE: AT_DATE
ATTRDESC:: eod
Within the lease database, holds the time when a lease binding
began.
eod

ATTR: binding-end-time
ATTRID: 25
ATTRTYPE: AT_DATE
ATTRDESC:: eod
Within the lease database, this holds the time when a lease binding
ended.
eod

ATTR: client-active-leases
ATTRID: 26
ATTRTYPE: AT_INT
ATTRDESC:: eod
Shows the number of active leases that a client currently
has in use.
eod

# CNR 6.2T3 had this attribute defined
ATTR: reservation-client-id
ATTRID: 27
ATTRTYPE: AT_BLOB
ATTRVIZ: 1
DEPRECATED: 7.0
ATTRDESC:: eod
Specifies the DUID of the client for which this lease is reserved.

eod

# CNR 6.2T3 had this attribute defined
ATTR: client-override-client-id
ATTRID: 28
ATTRTYPE: AT_BLOB
ATTRVIZ: 1
DEPRECATED: 7.0
ATTRDESC:: eod
Specifies the value of the v6-override-client-id expression for this
client.  If it appears, it is used as the client-id for this client.
eod

ATTR: reservation-lookup-key
ATTRID: 29
ATTRTYPE: AT_BLOB
ATTRDESC:: eod
Retrieves the lookup key of a lease reservation,

eod

ATTR: reservation-lookup-key-type
ATTRID: 30
ATTRTYPE: AT_INT
ATTRVIZ: 3
ATTRDESC:: eod
Determines the type of the reservation-lookup-key attribute.
eod

ATTR: client-lookup-key
ATTRID: 31
ATTRTYPE: AT_BLOB
ATTRDESC:: eod
Provides the lookup key for the client - it is either the client
identifier (DUID) or the v6-override-client-id expression.
eod

ATTR: client-lookup-key-type
ATTRID: 32
ATTRTYPE: AT_INT
ATTRVIZ: 3
ATTRDESC:: eod
Determines the type of the client-lookup-key attribute.
eod

ATTR: client-relay-address
ATTRID: 33
ATTRTYPE: AT_IP6ADDR
ATTRDESC:: eod
If present, displays the source address from the most recently
received Relay-Forw message. If not present, the client communicated
directly to the server.
eod

ATTR: client-user-defined-data
ATTRID: 34
ATTRTYPE: AT_STRING
ATTRDESC:: eod
Enables customer applications to relate the client record to other
databases.  It is not used directly by the DHCP server, but may be
read and written by extensions and expressions.

eod

ATTR: client-vendor-info
ATTRID: 35
ATTRTYPE: AT_NLIST(AT_OPTION6)
ATTRVAL: 17
ATTRDESC:: eod
The most recently received vendor-specific information
options data from the client. Each group of data bytes
starts with the 4-byte enterprise-number followed by the
option-data bytes (if any).
eod

ATTR: client-reconfigure-key
ATTRID: 36
ATTRTYPE: AT_BLOB
ATTRDESC:: eod
The 128-bit key required for Reconfigure Messages to the client
per the RFC 3315 Reconfigure Key Authentication Protocol.
eod

ATTR: client-reconfigure-key-generation-time
ATTRID: 37
ATTRTYPE: AT_DATE
ATTRDESC:: eod
The time at which the client-reconfigure-key was generated.
eod

ATTR: requested-fqdn
ATTRID: 38
ATTRTYPE: AT_ROF_FQDN
ATTRDESC:: eod
The partial or fully qualified domain name most recently
requested by the client for the lease.
eod

ATTR: fqdn
ATTRID: 39
ATTRTYPE: AT_DNSNAME
ATTRDESC:: eod
The fully qualified domain name assigned to the lease by the
server (and possibly successfully entered into DNS).
eod

# This attribute's flags and the FQDNRemovalData attribute of
# the same name MUST have the same flag bits defined!
ATTR: dns-update-flags
ATTRID: 40
ATTRTYPE: AT_FLAGSINT(forward-uptodate=1, reverse-uptodate=2, update-pending=3, add-pending=4, delete-pending=5, synthesized-name=6, using-requested-fqdn=7)
ATTRDESC:: eod
The dns update flags maintained for the lease / fqdn binding.
eod

ATTR: forward-dnsupdate
ATTRID: 41
ATTRVAL: 1145
ATTRTYPE: AT_NAMEREF(DnsUpdateConfig)
ATTRDESC:: eod
Names the forward zone's DNS Update Configuration object
for the lease.
eod

ATTR: reverse-dnsupdate
ATTRID: 42
ATTRTYPE: AT_NAMEREF(DnsUpdateConfig)
ATTRVAL: 1145
ATTRDESC:: eod
Names the reverse zone's DNS update configuration object
for the lease.
eod

ATTR: fqdn-host-label-count
ATTRID: 43
ATTRTYPE: AT_INT
ATTRDEFVAL: 1
ATTRDESC:: eod
The number of labels in the fqdn that constitute the
host name portion.
eod

ATTR: name-number
ATTRID: 44
ATTRTYPE: AT_INT
ATTRDESC:: eod
The numeric characters in the fqdn, if any, that were added
by the DHCP server to disambiguate the host name.
eod

ATTR: fqdn-removal-data
ATTRID: 45
ATTRTYPE: AT_NLIST(AT_OBJ(FQDNRemovalData))
ATTRVAL: 1152
ATTRVIZ: 3
ATTRDESC:: eod
The fqdn, dns-update-flags, forward-dnsupdate, and
reverse-dnsupdate for previous fully qualified domain names
previously assigned to the lease by the server and awaiting
removal from DNS.
eod

# End of Lease6 Class

#
# dhcp option data-type class: used to describe vendor-specific
# option data
#

CLASS: OptionDataType-Field
CLASSROOT: OPTIONDATATYPE_FIELD
CLASSID: 1120
CLASSVIZ: 5
CLASSNAME: 1
CLASSPCV: 1.0.0
CLASSDEPRECATED: 7.0.0

ATTR: name
ATTRID: 1
ATTRHDRNAME: AO_OPTIONDATATYPE_FIELD_NAME
ATTRTYPE: AT_STRING
ATTRMCDPATH: name
ATTRVIZ: 5

ATTR: number
ATTRID: 2
ATTRHDRNAME: AO_OPTIONDATATYPE_FIELD_NUMBER
ATTRTYPE: AT_INT
ATTRMCDPATH: number
ATTRVIZ: 5

ATTR: length
ATTRID: 3
ATTRHDRNAME: AO_OPTIONDATATYPE_FIELD_LENGTH
ATTRTYPE: AT_INT
ATTRMCDPATH: length
ATTRVIZ: 5

ATTR: type
ATTRID: 4
ATTRHDRNAME: AO_OPTIONDATATYPE_FIELD_TYPE
# note: type currently omits OVERLOAD, OT_MESSAGE, OT_REQUEST,
# OT_NODE, OT_IPADDRPAIR, OT_IPNET
# note: this MUST be kept in sync with the option_type enum in
# optiondesc.h !!!
ATTRTYPE: AT_ENUMINT(PAD=0, BOOL, INT, INT_ARRAY, STRING, IPADDR, IPADDR_ARRAY, BYTE, BYTE_ARRAY, WORD, WORD_ARRAY, UINT, UINT_ARRAY)
ATTRMCDPATH: type
ATTRVIZ: 5
ATTRFLAGS: AF_PRINT_ALT

ATTR: flags
ATTRID: 5
ATTRHDRNAME: AO_OPTIONDATATYPE_FIELD_FLAGS
ATTRTYPE: AT_FLAGSINT( little-endian=1, exclude-from-dhcp-packet=2, counted-array=3 )
ATTRMCDPATH: flags
ATTRVIZ: 5

# Class "OptionType" definition starts here
#
# nrmcd> option-datatype <name> { create | delete | list }
# nrmcd> option-datatype <name> enable | disable } read-only
# nrcmd> option-datatype <name> definefield <field-name>
# <field-number> <DHCP option type> [<flags>]
# nrcmd> option-datatype <name> undefinefield <field-name>
# nrcmd> option-datatype <name> listfields
#

CLASS: OptionDataType
CLASSROOT: OPTIONDATATYPE
CLASSID: 1121
CLASSNAME: 1
CLASSPCV: 1.0.0
CLASSDEPRECATED: 7.0.0

ATTR: name
ATTRID: 1
ATTRHDRNAME: AO_OPTIONDATATYPE_NAME
ATTRTYPE: AT_STRING
ATTRMCDPATH: name
ATTRVIZ: 5
ATTRDESC:: eod
The name of the option-datatype.
eod

ATTR: read-only
ATTRID: 3
ATTRHDRNAME: AO_OPTIONDATATYPE_READ_ONLY
ATTRTYPE: AT_BOOL
ATTRFLAGS: AF_FEATURE, AF_INITIALIZE
ATTRDEFVAL: false
ATTRMCDPATH: read-only
ATTRVIZ: 5
ATTRDESC:: eod
If read-only is enabled, DHCP server will not allow changes to
option-datatype. When an option-datatype is create, read-only
is disabled by default.
eod

ATTR: fields
ATTRID: 2
ATTRHDRNAME: AO_OPTIONDATATYPE_FIELDS
ATTRTYPE: AT_NLIST(AT_OBJ(OptionDataType-Field))
# 1<<16 | 1120
ATTRVAL: 66656
ATTRMCDPATH: fields
ATTRVIZ: 3
ATTRDESC:: eod
Lists the fields in the option-datatype.
eod

CLASS: VendorSubOption
CLASSROOT: VENDORSUBOPTION
CLASSID: 1122
CLASSVIZ: 3
CLASSNAME: 1
CLASSPCV: 1.0.0
CLASSDEPRECATED: 7.0.0

ATTR: name
ATTRID: 1
ATTRHDRNAME: AO_VENDORSUBOPTION_NAME
ATTRTYPE: AT_STRING
ATTRMCDPATH: name
ATTRVIZ: 5

ATTR: suboption-number
ATTRID: 2
ATTRHDRNAME: AO_VENDORSUBOPTION_SUBOPTION_NUMBER
ATTRTYPE: AT_INT
ATTRMCDPATH: suboption-number
ATTRVIZ: 5

ATTR: option-datatype-name
ATTRID: 3
ATTRHDRNAME: AO_VENDORSUBOPTION_OPTIONDATATYPE_NAME
ATTRTYPE: AT_STRING
ATTRMCDPATH: option-datatype-name
ATTRVIZ: 5

ATTR: flags
ATTRID: 4
ATTRHDRNAME: AO_VENDORSUBOPTION_FLAGS
ATTRTYPE: AT_FLAGSINT( array=1, no-suboption-opcode=2, no-suboption-len=3, no-suboption-data=4 )
ATTRMCDPATH: flags
ATTRVIZ: 5

CLASS: VendorOption
CLASSROOT: VENDOROPTION
CLASSID: 1123
CLASSNAME: 1
CLASSPCV: 1.0.0
CLASSDEPRECATED: 7.0.0

ATTR: name
ATTRID: 1
ATTRHDRNAME: AO_VENDOROPTION_NAME
ATTRTYPE: AT_STRING
ATTRMCDPATH: name
ATTRVIZ: 5
ATTRDESC:: eod
The name of the vendor-option. The name cannot have a '-' (hyphen)
character in it.
eod

ATTR: vendor-class-id
ATTRID: 2
ATTRHDRNAME: AO_VENDOROPTION_VENDOR_CLASS_ID
ATTRTYPE: AT_STRING
ATTRMCDPATH: vendor-class-id
ATTRVIZ: 5
ATTRDESC:: eod
Contains the vendor class identifier string provided by the DHCP
client device vendor.  The DHCP server uses this string to identify
the DHCP client device and return appropriate vendor specific option
data.
eod

# Not yet implemeneted. (dhcp-offer-reply, dhcp-offer-reply)
ATTR: dhcp-offer-reply
ATTRID: 3
ATTRHDRNAME: AO_VENDOROPTION_DHCP_OFFER_REPLY
ATTRTYPE: AT_LIST(AT_STRING)
ATTRMCDPATH: dhcp-offer-reply
ATTRVIZ: 3
ATTRDESC:: eod
Lists the suboption names (in this vendor-option) that should
always be part of DHCPOFFER packet, sent to the DHCP client device.
eod

ATTR: dhcp-ack-reply
ATTRID: 4
ATTRHDRNAME: AO_VENDOROPTION_DHCP_ACK_REPLY
ATTRTYPE: AT_LIST(AT_STRING)
ATTRMCDPATH: dhcp-ack-reply
ATTRVIZ: 3
ATTRDESC:: eod
Lists the suboption names (in this vendor-option) that should
always be part of DHCPACK packet, sent to the DHCP client device.
eod

ATTR: suboptions
ATTRID: 5
ATTRHDRNAME: AO_VENDOROPTION_SUBOPTIONS
ATTRTYPE: AT_NLIST(AT_OBJ(VendorSubOption))
# 1<<16 | 1122
ATTRVAL: 66658
ATTRMCDPATH: suboptions
ATTRVIZ: 3
ATTRDESC:: eod
Lists the suboption within a vendor-option.
eod

ATTR: read-only
ATTRID: 6
ATTRHDRNAME: AO_VENDOROPTION_READ_ONLY
ATTRTYPE: AT_BOOL
ATTRFLAGS: AF_FEATURE, AF_INITIALIZE
ATTRDEFVAL: false
ATTRMCDPATH: read-only
ATTRVIZ: 5
ATTRDESC:: eod

Determines whether a DHCP server allows changes to vendor-option.
If read-only is enabled, DHCP server will not allow changes to
vendor-option. When a new vendor-option is create, read-only is
disabled.
eod

ATTR: vendor-option-number
ATTRID: 7
ATTRHDRNAME: AO_VENDOROPTION_OPTION_NUMBER
ATTRTYPE: AT_RANGEINT(1-255)
ATTRFLAGS: AF_INITIALIZE
ATTRDEFVAL: 43
ATTRMCDPATH: vendor-option-number
ATTRVIZ: 3
ATTRDESC:: eod
By default, vendor-option-number is set to 43 (RFC 2132). For
non-standard DHCP client devices the option number must be
assigned a value based on the device vendor specification.
eod

# VendorOptionData - object to hold the data for vendor-option
# (used in policy object).
CLASS: VendorOptionData
CLASSROOT: VENDOROPTIONDATA
CLASSID: 1124
CLASSVIZ: 3
CLASSNAME: 1
CLASSPCV: 1.0.0
CLASSDEPRECATED: 7.0.0

ATTR: name
ATTRID: 1
ATTRHDRNAME: AO_VENDOROPTIONDATA_NAME
ATTRTYPE: AT_STRING
ATTRMCDPATH: name
ATTRVIZ: 5

ATTR: vendor-class-id
ATTRID: 2
ATTRHDRNAME: AO_VENDOROPTIONDATA_VENDOR_CLASS_ID
ATTRTYPE: AT_STRING
ATTRMCDPATH: vendor-class-id
ATTRVIZ: 5

ATTR: data
ATTRID: 3
ATTRHDRNAME: AO_VENDOROPTIONDATA_DATA
ATTRTYPE: AT_ARRAY(VendorSubOptionData)
ATTRMCDPATH: data
ATTRVIZ: 3

ATTR: wireformat-data
ATTRID: 4
ATTRHDRNAME: AO_VENDOROPTIONDATA_WIREFORMAT_DATA
ATTRTYPE: AT_BLOB
ATTRMCDPATH: wireformat-data
ATTRVIZ: 3

#
#VendorSubOptionData - object to hold the data for each Sub-option
#

CLASS: VendorSubOptionData
CLASSROOT: VENDORSUBOPTIONDATA
CLASSID: 1125
CLASSVIZ: 3
CLASSNAME: 1
CLASSPCV: 1.0.0
CLASSDEPRECATED: 7.0.0

ATTR: suboption-name
ATTRID: 1
ATTRHDRNAME: AO_VENDOROSUBPTIONDATA_SUBOPTION_NAME
ATTRTYPE: AT_STRING
ATTRMCDPATH: suboption-name
ATTRVIZ: 5

ATTR: suboption-number
ATTRID: 2
ATTRHDRNAME: AO_VENDOROSUBPTIONDATA_SUBOPTION_NUMBER
ATTRTYPE: AT_INT
ATTRMCDPATH: suboption-number
ATTRVIZ: 5

ATTR: suboption-array-data
ATTRID: 3
ATTRHDRNAME: AO_VENDOROSUBPTIONDATA_SUBOPTION_ARRAY_DATA
ATTRTYPE: AT_ARRAY(AT_LISTREF(OptionDataTypeFieldData))
ATTRMCDPATH: suboption-array-data
ATTRVIZ: 3

# OptionDataTypeFieldData - hold data for a field within
# option-datatype
CLASS: OptionDataTypeFieldData
CLASSROOT: OPTIONDATATYPEFIELDDATA
CLASSID: 1126
CLASSVIZ: 3
CLASSNAME: 1
CLASSPCV: 1.0.0
CLASSDEPRECATED: 7.0.0

ATTR: field-name
ATTRID: 1
ATTRHDRNAME: AO_OPTIONDATATYPEFIELDDATA_FIELD_NAME
ATTRTYPE: AT_STRING
ATTRMCDPATH: name
ATTRVIZ: 5

ATTR: suboption-name
ATTRID: 2
ATTRHDRNAME: AO_OPTIONDATATYPEFIELDDATA_SUBOPTION_NAME
ATTRTYPE: AT_STRING
ATTRMCDPATH: suboption-name
ATTRVIZ: 5

ATTR: suboption-index
ATTRID: 3
ATTRHDRNAME: AO_OPTIONDATATYPEFIELDDATA_SUBOPTION_INDEX
ATTRTYPE: AT_INT
ATTRMCDPATH: suboption-index
ATTRVIZ: 5

ATTR: field-data
ATTRID: 4
ATTRHDRNAME: AO_OPTIONDATATYPEFIELDDATA_FIELD_DATA
ATTRTYPE: AT_BLOB
ATTRMCDPATH: field-data
ATTRVIZ: 5

#
# VPN object for dhcp (formerly the namespace object)
#

CLASS: VPN
CLASSROOT: VPN
CLASSID: 1127
CLASSNAME: 1
CLASSKEY: 4
CLASSVIZ: 5
CLASSPCV: 3.0.0
CLASSDESC:: eod
A VPN. A VPN is used to support VPN-aware DHCP and
address-space management.
eod

ATTR: name
ATTRID: 1
ATTRTYPE: AT_STRING
ATTRFLAGS: AF_REQUIRED, AF_UNIQUE
ATTRDESC:: eod
The VPN's name within the CNR management system. Independent from,
but could be the same as the vrf-name.
eod

ATTR: vpn-id
ATTRID: 2
ATTRHDRNAME: AO_VPN_VPNID
ATTRTYPE: AT_VPNID
ATTRDESC:: eod
The vpn-id in RFC 2685 format (i.e, 7 octets),
using a syntax similar to that used by IOS to enter the
same information.  The syntax is 3 hex octets, a colon,
and 4 hex octets.  For example 010203:04050607 would
be the way to enter the following hex octets:
01:02:03:04:05:06:07 into this property.
eod

ATTR: vrf-name
ATTRID: 3
ATTRTYPE: AT_STRING
ATTRDESC:: eod
The VPN's VRF name.
eod

ATTR: id
ATTRID: 4
ATTRTYPE: AT_INT
ATTRFLAGS: AF_REQUIRED, AF_IMMUTABLE, AF_UNIQUE
ATTRDESC:: eod
The VPN's unique id.  This is a 32 bit value that is associated
with every VPN-qualified IP address, subnet or address block.
It is different than and unrelated to the standard 7-byte VPN-ID.
eod

ATTR: description
ATTRID: 5
ATTRTYPE: AT_STRING
ATTRDESC:: eod
Describes the VPN that this  object represents.
eod

ATTR: addr-blocks-use-lan-segments
ATTRID: 6
ATTRHDRNAME: AO_VPN_BLOCKS_USE_LANSEGMENTS
ATTRTYPE: AT_BOOL
ATTRVIZ: 5
ATTRDESC:: eod
Controls whether DHCP subnet-allocation uses the
lan-segment attribute when configured on address-blocks.


eod

ATTR: addr-blocks-use-client-affinity
ATTRID: 7
ATTRHDRNAME: AO_VPN_BLOCKS_USE_AFFINITY
ATTRTYPE: AT_BOOL
ATTRVIZ: 5
ATTRDESC:: eod
Determines whether the DHCP server attempts to allocate
subnets to clients using address-blocks that the clients
have already used. Default is true (enable).

If you disable this attribute, the server then supplies
subnets from any block that is suitable, based on other
selection data in the clients' messages.

eod

ATTR: addr-blocks-use-selection-tags
ATTRID: 8
ATTRHDRNAME: AO_VPN_BLOCKS_USE_TAGS
ATTRTYPE: AT_BOOL
ATTRVIZ: 5
ATTRDESC:: eod
Controls whether the server compares the subnet name data in
incoming subnet-allocation requests with each address-block's
selection tags. A block will only be considered if the
two match. No default.
eod

ATTR: addr-blocks-default-selection-tags
ATTRID: 9
ATTRHDRNAME: AO_VPN_BLOCKS_DEFAULT_TAGS
ATTRTYPE: AT_ARRAY(AT_STRING)
ATTRVIZ: 5
ATTRDESC:: eod
Specifies the default selection tag (or list of tags) that will
be associated with incoming subnet-allocation requests in this
vpn that do not contain any subnet name data. No
default.
eod

ATTR: cluster-id
ATTRID: 10
ATTRTYPE: AT_SHORT
ATTRVIZ: 1
DEPRECATED: 7.0
ATTRFLAGS: AF_REFERENCE
# Encode attribute 11 of Cluster(1449) as 11<<16 + 1449 == 722345
ATTRVAL: 722345
ATTRDESC:: eod
The id of the (local) cluster that is the authoritative source
for this object.  This attribute is set as part of replica data
propagation.
eod

ATTR: replica-deleted
ATTRID: 11
ATTRTYPE: AT_BYTE
ATTRVIZ: 1
DEPRECATED: 7.0
ATTRDESC:: eod
A marker that the replica propagation code thinks that this
object should be deleted.  This is used rather than removing
the cluster-id value so we can tell when an object has been
created by replica propagation and then should be deleted.
eod

#
# Address Block class (for dhcp)
#

CLASS: AddrBlock
CLASSROOT: ADDRBLOCK
CLASSID: 1128
CLASSNAME: 1
CLASSVIZ: 5
CLASSPCV: 3.0.0
CLASSDESC:: eod
A contiguous block of IPv4 address space for use in DHCP
subnet-allocation.
eod

ATTR: name
ATTRID: 1
ATTRHDRNAME: AO_ADDRBLOCK_NAME
ATTRTYPE: AT_STRING
ATTRDESC:: eod
Defines the name of the address-block. This value is defined
when you create the address block.
eod

ATTR: address
ATTRID: 2
ATTRHDRNAME: AO_ADDRBLOCK_ADDRESS
ATTRTYPE: AT_SUBNET
ATTRFLAGS: AF_REQUIRED
ATTRDESC:: eod
Determines the IP subnet address (in the address/mask format) of
a DHCP address block. This value is defined when you create the
address block.
eod

ATTR: default-subnet-size
ATTRID: 3
ATTRHDRNAME: AO_ADDRBLOCK_DEFAULT_SUBNET
ATTRTYPE: AT_INT
ATTRDEFVAL: 28
ATTRDESC:: eod
Sets the default subnet size for allocations from this address
block.
eod

ATTR: subnet-increment
ATTRID: 4
ATTRHDRNAME: AO_ADDRBLOCK_SUBNET_INCREMENT
ATTRTYPE: AT_INT
ATTRVIZ: 3
ATTRDESC:: eod
The default size of subsequent subnets to allocate from this
address block.
eod

ATTR: vpn-id
ATTRID: 5
ATTRHDRNAME: AO_ADDRBLOCK_VPN_ID
ATTRTYPE: AT_INT
ATTRFLAGS: AF_REFERENCE
# Encode attribute 4 of Vpn(1127) as 4<<16 + 1127 == 263271
ATTRVAL: 263271
ATTRDEFVAL: 0
ATTRDESC:: eod
Sets the VPN identifier for the VPN that contains this address-block.
eod

ATTR: policy
ATTRID: 6
ATTRHDRNAME: AO_ADDRBLOCK_POLICY
ATTRTYPE: AT_NAMEREF(Policy)
ATTRVAL: 1102
ATTRFLAGS: AF_REQUIRED
ATTRDEFVAL: default
ATTRDESC:: eod
Identifies the name of the policy associated with this address-block.
eod

ATTR: embedded-policy
ATTRID: 7
ATTRHDRNAME: AO_ADDRBLOCK_EMBEDDED_POLICY
ATTRTYPE: AT_OBJ(Policy)
ATTRDESC:: eod
Displays the embedded policy object for this DHCP address block.
Read-only. Use the dhcp-address-block-policy command to set the
embedded policy.
eod

ATTR: segment-name
ATTRID: 8
ATTRHDRNAME: AO_ADDRBLOCK_SEGMENT_NAME
ATTRTYPE: AT_STRING
ATTRDESC:: eod
Designates the LAN segment name for this DHCP address block. To group
multiple, logical IP subnets on a single, physical network, give each
DHCP address block the same segment-name string. The server ignores
character case when comparing values.

eod

ATTR: selection-tags
ATTRID: 9
ATTRHDRNAME: AO_ADDRBLOCK_SELECTION_TAGS
ATTRTYPE: AT_STRING
ATTRDESC:: eod
Lists tag strings that are compared with incoming selection tags in
an allocation request. All tags in the request must match a DHCP
address blocks selection tags for that block to satisfy the request.

Separate multiple tags with a comma (do not include commas in tag
names).
eod

ATTR: deprecated
ATTRID: 10
ATTRHDRNAME: AO_ADDRBLOCK_DEPRECATED
ATTRTYPE: AT_BOOL
ATTRDEFVAL: false
ATTRDESC:: eod

Determines whether the server deactivates a DHCP address block.
The server ignores a deprecated DHCP address block for new subnet
allocations. It allows existing clients to renew their subnets, but
indicates to them that the subnet is deprecated. The client then
prepares to release the deprecated subnet or subnets back to the
server.

eod

#
# subnet class, for dhcp
#

CLASS: Subnet
CLASSROOT: SUBNET
CLASSID: 1129
CLASSNAME: 1
CLASSVIZ: 5
CLASSPCV: 3.0.0
CLASSDESC:: eod
An IPv4 subnet that has been leased to a DHCP subnet-allocation
client.
eod

ATTR: address
ATTRID: 1
ATTRHDRNAME: AO_SUBNET_ADDRESS
ATTRTYPE: AT_SUBNET
ATTRFLAGS: AF_IMMUTABLE
ATTRDESC:: eod
Displays the subnet address, including the mask.
eod

ATTR: in-use-addresses
ATTRID: 2
ATTRHDRNAME: AO_SUBNET_STAT_IN_USE
ATTRTYPE: AT_INT
ATTRDESC:: eod
Displays the number of addresses currently being used by hosts.
eod

ATTR: unusable-addresses
ATTRID: 3
ATTRHDRNAME: AO_SUBNET_STAT_UNUSABLE
ATTRTYPE: AT_INT
ATTRDESC:: eod
The number of addresses marked unusable.
eod

ATTR: high-water
ATTRID: 4
ATTRHDRNAME: AO_SUBNET_STAT_HIGH_WATER
ATTRTYPE: AT_INT
ATTRDESC:: eod
Displays the highest utilization level recorded since the last time
that statistics were retrieved.
eod

ATTR: vpn-id
ATTRID: 5
ATTRHDRNAME: AO_SUBNET_VPN_ID
ATTRTYPE: AT_INT
ATTRFLAGS: AF_REFERENCE
# Encode attribute 4 of Vpn(1127) as 4<<16 + 1127 == 263271
ATTRVAL: 263271
ATTRDEFVAL: 0
ATTRDESC:: eod
Identifies the VPN that contains this subnet.
eod

ATTR: state
ATTRID: 6
ATTRHDRNAME: AO_SUBNET_CURRENT_STATE
ATTRTYPE: AT_ENUMINT(none=0, available=1, other-available=2, offered=3, leased=4, expired=5, released=6, unavailable=7, pending-available=8)
ATTRFLAGS: AF_PRINT_ALT
ATTRDESC:: eod
Displays the state of the subnet.
eod

ATTR: previous-state
ATTRID: 7
ATTRHDRNAME: AO_SUBNET_PREV_STATE
ATTRTYPE: AT_ENUMINT(none=0, available=1, other-available=2, offered=3, leased=4, expired=5, released=6, unavailable=7, pending-available=8)
ATTRFLAGS: AF_PRINT_ALT
ATTRVIZ: 3
ATTRDESC:: eod
The previous state, useful for history logging.
eod

ATTR: expiration
ATTRID: 8
ATTRHDRNAME: AO_SUBNET_EXPIRATION
ATTRTYPE: AT_DATE
ATTRVIZ: 5
ATTRDESC:: eod
Displays the expiration time of the subnet binding.
eod

ATTR: last-transaction-time
ATTRID: 9
ATTRHDRNAME: AO_SUBNET_LAST_TRANS_TIME
ATTRTYPE: AT_DATE
ATTRVIZ: 5
ATTRDESC:: eod

Displays the time at which the client last communicated with the
server about this subnet. Read only.
eod

ATTR: client-id
ATTRID: 10
ATTRHDRNAME: AO_SUBNET_CLIENT_ID
ATTRTYPE: AT_BLOB
ATTRDESC:: eod
Displays the client-id of the subnet's client.
eod

ATTR: client-flags
ATTRID: 11
ATTRHDRNAME: AO_SUBNET_CLIENT_FLAGS
ATTRTYPE: AT_FLAGSINT(client-valid=1, client-id-created-from-mac-address=2)
ATTRDESC:: eod
Displays either client-valid or client-id-created-from-mac-address
(the client ID was created for internal use from the client MAC
address).

eod

ATTR: client-mac-addr
ATTRID: 12
ATTRHDRNAME: AO_SUBNET_CLIENT_MAC_ADDR
ATTRTYPE: AT_MACADDR
ATTRMCDPATH: client-mac-addr
ATTRVIZ: 5
ATTRDESC:: eod
Displays the MAC address which the client presented to the DHCP
server.
eod

ATTR: client-domain-name
ATTRID: 13
ATTRHDRNAME: AO_SUBNET_CLIENT_DOMAIN_NAME
ATTRTYPE: AT_STRING
ATTRMCDPATH: client-domain-name
ATTRVIZ: 5
ATTRDESC:: eod
Displays the domain name the client specified in its messages (if
any).
eod

ATTR: client-host-name
ATTRID: 14
ATTRHDRNAME: AO_SUBNET_CLIENT_HOST_NAME
ATTRTYPE: AT_STRING
ATTRMCDPATH: client-host-name
ATTRVIZ: 5
ATTRDESC:: eod
Displays the host name that the client specified (if any).
eod

ATTR: client-last-transaction-time
ATTRID: 15
ATTRHDRNAME: AO_SUBNET_CLIENT_LAST_TRANS_TIME
ATTRTYPE: AT_DATE
ATTRMCDPATH: client-last-trans-time
ATTRVIZ: 5
ATTRDESC:: eod
Displays the time when the client last contacted the DHCP server.
eod

ATTR: client-class-name
ATTRID: 16
ATTRHDRNAME: AO_SUBNET_CLIENT_CLASS_NAME
ATTRTYPE: AT_STRING
ATTRVIZ: 3
ATTRDESC:: eod
eod

ATTR: version
ATTRID: 17
ATTRHDRNAME: AO_SUBNET_VERSION
ATTRTYPE: AT_VERSION
ATTRMCDPATH: version
ATTRVIZ: 3
ATTRDESC:: eod
The (internal) version of the subnet data blob.
eod

ATTR: relay-agent-option
ATTRID: 18
ATTRHDRNAME: AO_SUBNET_CLIENT_RELAY_AGENT_OPTION
ATTRTYPE: AT_BLOB
ATTRVIZ: 5
ATTRDESC:: eod
Displays the contents of the relay agent information option from
the most recent client interaction. Read only.
eod

ATTR: selection-tags
ATTRID: 19
ATTRHDRNAME: AO_SUBNET_CLIENT_SELECTION_TAGS
ATTRTYPE: AT_STRING
ATTRVIZ: 5
ATTRDESC:: eod
Displays the selection-tag string that the client presented when
it last leased or renewed the subnet binding. Read only.
eod

ATTR: all-vpns
ATTRID: 20
ATTRTYPE: AT_BOOL
ATTRDESC:: eod
Provides failover configuration information for this subnet.

If true, this subnet is configured to use the same failover
configuration for all VPNs. Read only.
eod

# end of Subnet class
CLASS: Range
CLASSROOT: RANGE
CLASSID: 1130
CLASSPCV: 4.0.0
CLASSDESC:: eod
A simple contiguous range of IPv4 addresses, represented by the
start and end of the range.
eod

# save ATTR: 1 for compatability w/ CCMIPRange
ATTR: start
ATTRID: 2
ATTRTYPE: AT_IPADDR
ATTRDESC:: eod
The first address in this range.
eod

ATTR: end
ATTRID: 3
ATTRTYPE: AT_IPADDR
ATTRDESC:: eod
The last address in this range.
eod

CLASS: Option
CLASSROOT: NEWOPTION
CLASSID: 1131
CLASSPCV: 7.0.0
CLASSDESC:: eod
A DHCP Option, used to hold configuration information for DHCP
clients.
eod

ATTR: number
ATTRID: 1
ATTRTYPE: AT_INT
ATTRDESC:: eod
The option number (the T part of the TLV)
eod

ATTR: value
ATTRID: 2
ATTRTYPE: AT_BLOB
ATTRDESC:: eod
The option value (the V part of the TLV)
eod

ATTR: sub-options
ATTRID: 3
ATTRTYPE: AT_NLIST(AT_OBJ(Option))
# 1<<16 | 1131
ATTRVAL: 66667
ATTRDESC:: eod
This attribute provides for the optional subdivision of
option data into nested sub-option objects.  This is
not used for storing DHCP server configuration, but may be
useful in other uses of TLV based values.
eod

ATTR: option-desc
ATTRID: 4
# ATTRTYPE: AT_OID
ATTRTYPE: AT_OBJREF(AttrDesc)
ATTRVAL: 2
ATTRDESC:: eod
The option description that provides the type and name
for this specific option.  This is a shortcut for a
lookup by id in the appropriate TLV desc table.
eod

ATTR: option-definition-set-name
ATTRID: 5
ATTRTYPE: AT_NAMEREF(OptionDefinitionSet)
ATTRVAL: 23
ATTRDESC:: eod
A reference to the option-definition-set used to create
this option instance.
eod

#
# Network class
#

CLASS: Network
CLASSID: 1132
CLASSKEY: 2
CLASSPCV: 4.0.0
CLASSDEPRECATED: 7.0.0
CLASSDESC:: eod
A network represents a group of IP subnets that are
in the same broadcast domain.  A common example
of the need for a network is when a router interface
has secondary subnets and the DHCP server needs to
be told that these diverse subnets are topologically
related to the primary subnet on the router interface.
This concept has also been known as lan-segment.
eod

ATTR: name
ATTRID: 1
ATTRFLAGS: AF_REQUIRED
ATTRTYPE: AT_STRING
ATTRDESC:: eod
The name of this network.
eod

ATTR: subnet
ATTRID: 2
ATTRFLAGS: AF_REQUIRED, AF_IMMUTABLE, AF_UNIQUE
ATTRTYPE: AT_SUBNET
ATTRDESC:: eod
The subnet that uniquely defines this network.  This
is usually the primary subnet on a router interface
or the subnet of the primary scope in a group of
primary/secondary scopes.
eod

ATTR: vpn
ATTRID: 3
ATTRTYPE: AT_INT
ATTRFLAGS: AF_REFERENCE
# Encode attribute 4 of Vpn(1127) as 4<<16 + 1127 == 263271
ATTRVAL: 263271
ATTRDEFVAL: 0
ATTRDESC:: eod
The VPN that contains the subnet for this network.
eod

ATTR: secondary-subnets
ATTRID: 4
ATTRTYPE: AT_NLIST(AT_SUBNET)
ATTRDESC:: eod
Lists the secondary subnets in this network.
eod

CLASS: FailoverPair
CLASSROOT: FOPAIR
CLASSID: 1133
CLASSNAME: 12
CLASSPCV: 4.0.0
CLASSDEPRECATED: 7.0.0
CLASSDESC:: eod
The FailoverPair object represents a failover pair relationship
from the perspective of a specific DHCP server.  The related
CCMFailoverPair object represents failover relationships
from a perspective that is independent of either DHCP server.
eod

ATTR: name
ATTRID: 1
ATTRFLAGS: AF_REQUIRED
ATTRTYPE: AT_STRING
ATTRDESC:: eod
Designates the name of this failover pair.

eod

# We are using AT_IPADDR rather than the more general AT_STRING
# because we want to eliminate the ambiguity introduced by
# supporting DNS names, and because it more closely matches the
# actual server behavior.
ATTR: main-server
ATTRID: 2
ATTRFLAGS: AF_REQUIRED
ATTRTYPE: AT_IPADDR
ATTRDESC:: eod
Specifies the primary IP address of the main server.  The
distinguished value 0.0.0.0 refers to the local DHCP server.
For two reasons, you should explicitly specify the IP address:

1) The failover protocol uses explicit IP addresses.
2) The main and backup server must agree on what IP addresses
to use to define a failover pair.

Therefore, provide the address, rather than have the server pick
from one of many addresses associated with its interfaces.

eod

ATTR: backup-server
ATTRID: 3
ATTRFLAGS: AF_REQUIRED
ATTRTYPE: AT_IPADDR
ATTRDESC:: eod
Specifies the primary IP address of the backup server.  The
distinguished value 0.0.0.0 refers to the local DHCP server.
For two reasons, you should explicitly specify the IP address:

1) The failover protocol uses explicit IP addresses.
2) The main and backup server must agree on what IP addresses
to use to define a failover pair.

Therefore, provide the address, rather than have the server pick
from one of many addresses associated with its interfaces.

eod

ATTR: backup-percentage
ATTRID: 4
ATTRTYPE: AT_INT
ATTRDEFVAL: 10
ATTRVIZ: 5
ATTRDESC:: eod
Controls the percentage of available addresses that the main server
should send to the backup server. You must define this value on the
main server. If you define it on a backup server, the value is
ignored to enable copying of configurations. The value you define
here is used as the default value on a scope, unless you have
explicitly configured another value.

eod

ATTR: remote-username
ATTRID: 5
ATTRTYPE: AT_STRING
ATTRVIZ: 5
ATTRDESC:: eod
Defines the username used in connecting to the target failover server
to update the remote server configuration.

eod

ATTR: remote-password
ATTRID: 6
ATTRTYPE: AT_CLEARTEXT
ATTRVAL: 17
ATTRVIZ: 5
ATTRDESC:: eod
Defines the password associated with the remote username used in
connecting to the target failover server.

eod

ATTR: remote-scp-port
ATTRID: 7
ATTRTYPE: AT_INT
ATTRVIZ: 5
ATTRDESC:: eod
Determines the SCP port number to use in communicating with the
target failover server. This port number is set during installation.
The default suggested by the installer is 1234.
eod

ATTR: server-default
ATTRID: 8
ATTRTYPE: AT_BOOL
ATTRDEFVAL: true
ATTRVIZ: 5
ATTRDESC:: eod
Determines whether this failover pair is the default one for the DHCP
server or a scope-specific failover pair.
eod

ATTR: last-sync-time
ATTRID: 9
ATTRTYPE: AT_DATE
ATTRDEFVAL: 0
ATTRVIZ: 3
ATTRDESC:: eod
When was the last time that we performed configuration
synchronization with the remote server.
eod

ATTR: last-sync-main-dbsn
ATTRID: 10
ATTRTYPE: AT_INT
ATTRDEFVAL: 0
ATTRVIZ: 3
ATTRDESC:: eod
What was the DBSN for the main server's MCD datastore when
we last synchronized the configuration information.
eod

ATTR: last-sync-backup-dbsn
ATTRID: 11
ATTRTYPE: AT_INT
ATTRDEFVAL: 0
ATTRVIZ: 3
ATTRDESC:: eod
What was the DBSN for the backup server's MCD datastore when
we last synchronized the configuration information.
eod

ATTR: id
ATTRID: 12
ATTRTYPE: AT_STRING
ATTRFLAGS: AF_REQUIRED, AF_UNIQUE, AF_IMMUTABLE
ATTRVIZ: 1
ATTRDESC:: eod
The actual MCD 'name' of the object so that its real name
can be editable.
eod

ATTR: main-server-username
ATTRID: 13
ATTRTYPE: AT_STRING
ATTRVIZ: 3
ATTRDESC:: eod
The admin id for performing edits on the main server
(or is it the remote server?)
eod

ATTR: main-server-password
ATTRID: 14
ATTRTYPE: AT_CLEARTEXT
ATTRVIZ: 3
ATTRVAL: 18
ATTRDESC:: eod
The clear text password for authenticating the admin id.
eod

ATTR: main-server-scp-port
ATTRID: 15
ATTRTYPE: AT_INT
ATTRVIZ: 3
ATTRDESC:: eod
The SCP port to use when communicating with the
remote server for synchronizing configuration.
eod

ATTR: refcount
ATTRID: 16
ATTRTYPE: AT_INT
ATTRVIZ: 5
ATTRDESC:: eod
Maintains the number of references to this failover-pair.  The
references come from either the DHCP Server configuration or from
the per-scope failover configuration settings.
eod

ATTR: remote-password-id
ATTRID: 17
ATTRTYPE: AT_SECRET
ATTRVAL: 6
ATTRDESC:: eod
The secret id for the secret containing the password for
the admin identity.  (Why do we have both remote-password-id
and main-server-password-id?  I think we should just have:
remote-admin, remote-password, remote-password-id).
eod

ATTR: main-server-password-id
ATTRID: 18
ATTRTYPE: AT_SECRET
ATTRVIZ: 3
ATTRVAL: 14
ATTRDESC:: eod
The secret id for the secret containing the password for
the admin identity.  (Why do we have both remote-password-id
and main-server-password-id?  I think we should just have:
remote-admin, remote-password, remote-password-id).
eod

ATTR: use-ssl
ATTRID: 19
ATTRTYPE: AT_ENUMSTR(disabled, optional, required)
ATTRDEFVAL: optional
ATTRDESC:: eod
Defines the security mode that CCM should use when connecting to
the remote server to examine or change its configuration. If
optional, and we have a security library installed, we will try
to secure the connection. If required, we will not make the
connection unless we can secure the connection (this requires the
security library to be installed). If none, we will not try to
secure the connection.

eod

ATTR: failover
ATTRID: 20
ATTRTYPE: AT_BOOL
ATTRFLAGS: AF_FEATURE
ATTRDEFVAL: enabled
ATTRDESC:: eod
Determines whether this device is configured for failover.

If enabled, the device is configured for failover.

If disabled, failover occurs on the attached subnets without
changing the fundamental configuration.

eod

ATTR: failover-mclt
ATTRID: 21
ATTRTYPE: AT_TIME
ATTRFLAGS: AF_INITIALIZE
ATTRDEFVAL: 3600
ATTRDESC:: eod
Sets the maximum client lead time, in seconds.  The "MCLT" controls
how much ahead of the backup server the client lease expiration
can be.  Make certain to define this attribute on both the main and
backup servers. For proper operation, the main and backup servers
must be configured with identical values for proper operation.

eod

ATTR: failover-lease-period-factor
ATTRID: 22
ATTRTYPE: AT_INT100
ATTRFLAGS: AF_INITIALIZE
ATTRDEFVAL: 1.50
ATTRDESC:: eod
Determines how independent the operation of the main server is from
the backup server.  This attribute sets a multiple of the desired
lease period and is used to update the backup server when the main
server informs it of a new DHCP client lease period.

A value of 1.00 would be the same as the lease period
that the main would like to give the DHCP client.  A value of 2.00
would be twice the lease period the main would like to give the
client.

The larger this value, the more the main is independent of the
operation of the backup and the less performance impact the
failover protocol has on the main server performance.  However,
the larger this value, the longer the backup will have to wait to
time out an expired lease and re-use it for a different client in
the event that the main fails and the backup takes over all DHCP
functions.  This attribute must be defined on the main
server.  If it is defined in a backup server, it is ignored (to
enable copying of configurations).

eod

ATTR: failover-use-safe-period
ATTRID: 23
ATTRTYPE: AT_BOOL
ATTRFLAGS: AF_FEATURE, AF_INITIALIZE
ATTRDEFVAL: false
ATTRDESC:: eod
If use-safe-period is disabled, then a server will never go into
PARTNER-DOWN state without an operator command.  It must be
defined for the scope on the main server.  If it is
defined in a backup server, it is ignored (to enable copying of
configurations).

eod

ATTR: failover-safe-period
ATTRID: 24
ATTRTYPE: AT_TIME
ATTRFLAGS: AF_INITIALIZE
ATTRDEFVAL: 3600
ATTRDESC:: eod
Determines the safe period, in seconds.  This value need not be
the same on both main and backup servers and only has meaning if
you enable use-safe-period.  Make sure you define this value for
the scope on the main server.  If it is defined on a backup
server, it is ignored (to enable copying of configurations).

eod

ATTR: failover-recover
ATTRID: 25
ATTRTYPE: AT_BOOL
ATTRFLAGS: AF_INITIALIZE
ATTRDEFVAL: false
ATTRDESC:: eod
If recover is disabled, then the server will perform
initialization (if there is any state), and then will go into
RECOVER state.  This state assumes that the other server was
running, and attempts to refresh its state from that of the
other server.
This is only meaningful if server-default on this object
is also true.  It will be ignored for failover objects which
are not the default servers.

eod

ATTR: failover-persist-lease-data-on-partner-ack
ATTRID: 26
ATTRTYPE: AT_BOOL
ATTRFLAGS: AF_INITIALIZE
ATTRDEFVAL: true
ATTRDESC:: eod
Normally, the main server will update MCD whenever the backup
server ACK's it with what the backup knows.  Disabling this
capability will speed up the main server, with the downside that
after restart of the main server it won't know what the backup
knows, and may offer all clients one lease period with a renew
time of the current time plus the MCLT.

eod

ATTR: subnets
ATTRID: 27
ATTRTYPE: AT_NLIST(AT_OBJ(Subnet))
# 1<<16 | 1129
ATTRVAL: 66665
ATTRDESC:: eod
Lists the primary subnet objects associated with this failover
relationship. This is needed to qualify each subnet with its vpn.
eod

#
# end FailoverPair class
#

CLASS: DHCPPacket
CLASSID: 1134
CLASSVIZ: 1
CLASSDESC:: eod
A genobj representation of a DHCP packet
eod

ATTR: op
ATTRID: 1
ATTRTYPE: AT_BYTE

ATTR: htype
ATTRID: 2
ATTRTYPE: AT_BYTE

ATTR: hlen
ATTRID: 3
ATTRTYPE: AT_BYTE

ATTR: hops
ATTRID: 4
ATTRTYPE: AT_BYTE

ATTR: xid
ATTRID: 5
ATTRTYPE: AT_INT

ATTR: secs
ATTRID: 6
ATTRTYPE: AT_SHORT

ATTR: flags
ATTRID: 7
ATTRTYPE: AT_SHORT

ATTR: ciaddr
ATTRID: 8
ATTRTYPE: AT_IPADDR

ATTR: yiaddr
ATTRID: 9
ATTRTYPE: AT_IPADDR

ATTR: siaddr
ATTRID: 10
ATTRTYPE: AT_IPADDR

ATTR: giaddr
ATTRID: 11
ATTRTYPE: AT_IPADDR

ATTR: chaddr
ATTRID: 12
ATTRTYPE: AT_BLOB

ATTR: sname
ATTRID: 13
ATTRTYPE: AT_STRING

ATTR: file
ATTRID: 14
ATTRTYPE: AT_STRING

# Leave attributes 15 - 17 or so as place-holders for the pseudo
# attribute numbers defined in the DHCP expression specification
# EDCS-188584
ATTR: option-list
ATTRID: 101
ATTRTYPE: AT_NLIST(AT_OBJ(Option))
# 1<<16 | 1131
ATTRVAL: 66667
ATTRDESC:: eod
Lists the DHCP options for this packet as option objects.
eod

#
# end class DhcpPacket
#

#
# DhcpServerStats class
#

CLASS: DHCPServerStats
CLASSID: 1135
CLASSPCV: 7.0.0
CLASSDESC:: eod
The global statistics available from the DHCP server.
eod

ATTR: start-time-str
ATTRID: 2
ATTRTYPE: AT_STRING
ATTRDESC:: eod
The 'ctime' string form of the time at which the DHCP server was
last reloaded.
eod

ATTR: total-discovers
ATTRID: 3
ATTRTYPE: AT_INT
ATTRDESC:: eod
The total number of discovers that the DHCP server has received.
eod

ATTR: total-requests
ATTRID: 4
ATTRTYPE: AT_INT
ATTRDESC:: eod
The total number of requests that the DHCP server has received.
eod

ATTR: total-releases
ATTRID: 5
ATTRTYPE: AT_INT
ATTRDESC:: eod
The total number of releases that the DHCP server has received.
eod

ATTR: total-offers
ATTRID: 6
ATTRTYPE: AT_INT
ATTRDESC:: eod
The total number of offers that the DHCP server has sent.
eod

ATTR: total-acks
ATTRID: 7
ATTRTYPE: AT_INT
ATTRDESC:: eod
The total number of acks that the DHCP server has sent.
eod

ATTR: total-naks
ATTRID: 8
ATTRTYPE: AT_INT
ATTRDESC:: eod
The total number of naks that the DHCP server has sent.
eod

ATTR: total-declines
ATTRID: 9
ATTRTYPE: AT_INT
ATTRDESC:: eod
The total number of declines that the DHCP server has received.
eod

ATTR: start-time
ATTRID: 10
ATTRTYPE: AT_DATE
ATTRDESC:: eod
The time the server was last reloaded.
eod

ATTR: categories
ATTRID: 11
ATTRTYPE: AT_FLAGSINT(all=1, server=2, failover=3, dhcpv6=4, history=100)
ATTRVIZ: 1
ATTRDESC:: eod
A list of the valid specialized dhcp server statistics categories
available.
eod

ATTR: server-start-time
ATTRID: 12
ATTRTYPE: AT_DATE
ATTRDESC:: eod
The time the server was started.
eod

ATTR: server-reload-time
ATTRID: 13
ATTRTYPE: AT_DATE
ATTRDESC:: eod
The time the server was last reloaded.
eod

ATTR: statistics-request-time
ATTRID: 14
ATTRTYPE: AT_DATE
ATTRDESC:: eod
The time at which the server processed the request for statistics.
eod

ATTR: server-up-time
ATTRID: 15
ATTRTYPE: AT_TIME
ATTRDESC:: eod
Indicates the number of seconds that the server has been running;
that is, the difference between statistics-request-time and
server-start-time.
eod

ATTR: sample-end-time
ATTRID: 16
ATTRTYPE: AT_DATE
ATTRDESC:: eod
The time that the server last calculated sample statistics.
eod

ATTR: sample-delta-time
ATTRID: 17
ATTRTYPE: AT_TIME
ATTRDESC:: eod
Determines the number of seconds since the server last calculated
sample statistics.
eod

ATTR: statistics-reset-time
ATTRID: 18
ATTRTYPE: AT_DATE
ATTRDESC:: eod
The time at which the server reset the statistics counters.
eod

#
# This class is used to pass lease history detail data from
# ccm to its clients.
#

CLASS: LeaseHistDetail
CLASSID: 1136
CLASSPCV: 6.0.0
CLASSDESC:: eod
A single detailed change to a lease binding. The detailed change
information supplements the base Lease History information
with changes recorded when an existing client renews a lease.
eod

ATTR: vpn
ATTRID: 1
ATTRTYPE: AT_INT
ATTRFLAGS: AF_REFERENCE
# Encode attribute 4 of Vpn class (1127) as 4<<16 + 1127 == 263271
ATTRVAL: 263271
ATTRDEFVAL: 0
ATTRDESC:: eod
The lease's vpn id.
eod

ATTR: address
ATTRID: 2
ATTRTYPE: AT_IPADDR
ATTRDESC:: eod
The lease's address.
eod

ATTR: start-time
ATTRID: 3
ATTRTYPE: AT_DATE
ATTRDESC:: eod
The lease's start-time.
eod

ATTR: change-time
ATTRID: 4
ATTRTYPE: AT_DATE
ATTRDESC:: eod
The timestamp of the change.
eod

ATTR: change-entry
ATTRID: 5
ATTRTYPE: AT_OBJ(ChangeEntry)
ATTRDESC:: eod
A changeentry containing the change to the lease data.
eod

ATTR: dbtxn-seq
ATTRID: 6
ATTRTYPE: AT_INT
ATTRFLAGS: AF_JAVADOC
ATTRVIZ: 3
ATTRDESC:: eod
The database transaction sequence number for this lease history
detail record.
eod

ATTR: dbtxn-generation
ATTRID: 7
ATTRTYPE: AT_INT
ATTRFLAGS: AF_JAVADOC
ATTRVIZ: 3
ATTRDESC:: eod
The generation number for database transaction sequence numbers that
exceed the 32-bit number space.
eod

# end LeaseHistDetail class

#
# This class is used to pass current utilization detail data from
# dhcp to ccm and from ccm to clients. There is no parallel CCM
# object defined in ccm_datadict.
#

CLASS: CurrentUtilization
CLASSID: 1137
CLASSROOT: CURRENTUTIL
CLASSPCV: 6.0.0
CLASSDESC:: eod
Detailed address utilization information from a single dhcp scope,
or an entire subnet or address block.
eod

ATTR: scope-name
ATTRID: 1
ATTRTYPE: AT_STRING
ATTRDESC:: eod
For scope level utilization data, the name of the scope for which
this data applies.
eod

ATTR: subnet
ATTRID: 2
ATTRTYPE: AT_SUBNET
ATTRDESC:: eod
The subnet (network number and mask) for which this utilization
data applies.
Note, This attribute needs to be attrid 2 for sorting by subnet
and vpn-id.
eod

ATTR: vpn-id
ATTRID: 3
ATTRTYPE: AT_INT
ATTRFLAGS: AF_REFERENCE
# Encode attribute 4 of Vpn class (1127) as 4<<16 + 1127 == 263271
ATTRVAL: 263271
ATTRDEFVAL: 0
ATTRDESC:: eod
The VPN identifier of the subnet for which this utilization
data applies.
Note, This attribute needs to be attrid 3 for sorting by subnet
and vpn-id.
eod

ATTR: aggregation-level
ATTRID: 4
ATTRTYPE: AT_ENUMINT(scope-level=1, subnet-level=2, addr-block-level=3, totals=4)
ATTRFLAGS: AF_PRINT_ALT
ATTRDESC:: eod
Indicates the granularity of this utilization data. The
scope-level is the most detailed data available from the DHCP
server. Aggregated counters are reported at the subnet-level
and addr-block-level. These are the sum of scope-level
data in a given subnet or address block.
eod

ATTR: oid
ATTRID: 5
ATTRTYPE: AT_OID
ATTRVIZ: 3
ATTRDESC:: eod
The object reference of the Scope, CCMSubnet, or CCMAddrBlock
for which this utilization data applies.
eod

ATTR: avail
ATTRID: 6
ATTRTYPE: AT_INT
ATTRDESC:: eod
The number of dynamic leases (leases that are not reserved)
in this scope, subnet or address block that are currently
available to be issued to clients.
eod

ATTR: offered
ATTRID: 7
ATTRTYPE: AT_INT
ATTRDESC:: eod
The number of dynamic leases (leases that are not reserved)
in this scope, subnet or address block that are currently
offered to a client, but not yet acknowledged as leased.
eod

ATTR: leased
ATTRID: 8
ATTRTYPE: AT_INT
ATTRDESC:: eod
The number of dynamic leases (leases that are not reserved) in this
scope, subnet or address block that are leased to DHCP clients.
eod

ATTR: expired
ATTRID: 9
ATTRTYPE: AT_INT
ATTRDESC:: eod
The number of dynamic leases (leases that are not reserved) in
this scope, subnet or address block that are past their lease
expiration time (or in release-grace-period for leases released by
clients), but not yet available for other DHCP clients. An expired
(or released) lease will become available after the policy
grace-period (or release-grace-period) has elapsed.
eod

ATTR: unavail
ATTRID: 10
ATTRTYPE: AT_INT
ATTRDESC:: eod
The number of dynamic leases (leases that are not reserved) in
this scope, subnet or address block that are currently marked
unavailable.  A lease will be marked unavailable if it has been
declined by the client or the server has detected an address
conflict.  Leases in this state indicate there are configuration
errors in the network that need to be corrected.
eod

ATTR: pend-avail
ATTRID: 11
ATTRTYPE: AT_INT
ATTRDESC:: eod
The number of dynamic leases (leases that are not reserved) in
this scope, subnet or address block that are in the
pending-available state. Leases in this state are waiting for
acknowledgement from the server's failover partner that it has not
reissued the lease.  Leases may remain in this state for an
extended period if a failover pair is in
communications-interrupted mode.
eod

ATTR: other-avail
ATTRID: 12
ATTRTYPE: AT_INT
ATTRDESC:: eod
The number of dynamic leases (leases that are not reserved) in
this scope, subnet or address block that are available to be
issued to clients by the server's failover partner.
eod

ATTR: leased-deactivated
ATTRID: 13
ATTRTYPE: AT_INT
ATTRDESC:: eod
The number of dynamic leases (leases that are not reserved) in
this scope, subnet or address block that are currently leased by
DHCP clients, but have also been deactivated by an administrator.
eod

ATTR: reserved-inactive
ATTRID: 14
ATTRTYPE: AT_INT
ATTRDESC:: eod
The number of reserved leases in this scope, subnet or address
block that are at present not used by their assigned DHCP clients.
eod

ATTR: reserved-active
ATTRID: 15
ATTRTYPE: AT_INT
ATTRDESC:: eod
The number of reserved leases in this scope, subnet or address
block that are actively being used by their assigned DHCP clients.
eod

ATTR: reserved-leased-deactivated
ATTRID: 16
ATTRTYPE: AT_INT
ATTRDESC:: eod
The number of reserved leases in this scope, subnet or address
block that are currently leased by their assigned DHCP clients,
but have also been deactivated by an administrator.
eod

ATTR: reserved-unavail
ATTRID: 17
ATTRTYPE: AT_INT
ATTRDESC:: eod
The number of reserved leases in this scope, subnet or address
block that have been marked unavailable. A lease will be marked
unavailable if it has been declined by the client or the server
has detected an address conflict. Leases in this state indicate
there are configuration errors in the network that need to be
corrected.
eod

ATTR: total-dynamic
ATTRID: 18
ATTRTYPE: AT_INT
ATTRDESC:: eod
The total number of leases configured in this scope, subnet or
address block, excluding reservations.
eod

ATTR: total-reserved
ATTRID: 19
ATTRTYPE: AT_INT
ATTRDESC:: eod
The total number of reserved leases configured in this scope,
subnet or address block.
eod

ATTR: active-dynamic
ATTRID: 20
ATTRTYPE: AT_INT
ATTRDESC:: eod
The total number of dynamic leases in this scope, subnet or
address block that are actively in use. A lease is defined as
active if it is in the leased, offered, released, expired, or
pending-available state.
eod

ATTR: free-dynamic
ATTRID: 21
ATTRTYPE: AT_INT
ATTRDESC:: eod
The number of dynamic leases in this scope, subnet or address
block that are currently free to be offered to DHCP clients.
A lease is defined as free if it is in the available or
other-available state.
eod

ATTR: deactivated
ATTRID: 22
ATTRTYPE: AT_INT
ATTRDESC:: eod
Shows The number of leases in this scope, subnet or address block
that an administrator has deactivated by an administrator, including
both regular leases and reservation leases.
eod

ATTR: scope-deactivated
ATTRID: 23
ATTRTYPE: AT_BOOL
ATTRDEFVAL: false
ATTRDESC:: eod
For scope-level counters, indicates whether the scope has been
deactivated.
eod

ATTR: failover-role
ATTRID: 24
ATTRTYPE: AT_ENUMINT(none=0, main=1, backup=2)
ATTRFLAGS: AF_PRINT_ALT
ATTRDEFVAL: 0
ATTRDESC:: eod
For scope-level counters, indicates the failover role of the scope.
eod

ATTR: failover-state
ATTRID: 25
ATTRTYPE: AT_ENUMINT(none=0, startup=1, normal=2, communications-interrupted=3, partner-down=4, potential-conflict=5, recover=6, paused=7, shutdown=8, recover-done=9)
ATTRFLAGS: AF_PRINT_ALT
ATTRDEFVAL: 0
ATTRDESC:: eod
For scope-level counters, indicates the state of the failover
relationship that involves the scope (if any).
eod

# end utilization detail class

#
# DhcpServerActivityStats class: server-wide snapshot stats
#

CLASS: DHCPServerActivityStats
CLASSID: 1142
CLASSPCV: 7.0.0
CLASSDESC:: eod
The activity statistics available from the DHCP
server.
eod

ATTR: discovers
ATTRID: 2
ATTRTYPE: AT_INT
ATTRDESC:: eod
Shows the number of DHCPDISCOVER packets received in this time
interval.
eod

ATTR: offers
ATTRID: 3
ATTRTYPE: AT_INT
ATTRDESC:: eod
Shows the number of DHCPOFFER packets sent in this time interval.
eod

ATTR: requests
ATTRID: 4
ATTRTYPE: AT_INT
ATTRDESC:: eod
Shows the number of DHCPREQUEST packets received in this time
interval.
eod

ATTR: acks
ATTRID: 5
ATTRTYPE: AT_INT
ATTRDESC:: eod
Shows the number of DHCPACK packets sent in this time interval.
eod

ATTR: naks
ATTRID: 6
ATTRTYPE: AT_INT
ATTRDESC:: eod
Shows the number of DHCPNAK packets sent in this time interval.
eod

ATTR: releases
ATTRID: 7
ATTRTYPE: AT_INT
ATTRDESC:: eod
Shows the number of DHCPRELEASE packets received in this time
interval.
eod

ATTR: declines
ATTRID: 8
ATTRTYPE: AT_INT
ATTRDESC:: eod
Shows the number of DHCPDECLINE packets received in this time
interval.
eod

#
# This is a server-wide statistic, applies to v4.
#
ATTR: timeouts
ATTRID: 9
ATTRTYPE: AT_INT
ATTRDESC:: eod
Shows the number of timeouts (leases, offers) experienced in this
time interval.
eod

ATTR: acks-per-second
ATTRID: 10
ATTRTYPE: AT_INT
ATTRDESC:: eod
Shows the average rate at which DHCPACK packets were sent to clients
in this time interval.
eod

#
#  These are global statistics
#  not specific to v4 processing.
#
ATTR: packets-dropped
ATTRID: 11
ATTRTYPE: AT_INT
ATTRDESC:: eod
Displays the number of incoming packets dropped in this time
interval because of  heavy load on the server. These packets were not
processed in any way by the server, other than to discard them.
eod

ATTR: request-buffers-in-use
ATTRID: 12
ATTRTYPE: AT_INT
ATTRDESC:: eod
Displays the number of request buffers the DHCP server is using at
the time the statistics are calculated.
eod

ATTR: response-buffers-in-use
ATTRID: 13
ATTRTYPE: AT_INT
ATTRDESC:: eod
Displays the number of response buffers the DHCP server is using at
the time the statistics are calculated.
eod

ATTR: informs
ATTRID: 14
ATTRTYPE: AT_INT
ATTRDESC:: eod
Shows the number of DHCPINFORM packets received in this time
interval.
eod

ATTR: lease-queries
ATTRID: 15
ATTRTYPE: AT_INT
ATTRDESC:: eod
Shows the number of DHCPLEASEQUERY packets (RFC4388 message id 10
or Cisco-proprietary message id 13) received in this time interval.
eod

#
# lease query msg types - new in 7.0 release
#
ATTR: lease-queries-unassigned
ATTRID: 16
ATTRTYPE: AT_INT
ATTRDESC:: eod
Displays the number of DHCPLEASEUNASSIGNED packets (message id 11)
sent in this time interval.
eod

ATTR: lease-queries-unknown
ATTRID: 17
ATTRTYPE: AT_INT
ATTRDESC:: eod
Displays the number of DHCPLEASEUNKNOWN packets (message id 12)sent
in this time interval.
eod

ATTR: lease-queries-active
ATTRID: 18
ATTRTYPE: AT_INT
ATTRDESC:: eod
Displays the number of DHCPLEASEACTIVE packets (message id 13) sent
in this time interval.
eod

#
# additional v4 counter types for 7.0 release
#

ATTR: offer-timeouts
ATTRID: 19
ATTRTYPE: AT_INT
ATTRDESC:: eod
Displays the number of offer packets that timed out during this time
interval.
eod

ATTR: grace-expirations
ATTRID: 20
ATTRTYPE: AT_INT
ATTRDESC:: eod
Displays the number of leases that timed out the grace period during
this time interval.
eod

ATTR: bootp-received
ATTRID: 21
ATTRTYPE: AT_INT
ATTRDESC:: eod
Displays the number of bootp packets received in this time interval.
eod

ATTR: bootp-sent
ATTRID: 22
ATTRTYPE: AT_INT
ATTRDESC:: eod
Displays the number of bootp packets sent in this time interval.
eod

ATTR: packets-sent
ATTRID: 23
ATTRTYPE: AT_INT
ATTRDESC:: eod
Displays the number of DHCP packets sent in this time interval.
eod

ATTR: packets-received
ATTRID: 24
ATTRTYPE: AT_INT
ATTRDESC:: eod
Displays the number of DHCP packets received in this time interval.
eod

ATTR: invalid-packets
ATTRID: 25
ATTRTYPE: AT_INT
ATTRDESC:: eod
Displays the number of invalid DHCP packets received in this time
interval.
eod

ATTR: responses-dropped
ATTRID: 26
ATTRTYPE: AT_INT
ATTRDESC:: eod
Displays the number of responses dropped in this time interval, due
to heavy load on the server. This is the number of times the server
ran out of response buffers.
eod

#
#  "dropped" counters - new in 7.0 release
#

ATTR: dropped-total
ATTRID: 27
ATTRTYPE: AT_INT
ATTRDESC:: eod
Displays the total number of DHCP packets dropped due to server or
client configuration issues in this time interval.
eod
ATTR: request-dropped-others
ATTRID: 28
ATTRTYPE: AT_INT
ATTRDESC:: eod
Displays the number of DHCP packets dropped in request processing
for other reasons in this time interval.
eod

ATTR: response-dropped-others
ATTRID: 29
ATTRTYPE: AT_INT
ATTRDESC:: eod
Displays the number of DHCP packets dropped in response processing
for other reasons in this time interval.
eod

ATTR: extension-errors
ATTRID: 30
ATTRTYPE: AT_INT
ATTRDESC:: eod
Displays the number of DHCP packets that an extension failed to
process and that the server dropped in this time interval.
eod

ATTR: extension-drops
ATTRID: 31
ATTRTYPE: AT_INT
ATTRDESC:: eod
Displays the number of DHCP packets that an extension requested
and that were dropped in this time interval.
eod

ATTR: duplicates
ATTRID: 32
ATTRTYPE: AT_INT
ATTRDESC:: eod
Displays the number of DHCP duplicate packets dropped in this
time interval.
eod

ATTR: over-max-waiting
ATTRID: 33
ATTRTYPE: AT_INT
ATTRDESC:: eod
Displays the number of DHCP packets dropped because the server
max-waiting-packets attribute was exceeded in this time interval.
eod

ATTR: request-dropped-old
ATTRID: 34
ATTRTYPE: AT_INT
ATTRDESC:: eod
Displays the number of DHCP packets dropped in request processing
because the server drop-old-packets attribute was exceeded
in this time interval.
eod

ATTR: response-dropped-old
ATTRID: 35
ATTRTYPE: AT_INT
ATTRDESC:: eod
Displays the number of DHCP packets dropped in response processing
because the server drop-old-packets attribute was exceeded
in this time interval.
eod

ATTR: unknown-scopes
ATTRID: 36
ATTRTYPE: AT_INT
ATTRDESC:: eod
Displays the number of DHCP packets dropped in this time interval
because the server could not assign an appropriate scope.
eod

ATTR: discards
ATTRID: 37
ATTRTYPE: AT_INT
ATTRDESC:: eod
Displays the number of DHCP packets dropped in this time interval
because the server could not construct a response.
eod

ATTR: client-class-fails
ATTRID: 38
ATTRTYPE: AT_INT
ATTRDESC:: eod
Displays the number of DHCP packets dropped because the server
could not assign a client-class.
eod

ATTR: invalid-clients
ATTRID: 39
ATTRTYPE: AT_INT
ATTRDESC:: eod
Displays the number of DHCP packets dropped in this time interval
because server configuration prevents responding to the packet.
eod

#
# new stats for 7.0 release
#
ATTR: request-buffers-allocated
ATTRID: 40
ATTRTYPE: AT_INT
ATTRDESC:: eod
Shows the number of request buffers that the server has allocated.
(This is the maximum number of requests that the server can hold
at any one time.)
eod

ATTR: response-buffers-allocated
ATTRID: 41
ATTRTYPE: AT_INT
ATTRDESC:: eod
Shows the number of response buffers that the server has allocated.
(This is the maximum number of responses that the server can hold
at any one time.)
eod

ATTR: active-leases
ATTRID: 42
ATTRTYPE: AT_INT
ATTRDESC:: eod
Shows the number of DHCPv4 leases and reservations that are
currently unavailable to new clients.
Leases in the following states are counted as active:

 	OFFERED
 	LEASED
 	RELEASED
 	EXPIRED
 	DISCONNECTED
eod

ATTR: configured-leases
ATTRID: 43
ATTRTYPE: AT_INT
ATTRDESC:: eod
Shows the number of DHCPv4 leases and reservations that are
configured on the server. This includes all possible
leases in the ranges that are defined by the configuration.
eod

ATTR: reserved-leases
ATTRID: 44
ATTRTYPE: AT_INT
ATTRDESC:: eod
Shows the number of reserved DHCPv4 leases configured in
the server.
eod

ATTR: reserved-active-leases
ATTRID: 45
ATTRTYPE: AT_INT
ATTRDESC:: eod
Shows the number of reserved DHCPv4 leases that are currently
unavailable to new clients.
Leases in the following states are counted as active:

 	OFFERED
 	LEASED
 	RELEASED
 	EXPIRED
 	DISCONNECTED
eod

ATTR: ack-latency-counts
ATTRID: 46
ATTRTYPE: AT_NLIST(AT_INT)
ATTRDESC:: eod
An ordered list of the number of DHCPACK responses falling
into these categories:

< 50 ms
50-200 ms
200-500 ms
500-1000 ms
1-2 secs
2-3 secs
3-4 secs
 > 4 secs

When enhanced-sample-counters is disabled, only second timing
resolution is available and all responses taking less than 1
second are counted in the 500-1000ms category.
eod

ATTR: total-scopes
ATTRID: 47
ATTRTYPE: AT_INT
ATTRDESC:: eod
The number of scopes configured in the server.
eod

# end DHCPServerActivityStats

#
# dhcp server failover stats
#

CLASS: DHCPFailoverStats
CLASSID: 1143
CLASSPCV: 7.0.0
CLASSDESC:: eod
The failover activity statistics available from the
DHCP server.
eod


ATTR: packets-received
ATTRID: 2
ATTRTYPE: AT_INT
ATTRDESC:: eod
Shows the number of failover packets received in this time interval.
eod

ATTR: binding-updates-received
ATTRID: 3
ATTRTYPE: AT_INT
ATTRDESC:: eod
Displays the number of failover DHCPBNDUPD packets received in this
time interval.
eod

ATTR: binding-acks-received
ATTRID: 4
ATTRTYPE: AT_INT
ATTRDESC:: eod
Displays the number of failover DHCPBNDACK packets received in this
time interval.
eod

ATTR: binding-naks-received
ATTRID: 5
ATTRTYPE: AT_INT
ATTRDESC:: eod
Displays the number of failover DHCPBNDNAK packets received in this
time interval.
eod

ATTR: pool-requests-received
ATTRID: 6
ATTRTYPE: AT_INT
ATTRDESC:: eod
Displays the number of failover DHCPPOOLREQ packets received in this
time interval.
eod

ATTR: polls-received
ATTRID: 7
ATTRTYPE: AT_INT
ATTRDESC:: eod
Displays the number of failover DHCPPOLL packets received in this
time interval.
eod

ATTR: update-requests-received
ATTRID: 8
ATTRTYPE: AT_INT
ATTRDESC:: eod
Shows the number of failover DHCPUPDATEREQ packets received in this
time interval.
eod

ATTR: update-done-received
ATTRID: 9
ATTRTYPE: AT_INT
ATTRDESC:: eod
Displays the number of failover DHCPUPDATEDONE packets received in
this time interval.
eod

ATTR: packets-sent
ATTRID: 10
ATTRTYPE: AT_INT
ATTRDESC:: eod
Displays the number of failover packets sent in this time interval.
eod

ATTR: binding-updates-sent
ATTRID: 11
ATTRTYPE: AT_INT
ATTRDESC:: eod
Shows the number of failover DHCPBNDUPD packets sent in this time
interval.
eod

ATTR: binding-acks-sent
ATTRID: 12
ATTRTYPE: AT_INT
ATTRDESC:: eod
Displays The number of failover DHCPBNDACK packets sent in this
time interval.
eod

ATTR: binding-naks-sent
ATTRID: 13
ATTRTYPE: AT_INT
ATTRDESC:: eod
Displays the number of failover DHCPBNDNAK packets sent in this
time interval.
eod

ATTR: pool-responses-sent
ATTRID: 14
ATTRTYPE: AT_INT
ATTRDESC:: eod
Displays the number of failover DHCPPOOLRESP packets sent in this
time interval.
eod

ATTR: polls-sent
ATTRID: 15
ATTRTYPE: AT_INT
ATTRDESC:: eod
Displays the number of failover DHCPPOLL packets sent in this
time interval.
eod

ATTR: update-requests-sent
ATTRID: 16
ATTRTYPE: AT_INT
ATTRDESC:: eod
Displays the of failover DHCPUPDATEREQ packets sent in this
time interval.
eod

ATTR: update-done-sent
ATTRID: 17
ATTRTYPE: AT_INT
ATTRDESC:: eod
Displays the number of failover DHCPUPDATEDONE packets sent in this
time interval.
eod

ATTR: packets-dropped
ATTRID: 18
ATTRTYPE: AT_INT
ATTRDESC:: eod
Displays the number of failover packets dropped in time interval.
eod

# end DHCPFailoverStats

#
# dhcp server dhcpv6 stats
#

CLASS: DHCP6Stats
CLASSID: 1144
CLASSPCV: 7.0.0
CLASSDESC:: eod
The v6 activity statistics available from the
DHCP server.
eod

ATTR: packets-received
ATTRID: 2
ATTRTYPE: AT_INT
ATTRDESC:: eod
Shows the number of DHCPv6 packets received in this time interval.
eod

ATTR: packets-received-relay
ATTRID: 3
ATTRTYPE: AT_INT
ATTRDESC:: eod
Shows the number of DHCPv6 packets received using RELAY in this time
interval.
eod

#
# detailed stuff we receive in
#
ATTR: solicits
ATTRID: 4
ATTRTYPE: AT_INT
ATTRDESC:: eod
Shows the number of DHCPv6 solicits received in this time interval.
eod

ATTR: requests
ATTRID: 5
ATTRTYPE: AT_INT
ATTRDESC:: eod
Shows the number of DHCPv6 requests received in this time interval.
eod

ATTR: confirms
ATTRID: 6
ATTRTYPE: AT_INT
ATTRDESC:: eod
Shows the number of DHCPv6 confirms received in this time interval.
eod

ATTR: renews
ATTRID: 7
ATTRTYPE: AT_INT
ATTRDESC:: eod
Shows the number of DHCPv6 renews received in this time interval.
eod

ATTR: rebinds
ATTRID: 8
ATTRTYPE: AT_INT
ATTRDESC:: eod
Shows the number of DHCPv6 rebinds received in this time interval.
eod

ATTR: releases
ATTRID: 9
ATTRTYPE: AT_INT
ATTRDESC:: eod
Shows the number of DHCPv6 releases received in this time interval.
eod

ATTR: declines
ATTRID: 10
ATTRTYPE: AT_INT
ATTRDESC:: eod
Shows the number of DHCPv6 declines received in this time interval.
eod

ATTR: info-requests
ATTRID: 11
ATTRTYPE: AT_INT
ATTRDESC:: eod
Shows the number of DHCPv6 info-requests received in this time
interval.
eod

ATTR: invalid-packets
ATTRID: 12
ATTRTYPE: AT_INT
ATTRDESC:: eod
Shows the number of invalid DHCPv6 packets received in this time
interval.
eod

#
# stuff that we sent
#
ATTR: packets-sent
ATTRID: 13
ATTRTYPE: AT_INT
ATTRDESC:: eod
Shows the number of DHCPv6 packets sent in this time interval.
eod

ATTR: packets-sent-relay
ATTRID: 14
ATTRTYPE: AT_INT
ATTRDESC:: eod
TShows the number of DHCPv6 packets sent using RELAY in this
time interval.
eod

ATTR: advertises
ATTRID: 15
ATTRTYPE: AT_INT
ATTRDESC:: eod
Shows the number of DHCPv6 advertises sent in this time interval.
eod

ATTR: replies
ATTRID: 16
ATTRTYPE: AT_INT
ATTRDESC:: eod
Shows the number of DHCPv6 replies sent in this time interval.
eod

ATTR: reconfigures
ATTRID: 17
ATTRTYPE: AT_INT
ATTRDESC:: eod
Shows the number of DHCPv6 reconfigures sent in this time interval.
eod

#
# Stuff that comes in valid packet, but server chooses to drop
#

ATTR: auth-fails
ATTRID: 18
ATTRTYPE: AT_INT
ATTRDESC:: eod
Shows the number of DHCPv6 auth_fails dropped in this time interval.
eod

ATTR: discards
ATTRID: 19
ATTRTYPE: AT_INT
ATTRDESC:: eod
Shows the number of DHCPv6 packets discarded due to RFC3315
validation failures in this time interval.
eod

ATTR: duplicates
ATTRID: 20
ATTRTYPE: AT_INT
ATTRDESC:: eod
Shows the number of DHCPv6 duplicate packets dropped in this time
interval.
eod

ATTR: invalid-clients
ATTRID: 21
ATTRTYPE: AT_INT
ATTRDESC:: eod
Shows the number of DHCPv6 packets from invalid clients dropped
in this time interval. Server configuration prevents responding
to the packet.
eod

ATTR: unknown-links
ATTRID: 22
ATTRTYPE: AT_INT
ATTRDESC:: eod
The number of dhcpv6 packets dropped from unknown links
in this time interval.
eod

#
#  split into requests/responses in 7.0 release
#
ATTR: dropped-others
ATTRID: 23
ATTRTYPE: AT_INT
ATTRVIZ: 1
DEPRECATED: 8.0.0
ATTRDESC:: eod
Shows the number of DHCPv6 packets dropped for other reasons
in this time interval.
eod

ATTR: over-max-waiting
ATTRID: 24
ATTRTYPE: AT_INT
ATTRDESC:: eod
Shows the number of DHCPv6 packets dropped because the server
max-waiting-packets attribute was exceeded in this time interval.
eod

ATTR: request-dropped-old
ATTRID: 25
ATTRTYPE: AT_INT
ATTRDESC:: eod
Shows the number of DHCPv6 packets dropped in request processing
because the server drop-old-packets attribute was exceeded
in this time interval.
eod

ATTR: response-dropped-old
ATTRID: 26
ATTRTYPE: AT_INT
ATTRDESC:: eod
Shows the number of DHCPv6 packets dropped in response processing
because the server drop-old-packets attribute was exceeded
in this time interval.
eod

ATTR: client-class-fails
ATTRID: 27
ATTRTYPE: AT_INT
ATTRDESC:: eod
Shows the number of DHCPv6 packets dropped because the server
could not assign a client-class.
eod

ATTR: request-dropped-others
ATTRID: 28
ATTRTYPE: AT_INT
ATTRDESC:: eod
Shows the number of DHCPv6 packets dropped in request processing
for other reasons in this time interval.
eod


ATTR: response-dropped-others
ATTRID: 29
ATTRTYPE: AT_INT
ATTRDESC:: eod
Shows the number of DHCPv6 packets dropped in response processing
for other reasons in this time interval.
eod

ATTR: dropped-total
ATTRID: 30
ATTRTYPE: AT_INT
ATTRDESC:: eod
Shows the total number of DHCPv6 packets dropped due to server or
client configuration in this time interval.
eod

ATTR: offer-timeouts
ATTRID: 31
ATTRTYPE: AT_INT
ATTRDESC:: eod
Shows the number of offer packets that timed out in this time
interval.
eod

ATTR: grace-expirations
ATTRID: 32
ATTRTYPE: AT_INT
ATTRDESC:: eod
Shows the number of leases that timed out the grace period
in this time interval.
eod

#
# new stats classes for 7.0 release
#
ATTR: active-leases
ATTRID: 33
ATTRTYPE: AT_INT
ATTRDESC:: eod
Show the number of DHCPv6 leases, reservations and delegated
prefixes that are currently unavailable to new clients.
Leases in the following states are counted as active:

 	OFFERED
 	LEASED
 	RELEASED
 	EXPIRED
 	DISCONNECTED
eod

ATTR: allocated-leases
ATTRID: 34
ATTRTYPE: AT_INT
ATTRDESC:: eod
Shows the number of DHCPv6 leases, reservations, and delegated
prefixes that are presently allocated in the server.
eod

ATTR: reserved-leases
ATTRID: 36
ATTRTYPE: AT_INT
ATTRDESC:: eod
Shows the number of DHCPv6 reserved leases and reserved
prefixes that are configured on the server.
eod

ATTR: reserved-active-leases
ATTRID: 37
ATTRTYPE: AT_INT
ATTRDESC:: eod
Shows the number of DHCPv6 reserved leases and reserved
prefixes that are currently unavailable to new clients.
Leases in the following states are counted as active:

 	OFFERED
 	LEASED
 	RELEASED
 	EXPIRED
 	DISCONNECTED
eod

ATTR: reply-latency-counts
ATTRID: 38
ATTRTYPE: AT_NLIST(AT_INT)
ATTRDESC:: eod
An ordered list of the number of Reply responses falling
into these categories:

< 50 ms
50-200 ms
200-500 ms
500-1000 ms
1-2 secs
2-3 secs
3-4 secs
 > 4 secs

When enhanced-sample-counters is disabled, only second timing
resolution is available and all responses taking less than 1
second are counted in the 500-1000ms category.
eod

ATTR: total-prefixes
ATTRID: 39
ATTRTYPE: AT_INT
ATTRDESC:: eod
The number of prefixes configured in the server.
eod

ATTR: leasequeries
ATTRID: 40
ATTRTYPE: AT_INT
ATTRDESC:: eod
Shows the number of DHCPv6 Leasequery messages received.
eod

ATTR: leasequery-replies
ATTRID: 41
ATTRTYPE: AT_INT
ATTRDESC:: eod
Shows the number of responses to DHCPv6 Leasequery messages which may
or may not have been successful.
eod

ATTR: server-duid
ATTRID: 42
ATTRTYPE: AT_BLOB
ATTRDESC:: eod
Shows the current DHCPv6 server-identifier (DUID) for the server.
eod

# ---------------------
# end of DHCP6Stats
# ---------------------


#
# PREFIX class - an IPv6 prefix, possibly including selection tags
#                and ranges
#

CLASS: Prefix
CLASSID: 1141
CLASSNAME: 1
CLASSVIZ: 5
CLASSPCV: 7.0.0
CLASSDESC:: eod
An IPv6 prefix. A prefix defines the DHCPv6 configuration
for the given address pool.
eod

ATTR: name
ATTRID: 1
ATTRTYPE: AT_STRING
ATTRFLAGS: AF_REQUIRED, AF_UNIQUE, AF_IMMUTABLE
ATTRDESC:: eod
Assigns a name to an IPv6 prefix (subnet).
eod

ATTR: address
ATTRID: 2
ATTRTYPE: AT_PREFIX
ATTRFLAGS: AF_REQUIRED, AF_IMMUTABLE
ATTRDESC:: eod
Identifies a prefix (subnet) that an interface belongs to using the
high-order bits of an IPv6 address.
eod

ATTR: selection-tags
ATTRID: 3
ATTRTYPE: AT_NLIST(AT_STRING)
ATTRDESC:: eod
Associates selection tags with an IPv6 prefix (subnet).
eod

ATTR: dhcp-type
ATTRID: 4
ATTRTYPE: AT_ENUMINT(stateless=0,dhcp=1,prefix-delegation=2,infrastructure=3,parent=4)
ATTRDEFVAL: dhcp
ATTRFLAGS: AF_PRINT_ALT
ATTRDESC:: eod
Defines how DHCP manages address assignment within a prefix:

  stateless         Prefix is used only for stateless
                    option configuration.

  dhcp              Prefix is used for stateful address
                    assignment.

  prefix-delegation Prefix is used for prefix-delegation.

  infrastructure    Prefix is used to map a client address to
                    a link, and does not have an address pool.

  parent            Prefix is not used by DHCP. It is used as
                    a container object, to group child prefixes.
eod

ATTR: range
ATTRID: 5
ATTRTYPE: AT_PREFIX
ATTRDEFATTRID: 2
ATTRDESC:: eod
Specifies a subrange the server can use to configure prefixes
for address assignment.

The prefix used depends on the value set for the dhcp-type attribute.
If not set, the prefix address is used. This may specify a longer
prefix than the prefix address to limit the range of addresses
or prefixes available for assignment.
eod

ATTR: policy
ATTRID: 6
ATTRTYPE: AT_NAMEREF(Policy)
ATTRVAL: 1102
ATTRDESC:: eod
Refers to a shared policy to use when replying to clients.
eod

ATTR: embedded-policy
ATTRID: 7
ATTRTYPE: AT_OBJ(Policy)
ATTRDESC:: eod
Specifies a policy embedded within an IPv6 prefix.
eod

ATTR: vpn-id
ATTRID: 8
ATTRTYPE: AT_INT
ATTRFLAGS: AF_REFERENCE, AF_IMMUTABLE, AF_INITIALIZE
# Encode attribute 4 of Vpn(1127) as 4<<16 + 1127 == 263271
ATTRVAL: 263271
ATTRDEFVAL: 0
ATTRDESC:: eod
Identifies the VPN that contains an IPv6 prefix.
eod

ATTR: link
ATTRID: 9
ATTRTYPE: AT_NAMEREF(Link)
ATTRVAL: 61
ATTRDESC:: eod
Associates an IPv6 prefix (subnet) with a link. Use this attribute
to group prefixes that are on a single link.
eod

ATTR: reservation-list
ATTRID: 10
ATTRTYPE: AT_NLIST(AT_OBJ(Reservation))
# 1<<16 | 1107
ATTRVAL: 66643
ATTRVIZ: 3
ATTRDESC:: eod
Lists the reservations associated with this prefix.
eod

ATTR: expiration-time
ATTRID: 11
ATTRTYPE: AT_DATE
ATTRDESC:: eod
Sets the time and date on which a prefix expires. After this date
and time, the server neither grants new leases nor renews existing
leases from this prefix.

Once the expiration-time has passed, the prefix is no longer used
(though old leases and leases with grace or affinity periods
continue to exist until those periods elapse).

Enter this as a date in the format  "[weekday] mon day
hh:mm[:ss] year". For example, "Dec 31 23:59 2006".
eod

ATTR: prefer-interface-identifier
ATTRID: 12
ATTRTYPE: AT_BOOL
ATTRDEFVAL: false
ATTRVIZ: 0
DEPRECATED: 7.1.0
ATTRDESC:: eod
Determines how the server generates non-temporary addresses.

If true, the server generates non-temporary addresses for clients
using their interface identifier, unless the resulting address
is already assigned to another client. If an address is unavailable,
the server generates a random address.

If false (the default), the server also generates random addresses
for clients.
eod

ATTR: ignore-declines
ATTRID: 13
ATTRTYPE: AT_BOOL
ATTRDEFVAL: false
ATTRDESC:: eod
Controls whether the DHCP server responds to a DHCPv6 DECLINE
message that refers to an IPv6 address or a delegated prefix
from this prefix.

If enabled, the DHCP server ignores all declines for leases
in this prefix.

If disabled or not set, the DHCP server sets to UNAVAILABLE
every address or delegated prefix requested in a DECLINE
message if it is leased to the client.

The default value is false, so that DECLINE messages are
processed normally.
eod

ATTR: deactivated
ATTRID: 14
ATTRTYPE: AT_BOOL
ATTRDEFVAL: false
ATTRFLAGS: AF_FEATURE
ATTRDESC:: eod
Controls whether a prefix extends leases to clients. A deactivated
prefix does not extend leases to any clients. It treats all addresses
in its ranges as if they were individually deactivated.

Default, false (active).
eod

ATTR: allocation-algorithms
ATTRID: 15
ATTRTYPE: AT_FLAGSINT( client-request=1, reservation=2, extension=3, interface-identifier=4, random=5, best-fit=6 )
ATTRDEFVAL: reservation,extension,random,best-fit
ATTRDESC:: eod
Controls the algorithms used by the server to select a new address
or prefix to lease to a client. The available algorithms are:
  client-request
    This setting (off by default) controls whether the server
    uses a client requested lease.
  reservation
    This setting (on by default) controls whether the server
    uses an available reservation for the client.
  extension
    This setting (on by default) controls whether the server calls
    extensions attached at the generate-lease extension point
    to generate an address or prefix for the client.
  interface-identifier
    This setting (off by default) controls whether the server uses
    the interface-identifier from the client's (link-local)
    address to generate an address. It is ignored for temporary
    addresses and prefix delegation.
  random
    This setting (on by default) controls whether the server
    generates an address using an RFC 3041-like algorithm. It is
    is ignored for prefix delegation.
  best-fit
    This setting (on by default) controls whether the server will
    delegate the first, best-fit available prefix. It is ignored
    for addresses.

When the server needs an address to assign to a client, it
processes the flags in the following order: client-request,
reservation, extension, interface-identifier, and random.
Processing stops when a usable address is produced.

When the server needs to delegate a prefix to a client, it
processes the flags in the following order: client-request,
reservation, extension, best-fit. Processing stops when a
usable prefix is produced.

eod

ATTR: owner
ATTRID: 16
ATTRTYPE: AT_NAMEREF(CCMOwner)
ATTRVIZ: 1
ATTRVAL: 1416
ATTRDESC:: eod
Identifies the owner of this prefix, referenced by name. Owners
can be used to limit administrative access to prefixes
by owner.

If the prefix has an associated link, the owner of the
associated link will apply, if it is set.
If there is no associated link, or the link owner
is unset, the owner of the parent prefix will apply,
if the prefix owner is unset.

(Support for this attribute is deferred beyond 7.0).
eod

ATTR: region
ATTRID: 17
ATTRTYPE: AT_NAMEREF(CCMRegion)
ATTRVIZ: 1
ATTRVAL: 1425
ATTRDESC:: eod
Identifies the region for this prefix, referenced by name. Regions
can be used to limit administrative access to prefixes
by region.

If the prefix has an associated link, the region for the
associated link will apply, if it is set.
If there is no associated link, or the link region
is unset, the region for the parent prefix will apply,
if the prefix region is unset.

(Support for this attribute is deferred beyond 7.0).
eod

ATTR: description
ATTRID: 18
ATTRTYPE: AT_STRING
ATTRDESC:: eod
Describes the prefix.
eod

ATTR: local-cluster
ATTRID: 19
#ATTRTYPE: AT_OBJREF(CCMFailoverPair|CCMCluster)
ATTRTYPE: AT_OID
ATTRDESC:: eod
Identifies the local DHCP cluster or failover pair
for this regional prefix.
eod

ATTR: reverse-zone-prefix-length
ATTRID: 20
ATTRTYPE: AT_RANGEINT(0-124)
ATTRDESC:: eod
Specifies the prefix length of the reverse zone for ip6.arpa
updates. You do not need to specify the full reverse zone, 
because you can synthesize it by using the ip6.arpa domain. 

    Use a multiple of 4 for the value, because ip6.arpa zones 
    are on 4-bit boundaries. If not a multiple of 4, the value
    is rounded up to the next multiple of 4. 

    The maximum value is 124, because specifying 128 would 
    create a zone name without any possible hostnames 
    contained within. 

    A value of 0 means none of the bits are used for the zone 
    name, hence ip6.arpa is used. 

    If you omit the value from the DNS update configuration, 
    the server uses the value from the prefix or, as a last 
    resort, the prefix length derived from the address value
    of the prefix.
eod

ATTR: max-leases
ATTRID: 21
ATTRTYPE: AT_RANGEINT(0-2000000)
ATTRDEFVAL: 65536
ATTRDESC:: eod
Sets the maximum number of non-reserved leases that the server
will allow to exist on this prefix. When a new lease needs to
be created, the server will only do so if the limit has not
been exceeded. When the limit is exceeded, no new leases can be
created and offered to clients.

This limit is not applied when existing leases are loaded from
the lease state database during server start-up.

This attribute is also used when calculating the free-address
level for address traps.
eod

ATTR: free-address-config
ATTRID: 22
ATTRTYPE: AT_NAMEREF(AddrTrapConfig)
ATTRVAL: 1146
ATTRDESC:: eod
Identifies which trap captures unexpected free address events
on this prefix.

If this attribute is not configured, the server looks for
the free-address-config attribute on the parent Link object.
If that attribute is not configured, the server looks for
the v6-default-free-address-config on the DHCPServer object.
eod

# end prefix class

#
# DnsUpdateConfig -- dhcp configuration for dns updates
#

CLASS: DnsUpdateConfig
CLASSID: 1145
CLASSNAME: 1
CLASSVIZ: 5
CLASSPCV: 7.0.0
CLASSDESC:: eod
Provides configuration information to a DHCP server performing
DNS updates.
eod

ATTR: name
ATTRID: 1
ATTRTYPE: AT_STRING
ATTRFLAGS: AF_REQUIRED,AF_UNIQUE,AF_IMMUTABLE
ATTRDESC:: eod
Gives a unique name to the configuration object.
eod

ATTR: forward-zone-name
ATTRID: 2
ATTRTYPE: AT_DNSNAME
ATTRDESC:: eod
Designates the DNS forward zone used to add a DHCP client host name
(A record).
eod

ATTR: server-addr
ATTRID: 3
ATTRTYPE: AT_IPADDR
ATTRDESC:: eod
Specifies the DNS server address that receives dynamic DNS updates.
eod

ATTR: backup-server-addr
ATTRID: 4
ATTRTYPE: AT_IPADDR
ATTRDESC:: eod
Specifies the backup DNS server address that receives DNS updates
if the server specified in server-addr is down.
eod

ATTR: server-key
ATTRID: 5
ATTRTYPE: AT_NAMEREF(Key)
ATTRVAL: 54
ATTRDESC:: eod
Specifies the TSIG key used to process all dynamic DNS updates for
server-addr.
eod

ATTR: backup-server-key
ATTRID: 6
ATTRTYPE: AT_NAMEREF(Key)
ATTRVAL: 54
ATTRDESC:: eod
Specifies the TSIG key used to process all dynamic DNS updates for
backup-server-addr.
eod

# ATTRID: 7 is unused (was tsig-use for a short time)
ATTR: synthetic-name-stem
ATTRID: 8
ATTRTYPE: AT_STRING
ATTRDEFVAL: dhcp
ATTRDESC:: eod
Identifies the stem of the default host name to use if clients do not
supply host names.
eod

ATTR: dynamic-dns
ATTRID: 9
ATTRTYPE: AT_ENUMBYTE(update-none=0, update-all=1, update-fwd-only=2,update-reverse-only=3)
ATTRFLAGS: AF_FEATURE, AF_PRINT_ALT
ATTRDEFVAL: update-all
ATTRDESC:: eod
Controls whether the DHCP server should attempt to update a
DNS server with the name and address information from leases
that are granted to requesting clients.
eod

ATTR: synthesize-name
ATTRID: 10
ATTRTYPE: AT_BOOL
ATTRFLAGS: AF_FEATURE
ATTRDEFVAL: false
ATTRDESC:: eod
Controls whether the DHCP server automatically creates DNS host
names for DHCP clients that do not provide names. The server
can synthesize unique names for clients based on the 'synthetic
name stem' attribute.
eod

ATTR: update-dns-first
ATTRID: 11
ATTRTYPE: AT_BOOL
ATTRFLAGS: AF_FEATURE
ATTRDEFVAL: false
ATTRDESC:: eod
Controls whether to update the DNS server before granting a lease.
eod

ATTR: reverse-zone-name
ATTRID: 12
ATTRTYPE: AT_DNSNAME
ATTRDESC:: eod
Designates the DNS reverse (in-addr.arpa) zone that is updated
with PTR records.

If a reverse-zone-name is configured, DHCP always uses it.
Alternately, if DHCP server synthesize-reverse-zone feature is
enabled and if a reverse-zone-name is not configured, DHCP
uses the lease IP address and the scope dns-host-bytes to
automatically generate a reverse zone name.
eod

ATTR: update-dns-for-bootp
ATTRID: 13
ATTRTYPE: AT_BOOL
ATTRFLAGS: AF_FEATURE
ATTRDEFVAL: true
ATTRDESC:: eod
Controls whether the DNS server receives updates for BOOTP clients.

If the server is replying to a BOOTP request, and is offering a
lease configured to perform DNS updates, it checks
this attribute before beginning the DNS update. This attribute allows
an administrator to prevent DNS updates for BOOTP clients, while
allowing updates for DHCP clients. If not configured, the server
setting is used (which defaults to true).
eod

ATTR: dns-host-bytes
ATTRID: 14
ATTRTYPE: AT_RANGEINT(1-4)
ATTRDESC:: eod
Sets the number of bytes in a lease IP address to use when forming
in-addr.arpa names. The server forms names in the in-addr.arpa zone
by prepending these bytes of the address (in reverse order) to the
reverse zone name. If unset, the server synthesizes an appropriate
value based on the scopes subnet size.
eod

ATTR: use-dns-update-prereqs
ATTRID: 15
ATTRTYPE: AT_BOOL
ATTRDEFVAL: TRUE
ATTRDESC:: eod
If configured, the update ignores DHCP server level
use-dns-update-prereqs. By default (enabled), the DHCP server
adds prerequisites to DNS update messages to assure that the
current client uses the domain name, before updating the client
with the current lease (IP Address).

If disabled, the DHCP server assumes that the current client is
entitled to the domain name (and hence not add prerequisites to
DNS update message) and associates the client's current lease
with that domain name.

Note: The DHCP server always adds prerequisites to the DNS
update message while adding a new domain name record on behalf of
a client acquiring a new lease and removing the domain name record
when client release its lease or the lease expires.
eod

ATTR: force-dns-updates
ATTRID: 16
ATTRTYPE: AT_BOOL
ATTRDEFVAL: false
ATTRDESC:: eod
Determines whether the DHCP server retries a dynamic DNS update
whenever a client renews its lease, even if DHCP thinks that the
update has already been completed successfully.
eod

ATTR: max-dns-ttl
ATTRID: 17
ATTRTYPE: AT_TIME
ATTRVIZ: 5
ATTRDESC:: eod
Indicates the maximum number of seconds the DHCP server keeps DNS
records it acquired through dynamic updates. Default is 86400s (1d).
This value sets a ceiling (or time to live) on how long to keep
DNS updates.

When the DHCP server adds a DNS record, it uses a TTL of one
third the lease time if it is between min-dns-ttl and
max-dns-ttl values. If one third of the lease time is greater
than max-dns-ttl, the TTL value is set to max-dns-ttl.
eod

ATTR: min-dns-ttl
ATTRID: 18
ATTRTYPE: AT_TIME
ATTRVIZ: 5
ATTRDESC:: eod
Indicates the minimum number of seconds the DHCP server keeps the
DNS records acquired through dynamic updates. This value sets the
shortest allowable time (or time to live) to keep DNS updates.

When the DHCP server adds a DNS record, it uses a TTL of one
third the lease time if it is  between min-dns-ttl and
max-dns-ttl values. If one third of the lease time is smaller
than min-dns-ttl, the TTL value will be set to min-dns-ttl.
eod

ATTR: v6-synthetic-name-generator
ATTRID: 19
ATTRTYPE: AT_ENUMINT(duid=1,hashed-duid=2,cablelabs-device-id=3,cablelabs-cm-mac-addr=4)
ATTRFLAGS: AF_PRINT_ALT
ATTRDEFVAL: 2
ATTRDESC:: eod
Controls what the DHCP server appends to the synthetic name stem
when synthesizing the fully-qualified domain name for a client:

   duid
      The raw client DUID. This is formatted as a hexadecimal
      string with a hyphen as separator between each octet.

   hashed-duid
      The hashed client DUID. The rightmost 64-bits of the SHA-256
      hash over the client's DUID appended with the forward zone
      name (in DNS wire format) is used to generate a 13-character
      base 32 encoded string. This is the default method and the
      fallback method if the configured type is not possible
      (that is, the option needed to generate the selected type
      does not exist for the client).

   cablelabs-device-id
      The Cablelabs CL_OPTION_DEVICE_ID option data is used, if
      available. This is formatted as a hexadecimal string with a
      hyphen as separator between each octet. This might be used
      for names generated for DOCSIS 3.0 cable modems.

   cablelabs-cm-mac-addr
      The Cablelabs CL_CM_MAC_ADDR option data is used, if
      available. This is formatted as a hexadecimal string with
      a hyphen as separator between each octet. This might be
      used for names generated for CPEs behind a customer's
      DOCSIS 3.0 cable modem (if the customer has multiple CPEs,
      a name collision and disambiguation will likely result).

Note: Several of these methods may cause privacy concerns if
the DNS is accessible from the Internet.
eod

ATTR: reverse-zone-prefix-length
ATTRID: 20
ATTRTYPE: AT_RANGEINT(0-124)
ATTRDESC:: eod
Identifies the prefix length of the reverse zone for ip6.arpa
updates. The server forms the zone name using this value if
configured; otherwise the prefix length is determined from the
Prefix. This value must be a multiple of 4 as ip6.arpa zones are
on 4 bit (nibble) boundaries. If not a multiple of 4, it is
rounded up to the next higher multiple of 4.
eod

ATTR: one-aaaa-rr-per-dns-name
ATTRID: 21
ATTRTYPE: AT_BOOL
ATTRDEFVAL: false
ATTRVIZ: 3
ATTRDESC:: eod
Controls whether v6 dns updates delete existing AAAA records
for the same client and name, so that there is at most
one AAAA record per name per client in DNS.

This attribute should only be enabled in deployments using
multiple DHCP servers, where each DHCP server is configured
to give out at most one v6 lease per v6 client, and to give
out the same FQDN to the same v6 client.

Enabling this attribute may cause problems if the DHCP servers
are configured to allow Rapid Commit.

eod

ATTR: host-name-generator
ATTRID: 22
ATTRTYPE: AT_EXPR
ATTRDESC:: eod
Defines an expression that evaluates to the synthesized host name
to be used. If undefined or the expression returns "<none>", the
configured host name synthesis is used. If the expression returns
a null value, no host name will be used.
eod

ATTR: v6-host-name-generator
ATTRID: 23
ATTRTYPE: AT_EXPR
ATTRDESC:: eod
Defines an expression that evaluates to the synthesized host name
to be used. If undefined or the expression returns "<none>", the
configured host name synthesis is used. If the expression returns
a null value, no host name will be used.
eod



# end DnsUpdateConfig class

#
# the AddrTrapConfig class: used to configure free-address
# traps/events at the DHCP server.
#

CLASS: AddrTrapConfig
CLASSID: 1146
CLASSNAME: 1
CLASSVIZ: 5
CLASSPCV: 7.0.0
CLASSDESC:: eod
The configuration information for the DHCP server's
address-threshold notifications. Scopes may refer to these objects
to configure the notification. The DHCP server may also refer to
one that will serve as the global default.
eod

ATTR: name
ATTRID: 1
ATTRTYPE: AT_STRING
ATTRFLAGS: AF_REQUIRED,AF_UNIQUE,AF_IMMUTABLE
ATTRDESC:: eod
Gives a unique name to the configuration object.
eod

ATTR: mode
ATTRID: 2
ATTRTYPE: AT_ENUMINT(scope=1,network=2,selection-tags=3,prefix=4,link=5,v6-selection-tags=6,countonly=7,v6-countonly=8)
ATTRFLAGS: AF_PRINT_ALT
ATTRDEFVAL: 1
ATTRDESC:: eod
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.

eod

ATTR: enable
ATTRID: 3
ATTRTYPE: AT_BOOL
ATTRFLAGS: AF_PRINT_ALT
ATTRDEFVAL: true
ATTRDESC:: eod
Indicates whether this configuration is active, causing scopes to
track their free-address levels and possibly send trap events.
eod

ATTR: low-threshold
ATTRID: 4
ATTRTYPE: AT_PERCENT
ATTRDEFVAL: 20%
ATTRDESC:: eod
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.
eod

ATTR: high-threshold
ATTRID: 5
ATTRTYPE: AT_PERCENT
ATTRDEFVAL: 25%
ATTRDESC:: eod
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.
eod

# end addrtrapconfig class

#
# DHCPTopUtiliizedStats
#  added in 7.0 release
#
CLASS: DHCPTopUtilizedStats
CLASSID: 1147
CLASSPCV: 7.5.0
CLASSDESC:: eod
The top utilized DHCP scope aggregations. These aggregations
may be by scope, primary subnet, or primary subnet & selection
tags depending on the configuration of the AddrTrapConfig
objects.
eod

ATTR: list
ATTRID: 1
ATTRTYPE: AT_NLIST(AT_OBJ(DHCPScopeAggregationStats))
# 1<<16 | 1148
ATTRVAL: 66684
ATTRDESC:: eod
Lists the top utilized scope aggregations.
eod

#
# end - DHCPTopUtiliizedStats
#

#
# DHCPScopeAggregationStats
#  added in 7.0 release
#
CLASS: DHCPScopeAggregationStats
CLASSID: 1148
CLASSPCV: 7.5.0
CLASSDESC::eod
The utilization details for a scope aggregation.
eod

ATTR: name
ATTRID: 1
ATTRTYPE: AT_STRING
ATTRDESC:: eod
The name of the scope aggregation.

For scope aggregations, it is the name of the scope.
For network aggregations, it is the primary subnet.
For selection tag aggregations, it is the primary subnet
followed by the selection tags.
eod

ATTR: mode
ATTRID: 2
ATTRTYPE: AT_ENUMINT(scope=1,network=2,selection-tags=3,prefix=4,link=5,v6-selection-tags=6,countonly=7,v6-countonly=8)
ATTRFLAGS: AF_PRINT_ALT
ATTRDESC:: eod
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.
eod

ATTR: utilized-pct
ATTRID: 3
ATTRTYPE: AT_PERCENT
ATTRDESC:: eod
Displays the aggregation's percentage utilized.
eod

ATTR: in-use-addresses
ATTRID: 4
ATTRTYPE: AT_INT
ATTRDESC:: eod
Displays the number of addresses in use.
eod

ATTR: total-addresses
ATTRID: 5
ATTRTYPE: AT_INT
ATTRDESC:: eod
Displays the total number of addresses in the aggregation.
eod
#
# end - DHCPScopeAggregationStats
#


#
# PrefixTemplate class
#   attribute id matches Prefix class
#
CLASS: PrefixTemplate
CLASSID: 1149
CLASSNAME: 1
CLASSVIZ: 5
CLASSPCV: 7.5.0
CLASSDESC:: eod
A template to create IPv6 prefixes. The prefix
address and vpn can only be supplied as context variables.
Attributes of type AT_EXPR are evaluated as expressions
to generate a prefix-specific value for the corresponding
prefix attribute. All other attributes, except the prefix name,
are copied literally from the template to the newly created
prefix.
eod

ATTR: name
ATTRID: 1
ATTRTYPE: AT_STRING
ATTRFLAGS: AF_REQUIRED, AF_UNIQUE, AF_IMMUTABLE
ATTRDESC:: eod
Assigns a name to this prefix template.
eod

ATTR: prefix-name-expr
ATTRID: 2
ATTRTYPE: AT_EXPR
ATTRFLAGS: AF_PRINT_ALT
ATTRVAL: 1
ATTRDESC:: eod
Defines an expression that evaluates to an AT_STRING value
to use for the name of the prefix object created when using
the template.
eod

ATTR: selection-tags
ATTRID: 3
ATTRTYPE: AT_NLIST(AT_STRING)
ATTRDESC:: eod
Associates selection tags with an IPv6 prefix.
eod

ATTR: dhcp-type
ATTRID: 4
ATTRTYPE: AT_ENUMINT(stateless=0,dhcp=1,prefix-delegation=2,infrastructure=3,parent=4)
ATTRDEFVAL: dhcp
ATTRFLAGS: AF_PRINT_ALT
ATTRDESC:: eod
Defines how DHCP manages address assignment within a prefix:

  stateless         Prefix is used only for stateless
                    option configuration.

  dhcp              Prefix is used for stateful address
                    assignment.

  prefix-delegation Prefix is used for prefix-delegation.

  infrastructure    Prefix is used to map a client address to
                    a link, and does not have an address pool.

  parent            Prefix is not used by DHCP. It is used as
                    a container object, to group child prefixes.
eod

ATTR: range-expr
ATTRID: 5
ATTRTYPE: AT_EXPR
ATTRFLAGS: AF_PRINT_ALT
ATTRVAL: 5
ATTRDESC:: eod
Defines an expression that evaluates to an AT_PREFIX value
for the prefix range to be created.
eod

ATTR: policy
ATTRID: 6
ATTRTYPE: AT_NAMEREF(Policy)
ATTRVAL: 1102
ATTRDESC:: eod
Refers to a shared policy to use when replying to clients.
eod

ATTR: options-expr
ATTRID: 7
ATTRTYPE: AT_EXPR
ATTRFLAGS: AF_PRINT_ALT
ATTRVAL: 7
ATTRDESC:: eod
Defines an expression that evaluates to the list of
embedded policy options to be created.
eod

ATTR: expiration-time
ATTRID: 11
ATTRTYPE: AT_DATE
ATTRDESC:: eod
Sets the time and date on which a prefix expires. After this date
and time, the server neither grants new leases nor renews existing
leases from this prefix.

Once the expiration-time has passed, the prefix is no longer used
(though old leases and leases with grace or affinity periods
continue to exist until those periods elapse).

Enter this as a date in the format  "[weekday] mon day
hh:mm[:ss] year". For example, "Dec 31 23:59 2006".
eod

ATTR: ignore-declines
ATTRID: 13
ATTRTYPE: AT_BOOL
ATTRDEFVAL: false
ATTRDESC:: eod
Controls whether the DHCP server responds to a DHCPv6 DECLINE
message that refers to an IPv6 address or a delegated prefix
from this prefix.

If enabled, the DHCP server ignores all declines for leases
in this prefix.

If disabled or not set, the DHCP server sets to UNAVAILABLE
every address or delegated prefix requested in a DECLINE
message if it is leased to the client.

The default value is false, so that DECLINE messages are
processed normally.
eod

ATTR: deactivated
ATTRID: 14
ATTRTYPE: AT_BOOL
ATTRDEFVAL: false
ATTRFLAGS: AF_FEATURE
ATTRDESC:: eod
Controls whether a prefix extends leases to clients. A deactivated
prefix does not extend leases to any clients. It treats all addresses
in its ranges as if they were individually deactivated.

Default, false (active).
eod

ATTR: allocation-algorithms
ATTRID: 15
ATTRTYPE: AT_FLAGSINT(client-request=1,reservation=2,extension=3,interface-identifier=4,random=5,best-fit=6)
ATTRDEFVAL: reservation,extension,random,best-fit
ATTRDESC:: eod
Controls the algorithms used by the server to select a new address
or prefix to lease to a client. The available algorithms are:
  client-request
    This setting (off by default) controls whether the server
    uses a client requested lease.
  reservation
    This setting (on by default) controls whether the server
    uses an available reservation for the client.
  extension
    This setting (on by default) controls whether the server calls
    extensions attached at the generate-lease extension point
    to generate an address or prefix for the client.
  interface-identifier
    This setting (off by default) controls whether the server uses
    the interface-identifier from the client's (link-local)
    address to generate an address. It is ignored for temporary
    addresses and prefix delegation.
  random
    This setting (on by default) controls whether the server
    generates an address using an RFC 3041-like algorithm. It is
    is ignored for prefix delegation.
  best-fit
    This setting (on by default) controls whether the server will
    delegate the first, best-fit available prefix. It is ignored
    for addresses.

When the server needs an address to assign to a client, it
processes the flags in the following order: client-request,
reservation, extension, interface-identifier, and random.
Processing stops when a usable address is produced.

When the server needs to delegate a prefix to a client, it
processes the flags in the following order: client-request,
reservation, extension, best-fit. Processing stops when a
usable prefix is produced.
eod

ATTR: owner
ATTRID: 16
ATTRTYPE: AT_NAMEREF(CCMOwner)
ATTRVIZ: 1
ATTRVAL: 1416
ATTRDESC:: eod
Identifies the owner of this prefix, referenced by name. Owners
can be used to limit administrative access to prefixes
by owner.

If the prefix has an associated link, the owner of the
associated link will apply, if it is set.
If there is no associated link, or the link owner
is unset, the owner of the parent prefix will apply,
if the prefix owner is unset.

(Support for this attribute is deferred beyond 7.0).
eod

ATTR: region
ATTRID: 17
ATTRTYPE: AT_NAMEREF(CCMRegion)
ATTRVIZ: 1
ATTRVAL: 1425
ATTRDESC:: eod
Identifies the region for this prefix, referenced by name. Regions
can be used to limit administrative access to prefixes
by region.

If the prefix has an associated link, the region for the
associated link will apply, if it is set.
If there is no associated link, or the link region
is unset, the region for the parent prefix will apply,
if the prefix region is unset.

(Support for this attribute is deferred beyond 7.0).
eod

ATTR: prefix-description-expr
ATTRID: 18
ATTRTYPE: AT_EXPR
ATTRFLAGS: AF_PRINT_ALT
ATTRVAL: 18
ATTRDESC:: eod
Defines an AT_STRING expression to apply to the description
on the prefix object created when using the template.
eod

ATTR: description
ATTRID: 19
ATTRTYPE: AT_STRING
ATTRDESC:: eod
Describes the prefix template.
eod

ATTR: reverse-zone-prefix-length
ATTRID: 20
ATTRTYPE: AT_RANGEINT(0-124)
ATTRDESC:: eod
Identifies the prefix length of the reverse zone for ip6.arpa
updates. The server forms the zone name using this value if
configured; otherwise the prefix length is determined from the
Prefix. This value must be a multiple of 4 as ip6.arpa zones are
on 4 bit (nibble) boundaries. If not a multiple of 4, it is
rounded up to the next higher multiple of 4.
eod

ATTR: max-leases
ATTRID: 21
ATTRTYPE: AT_RANGEINT(0-2000000)
ATTRDEFVAL: 65536
ATTRDESC:: eod
Sets the maximum number of non-reserved leases that the server
will allow to exist on the prefix. When a new lease needs to
be created, the server will only do so if the limit has not
been exceeded. When the limit is exceeded, no new leases can be
created and offered to clients.
eod

ATTR: free-address-config
ATTRID: 22
ATTRTYPE: AT_NAMEREF(AddrTrapConfig)
ATTRVAL: 1146
ATTRDESC:: eod
Identifies which trap captures unexpected free address events
on this prefix.

If this attribute is not configured, the server looks for
the free-address-config attribute on the parent Link object.
If that attribute is not configured, the server looks for
the v6-default-free-address-config on the DHCPServer object.
eod

# end PrefixTemplate class

#
# the LinkTemplate class
#
CLASS: LinkTemplate
CLASSID: 1150
CLASSNAME: 1
CLASSPCV: 7.5.0
CLASSDESC:: eod
A template to create IPv6 links and associated prefixes.
The root prefix address and vpn can only be supplied as
context variables. Attributes of type AT_EXPR are evaluated
as expressions to generate a link-specific value for the
corresponding link attribute. The prefix-expr attribute is a
special case where the expression result defines the list
of prefix addresses and prefix templates, which combined with
the link vpn, are used to create associated prefixes. All
other attributes, except the link name and description, are
copied literally from the template to the newly created link.
eod

ATTR: name
ATTRID: 1
ATTRTYPE: AT_STRING
ATTRFLAGS: AF_REQUIRED,AF_UNIQUE,AF_IMMUTABLE
ATTRDESC:: eod
Assigns a name to this link template.
eod

ATTR: description
ATTRID: 2
ATTRTYPE: AT_STRING
ATTRDESC:: eod
Describes the link template.
eod

ATTR: link-name-expr
ATTRID: 3
ATTRTYPE: AT_EXPR
ATTRFLAGS: AF_PRINT_ALT
ATTRVAL: 1
ATTRDESC:: eod
An expression to define the name of the link object created
when using the template.
eod

ATTR: link-description-expr
ATTRID: 4
ATTRTYPE: AT_EXPR
ATTRFLAGS: AF_PRINT_ALT
ATTRVAL: 2
ATTRDESC:: eod
An expression to define the description on the link object
 created when using the template.
eod

ATTR: policy
ATTRID: 5
ATTRTYPE: AT_NAMEREF(Policy)
ATTRVAL: 1102
ATTRDEFVAL: default
ATTRDESC:: eod
Refers to a shared policy used when replying to clients.
eod

ATTR: options-expr
ATTRID: 6
ATTRTYPE: AT_EXPR
ATTRFLAGS: AF_PRINT_ALT
ATTRVAL: 5
ATTRDESC:: eod
An expression to define the list of embedded policy options
to be created.
eod

ATTR: owner
ATTRID: 7
ATTRTYPE: AT_NAMEREF(CCMOwner)
ATTRVIZ: 1
ATTRVAL: 1416
ATTRDESC:: eod
Identifies the owner of this link, referenced by name. Owners
can be used to limit administrative access by owner.

(Support for this attribute is deferred beyond 7.0).
eod

ATTR: region
ATTRID: 8
ATTRTYPE: AT_NAMEREF(CCMRegion)
ATTRVIZ: 1
ATTRVAL: 1425
ATTRDESC:: eod
Identifies the region for this link, referenced by name. Regions
can be used to limit administrative access by region.

(Support for this attribute is deferred beyond 7.0).
eod

ATTR: prefix-expr
ATTRID: 9
ATTRTYPE: AT_EXPR
ATTRFLAGS: AF_PRINT_ALT
ATTRDESC:: eod
Defines an expression used to create the list of associated
prefixes.
eod

ATTR: free-address-config
ATTRID: 10
ATTRTYPE: AT_NAMEREF(AddrTrapConfig)
ATTRVAL: 1146
ATTRDESC:: eod
Identifies which trap captures unexpected free address events
on this link.

If this attribute is not configured, the server looks for
the v6-default-free-address-config on the DHCPServer object.
eod

# end of LinkTemplate class

#
# the CurrentPrefixUtilization class
#
CLASS: CurrentPrefixUtilization
CLASSID: 1151
CLASSPCV: 7.5.0
CLASSDESC:: eod
Detailed address utilization information from a single DHCP prefix,
or for all DHCP prefixes contained in a parent prefix.
eod

ATTR: prefix-name
ATTRID: 1
ATTRTYPE: AT_STRING
ATTRDESC:: eod
For prefix level utilization data, the name of the prefix for which
this data applies.
eod

ATTR: prefix
ATTRID: 2
ATTRTYPE: AT_PREFIX
ATTRDESC:: eod
The prefix (network number and mask) for which this utilization
data applies.
eod

ATTR: vpn-id
ATTRID: 3
ATTRTYPE: AT_INT
ATTRDEFVAL: 0
ATTRDESC:: eod
The VPN identifier of the prefix for which this utilization
data applies.
eod

ATTR: aggregation-level
ATTRID: 4
ATTRTYPE: AT_ENUMINT(prefix-level=1,parent-prefix-level=2,totals=3)
ATTRFLAGS: AF_PRINT_ALT
ATTRDESC:: eod
Indicates the granularity of this utilization data. The
prefix-level is the most detailed data available from the DHCP
server. Aggregated counters are reported at the parent-prefix-level
for each dhcp-type. These are the sum of prefix-level counters
of a given type within the parent prefix address.
eod

ATTR: oid
ATTRID: 5
ATTRTYPE: AT_OID
ATTRVIZ: 3
ATTRDESC:: eod
The Prefix object reference for which this utilization data applies.
eod

ATTR: dhcp-type
ATTRID: 6
ATTRTYPE: AT_ENUMINT(stateless=0,dhcp=1,prefix-delegation=2,infrastructure=3)
ATTRDEFVAL: dhcp
ATTRFLAGS: AF_PRINT_ALT
ATTRDESC:: eod
The DHCP address assignment type associated with the prefix
for which this utilization data applies:

  stateless         Prefix is used only for stateless
                    option configuration.

  dhcp              Prefix is used for stateful address
                    assignment.

  prefix-delegation Prefix is used for prefix-delegation.

  infrastructure    Prefix is used to map a client address to
                    a link, and does not have an address pool.

eod

ATTR: offered
ATTRID: 7
ATTRTYPE: AT_INT
ATTRDESC:: eod
The number of dynamic leases (leases that are not reserved)
in this prefix that are currently offered to a client,
but not yet acknowledged as leased.
eod

ATTR: leased
ATTRID: 8
ATTRTYPE: AT_INT
ATTRDESC:: eod
The number of dynamic leases (leases that are not reserved) in this
prefix that are leased to DHCP clients.
eod

ATTR: expired
ATTRID: 9
ATTRTYPE: AT_INT
ATTRDESC:: eod
The number of dynamic leases (leases that are not reserved) in
this prefix that are past their lease expiration time,
but not yet available for other DHCP clients. An expired
(or released) lease will become available after the policy
grace-period has elapsed.
eod

ATTR: unavail
ATTRID: 10
ATTRTYPE: AT_INT
ATTRDESC:: eod
The number of dynamic leases (leases that are not reserved) in
this prefix that are currently marked unavailable.
A lease will be marked unavailable if it has been
declined by the client or the server has detected an address
conflict.  Leases in this state indicate there are configuration
errors in the network that need to be corrected.
eod

ATTR: revoked
ATTRID: 11
ATTRTYPE: AT_INT
ATTRDESC:: eod
The number of dynamic leases (leases that are not reserved) in
this prefix that are no longer usable by the client, but that
may still be in use.
eod

ATTR: leased-deactivated
ATTRID: 13
ATTRTYPE: AT_INT
ATTRDESC:: eod
The number of dynamic leases (leases that are not reserved) in
this prefix that are currently leased by DHCP clients,
but have also been deactivated by an administrator.
eod

ATTR: reserved-inactive
ATTRID: 14
ATTRTYPE: AT_INT
ATTRDESC:: eod
The number of reserved leases in this prefix
that are at present not used by their assigned DHCP clients.
eod

ATTR: reserved-active
ATTRID: 15
ATTRTYPE: AT_INT
ATTRDESC:: eod
The number of reserved leases in this prefix
that are actively being used by their assigned DHCP clients.
eod

ATTR: reserved-leased-deactivated
ATTRID: 16
ATTRTYPE: AT_INT
ATTRDESC:: eod
The number of reserved leases in this prefix
that are currently leased by their assigned DHCP clients,
but have also been deactivated by an administrator.
eod

ATTR: reserved-unavail
ATTRID: 17
ATTRTYPE: AT_INT
ATTRDESC:: eod
The number of reserved leases in this prefix
that have been marked unavailable. A lease will be marked
unavailable if the server has detected an address conflict.
Leases in this state indicate there are configuration errors
in the network that need to be corrected.
eod

ATTR: total-reserved
ATTRID: 19
ATTRTYPE: AT_INT
ATTRDESC:: eod
The total number of reserved leases configured in this prefix.
eod

ATTR: active-dynamic
ATTRID: 20
ATTRTYPE: AT_INT
ATTRDESC:: eod
The total number of dynamic leases in this prefix that are
actively in use. A lease is defined as active if it is in the
leased, offered, released, expired, or revoked state.
eod

ATTR: deactivated
ATTRID: 22
ATTRTYPE: AT_INT
ATTRDESC:: eod
The number of leases in this prefix, including
both regular leases and reservation leases,
that an administrator has deactivated.
eod

ATTR: prefix-deactivated
ATTRID: 23
ATTRTYPE: AT_BOOL
ATTRDEFVAL: false
ATTRDESC:: eod
For prefix-level counters, indicates whether the prefix has been
deactivated.
eod

ATTR: prefix-deactivated-count
ATTRID: 24
ATTRTYPE: AT_INT
ATTRDESC:: eod
For parent-prefix-level counters, indicates the number of prefixes
of this dhcp-type that are prefix-deactivated.
eod

ATTR: prefix-count
ATTRID: 25
ATTRTYPE: AT_INT
ATTRDESC:: eod
For parent-prefix-level counters, indicates the number of prefixes
of this dhcp-type.
eod

ATTR: prefix-range
ATTRID: 26
ATTRTYPE: AT_PREFIX
ATTRDESC:: eod
For prefix level utilization data, indicates the range of the prefix
for which this data applies.
eod

# end of CurrentPrefixUtilization class

CLASS: FQDNRemovalData
CLASSID: 1152
CLASSNAME: 1
CLASSPCV: 7.1.0
CLASSVIZ: 3
CLASSDESC:: eod
The data required for removing a name/address binding
from DNS. This class is embedded within an attribute
on Lease6 objects (hence there is no need to store the
address or the client identity).
eod

ATTR: fqdn
ATTRID: 1
ATTRTYPE: AT_DNSNAME

# This attribute's flags and the Lease6's attribute of
# the same name MUST have the same flag bits defined!
# Not all bits are significant here though!

ATTR: dns-update-flags
ATTRID: 2
ATTRTYPE: AT_FLAGSINT(forward-uptodate=1, reverse-uptodate=2, update-pending=3, add-pending=4, delete-pending=5, synthesized-name=6, using-requested-fqdn=7)

ATTR: forward-dnsupdate
ATTRID: 3
ATTRVAL: 1145
ATTRTYPE: AT_NAMEREF(DnsUpdateConfig)

ATTR: reverse-dnsupdate
ATTRID: 4
ATTRTYPE: AT_NAMEREF(DnsUpdateConfig)
ATTRVAL: 1145

ATTR: forward-zone-name
ATTRID: 5
ATTRTYPE: AT_DNSNAME

#
# end of FQDNRemovalData
#

#
# end of CLASSID RANGE DHCP 1100 - 1199
#

#
# CLASSID RANGE DNS classes 1200 - 1299
#

CLASS: DNSServer
CLASSROOT: DNSSERVER
CLASSID: 1200
CLASSNAME: 1
CLASSNAMEDESC:: eod
In Network Registrar, there is only one DNS server per cluster,
and DNS servers are not referenced by name.
eod
CLASSVIZ: 5
CLASSPCV: 1.0.0
CLASSDESC:: eod
The DNS server configuration object. This object is used to
configure server-wide properties.
eod

ATTR: name
ATTRID: 1
ATTRHDRNAME: AO_DNSSERVER_NAME
ATTRTYPE: AT_STRING
ATTRMCDPATH: name
ATTRDEFVAL: DNS
ATTRVIZ: 3
ATTRDESC:: eod
The name of the DNS server.
eod

ATTR: zones
ATTRID: 2
ATTRHDRNAME: AO_DNSSERVER_ZONES
ATTRTYPE: AT_ARRAY(AT_NAMEREF(Zone))
ATTRMCDPATH: zones
ATTRVIZ: 0
DEPRECATED: 4.0.0
ATTRVAL: 1201
ATTRDESC:: eod
There is no specific reference from a DNS server to
the zones that it is serving.
eod

ATTR: secondaryzones
ATTRID: 3
ATTRHDRNAME: AO_DNSSERVER_SECONDARYZONES
ATTRTYPE: AT_ARRAY(AT_NAMEREF(SecondaryZone))
ATTRMCDPATH: secondaryzones
ATTRVIZ: 0
DEPRECATED: 4.0.0
ATTRVAL: 1210
ATTRDESC:: eod
There is no specific reference from a DNS server to
the secondary zones that it is serving.
eod

ATTR: local-port-num
ATTRID: 10
ATTRHDRNAME: AO_DNSSERVER_LOCALPORT
ATTRTYPE: AT_RANGEINT(1-65535)
ATTRMCDPATH: local_port_num
ATTRVIZ: 5
ATTRDEFVAL: 53
ATTRDESC:: eod
Specifies the UDP and TCP port number that the DNS server
uses to listen for queries.
eod

ATTR: remote-port-num
ATTRID: 11
ATTRHDRNAME: AO_DNSSERVER_REMOTEPORT
ATTRTYPE: AT_RANGEINT(1-65535)
ATTRMCDPATH: remote_port_num
ATTRVIZ: 5
ATTRDEFVAL: 53
ATTRDESC:: eod
Specifies the UDP and TCP port number the DNS server
uses to send queries to other servers. Default is port 53.
eod

ATTR: rcv-bufsize
ATTRID: 12
ATTRHDRNAME: AO_DNSSERVER_RECVBUFSZ
ATTRTYPE: AT_RANGEINT(512-65535)
ATTRMCDPATH: rcv_bufsize
ATTRVIZ: 3
ATTRDEFVAL: 8192
ATTRDESC:: eod
Size of UDP socket send and receive buffer sizes in kernel.
eod

ATTR: snd-bufsize
ATTRID: 13
ATTRHDRNAME: AO_DNSSERVER_SNDBUFSZ
ATTRTYPE: AT_RANGEINT(1-65535)
ATTRMCDPATH: snd_bufsize
ATTRVIZ: 3
ATTRDEFVAL: 16384
ATTRDESC:: eod
Size of TCP socket send buffer size in kernel.
eod

ATTR: no-fetch-glue
ATTRID: 14
ATTRHDRNAME: AO_DNSSERVER_NOFETCHGLUE
ATTRTYPE: AT_BOOL
ATTRFLAGS: AF_FEATURE
ATTRDEFVAL: false
ATTRMCDPATH: no_fetch_glue
ATTRVIZ: 5
ATTRDESC:: eod
Specifies whether you want the DNS server, when composing
a response to a query, to fetch missing glue records.
Glue records are DNS A records, which specify the address of a
domain's authoritative name servers. Normal DNS responses include
NS records and their A records related to the name being queried.
eod
ATTR: no-recurse
ATTRID: 15
ATTRHDRNAME: AO_DNSSERVER_NORECURSE
ATTRTYPE: AT_BOOL
ATTRFLAGS: AF_FEATURE
ATTRDEFVAL: false
ATTRMCDPATH: no_recurse
ATTRVIZ: 5
ATTRDESC:: eod
Specifies whether you want to disable forwarding client queries
to other name servers when your DNS server is
not authoritative for data in its own cache. If you disable
recursive queries, you make your name server a noncaching server.
eod

ATTR: slave-mode
ATTRID: 16
ATTRHDRNAME: AO_DNSSERVER_SLAVEMODE
ATTRTYPE: AT_BOOL
ATTRFLAGS: AF_PRINT_ONOFF,AF_FEATURE
ATTRDEFVAL: false
ATTRMCDPATH: slave_mode
ATTRVIZ: 5
ATTRDESC:: eod
Specifies whether you want this server to be a slave server; that
is, a server that relies entirely on forwarders for data that
is not in its cache. Default is false (disable).

This attribute takes effect only if you specify the corresponding
forwarders.

Note: You can override slave-mode for specific domains with the
exception-list property.

eod

# DEPRECATED in favor of lame-delegation log setting
ATTR: lame-deleg-notify
ATTRID: 17
ATTRHDRNAME: AO_DNSSERVER_LAMEDELEGNOTIFY
ATTRTYPE: AT_BOOL
ATTRFLAGS: AF_PRINT_ONOFF,AF_FEATURE
DEPRECATED: 6.1
ATTRDEFVAL: true
ATTRMCDPATH: lame_deleg_notify
ATTRVIZ: 1
ATTRDESC:: eod
Specifies whether you want Network Registrar to notice and
log when a DNS server listed in a parent-zone's delegation
of subzones does not know that is authoritative for the zone.
eod

# DEPRECATED in favor of max-negcache-ttl
#
ATTR: neg-cache-ttl
ATTRID: 18
ATTRHDRNAME: AO_DNSSERVER_NEGCACHETTL
ATTRTYPE: AT_RANGETIME(0-2147483647)
ATTRMCDPATH: neg_cache_ttl
ATTRVIZ: 5
DEPRECATED: 4.0
ATTRDEFVAL: 600
ATTRDESC:: eod
Indicates how long information learned from other name
servers about non-existent names or data should be cached.
eod


ATTR: min-cache-ttl
ATTRID: 19
ATTRHDRNAME: AO_DNSSERVER_MINCACHETTL
ATTRTYPE: AT_RANGETIME(0-2147483647)
ATTRMCDPATH: min_cache_ttl
ATTRVIZ: 3
ATTRDEFVAL: 1
ATTRDESC:: eod
The minimum length of time, in seconds, to cache data learned from
other name servers.  Overrides individual resource record TTLs,
which is technically incorrect.  Primarily used to allow
non-cacheable(0 TTL) records to be employed effectively in complex
name resolutions.
eod


ATTR: max-cache-ttl
ATTRID: 20
ATTRHDRNAME: AO_DNSSERVER_MAXCACHETTL
ATTRTYPE: AT_RANGETIME(0-2147483647)
ATTRMCDPATH: max_cache_ttl
ATTRVIZ: 5
ATTRDEFVAL: 604800
ATTRDESC:: eod
Sets the maximum amount of time that you want the DNS server
to retain cached information.  Default is 604800s (1w).
eod

ATTR: mem-cache-size
ATTRID: 21
ATTRHDRNAME: AO_DNSSERVER_MAXMEMCACHESIZE
ATTRTYPE: AT_RANGEINT(200-4194303)
ATTRMCDPATH: mem_cache_size_limit
ATTRVIZ: 5
ATTRDEFVAL: 50000
ATTRDESC:: eod
Indicates the size, in kilobytes, of the in-memory record cache.
Default is 50000 (50MB).
eod

ATTR: btree-page-size
ATTRID: 22
ATTRHDRNAME: AO_DNSSERVER_BTREEPAGESIZE
ATTRTYPE: AT_INT
ATTRMCDPATH: btree_page_size
ATTRVIZ: 1
ATTRDEFVAL: 0
ATTRDESC:: eod
Page size of DB B-tree databases.  Zero indicates autosize
to match filesystem blocksize or preferred I/O size.
eod

ATTR: hash-page-size
ATTRID: 23
ATTRHDRNAME: AO_DNSSERVER_HASHPAGESIZE
ATTRTYPE: AT_INT
ATTRMCDPATH: hash_page_size
ATTRVIZ: 1
ATTRDEFVAL: 0
ATTRDESC:: eod
Page size of DB hash-table databases.  Zero indicates
autosize to match filesystem blocksize or prefered I/O size.
eod

ATTR: defer-zone-load
ATTRID: 24
ATTRHDRNAME: AO_DNSSERVER_DEFERZONELOAD
ATTRTYPE: AT_BOOL
ATTRFLAGS: AF_FEATURE
ATTRDEFVAL: true
ATTRMCDPATH: defer_zone_load
ATTRVIZ: 1
DEPRECATED: 4.0
ATTRDESC:: eod
Enable deferred zone loading to improve reload performance
with new zones.
eod

ATTR: cache-reconnect
ATTRID: 25
ATTRHDRNAME: AO_DNSSERVER_CACHERECONNECT
ATTRTYPE: AT_BOOL
ATTRFLAGS: AF_FEATURE
ATTRDEFVAL: true
ATTRMCDPATH: cache_reconnect
ATTRVIZ: 3
ATTRDESC:: eod
Controls reuse of exiting cache database files on reload.
Disabling this will disable cache persistence across reloads
and restarts.
eod

ATTR: auth-reconnect
ATTRID: 26
ATTRHDRNAME: AO_DNSSERVER_AUTHRECONNECT
ATTRTYPE: AT_BOOL
ATTRFLAGS: AF_FEATURE
ATTRDEFVAL: true
ATTRMCDPATH: auth_reconnect
ATTRVIZ: 3
ATTRDESC:: eod
Controls reuse of existing authoritative zone database files
on reload.  Disabling this will force the server to re-read all
zone data from MCD on each reload or restart.
eod

ATTR: xfer-server-concurrent-limit
ATTRID: 27
ATTRHDRNAME: AO_DNSSERVER_XFERSERVERLIMIT
ATTRTYPE: AT_RANGEINT(1-2147483647)
ATTRMCDPATH: xfer_server_concurrent_limit
ATTRVIZ: 3
ATTRDEFVAL: 5
ATTRDESC:: eod
The number of concurrent out-going zone transfers which
may be served.
eod

ATTR: xfer-client-concurrent-limit
ATTRID: 28
ATTRHDRNAME: AO_DNSSERVER_XFERCLIENTLIMIT
ATTRTYPE: AT_RANGEINT(1-2147483647)
ATTRMCDPATH: xfer_client_concurrent_limit
ATTRVIZ: 3
ATTRDEFVAL: 3
ATTRDESC:: eod
The number of concurrent in-coming zone transfers which
will be requested.
eod

ATTR: round-robin
ATTRID: 29
ATTRHDRNAME: AO_DNSSERVER_ROUND_ROBIN
ATTRTYPE: AT_BOOL
ATTRFLAGS: AF_FEATURE
ATTRDEFVAL: true
ATTRMCDPATH: round_robin
ATTRVIZ: 5
ATTRDESC:: eod
Specifies whether you want round-robin cycling of equivalent
records in responses to queries. Equivalent records are records
of the same name and type. Since clients often only look at the
first record of a set, enabling this features can help balance
loads and keep clients from forever trying to talk to an
out-of-service host.
eod

ATTR: axfr-multirec-default
ATTRID: 30
ATTRHDRNAME: AO_DNSSERVER_AXFR_MULTIREC_DEFAULT
ATTRTYPE: AT_BOOL
ATTRFLAGS: AF_FEATURE
ATTRMCDPATH: axfr_multirec_default
ATTRFLAGS: AF_PRINT_ONOFF
ATTRVIZ: 5
ATTRDEFVAL: true
ATTRDESC:: eod
Determines the default multi-record AXFR choice for
foreign (remote) servers not found in remote server list.
Default is true (enable). Only old version Bind 8.x and
Microsoft NT version require this attribute to set false.
eod

ATTR: ixfr-client-default
ATTRID: 31
ATTRHDRNAME: AO_DNSSERVER_IXFR_CLIENT_DEFAULT
ATTRTYPE: AT_BOOL
ATTRFLAGS: AF_FEATURE
ATTRFLAGS: AF_PRINT_ONOFF
ATTRMCDPATH: ixfr_client_default
ATTRVIZ: 3
ATTRDEFVAL: true
ATTRDESC:: eod
The default IXFR query choice for foreign (remote) servers not
found in remote server list.
eod

ATTR: ixfr-enable
ATTRID: 32
ATTRHDRNAME: AO_DNSSERVER_IXFR_ENABLE
ATTRTYPE: AT_BOOL
ATTRFLAGS: AF_FEATURE
ATTRDEFVAL: true
ATTRMCDPATH: ixfr_enable
ATTRVIZ: 5
ATTRDESC:: eod
Controls the incremental transfer behavior for zones for
which you have not configured a specific behavior. Required,
true (enable).
eod

ATTR: chg-set-max-recs
ATTRID: 33
ATTRHDRNAME: AO_DNSSERVER_CHG_SET_MAX_RECS
ATTRTYPE: AT_INT
ATTRMCDPATH: chg_set_max_recs
ATTRVIZ: 1
DEPRECATED: 4.0
ATTRDEFVAL: 0
ATTRDESC:: eod
The maximum number of change records to accumulate in
one change-set.  Zero indicates no limit.
eod

ATTR: ixfr-min-zone-size
ATTRID: 34
ATTRHDRNAME: AO_DNSSERVER_IXFR_MIN_ZONE_SIZE
ATTRTYPE: AT_INT
ATTRMCDPATH: ixfr_min_zone_size
ATTRVIZ: 3
ATTRDEFVAL: 50
ATTRDESC:: eod
The smallest zone size, by resource record count, for which
incremental transfer will be provided.
eod

ATTR: chg-set-history
ATTRID: 35
ATTRHDRNAME: AO_DNSSERVER_CHG_SET_HISTORY
ATTRTYPE: AT_INT
ATTRMCDPATH: chg_set_history
ATTRVIZ: 1
DEPRECATED: 4.0
ATTRDEFVAL: 10
ATTRDESC:: eod
The number of serial number change-sets, per zone, which
should be preserved for the generation of incremental transfers.
Zero indicates no limit.
eod

ATTR: chg-set-max-age
ATTRID: 36
ATTRHDRNAME: AO_DNSSERVER_CHG_SET_MAX_AGE
ATTRTYPE: AT_RANGETIME(0-2147483647)
ATTRMCDPATH: chg_set_max_age
ATTRVIZ: 1
DEPRECATED: 4.0
ATTRDEFVAL: 0
ATTRDESC:: eod
The longest time, in seconds, for which serial number change-sets
should be preserved for the generation of incremental transfers.
Zero indicates no limit.
eod

ATTR: chg-set-total-recs
ATTRID: 37
ATTRHDRNAME: AO_DNSSERVER_CHG_SET_TOTAL_RECS
ATTRTYPE: AT_INT
ATTRMCDPATH: chg_set_total_recs
ATTRVIZ: 1
DEPRECATED: 4.0
ATTRDEFVAL: 0
ATTRDESC:: eod
The maximum number of change set records to preserve, across
multiple serial number changes, for the generation of incremental
transfers.  Zero indicates no limit.
eod

ATTR: ixfr-expire-interval
ATTRID: 38
ATTRHDRNAME: AO_DNSSERVER_IXFR_EXPIRE_INTERVAL
ATTRTYPE: AT_RANGETIME(0-2147483647)
ATTRMCDPATH: ixfr_expire_interval
ATTRVIZ: 5
ATTRDEFVAL: 0
ATTRDESC:: eod
Specifies the maximum duration between full zone transfers that 
the DNS server will request incremental transfer updates for its 
secondary zones.  After this time interval expires, even if an 
incremental transfer would normally be requested, the DNS server 
will instead request a full zone transfer.  Setting this value 
to 0 does not enforce any time limit between full zone transfers.
eod

ATTR: notify
ATTRID: 39
ATTRHDRNAME: AO_DNSSERVER_NOTIFY_ENABLE
ATTRTYPE: AT_BOOL
ATTRFLAGS: AF_FEATURE
ATTRDEFVAL: true
ATTRMCDPATH: notify_enable
ATTRVIZ: 5
ATTRDESC:: eod
Controls how the DNS server sends NOTIFY packets for zones
that have changed. Default is true (enable).

You must also set these attributes or accept their defaults:
notify-defer-cnt, notify-min-interval, notify-rcv-internal,
notify-send-stagger, notify-wait.
eod

ATTR: notify-send-stagger
ATTRID: 40
ATTRHDRNAME: AO_DNSSERVER_NOTIFY_SEND_STAGGER
ATTRTYPE: AT_RANGETIME(0-2147483647)
ATTRMCDPATH: notify_send_stagger
ATTRVIZ: 5
ATTRDEFVAL: 1
ATTRDESC:: eod
With the notify attribute enabled, sets the interval
to use for staggering notifications to multiple servers
about a zone change. Default is 1s.
eod

ATTR: notify-min-interval
ATTRID: 41
ATTRHDRNAME: AO_DNSSERVER_NOTIFY_MIN_INTERVAL
ATTRTYPE: AT_RANGETIME(0-2147483647)
ATTRMCDPATH: notify_min_interval
ATTRVIZ: 5
ATTRDEFVAL: 2
ATTRDESC:: eod
With the notify attribute enabled, sets the minimum interval
required before sending notification to a particular server of
consecutive changes on the same zone. Default is 2s.
eod

ATTR: notify-wait
ATTRID: 42
ATTRHDRNAME: AO_DNSSERVER_NOTIFY_WAIT
ATTRTYPE: AT_RANGETIME(0-2147483647)
ATTRMCDPATH: notify_wait
ATTRVIZ: 5
ATTRDEFVAL: 5
ATTRDESC:: eod
With the notify attribute enabled, and after an initial zone
change, sets the period of time for the DNS server to wait
before it sends change notification to other name servers.
Default is 5s.

This property allows you to accumulate multiple changes,
and thus limit the number of times the serial number advances.
eod
ATTR: notify-defer-cnt
ATTRID: 43
ATTRHDRNAME: AO_DNSSERVER_NOTIFY_DEFER_CNT
ATTRTYPE: AT_INT
ATTRMCDPATH: notify_defer_cnt
ATTRVIZ: 5
ATTRDEFVAL: 100
ATTRDESC:: eod
With the notify attribute enabled, sets the maximum number of
changes the DNS server can accumulate during the notify-wait
period. If changes exceed this number, the DNS server sends
notification before the notify-wait period has elapsed.
Default is 100 changes.
eod

ATTR: notify-rcv-interval
ATTRID: 44
ATTRHDRNAME: AO_DNSSERVER_NOTIFY_RCV_INTERVAL
ATTRTYPE: AT_RANGETIME(0-2147483647)
ATTRMCDPATH: notify_rcv_interval
ATTRVIZ: 5
ATTRDEFVAL: 5
ATTRDESC:: eod
With the notify attribute enabled for secondary zones, sets the
minimum amount of time between complete processing of one
notification (serial number testing and/or zone transfer), and
the start of processing of another notification. ,
default 5s.
eod

ATTR: update-relax-zone-name
ATTRID: 45
ATTRHDRNAME: AO_DNSSERVER_UPDATE_RELAX_ZONE_NAME
ATTRTYPE: AT_BOOL
ATTRFLAGS: AF_FEATURE
ATTRDEFVAL: false
ATTRMCDPATH: update_relax_zone_name
ATTRVIZ: 5
ATTRDESC:: eod
Enables DNS updates to specify any zone name in the authoritative
zone rather than the exact zone name; thus, relaxing the RFC 2136
restriction on the zone name record in dynamic updates. This
attribute allows updates to specify a zone name which is any name
within an authoritative zone rather than exactly the name of a zone.
eod

ATTR: do-incr-zone-load
ATTRID: 46
ATTRHDRNAME: AO_DNSSERVER_DO_INCR_ZONE_LOAD
ATTRTYPE: AT_BOOL
ATTRFLAGS: AF_FEATURE
ATTRDEFVAL: true
ATTRMCDPATH: do_incr_zone_load
ATTRVIZ: 3
ATTRDESC:: eod
Enables incremental (change-based) loading of changes to primary
zone resource records, rather than reloading of entire zones
records.
eod

ATTR: strm-bufsize
ATTRID: 47
ATTRHDRNAME: AO_DNSSERVER_STRM_BUFSIZE
ATTRTYPE: AT_RANGEINT(1024-0xffff)
ATTRMCDPATH: strm_bufsize
ATTRVIZ: 1
ATTRDEFVAL: 16384
ATTRDESC:: eod
Size of buffers allocated for composition of TCP responses and
zone transfer packets.
eod

ATTR: table-read-cnt
ATTRID: 48
ATTRHDRNAME: AO_DNSSERVER_TABLE_READ_CNT
ATTRTYPE: AT_RANGEINT(1-10000)
ATTRMCDPATH: table_read_cnt
ATTRVIZ: 1
ATTRDEFVAL: 200
ATTRDESC:: eod
Maximum number of RR Table records to read in one MCD transaction.
eod

ATTR: table-write-cnt
ATTRID: 49
ATTRHDRNAME: AO_DNSSERVER_TABLE_WRITE_CNT
ATTRTYPE: AT_RANGEINT(1-10000)
ATTRMCDPATH: table_write_cnt
ATTRVIZ: 1
DEPRECATED: 4.0
ATTRDEFVAL: 100
ATTRDESC:: eod
Maximum number of existing RR Table records to write in one
MCD transaction.  Used for "whiting-out" deleted records
(preserved as deletions for IXFR).
eod

ATTR: table-clobber-cnt
ATTRID: 50
ATTRHDRNAME: AO_DNSSERVER_TABLE_CLOBBER_CNT
ATTRTYPE: AT_RANGEINT(1-10000)
ATTRMCDPATH: table_clobber_cnt
ATTRVIZ: 1
DEPRECATED: 4.0
ATTRDEFVAL: 150
ATTRDESC:: eod
Maximum number of RR Table records to eliminate in one MCD
transaction.  Used for removing historical records (preserved
for IXFR) or failed zone transfers.
eod

ATTR: table-setmany-cnt
ATTRID: 51
ATTRHDRNAME: AO_DNSSERVER_TABLE_SETMANY_CNT
ATTRTYPE: AT_RANGEINT(1-10000)
ATTRMCDPATH: table_setmany_cnt
ATTRVIZ: 1
DEPRECATED: 4.0
ATTRDEFVAL: 75
ATTRDESC:: eod
Maximum number of RR Table records so add in one MCD transaction.
Used for buffering of writes for full zone transfers.
eod

ATTR: xfer-server-max-time
ATTRID: 52
ATTRHDRNAME: AO_DNSSERVER_XFER_SERVER_MAX_TIME
ATTRTYPE: AT_RANGETIME(0-2147483647)
ATTRMCDPATH: xfer_server_max_time
ATTRVIZ: 3
ATTRDEFVAL: 21600
ATTRDESC:: eod
Maximum time, in seconds, to allow an outbound zone transfer to
go on.
eod

ATTR: xfer-client-error-handling-flags
ATTRID: 53
ATTRHDRNAME: AO_DNSSERVER_XFER_CLIENT_ERROR_HANDLING_FLAGS
ATTRTYPE: AT_FLAGSINT(ignore-inval-recs=1, ignore-inval-class=2, log-inval-recs=9, log-inval-class=10, ignore-dupl-recs=11)
ATTRMCDPATH: xfer_client_error_handling_flags
ATTRVIZ: 3
ATTRDEFVAL: 1795
ATTRDESC:: eod
Bitmap indicating handling of invalid and improper-class
resource records received in zone transfers.  Controls logging
and continuation of transfer.
eod

ATTR: xfer-client-def-retry-time
ATTRID: 54
ATTRHDRNAME: AO_DNSSERVER_XFER_CLIENT_DEF_RETRY_TIME
ATTRTYPE: AT_RANGETIME(1-2147483647)
ATTRMCDPATH: xfer_client_def_retry_time
ATTRVIZ: 3
ATTRDEFVAL: 600
ATTRDESC:: eod
Default zone transfer retry time used for secondary zones
which have not yet seen an SOA record (and for that reason do
not know the correct retry time).
eod

ATTR: notify-retry
ATTRID: 55
ATTRHDRNAME: AO_DNSSERVER_NOTIFY_RETRY
ATTRTYPE: AT_RANGETIME(0-2147483647)
ATTRMCDPATH: notify_retry
ATTRVIZ: 3
ATTRDEFVAL: 10
ATTRDESC:: eod
The period of time to delay, after encountering an error
sending change notification to other name servers, before
retrying sending the change notification.
eod

ATTR: defer-wrt-interval
ATTRID: 56
ATTRHDRNAME: AO_DNSSERVER_DEFER_WRT_INTERVAL
ATTRTYPE: AT_INT
ATTRDEFVAL: 1000
ATTRMCDPATH: defer_wrt_interval
ATTRVIZ: 1
DEPRECATED: 4.0
ATTRDESC:: eod
The interval (in milliseconds) at which to flush deferred dynamic
update resource records to the database.
eod

ATTR: subnet-sorting
ATTRID: 57
ATTRHDRNAME: AO_DNSSERVER_SUBNET_SORTING
ATTRTYPE: AT_BOOL
ATTRFLAGS: AF_FEATURE
ATTRDEFVAL: false
ATTRMCDPATH: subnet_sorting
ATTRVIZ: 5
ATTRDESC:: eod
Controls whether DNS reorders A records when responding to client
queries. Default is false (disable).

As implemented in BIND 4.9.7, the Network Registrar DNS
server confirms the clients network address before responding to
a query. If the client, server, and target of the query are on the
same subnet, and the target has multiple A records, the server tries
to reorder the A records in its response by putting the targets
closest address first in the response packet.

Because clients often only look at the first record in a set,
enabling this attribute can help localize network traffic onto
a subnet. This attribute is only applied on answers to queries
from clients located on the same subnet as the DNS server.

eod

ATTR: fail-if-unknown
ATTRID: 58
ATTRHDRNAME: AO_DNSSERVER_FAIL_IF_UNKNOWN
ATTRTYPE: AT_BOOL
ATTRFLAGS: AF_FEATURE
ATTRMCDPATH: fail_if_unknown
ATTRVIZ: 3
ATTRDEFVAL: false
ATTRDESC:: eod
Configures the server to respond with SERVFAIL if a non-recursive
query would result in a referral rather than an authoritative
response.
eod

ATTR: force-recursion
ATTRID: 59
ATTRHDRNAME: AO_DNSSERVER_FORCE_RECURSION
ATTRTYPE: AT_BOOL
ATTRFLAGS: AF_FEATURE
ATTRMCDPATH: force_recursion
ATTRVIZ: 3
ATTRDEFVAL: false
ATTRDESC:: eod
Configures the server to force queries to be recursive. This is
related to the attribute fail_if_unknown which will respond with
an error rather than referring the client to another name server.
eod

ATTR: hide-subzones
ATTRID: 60
ATTRHDRNAME: AO_DNSSERVER_HIDE_SUBZONES
ATTRTYPE: AT_BOOL
ATTRFLAGS: AF_FEATURE
ATTRMCDPATH: hide_subzones
ATTRVIZ: 3
ATTRDEFVAL: false
ATTRDESC:: eod
Configures the server to hide all information about the subzone
hierarchy for all zones delegated from this server.  This feature
effectively collapses a portion of the domain vpn into one
"virtual zone".
eod

#
# this attr wasn't ever used in cnr
#
ATTR: static-address-pools
ATTRID: 61
ATTRHDRNAME: AO_DNSSERVER_STATIC_ADDRESS_POOLS
ATTRTYPE: AT_BOOL
ATTRFLAGS: AF_FEATURE
ATTRDEFVAL: false
ATTRMCDPATH: static_address_pools
DEPRECATED: 3.0
ATTRVIZ: 1
ATTRDESC:: eod
Controls whether management of address allocation using static
address pools is allowed.  Enabling creates the
outside-address-pool and enabled maintenance of it.  Disabling
removes the outside-address-pool and deletes any static-pool
objects.
All address allocations are retained, but are no longer associated
with a pool.
eod

ATTR: use-update-optimization
ATTRID: 62
ATTRHDRNAME: AO_DNSSERVER_USE_UPDATE_OPTIMIZATION
ATTRTYPE: AT_BOOL
ATTRDEFVAL: true
ATTRMCDPATH: use_update_optimization
ATTRVIZ: 3
ATTRDESC:: eod
Controls whether dns code checks for multiple pending updates to
RR buffer.
If TRUE, code checks if we're the only pending update to the
buffer, and if so, it does a flush of the RRs to the database.
If FALSE, this optimization will be skipped, and we won't flush
on this particular event.  This flag was added to help with case
where many updates are pending directly after we've locked and
checked, so many extra flushes are being done.
eod

ATTR: min-working-set-size
ATTRID: 63
ATTRHDRNAME: AO_DNSSERVER_MIN_WORKING_SET_SIZE
ATTRTYPE: AT_INT
ATTRDEFVAL: 0
ATTRMCDPATH: min_working_set_size
ATTRVIZ: 3
ATTRDESC:: eod
For NT platforms, defines the DNS server's minimum working set
size.
eod

ATTR: max-working-set-size
ATTRID: 64
ATTRHDRNAME: AO_DNSSERVER_MAX_WORKING_SET_SIZE
ATTRTYPE: AT_INT
ATTRDEFVAL: 0
ATTRMCDPATH: max_working_set_size
ATTRVIZ: 3
ATTRDESC:: eod
For NT platforms, defines the DNS server's maximum working set
size.
eod

ATTR: enforce-min-ttl
ATTRID: 65
ATTRHDRNAME: AO_DNSSERVER_ENFORCEMINTTL
ATTRTYPE: AT_BOOL
ATTRFLAGS: AF_FEATURE
ATTRDEFVAL: false
ATTRMCDPATH: enforce_min_ttl
ATTRVIZ: 3
ATTRDESC:: eod
Enforce minimum ttl using minttl value in dns server definition.
eod

ATTR: relax-ixfr-query-validation
ATTRID: 66
ATTRHDRNAME: AO_DNSSERVER_RELAX_IXFR_QUERY_CHECK
ATTRTYPE: AT_BOOL
ATTRFLAGS: AF_FEATURE
ATTRDEFVAL: false
ATTRMCDPATH: relax_ixfr_query_validation
ATTRVIZ: 3
ATTRDESC:: eod
When responding to an IXFR request with a full zone response,
BIND 8.2.2p5 returns a response containing an AXFR in the
query section when it should be IXFR - matching the original
request. CNR expects question(s) in a response to match what was
originally furnished in the request. Though this is clearly a BIND
bug, BIND 8.2.2p5 is widely deployed. Hence, as a workaround,
enabling this DNS server attribute shall cause CNR to relax the
query validation in IXFR responses.
eod

ATTR: simulate-zone-top-dynupdate
ATTRID: 67
ATTRHDRNAME: AO_DNSSERVER_SIMULATE_ZONE_TOP_DYNUPDATE
ATTRTYPE: AT_BOOL
ATTRFLAGS: AF_FEATURE
ATTRDEFVAL: false
ATTRMCDPATH: simulate_zone_top_dynupdate
ATTRVIZ: 5
ATTRDESC:: eod
Enables compatibility with a Windows 2000 Domain Controller.
When processing a dynamic update packet, which attempts to add
or remove A records from the name of a zone, DNS responds as if
the update succeeded, rather than responding with a refusal, as
would normally occur due to the protected/unprotected name
conflict. No update to the records at the zone name will actually
occur, although the response indicates that it has.

eod

ATTR: changeset-db-transaction-interval
ATTRID: 71
ATTRHDRNAME: AO_DNSSERVER_CSETDB_XACT_INTERVAL
ATTRTYPE: AT_RANGEINT(2-2000)
ATTRDEFVAL: 10
ATTRMCDPATH: changeset_db_xact_interval
ATTRVIZ: 3
ATTRDESC:: eod
Time interval (ms) to commit a Changeset DB transaction
in the underlying Btree DB. Default is 10 ms.
eod

ATTR: changeset-db-checkpoint-interval
ATTRID: 72
ATTRHDRNAME: AO_DNSSERVER_CSETDB_CKPT_INTERVAL
ATTRTYPE: AT_RANGETIME(5-300)
ATTRDEFVAL: 20
ATTRMCDPATH: changeset_db_ckpt_interval
ATTRVIZ: 3
ATTRDESC:: eod
Controls the frequency at which the DNS server records a snapshot
in the changeset database.  Default is 20 seconds.
eod

ATTR: changeset-db-heap-size
ATTRID: 73
ATTRHDRNAME: AO_DNSSERVER_CSETDB_HEAP_SIZE
ATTRTYPE: AT_RANGEINT(128-768)
ATTRDEFVAL: 512
ATTRMCDPATH: changeset_db_heap_size
ATTRVIZ: 3
ATTRDESC:: eod
Changeset DB's one shot heap size (KBs). Default is 512 KB.
eod

ATTR: changeset-db-cache-size
ATTRID: 74
ATTRHDRNAME: AO_DNSSERVER_CSETDB_CACHE_SIZE
ATTRTYPE: AT_RANGEINT(200-50000)
ATTRDEFVAL: 10000
ATTRMCDPATH: changeset_db_cache_size
ATTRVIZ: 3
ATTRDESC:: eod
Changeset DB's underlying Btree total cache size (KBs).
Default is 10000 KB.
eod

ATTR: changeset-db-cache-partitions
ATTRID: 75
ATTRHDRNAME: AO_DNSSERVER_CSETDB_CACHE_PARTITIONS
ATTRTYPE: AT_RANGEINT(1-5)
ATTRDEFVAL: 1
ATTRMCDPATH: changeset_db_cache_partitions
ATTRVIZ: 3
ATTRDESC:: eod
The changeset DB's underlying Btree cache can be allocated as a
single partition.  However, on certain architectures, the size of
contiguous memory is limited; hence, the cache may need to be
(equally) partitioned.

A value of zero or one (default) designates one contiguous
partition; values greater than one designates the cache will be
broken up into changeset-db-cache-partitions equally sized but
separate pieces of memory.
Default is 1 partition.
eod

ATTR: changeset-db-logs-trimming-interval
ATTRID: 76
ATTRHDRNAME: AO_DNSSERVER_CSETDB_LOGS_TRIM_INTERVAL
ATTRTYPE: AT_RANGETIME(600-86400)
ATTRDEFVAL: 1800
ATTRMCDPATH: changeset_db_logs_trimming_interval
ATTRVIZ: 3
ATTRDESC:: eod
Controls the frequency at which the DNS server removes
unneeded changeset database log files.  Default is 1800
seconds.
Caution: Cisco strongly recommends that you accept the
default value, as setting a smaller value can cause database
backup failures.
eod

ATTR: changeset-db-log-size
ATTRID: 77
ATTRHDRNAME: AO_DNSSERVER_CSETDB_LOG_SIZE
ATTRTYPE: AT_RANGEINT(2-20)
ATTRDEFVAL: 10
ATTRMCDPATH: changeset_db_log_size
ATTRVIZ: 3
ATTRDESC:: eod
Changeset DB's underlying Btree log file size (MBs).
Default is 10 MB.
eod

ATTR: changeset-db-log-buffer-size
ATTRID: 78
ATTRHDRNAME: AO_DNSSERVER_CSETDB_LOG_BUFFER_SIZE
ATTRTYPE: AT_RANGEINT(32-2000)
ATTRDEFVAL: 32
ATTRMCDPATH: changeset_db_log_buffer_size
ATTRVIZ: 3
ATTRDESC:: eod
Changeset DB's underlying Btree initially logs a transaction in
memory and ultimately gets flushed to stable store when the
transaction gets committed.  This attribute specifies the size
of the (in-memory) log buffer which initially contains the
transaction. (KBs)  Default is 32 KB.
eod

ATTR: checkpoint-interval
ATTRID: 79
ATTRHDRNAME: AO_DNSSERVER_CHECKPOINT_INTERVAL
ATTRTYPE: AT_RANGETIME(3600-604800)
ATTRMCDPATH: checkpoint_interval
ATTRVIZ: 5
ATTRDEFVAL: 10800
ATTRDESC:: eod
Sets the seconds that elapse between snapshots of zone information.
DNS records this information in the Zone Checkpoint database.
eod

ATTR: log-settings
ATTRID: 80
ATTRHDRNAME: AO_DNSSERVER_LOGSETTING
# DO NOT USE BITS 6, 7 & 12 FOR THEY ARE RESERVED. THEY WERE USED
# IN 5.5 FOR EMPTY LOG-SETTINGS CATEGORIES. THESE EMPTY CATEGORIES
# HAVE BEEN REMOVED TO ELIMINATE CUSTOMER CONFUSIONS.
ATTRTYPE: AT_FLAGSINT( config=1, ddns=2, xfr-in=3, xfr-out=4, notify=5, datastore=8, scavenge=9, scavenge-details=10, server-operations=11, lame-delegation=13, root-query=14, ddns-refreshes=15, ddns-refreshes-details=16, ddns-details=17, tsig=18, tsig-details=19, activity-summary=20,query-errors=21,config-details=22, incoming-packets=23, outgoing-packets=24, xfr-in-packets=25, query-packets=26, notify-packets=27, ddns-packets=28, xfr-out-packets=29, ha-details=30 )
ATTRDEFVAL: config,ddns,xfr-in,xfr-out,notify,datastore,scavenge,server-operations,root-query,tsig,query-errors,ha-details
ATTRMCDPATH: log_settings
ATTRVIZ: 5
ATTRDESC:: eod
Determines which detailed events the DNS server logs, as set
using a bit mask. Logging these additional details can help
analyze a problem. Leaving detailed logging enable for a long
period, however, can fill the log files and cause the loss of
important information.

The possible flags are:
  config
    This flag will cause log messages pertaining to server
    configuration and server de-initialization (unconfiguration).
  ddns
    This flag will cause the logging of high-level DDNS messages.
    Detailed DDNS logging (e.g. RRs that have been deleted or
    added) can be enabled via ddns-details.
  xfr-in
    This flag will allow the generation of log messages
    associated with inbound full and incremental zone transfers.
  xfr-out
    This flag will allow the generation of log messages
    associated with outbound full and incremental zone transfers.
  notify
    This flag allows log messages associated with the processing
    of notify messages.
  datastore
    This flag allows the generation of log messages associated
    with datastores processing. Enabling this flag provides
    insight into various events in the server's embedded
    databases/datastores.
  scavenge
    This flag allows the logging of events associated (RR)
    scavenging.
  scavenge-details
    This flag causes more detailed logging, pertaining to
    scavenging, to be displayed. Note, this flag is disabled by
    default.
  server-operations
    This flag enables the logging of general high server events
    (such as those pertaining to sockets and interfaces).
  lame-delegation
    This flag allows the logging of lame-delegation events.
    Though enabled by default, disabling this flag could prevent
    the log from getting filled with frequent lame-delegation
    encounters.
  root-query
    This flag allows the generation of log messages associated
    queries (and responses) from root servers.
  ddns-refreshes
    This flag allows the server to log messages associated with
    (W2K) DDNS refreshes.
  ddns-refreshes-details
    This flag generates log messages that provide details
    describing RRs that were refreshed.
  ddns-details
    This flag enables detailed logging that describes the RR(s)
    that have deleted/added due to DDNS updates.
  tsig
    This flag allows the logging of events associated Transaction
    Signature (TSIG) DDNS updates.
  tsig-details
    This flag causes more detailed logging, pertaining to tsig, to
    be displayed. Note, this flag is disabled by default.
  query-errors
    This flag causes logging of errors encountered while
    processing DNS queries.
  config-details
    This flag generates detailed information during server
    configuration (e.g. displaying all configured and assumed
    server attributes)
  incoming-packets
    This flag causes incoming packets to be traced.
  outgoing-packets
    This flag causes outgoing packets to be traced.
  xfr-in-packets
    This flag causes incoming zone transfer packets to be traced.
  xfr-out-packets
    This flag causes outgoing zone transfer packets to be traced.
  query-packets
    This flag causes query packets to be traced.
  notify-packets
    This flag causes notify packets to be traced.
  ddns-packets
    This flag causes DDNS packets to be traced.
  performance
    This flag logs server level performance statistics.
  ha-details
    This flag enables detailed logging of HA related information.
eod

ATTR: scp-port
ATTRID: 81
ATTRHDRNAME: AO_DNSSERVER_SCP_PORT
ATTRTYPE: AT_RANGEINT(0-65535)
ATTRMCDPATH: scp_listen_port
ATTRVIZ: 3
ATTRDESC:: eod
Specifies the scp port number to be used. If the requested port
number is in use, the server will select an alternate number to
use.
eod

ATTR: auth-db-cache-size
ATTRID: 82
ATTRHDRNAME: AO_DNSSERVER_AUTHDB_CACHESIZE
ATTRTYPE: AT_INT
ATTRMCDPATH: auth_db_cache_size
ATTRVIZ: 1
DEPRECATED: 4.0
ATTRDEFVAL: 20
ATTRDESC:: eod
(Maximum) number of (internal cache) pages comprising the btree
used by the AUTHZONE DB.
eod

ATTR: cache-db-cache-size
ATTRID: 83
ATTRHDRNAME: AO_DNSSERVER_CACHEDB_CACHESIZE
ATTRTYPE: AT_INT
ATTRMCDPATH: cache_db_cache_size
ATTRVIZ: 1
DEPRECATED: 4.0
ATTRDEFVAL: 20
ATTRDESC:: eod
(Maximum) number of (internal cache) pages comprising the btree
used by the CACHE DB.
eod

ATTR: save-negative-cache-entries
ATTRID: 84
ATTRHDRNAME: AO_DNSSERVER_SAVE_NEGATIVE_CACHE_ENTRIES
ATTRTYPE: AT_BOOL
ATTRFLAGS: AF_FEATURE
ATTRDEFVAL: true
ATTRMCDPATH: save_negative_cache_entries
ATTRVIZ: 5
ATTRDESC:: eod
Controls whether to have the server store negative query results.
Default, true (enable).

Disabling this feature prevents persistent caching of negative
query responses.

eod

ATTR: cache-write-ttl-threshhold
ATTRID: 85
ATTRHDRNAME: AO_DNSSERVER_CACHE_WRITE_TTL_THRESHHOLD
ATTRTYPE: AT_RANGETIME(0-2147483647)
ATTRDEFVAL: 0
ATTRMCDPATH: cache_write_ttl_threshhold
ATTRVIZ: 1
DEPRECATED: 4.0
ATTRDESC:: eod
Resource Records with TTLs less than this value will not be
written to the cache database on disk.  A zero value disables
this threshold test, allowing all unexpired Resource Records to
be written.
eod

ATTR: fake-ip-name-response
ATTRID: 86
ATTRHDRNAME: AO_DNSSERVER_FAKE_IP_NAME_RESPONSE
ATTRTYPE: AT_BOOL
ATTRFLAGS: AF_FEATURE
ATTRDEFVAL: true
ATTRMCDPATH: fake_ip_name_response
ATTRVIZ: 5
ATTRDESC:: eod

Controls whether the DNS server rejects queries of fully
qualified domain names that are in IP address form (for
example, an A record like 192.168.40.40), without even trying
to query (or forward to) other servers. Default is true
(enable).

Enabling this feature causes the server to respond to these
queries indicating the name does not exist.   Queries of this
type are generally from rogue applications.
eod

ATTR: synthesize-aaaa-records
ATTRID: 87
ATTRHDRNAME: AO_DNSSERVER_SYNTHESIZE_AAAA_RECORDS
ATTRTYPE: AT_BOOL
ATTRFLAGS: AF_FEATURE
ATTRDEFVAL: false
ATTRMCDPATH: synthesize_aaaa_records
ATTRVIZ: 3
ATTRDESC:: eod
Synthesize AAAA record responses from A6 record data. This is to
support older clients which do not request or understand A6
records for IPv6 address information.
eod

ATTR: auth-db-cache-kbytes
ATTRID: 88
ATTRHDRNAME: AO_DNSSERVER_AUTHDB_CACHE_KBYTES
ATTRTYPE: AT_INT
ATTRMCDPATH: auth_db_cache_kbytes
ATTRVIZ: 5
ATTRDEFVAL: 10240
ATTRDESC:: eod
Sets the kilobytes of internal (BTREE) cache that the authzone
database uses.

Note: This value is rounded up to the nearest 4KB boundary. For
example, an 81KB value is rounded up to 84KB.
eod

ATTR: cache-db-cache-kbytes
ATTRID: 89
ATTRHDRNAME: AO_DNSSERVER_CACHEDB_CACHE_KBYTES
ATTRTYPE: AT_INT
ATTRMCDPATH: cache_db_cache_kbytes
ATTRVIZ: 5
ATTRDEFVAL: 10240
ATTRDESC:: eod
Sets the kilobytes of internal (BTREE) cache that the cache database
uses.

Note: This value is rounded up to the nearest 4KB boundary. For
example, an 81KB value is rounded up to 84KB.
eod

ATTR: scvg-interval
ATTRID: 90
ATTRHDRNAME: AO_DNSSERVER_SCVG_INTERVAL
ATTRTYPE: AT_RANGETIME(3600-31536000)
ATTRMCDPATH: scvg_interval
ATTRVIZ: 5
ATTRDEFVAL: 604800
ATTRDESC:: eod
Sets the seconds that DNS waits before removing (scavenging)
out-of-date address (A) records.

eod

ATTR: scvg-no-refresh-interval
ATTRID: 91
ATTRHDRNAME: AO_DNSSERVER_SCVG_NO_REFRESH_INTERVAL
ATTRTYPE: AT_RANGETIME(3600-31536000)
ATTRMCDPATH: scvg_no_refresh_interval
ATTRVIZ: 5
ATTRDEFVAL: 604800
ATTRDESC:: eod
Sets the number of seconds during which DNS updates cannot increment
the zone timestamp.
eod

ATTR: scvg-refresh-interval
ATTRID: 92
ATTRHDRNAME: AO_DNSSERVER_SCVG_REFRESH_INTERVAL
ATTRTYPE: AT_RANGETIME(3600-31536000)
ATTRMCDPATH: scvg_refresh_interval
ATTRVIZ: 5
ATTRDEFVAL: 604800
ATTRDESC:: eod
Sets the number of seconds during which DNS updates can increment
the zone timestamp. After both the no-refresh and refresh intervals
expire, the record is a candidate for scavenging. The value
can range from one hour to 365 days. The zone setting overrides
the server setting of 604800s (1w).
eod

ATTR: scvg-ignore-restart-interval
ATTRID: 93
ATTRHDRNAME: AO_DNSSERVER_SCVG_IGNORE_RESTART_INTERVAL
ATTRTYPE: AT_RANGETIME(7200-86400)
ATTRMCDPATH: scvg_ignore_restart_interval
ATTRVIZ: 5
ATTRDEFVAL: 7200
ATTRDESC:: eod
Ensures that the server does not reset the scavenging time with
every server restart. Within this interval, Network Registrar
ignores the time between when a server went down and its restart.
This interval is normally short. The value can range from two
hours to one day. With any time longer than that set,
Network Registrar recalculates the scavenging period
to allow for record updates that cannot take place while the
server is stopped. You can also set this  attribute on a zone,
and the value set on the zone overrides the server setting.
Default is 2h.
eod

ATTR: scvg-max-records-searched
ATTRID: 94
ATTRHDRNAME: AO_DNSSERVER_SCVG_MAX_RECORDS_SEARCHED
ATTRTYPE: AT_RANGEINT(1-2000000000)
ATTRMCDPATH: scvg_max_records_searched
ATTRVIZ: 3
ATTRDEFVAL: 1000
ATTRDESC:: eod
The maximum number of records to search at one time for a
candidate to be scavenged.
eod

ATTR: cache-write-ttl-threshold
ATTRID: 95
ATTRHDRNAME: AO_DNSSERVER_CACHE_WRITE_TTL_THRESHOLD
ATTRTYPE: AT_RANGETIME(0-2147483647)
ATTRDEFVAL: 0
ATTRMCDPATH: cache_write_ttl_threshold
ATTRVIZ: 3
ATTRDESC:: eod
Resource Records with TTLs less than this value will not be
written to the cache database on disk.  A zero value disables
this threshold test, allowing all unexpired Resource Records to
be written.
eod

ATTR: scvg-pause-interval
ATTRID: 96
ATTRHDRNAME: AO_DNSSERVER_SCVG_PAUSE_INTERVAL
ATTRTYPE: AT_RANGETIME(1-86400)
ATTRMCDPATH: scvg_pause_interval
ATTRVIZ: 3
ATTRDEFVAL: 1
ATTRDESC:: eod
The amount of time (in seconds) that scavenging will wait after
scavenging a set of records, before going onto the next set.
eod

ATTR: query-source-port
ATTRID: 97
ATTRHDRNAME: AO_DNSSERVER_QUERY_SOURCE_PORT
ATTRTYPE: AT_RANGEINT(0-65535)
ATTRMCDPATH: query_source_port
ATTRVIZ: 5
ATTRDESC:: eod
Specifies the UDP port number that the DNS server uses to send
queries to other servers when resolving names for clients.  A
value of zero instructs the server to choose a random port.  If
you unset this attribute, the server sends queries from the
port it uses to listen for queries (see the local-port-num
attribute).
eod

ATTR: query-source-address
ATTRID: 98
ATTRHDRNAME: AO_DNSSERVER_QUERY_SOURCE_ADDR
ATTRTYPE: AT_IPADDR
ATTRMCDPATH: query_source_addr
ATTRVIZ: 5
ATTRDESC:: eod
Specifies the source IP address from which the DNS server will
send queries to other servers when resolving names for clients.  A
value of 0.0.0.0 indicates that OS will use the best local address
based on the destination.
eod

ATTR: changeset-db-history-trim-interval
ATTRID: 99
ATTRHDRNAME: AO_DNSSERVER_CSETDB_HISTORY_TRIM_INTERVAL
ATTRTYPE: AT_RANGEINT(10-3600)
ATTRDEFVAL: 200
ATTRMCDPATH: changeset_db_history_trim_interval
ATTRVIZ: 0
ATTRDESC:: eod
The interval (seconds) at which the changeset database will
perform history trimming (i.e. purge old changesets that have
been checkpointed). Default is 200 seconds. Deprecated.
eod

ATTR: changeset-db-max-rr-size
ATTRID: 100
ATTRHDRNAME: AO_DNSSERVER_CSETDB_MAX_RR_SIZE
ATTRTYPE: AT_RANGEINT(10000-5000000)
ATTRDEFVAL: 500000
ATTRMCDPATH: changeset_db_max_rr_size
ATTRVIZ: 3
ATTRDESC:: eod
The maximum number of records in the changeset db, before issuing
a forced zone checkpoint, in RRs. Default is 500000 records.
eod

ATTR: changeset-db-hist-max-trim-count
ATTRID: 101
ATTRHDRNAME: AO_DNSSERVER_CSETDB_HIST_MAX_TRIM_COUNT
ATTRTYPE: AT_RANGEINT(200-20000)
ATTRDEFVAL: 2000
ATTRMCDPATH: changeset_db_hist_max_trim_count
ATTRVIZ: 3
ATTRDESC:: eod
The maximum number of (changeset) records to delete at one time
for history trimming. Default is 2000 records.
eod


ATTR: changeset-db-err-log-enabled
ATTRID: 102
ATTRHDRNAME: AO_DNSSERVER_CSETDB_ERR_LOG
ATTRTYPE: AT_BOOL
ATTRDEFVAL: true
ATTRMCDPATH: changeset_db_err_log_enabled
ATTRVIZ: 3
ATTRDESC:: eod
Enable sleepycat's error logging.
eod


ATTR: changeset-db-history-kept
ATTRID: 104
ATTRHDRNAME: AO_DNSSERVER_CSETDB_HISTORY_KEPT
ATTRTYPE: AT_RANGEINT(100-20000)
ATTRDEFVAL: 400
ATTRMCDPATH: changeset_db_history_kept
ATTRVIZ: 3
ATTRDESC:: eod
The maximum number of history that we will keep when performing
history trimming. This is to facilitate IXFRs. Default is 400.
eod

ATTR: changeset-db-max-age
ATTRID: 105
ATTRHDRNAME: AO_DNSSERVER_CSETDB_MAX_AGE
ATTRTYPE: AT_RANGETIME(0-3600)
ATTRDEFVAL: 0
ATTRMCDPATH: changeset_db_max_age
ATTRVIZ: 3
ATTRDESC:: eod
The maximum age that we will allow a history trimming element
to be before deciding to delete that element. If this value is
set to zero, we will not consider the record age when trimming.
Default is 0.
eod

ATTR: changeset-db-reads-per-transaction
ATTRID: 106
ATTRHDRNAME: AO_DNSSERVER_CSETDB_READS_PER_XACT
ATTRTYPE: AT_RANGEINT(100-10000)
ATTRDEFVAL: 1000
ATTRMCDPATH: changeset_db_reads_per_xact
ATTRVIZ: 3
ATTRDESC:: eod
This attribute defines the maximum number of reads that will be
conducted on a Sleepycat DB transaction. Once this limit is hit,
the Changeset DB shall close the current read transaction and
open up a new one.
eod

ATTR: checkpoint-min-interval
ATTRID: 107
ATTRHDRNAME: AO_DNSSERVER_CHECKPOINT_MIN_INTERVAL
ATTRTYPE: AT_RANGETIME(60-2700)
ATTRMCDPATH: checkpoint_min_interval
ATTRDEFVAL: 300
ATTRVIZ: 3
ATTRDESC:: eod
The minimum amount of time required ( in seconds ) between the
time the first zone checkpoint occurs and the second zone
checkpoint starts.  For dynamic checkpoints only. Default is 5m.
eod

ATTR: htrim-zone-size-to-travel
ATTRID: 108
ATTRHDRNAME: AO_DNSSERVER_HTRIM_ZONE_SIZE_TO_TRAVEL
ATTRTYPE: AT_RANGEINT(5-100)
ATTRMCDPATH: htrim_zone_size_to_travel
ATTRDEFVAL: 50
ATTRVIZ: 3
ATTRDESC:: eod
Percentage of the zone to travel.  Default is 50%.
eod

ATTR: htrim-zone-size-check-interval
ATTRID: 109
ATTRHDRNAME: AO_DNSSERVER_HTRIM_ZONE_SIZE_CHECK_INTERVAL
ATTRTYPE: AT_RANGETIME(10-86400)
ATTRMCDPATH: htrim_zone_size_check_interval
ATTRDEFVAL: 300
ATTRVIZ: 3
ATTRDESC:: eod
Time interval in which to check the zone size and determine if
history trimming is required.  Default is 300 sec.
eod

ATTR: htrim-ddns-between-htrims
ATTRID: 110
ATTRHDRNAME: AO_DNSSERVER_HTRIM_DDNS_BETWEEN_HTRIMS
ATTRTYPE: AT_RANGEINT(10-10000)
ATTRMCDPATH: htrim_ddns_between_htrims
ATTRDEFVAL: 10
ATTRVIZ: 3
ATTRDESC:: eod
Number of DDNS updates to a zone between history trims.
Default is 10 updates.
eod

ATTR: htrim-zone-max-hist-allowed
ATTRID: 111
ATTRHDRNAME: AO_DNSSERVER_HTRIM_ZONE_MAX_HIST_ALLOWED
ATTRTYPE: AT_RANGEINT(1-100)
ATTRMCDPATH: htrim_zone_max_hist_allowed
ATTRDEFVAL: 5
ATTRVIZ: 3
ATTRDESC:: eod
The amount of history allowed as a multiple of the amount of
history kept for IXFR. Default is 5 times the amount of history
kept.
eod

ATTR: htrim-zone-seek-more-trim-interval
ATTRID: 112
ATTRHDRNAME: AO_DNSSERVER_HTRIM_ZONE_SEEK_MORE_TRIM_INTERVAL
ATTRTYPE: AT_RANGETIME(10-86400)
ATTRMCDPATH: htrim_zone_seek_more_trim_interval
ATTRDEFVAL: 300
ATTRVIZ: 3
ATTRDESC:: eod
The interval at which to seek out zones that can be candidates
for history trimming. Default is 300 sec.
eod

ATTR: zone-db-cache-kbytes
ATTRID: 113
ATTRHDRNAME: AO_DNSSERVER_ZONEDB_CACHE_KBYTES
ATTRTYPE: AT_INT
ATTRMCDPATH: zone_db_cache_kbytes
ATTRVIZ: 3
ATTRDEFVAL: 1024
ATTRDESC:: eod
Size (kbytes) of internal BTREE cache used by the ZONE DB. Note,
this value will be rounded-up to the nearest 4 (kbyte) boundary.
For example, a 81 (kbyte) value will be rounded up to 84 (kbytes).
Values below 36 (kbytes) will be ignored; 36 (kbytes) will be used
instead. Default is 1000 kbytes.
eod

ATTR: scvg-max-records
ATTRID: 114
ATTRHDRNAME: AO_DNSSERVER_SCVG_MAX_RECORDS
ATTRTYPE: AT_RANGEINT(1-10000)
ATTRMCDPATH: scvg_max_records
ATTRVIZ: 3
ATTRDEFVAL: 1000
ATTRDESC:: eod
The maximum number of records to the dns server will scavenge from
one zone during a scavenging interval when scavenging is enabled.
eod

ATTR: zone-checkpoint-file-buf-ksize
ATTRID: 115
ATTRHDRNAME: AO_DNSSERVER_CHECKPOINT_FILEBUF_SIZE
ATTRTYPE: AT_INT
ATTRMCDPATH: zone_checkpoint_file_buf_ksize
ATTRVIZ: 3
ATTRDEFVAL: 256
ATTRDESC:: eod
The size (1K bytes) of the file IO buffer(s) used by the zone
checkpoint datastore when reading and writing a zone checkpoint
file.
eod


ATTR: dns-health-monitor-level
ATTRID: 116
ATTRHDRNAME: AO_DNSSERVER_HEALTH_MONITOR
ATTRTYPE: AT_RANGEINT(0-1000)
ATTRMCDPATH: dns_health_monitor_level
DEPRECATED: 4.0
ATTRVIZ: 1
ATTRDEFVAL: 1
ATTRDESC:: eod
Specifies dns monitoring level. default 1 (on). Deprecated.
eod

ATTR: dns-health-monitor-interval
ATTRID: 117
ATTRHDRNAME: AO_DNSSERVER_HEALTH_MONITOR_INTERVAL
ATTRTYPE: AT_RANGEINT(300-86400)
ATTRMCDPATH: dns_health_monitor_interval
DEPRECATED: 4.0
ATTRVIZ: 1
ATTRDEFVAL: 1800
ATTRDESC:: eod
Specifies dns monitoring level. default 1800 seconds. Deprecated.
eod

ATTR: zone-blobs-read-per-mcd-xact
ATTRID: 118
ATTRHDRNAME: AO_DNSSERVER_ZONE_BLOBS_READ_PER_MCD_XACT
ATTRTYPE: AT_INT
ATTRMCDPATH: zone_blobs_read_per_mcd_xact
ATTRVIZ: 3
ATTRDEFVAL: 100
ATTRDESC:: eod
The number of zone blobs, stored in MCD Config and State, to read
per a MCD transaction. A higher value yields greater server
configuration performance; however, a higher value requires more
heap space.
eod

ATTR: max-negcache-ttl
ATTRID: 119
ATTRHDRNAME: AO_DNSSERVER_MAXNEGCACHETTL
ATTRTYPE: AT_RANGETIME(0-2147483647)
ATTRMCDPATH: max_negcache_ttl
ATTRVIZ: 5
ATTRDEFVAL: 3600
ATTRDESC:: eod
Sets an upper limit on the number of seconds a DNS server
maintains negative cache entries. Default is 3600s (1h).

A server generates these cache entries after querying another
name server and receiving an authoritative reply stating the
requested records do not exist.
eod

ATTR: tsig-processing
ATTRID: 120
ATTRTYPE: AT_FLAGSINT( ddns=1, query=2, disable-all=3 )
ATTRFLAGS: AF_PRINT_ALT
ATTRDEFVAL: ddns,query
ATTRMCDPATH: tsig_processing
ATTRVIZ: 3
ATTRDESC:: eod
Enables you to turn on and off tsig processing for DNS
transactions.  Default is enabled on ddns and query requests.
eod

ATTR: zone-blobs-write-per-mcd-xact
ATTRID: 121
ATTRHDRNAME: AO_DNSSERVER_ZONE_BLOBS_WRITE_PER_MCD_XACT
ATTRTYPE: AT_INT
ATTRMCDPATH: zone_blobs_write_per_mcd_xact
ATTRVIZ: 3
ATTRDEFVAL: 100
ATTRDESC:: eod
The number of zone blobs to write to MCD state (during
configuration) per a MCD transaction. A higher value yields
greater server configuration performance; however, a higher
value shall also block out the UI and/or other CNR servers
(colocated on the same platform) from accessing MCD.
eod

ATTR: update-acl
ATTRID: 122
ATTRHDRNAME: AO_DNSSERVER_UPDATE_ACL
ATTRTYPE: AT_AMELST
ATTRMCDPATH: update-acl
ATTRDEFVAL: none
ATTRDESC:: eod
Provides server-level control of which devices can access and
update the DNS server. If the access control list is set at the
zone level, Network Registrar overrides the server-level setting.

eod

ATTR: hierarchical-alphabetic-rr-ordering
ATTRID: 123
ATTRHDRNAME: AO_DNSSERVER_HIERARCHICAL_ALPHABETIC_RR_ORDERING
ATTRTYPE: AT_BOOL
ATTRMCDPATH: hierarchical_alphabetic_rr_ordering
ATTRVIZ: 3
ATTRDEFVAL: true
ATTRDESC:: eod
Specifies whether to order RRs, during zone iterations as used
by the UIs, in a more user palatable form. Enabling this ordering
could affect server performance with respect to DDNS updates and
(inbound) zone transfers.
NOTE: altering this ordering scheme shall require a full reload
during the next server restart/startup, because the existing
AUTHZONE DB can not be used.
eod

ATTR: changeset-background-loading
ATTRID: 124
ATTRHDRNAME: AO_DNSSERVER_CHSET_BACKGROUND_LOADING
ATTRTYPE: AT_BOOL
ATTRFLAGS: AF_FEATURE
ATTRDEFVAL: true
ATTRMCDPATH: chset_background_loading
ATTRVIZ: 3
ATTRDESC:: eod
Enable chsetdb background loading to improve reload performance.
eod


ATTR: key-blobs-read-per-xact
ATTRID: 125
ATTRHDRNAME: AO_DNSSERVER_KEY_BLOBS_READ_PER_XACT
ATTRTYPE: AT_INT
ATTRMCDPATH: key_blobs_read_per_xact
ATTRVIZ: 3
ATTRDEFVAL: 10
ATTRDESC:: eod
The number of key blobs read per transaction.
eod

ATTR: acl-blobs-read-per-xact
ATTRID: 126
ATTRHDRNAME: AO_DNSSERVER_ACL_BLOBS_READ_PER_XACT
ATTRTYPE: AT_INT
ATTRMCDPATH: acl_blobs_read_per_xact
ATTRVIZ: 3
ATTRDEFVAL: 10
ATTRDESC:: eod
The number of acl blobs read per transaction.
eod

ATTR: activity-summary-interval
ATTRID: 127
ATTRHDRNAME: AO_DNSSERVER_ACTIVITY_SUMMARY_PERIOD
ATTRTYPE: AT_RANGETIME(60-86400)
ATTRMCDPATH: activity_summary_interval
ATTRDEFVAL: 300
ATTRVIZ: 5
ATTRDESC:: eod
Sets the seconds between DNS activity summary log messages,
if the activity-summary attribute is enabled in the server
log-settings. The default value is 5 minutes.
eod

ATTR: activity-summary-settings
ATTRID: 128
ATTRHDRNAME: AO_DNSSERVER_ACTIVITY_SUMMARY_LOGSETTING
ATTRTYPE: AT_FLAGSINT( default=1,system=2,server=3, cache=4, chsetdb=5, chsetdb-details=6, performance=7)
ATTRDEFVAL: server,cache,chsetdb
ATTRMCDPATH: activity_summary_settings
ATTRFLAGS: AF_PRINT_ALT
ATTRVIZ: 3
ATTRDESC:: eod
Specifies the DNS server activity summary in different categories.

The possible flags are:
  default
    Default categories.
  chsetdb
    This flag will cause the activity summary logging of
    changeset db related.
  chsetdb-details
    This flag will cause log chsetde details.
eod
ATTR: root-hints
ATTRID: 129
ATTRTYPE: AT_NLIST(AT_OBJ(AddrSet))
# 1<<16 | 50
ATTRVAL: 65586
ATTRFLAGS: AF_NOTREE
ATTRVIZ: 3
ATTRDESC:: eod
The root hints for this server
eod

ATTR: exceptions
ATTRID: 130
ATTRTYPE: AT_NLIST(AT_OBJ(AddrSet))
# 1<<16 | 50
ATTRVAL: 65586
ATTRFLAGS: AF_NOTREE
ATTRVIZ: 3
ATTRDESC:: eod
The resolution exception list for this server
eod

ATTR: forwarders
ATTRID: 131
ATTRTYPE: AT_NLIST(AT_IPADDR)
# AT_IPADDR = 4
ATTRVAL: 4
ATTRFLAGS: AF_NOTREE
ATTRVIZ: 3
ATTRDESC:: eod
The forwarders list for this server
eod

ATTR: foreign-servers
ATTRID: 132
ATTRTYPE: AT_NLIST(AT_OBJ(ForeignServer))
# 1<<16 | 100
ATTRVAL: 65636
ATTRFLAGS: AF_NOTREE
ATTRVIZ: 3
ATTRDESC:: eod
Information about the capabilities of remote dns servers that this
server might contact.
eod

ATTR: chset-db-lock-count
ATTRID: 133
ATTRHDRNAME: AO_DNSERVER_CHSET_DB_LOCK_COUNT
ATTRTYPE: AT_INT
ATTRMCDPATH: chset_db_lock_count
ATTRDEFVAL: 10000
ATTRVIZ: 3
ATTRDESC:: eod
The maximum number of changeset database transaction locks
available.
Set debug G=1, when the dns server does chsetdb log file trimming
(csetdb_logs_trim_interval), it will display the high water mark
for locks used.
eod

ATTR: full-reload-recovery-options
ATTRID: 134
ATTRHDRNAME: AO_DNSERVER_FULL_RELOAD_RECOVERY_OPTIONS
ATTRTYPE: AT_ENUMINT(abort-on-error=0, resume-roll-forward-on-err=1, remove-from-changeset-db=2, remove-dynamic-rrs=3)
ATTRMCDPATH: full_reload_recovery_options
ATTRFLAGS: AF_PRINT_ALT
ATTRDEFVAL: abort-on-error
ATTRVIZ: 3
ATTRDESC:: eod
This defines the option to use during zones configuration.
abort-on-error, the default, specifies that full zone reload
should abort when encountered an error (while rolling-forward
changesets on top of the zone checkpoint).
resume-roll-forward-on-err requests that the server should
continue rolling forward a zone eventhough there was an
encountered error. remove-from-changeset-db specifies that
zone(s) should be removed from the changeset DB  during server
startup/reload; this option may result in the loss of "recent"
RRs. Last, remove-dynamic-rrs causes the server to remove zones
from both the checkpoint datastore and the changeset DB, causing
all dynamic RRs to be lost (static RRs shall be retained though).
eod


ATTR: serial-gap-commit-check
ATTRID: 135
ATTRHDRNAME: AO_DNSSERVER_SERIAL_GAP_COMMIT_CHECK
ATTRTYPE: AT_BOOL
ATTRDEFVAL: false
ATTRMCDPATH: serial_gap_commit_check
ATTRVIZ: 1
ATTRDESC:: eod
Set TRUE to enable checking serial gap during commitment.
Used for internal debug only.
eod

ATTR: restrict-xfer-acl
ATTRID: 136
ATTRHDRNAME: AO_DNSSERVER_RESTRICT_XFER_ACL
ATTRTYPE: AT_AMELST
ATTRMCDPATH: restrict_xfer_acl
ATTRVIZ: 5
ATTRDEFVAL: none
ATTRDESC:: eod
Overrides the default access control list (designating who can
receive zone transfers).
eod

ATTR: tsig-every-n-pkts
ATTRID: 137
ATTRHDRNAME: AO_DNSSERVER_TSIG_EVERY_N_PKTS
ATTRTYPE: AT_RANGEINT(1-100)
ATTRMCDPATH: tsig_every_n_pkts
ATTRDEFVAL: 100
ATTRVIZ: 3
ATTRDESC:: eod
While send a TCP zone transfer, the dns server will insert a TSIG
record at this interval.
eod


ATTR: activity-sample-interval
ATTRID: 138
ATTRHDRNAME: AO_DNSSERVER_ACTIVITY_SAMPLE_INTERVAL
ATTRTYPE: AT_RANGETIME(60-86400)
ATTRMCDPATH: activity_sample_interval
ATTRDEFVAL: 300
ATTRVIZ: 1
ATTRDESC:: eod
The sampling period of dns activity counters, in seconds.
It will be rounded to minutes internally.
The default value is 5 minutes.
eod


ATTR: scp-skip-authenticate
ATTRID: 139
ATTRHDRNAME: AO_DNSSERVER_SCP_SKIP_AUTHENTICATE
ATTRTYPE: AT_BOOL
ATTRMCDPATH: scp_skip_authenticate
ATTRDEFVAL: false
ATTRVIZ: 1
ATTRDESC:: eod
Instructs the SCP handler to skip the authenticate process. This
attribute should generally be set for new SCP message(s)
development.  It should, otherwise, be set as false. It's purpose
is to serve as a development debugging aid.
eod


ATTR: collect-sample-counters
ATTRID: 140
ATTRHDRNAME: AO_DNSSERVER_COLLECT_SAMPLE_COUNTERS
ATTRTYPE: AT_BOOL
ATTRMCDPATH: collect_sample_counters
ATTRDEFVAL: true
ATTRVIZ: 5
ATTRDESC:: eod
Switches counter sampling on and off.
eod

ATTR: activity-counter-log-settings
ATTRID: 141
ATTRHDRNAME: AO_DNSSERVER_ACTIVITY_COUNTER_LOG_SETTINGS
ATTRTYPE: AT_FLAGSINT( total=1,sample=2,performance=3,query=4, errors=5, security=6, maxcounters=7, ha=8, ipv6=9, server=10)
ATTRDEFVAL: total,performance,query,errors,security,maxcounters,ha,ipv6
ATTRMCDPATH: activity_counter_log_settings
ATTRFLAGS: AF_PRINT_ALT
ATTRVIZ: 5
ATTRDESC:: eod
Controls what activity counters a DNS server uses for logging.

The possible flags are:
  total        log the accumulated counters since reset or server
               start.
  sample       log counters for each sampling interval.
  performance  log performance-related counters.
  query        log query-related counters.
  errors       log error-related counters.
  security     log security-related counters.
  maxcounters  log maxcounters-related counters.
  ha           log HA-related counters.
  ipv6         log IPv6-related counters.

eod


ATTR: activity-counter-interval
ATTRID: 142
ATTRHDRNAME: AO_DNSSERVER_ACTIVITY_COUNTER_INTERVAL
ATTRTYPE: AT_RANGETIME(10-86400)
ATTRMCDPATH: activity_counter_interval
ATTRDEFVAL: 300
ATTRVIZ: 5
ATTRDESC:: eod
Sets the period of time that server activity counters use to
collect metrics.

Use this attribute together with the 'collect-sample-counters'
attribute.  Make sure the 'collect-sample-counters' is set to
true (enable) to start sampling.
eod

ATTR: delegation-only-domains
ATTRID: 143
ATTRHDRNAME: AO_DNSSERVER_DELEGATION_ONLY_DOMAINS
ATTRTYPE: AT_NLIST(AT_DNSNAME)
# AT_DNSNAME = 35
ATTRVAL: 35
ATTRMCDPATH: delegation_only_domains
ATTRVIZ: 5
ATTRDESC:: eod

Instructs the DNS server to expect a specified zone to
return only delegations to authoritative nameservers
when queried.

Other than records at the domain name itself, the
specified zone must contain only NS records for each each
nameserver to which the subzone is delegated and the zone's
apex SOA record.  For example, 'com.' is a domain that should
contain only delegations.

Use this attribute to filter out wildcard or synthesized data
from authoritative nameservers whose undelegated (in-zone) data
is of no interest.

The server enforces the delegation-only nature of the domains on
this list when it examines responses that are not from a
forwarder or resolution exception server. The server converts
non-conforming answers to no-such-name responses.  This cannot
be enforced when the answer comes from a forwarder.
eod

ATTR: restrict-query-acl
ATTRID: 144
ATTRHDRNAME: AO_DNSSERVER_RESTRICT_QUERY_ACL
ATTRTYPE: AT_AMELST
ATTRDEFVAL: any
ATTRMCDPATH: restrict_query_acl
ATTRVIZ: 5
ATTRDESC:: eod
Provides a global access control list (ACL) used to limit device
queries that a DNS server must honor. You can restrict query
clients based on host IP address, network address, TSIG keys,
and access control lists. The default is to allow any client to
perform a query.

Zones inherit this ACL if they are missing their
restrict-query-acl. This ACL also serves as filtering queries for
non-authoritative zones.

eod
ATTR: requery-over-tcp
ATTRID: 145
ATTRHDRNAME: AO_DNSSERVER_REQUERY_OVER_TCP
ATTRTYPE: AT_BOOL
ATTRDEFVAL: true
ATTRVIZ: 3
ATTRDESC:: eod
Controls whether or not the DNS server will retry querying an
authoritative server or forwarder after having received a
truncated answer over UDP.
eod

ATTR: oldzonestate-max-records
ATTRID: 146
ATTRHDRNAME: AO_DNSSERVER_OLDZONESTATE_MAX_RECORDS
ATTRTYPE: AT_RANGEINT(1-10000)
ATTRMCDPATH: oldzonestate_max_records
ATTRVIZ: 3
ATTRDEFVAL: 1000
ATTRDESC:: eod
The maximum number of old zone state records the dns server will
remove from a zone during an interval when cleaning up old zone
state.
eod

ATTR: oldzonestate-pause-interval
ATTRID: 147
ATTRHDRNAME: AO_DNSSERVER_OLDZONESTATE_PAUSE_INTERVAL
ATTRTYPE: AT_RANGETIME(1-86400)
ATTRMCDPATH: oldzonestate_pause_interval
ATTRVIZ: 3
ATTRDEFVAL: 10
ATTRDESC:: eod
The amount of time (in seconds) that old zone state cleanup will
wait after removing a set of records, before going onto the next
set.
eod

ATTR: default-negcache-ttl
ATTRID: 148
ATTRHDRNAME: AO_DNSSERVER_DEFAULT_NEGCACHE_TTL
ATTRTYPE: AT_RANGETIME(0-86400)
ATTRMCDPATH: default_negcache_ttl
ATTRDEFVAL: 0
ATTRDESC:: eod
Sets the amount of time in seconds that the DNS server caches
negative answers if there is no SOA record in the authority
section of the reply.

The presence of an SOA record in the authority section of a
negative overrides this attribute value.
For more details, see IETF RFC2308.
eod

ATTR: restrict-recursion-acl
ATTRID: 149
ATTRHDRNAME: AO_DNSSERVER_RESTRICT_RECURSION_ACL
ATTRTYPE: AT_AMELST
ATTRDEFVAL: any
ATTRMCDPATH: restrict_recursion_acl
ATTRDESC:: eod
Defines the global Access Control List (ACL) used to restrict
recursive that the DNS server honors.  This list can contain
host, network addresses, TSIG keys and global ACLs that
restrict recursive queries to a certain set of DNS clients.
Default is to allow any client to perform a query. For any client
not passing this ACL andrequesting a recursive query, the server
responds with a referal - as if originally requested with an
iterative query.

eod


ATTR: persist-mem-cache
ATTRID: 150
ATTRHDRNAME: AO_DNSSERVER_PERSIST_MEM_CACHE
ATTRTYPE: AT_BOOL
ATTRDEFVAL: true
ATTRVIZ: 5
ATTRDESC:: eod
Specifies whether the DNS server writes memory chache, or reads
it from the persistent cache database.

If you set this to false, DNS does not use the persistent cache
database.

eod
ATTR: max-dns-packets
ATTRID: 151
ATTRHDRNAME: AO_DNSSERVER_MAX_DNS_PACKETS
ATTRTYPE: AT_INT
ATTRDEFVAL: 500
ATTRVIZ: 5
ATTRDESC:: eod
Specifies the maximum number of packets that dns server will
handle concurrently. DNS server will drop inbound packets if this
limit is reached.
eod

ATTR: request-retry-time
ATTRID: 152
ATTRHDRNAME: AO_DNSSERVER_REQUEST_RETRY_TIME
ATTRTYPE: AT_RANGETIME(1-30)
ATTRDEFVAL: 4
ATTRMCDPATH: request_retry_time
ATTRVIZ: 5
ATTRDESC:: eod
Dictates the retry time interval (in secs) when querying a name
server. This time interval is used in general queries - in
response to DNS clients queries - (zone transfers) SOA queries,
IXFR requests and notify requests. Understand that this is a
minium retry time. The server applies an exponential backoff on
retries.
eod

ATTR: request-expiration-time
ATTRID: 153
ATTRHDRNAME: AO_DNSSERVER_REQUEST_EXPIRATION_TIME
ATTRTYPE: AT_RANGETIME(10-300)
ATTRDEFVAL: 90
ATTRMCDPATH: request_expiration_time
ATTRVIZ: 5
ATTRDESC:: eod
Governs the expiration time of DNS queries; for example,
DNS query, zone transfer SOA query, IXFR request and notify
request). A query that is not answered within this time interval
expires.

Note: Cisco recommends that you make sure this value is
considerably larger than 'request-retry-time' to allow multiple
attempts to query multiple servers, using exponential backoff.
eod

ATTR: forward-retry-time
ATTRID: 154
ATTRHDRNAME: AO_DNSSERVER_FORWARD_RETRY_TIME
ATTRTYPE: AT_RANGETIME(1-30)
ATTRDEFVAL: 8
ATTRMCDPATH: forward_retry_time
ATTRVIZ: 5
ATTRDESC:: eod
Sets the retry interval for forwarding a DNS query to a
forwarder or resolution exception server. These queries are
recursive, and may require more time for the forwarder to
resolve.

To ensure the server tries all forwarders, set this value to the
'request-expiration-time' divided by one less than the total
number of configured forwarders).

Note:  This attribute has no affect when you enable slave-mode;
the server uses slave-forward-retry-time instead.
eod

ATTR: tcp-query-retry-time
ATTRID: 155
ATTRHDRNAME: AO_DNSSERVER_TCP_QUERY_RETRY_TIME
ATTRTYPE: AT_RANGETIME(10-300)
ATTRDEFVAL: 10
ATTRMCDPATH: tcp_query_retry_time
ATTRVIZ: 5
ATTRDESC:: eod
Defines the retry time for DNS queries over a TCP connection.


Cisco recommends that you set this value to less than
'request-expiration-time'.
eod

ATTR: slave-forward-retry-time
ATTRID: 156
ATTRHDRNAME: AO_DNSSERVER_SLAVE_FORWARD_RETRY_TIME
ATTRTYPE: AT_RANGETIME(5-60)
ATTRDEFVAL: 30
ATTRMCDPATH: slave_forward_retry_time
ATTRVIZ: 5
ATTRDESC:: eod
Sets the retry interval for forwarding a DNS query in slave-mode.
These queries are recursive, and may require more time for the
forwarder to resolve.

To ensure the server tries all forwarders, set this value to the
'request-expiration-time' divided by one less than the total
number of configured forwarders.

eod

ATTR: config-db-checkpoint-interval
ATTRID: 157
ATTRTYPE: AT_RANGETIME(60-86400)
ATTRVIZ: 3
ATTRDEFVAL: 3600
ATTRDESC:: eod
Controls the frequency at which the DNS server records a snapshot
in the configuration database.  Default is 3600 seconds.
eod

ATTR: config-db-purge-logs-interval
ATTRID: 158
ATTRTYPE: AT_RANGETIME(600-86400)
ATTRVIZ: 3
ATTRDEFVAL: 1800
ATTRDESC:: eod
Controls the frequency at which the DNS server removes unneeded
configuration database log files.  Default is 1800 seconds.
Caution: Cisco Systems strongly recommends that you accept the
default value, as setting a smaller value can cause database
backup failures.
eod

ATTR: ha-dns
ATTRID: 159
ATTRTYPE: AT_BOOL
ATTRFLAGS: AF_FEATURE
ATTRDEFVAL: false
ATTRVIZ: 3
ATTRDESC:: eod
If enabled, the DNS server will operate in a Highly Available mode
by communicating all DNS configuration changes to the specified
standby server. This attribute is also set from the HA DNS pair.
eod

ATTR: ha-dns-main-server
ATTRID: 160
ATTRTYPE: AT_IPADDR
ATTRVIZ: 3
ATTRDESC:: eod
The IP address of the main server. This attribute is also set
from the HA DNS pair.
eod

ATTR: ha-dns-backup-server
ATTRID: 161
ATTRTYPE: AT_IPADDR
ATTRVIZ: 3
ATTRDESC:: eod
The IP address of the backup server. This attribute is also set
from the HA DNS pair.
eod

ATTR: ha-dns-poll-interval
ATTRID: 162
ATTRTYPE: AT_RANGETIME(1-86400)
ATTRDEFVAL: 12
ATTRVIZ: 3
ATTRDESC:: eod
On the HA main server, this is the interval at which the
HA server will check if keep alive heartbeat message
requests need to be send to the HA partner. The request
will be sent if the last time we received a request or
response from our partner was more that ha-dns-comm-timeout.
On the HA backup server,  this is the interval at which
the HA server will send a heartbeat request.
eod

ATTR: ha-dns-comm-timeout
ATTRID: 163
ATTRTYPE: AT_RANGETIME(2-86400)
ATTRDEFVAL: 30
ATTRDESC:: eod
Sets the period of time that must elapse before the server
determines it cannot communicate with its HA DNS partner.

eod

ATTR: ha-dns-port
ATTRID: 164
ATTRTYPE: AT_RANGEINT(1-65535)
ATTRDEFVAL: 653
ATTRVIZ: 3
ATTRDESC:: eod
Controls the TCP port that DNS servers use for HA DNS
communication.
eod

ATTR: traps-enabled
ATTRID: 165
ATTRTYPE: AT_FLAGSINT(all=1, server-start=2, server-stop=3, ha-dns-partner-down=4, ha-dns-partner-up=5, ha-dns-config-error=6, masters-not-responding=7, masters-responding=8, secondary-zone-expired=9, forwarders-not-responding=10, forwarders-responding=11)
ATTRDESC:: eod
Defines the traps that this server is configured to send.

   1  all
      Sends notifications for all server events.

   2  server-start
      Sends notifications whenever the server is started or 
      reinitialized.

   3  server-stop
      Sends notifications whenever the server is stopped.

   4  ha-dns-partner-down
      Sends notifications whenever the HA DNS partner 
      goes down.      

   5  ha-dns-partner-up
      Sends notifications whenever the HA DNS partner becomes 
      available again after going down.

   6  ha-dns-config-error
      Sends notifications when a configuration mismatch between 
      HA DNS partners occurs.

   7  masters-not-responding
      Sends notifications when master servers stop responding.

   8  masters-responding
      Sends notifications when master servers start responding 
      again.

   9  secondary-zone-expired
      Sends notifications when a secondary server can no longer 
      claim authority for zone data when responding to queries
      during a zone transfer.

   10 forwarders-not-responding
      Sends notifications when DNS forwarders stop responding.

   11 forwarders-responding
      Sends notifications when DNS forwarders start responding
      again.
eod

ATTR: notify-source-port
ATTRID: 166
ATTRHDRNAME: AO_DNSSERVER_NOTIFY_SOURCE_PORT
ATTRTYPE: AT_RANGEINT(0-65535)
ATTRMCDPATH: notify_source_port
ATTRVIZ: 5
ATTRDESC:: eod
Specifies the UDP port number that the DNS server uses to send
notify requests to other servers.

A value of zero indicates that the server should choose a random
port. If this attribute is unset, then queries are sent from
the port used to listen for queries (See the local-port-num
attribute).
eod

ATTR: notify-source-address
ATTRID: 167
ATTRHDRNAME: AO_DNSSERVER_NOTIFY_SOURCE_ADDR
ATTRTYPE: AT_IPADDR
ATTRMCDPATH: notify_source_addr
ATTRVIZ: 5
ATTRDESC:: eod
Specifies the source IP address that the DNS server uses to send
notify requests to other servers. A value of 0.0.0.0 indicates
that operating systen uses the best local address based on the
destination.
eod

ATTR: transfer-source-port
ATTRID: 168
ATTRHDRNAME: AO_DNSSERVER_TRANSFER_SOURCE_PORT
ATTRTYPE: AT_RANGEINT(0-65535)
ATTRMCDPATH: transfer_source_port
ATTRVIZ: 5
ATTRDESC:: eod
Specifies the UDP port number that the DNS server uses to send
transfer and SOA requests to other servers.

A value of 0 (zero) indicates that you should choose a random port.
If this attribute  is unset, then queries are sent from the port
used to listen for queries (see local-port-num).
eod

ATTR: transfer-source-address
ATTRID: 169
ATTRHDRNAME: AO_DNSSERVER_TRANSFER_SOURCE_ADDR
ATTRTYPE: AT_IPADDR
ATTRMCDPATH: transfer_source_addr
ATTRVIZ: 5
ATTRDESC:: eod
Specifies the source IP address that the DNS server uses to send
transfer and SOA requests to other servers.

A value of 0.0.0.0 indicates that operating system uses the best
local address based on the destination.

eod

ATTR: ha-dns-max-batch-count
ATTRID: 170
ATTRTYPE: AT_RANGEINT(100-10000)
ATTRDEFVAL: 1000
ATTRVIZ: 3
ATTRDESC:: eod
The HA main server batches RR edits before dispatching them
to the backup server. To maintain a manageable history list
containing the RR changes that need to be dispatched to the
backup server, the main server will discontinue accepting
DNS updates/administrative sourced RR edits once the number
of RRs undispatched/unknowledged (to/by the backup server)
exceeds this value.
eod

ATTR: ha-dns-max-interrupted-edits
ATTRID: 171
ATTRTYPE: AT_RANGEINT(25-100)
ATTRDEFVAL: 100
ATTRVIZ: 3
ATTRDESC:: eod
This value defines a percentage that the HA server uses to
allow its edits-list to grow in the persisted changed-names
DB while in the communication-interrupted state. If the number
of name-set records exceeds this percentage of the total
size of the zone, the zone will be purged from the changed-
names DB. During zone synchronization, the HA server can
only provide its entire zone to its partner. Though this
value bounds a zone in the changed-names DB during
communication-interrupted state, it will require a full zone
exchange during zone synchronization. The probability of losing
RR changes during synchronization gets enhanced by decreasing
this value. Note, 100% will retain all name-set records for
the zones; zones will not be purged.
eod

ATTR: ha-dns-max-cached-names
ATTRID: 172
ATTRTYPE: AT_RANGEINT(1000-50000)
ATTRDEFVAL: 10000
ATTRVIZ: 3
ATTRDESC:: eod
This value defines the maximumn number of name records to
cache in the HA changed-names DB. The larger the number
the greater the performance due to less DB access on the
physical disk. However, larger values will increase actual
process size.
eod

ATTR: ha-dns-db-checkpoint-interval
ATTRID: 173
ATTRTYPE: AT_RANGETIME(60-86400)
ATTRVIZ: 3
ATTRDEFVAL: 3600
ATTRDESC:: eod
Controls the frequency at which the DNS server records a
snapshot in the HA DNS database.  Default is 3600 seconds.
eod

ATTR: ha-dns-db-purge-logs-interval
ATTRID: 174
ATTRTYPE: AT_RANGETIME(600-86400)
ATTRVIZ: 3
ATTRDEFVAL: 1800
ATTRDESC:: eod
Controls the frequency at which the DNS server removes
unneeded HA DNS database log files.  Default is 1800
seconds.
Caution: Cisco strongly recommends accepting the default value,
as setting a smaller value can cause database backup failures.
eod

ATTR: resolution-queue-max-size
ATTRID: 175
ATTRTYPE: AT_RANGEINT(10-50000)
ATTRVIZ: 3
ATTRDEFVAL: 5000
ATTRDESC:: eod
This value will imposes a maximum limit of queries on the
outgoing queue. However this maximum does not apply for zone
xfer requests, notify requests and root primings.
eod

ATTR: ha-dns-max-frame-size
ATTRID: 176
ATTRTYPE: AT_RANGEINT(32-65536)
ATTRVIZ: 3
ATTRDEFVAL: 65536
ATTRDESC:: eod
This value represents the maximum size of an HA message frame.
eod


ATTR: ha-dns-min-zone-size
ATTRID: 177
ATTRTYPE: AT_INT
ATTRVIZ: 3
ATTRDEFVAL: 1000
ATTRDESC:: eod
This value interacts with ha-dns-max-interrupted-edits.
This attribute defines a floor, with respect to the number
of names persisted in the HA changed names DB, before
ha-dns-max-interrupted-edits is engaged. As long as the
number of peristed names for a zone is less than this
value, the zone will not be purged from the changed names
DB. A value of zero yields no floor; a zone would be
purged from the changed names DB as soon as the
ha-dns-max-interrupted-edits is achieved. A smaller
value of this attribute causes more (and smaller) zones
to be purged from the changed names DB. A larger value
will allow a zone to incur increasing name changes before
applying the ha-dns-max-interrupted-edits limit.
eod

ATTR: ha-dns-max-connect-timeout
ATTRID: 178
ATTRTYPE: AT_RANGETIME(30-600)
ATTRVIZ: 3
ATTRDEFVAL: 300
ATTRDESC:: eod
The first time an HA server attempts to connect to its partner,
it timeouts if no connection was made with ha-dns-comm-timeout.
The second time it will timeout after twice the ha-dns-comm-timeout
and so on. The ha-dns-max-connect-timeout sets the maximum
time we will wait for a connection to occur before timing out the
connection.
eod

ATTR: ha-dns-max-records
ATTRID: 179
ATTRTYPE: AT_INT
ATTRVIZ: 3
ATTRDEFVAL: 1000
ATTRDESC:: eod
When forming potentially large messages (i.e. zone synchronization
nameset synchronization, etc) this value determines the maximum
number of records that we will put into a single message. If a
message needs to house more than ha-dns-max-records it will be
broken down into a series of smaller messages all with the same
transaction id.
eod

ATTR: optimistic-ddns-responses
ATTRID: 180
ATTRTYPE: AT_BOOL
ATTRFLAGS: AF_FEATURE
ATTRDEFVAL: false
ATTRVIZ: 3
ATTRDESC:: eod
When enabled, the server will respond to DDNS updates before the
DDNS changes get persisted in the changeset DB (though the updates
have been stored in the server's realtime DBs). This feature yields
the maximum DDNS update performance at the very slim risk of losing
DDNS data in the changeset DB due to a server crash. If the server
unexpectedly aborts when DDNS data has been recorded in its
realtime DBs and responded too but before it gets persisted in the
changeset DB, this data can be lost. This is recoverable by
forcing CNR DHCP to send DDNS updates on renewals.
eod

ATTR: ha-dns-max-retries
ATTRID: 181
ATTRTYPE: AT_RANGEINT(0-10)
ATTRVIZ: 3
ATTRDEFVAL: 3
ATTRDESC:: eod
There are certain situations where the backup lags behind the
main in changing between states (namely from start-up, comm-intr
and partner-down to synchronization). In those cases if the main
may send out a zone sync message before the backup is ready to
receive it. This will cause the backup to respond with an
inconsistent state error and the main will in turn change to the
comm-intr state. What we should do is retry the message in order
to give the backup time to transition states. This attribute tells
the main how many times to retry sending the message before
deciding to go into communications interrupted state.
eod

ATTR: ha-dns-wait-between-retries
ATTRID: 182
ATTRTYPE: AT_RANGETIME(0s-1m)
ATTRVIZ: 3
ATTRDEFVAL: 3
ATTRDESC:: eod
When resending a message after receiving an inconsistent state
response, the amount of time we will wait before retrying.
eod

# 183 & 184 are free

ATTR: sync-major-number
ATTRID: 185
ATTRTYPE: AT_BOOL
ATTRVIZ: 1
ATTRDEFVAL: false
DEPRECATED: 7.0
ATTRDESC:: eod
When enabled, the DNS server will change a zone's major version
number in MCD state, changeset db, auth db and checkpoint files
to match that of MCD config (if it does not already match).
eod

ATTR: gss-load-balancer-appliance
ATTRID: 186
ATTRTYPE: AT_BOOL
ATTRFLAGS: AF_FEATURE
ATTRDEFVAL: false
ATTRVIZ: 1
ATTRDESC:: eod
Controls whether the DNS server operates as a normal, fully
functional server or operates in conjunction with the GSS
Load Balancer product in an appliance environment.  Default is
false.

Caution: Cisco recommends that customers do not enable
this attribute unless they are administering a cluster that is
co-resident with the GSS Load Balancer product.  Enabling this
attribute in the absence of the GSS Load Balancer product will
result in a non-functional DNS server.
eod

ATTR: restrict-cache-query-acl
ATTRID: 187
ATTRTYPE: AT_AMELST
ATTRMCDPATH: restrict_cache_query_acl
ATTRDESC:: eod
Specifies an access control list that restricts which
clients are allowed to query for cached non-authoritative
resource records. If unset, restrict-query-acl is used.
Optional.
eod

ATTR: exception-forwarding
ATTRID: 188
ATTRTYPE: AT_ENUMINT(forward-last=0, forward-first=1, forward-always=2)
ATTRDEFVAL: forward-last
ATTRFLAGS: AF_PRINT_ALT
ATTRDESC:: eod
Controls the order (forward-first, forward-last or forward-always)
with which the DNS server will forward a query to a configured
resolution exception.

forward-always - DNS will always forward queries to a configured
         	 exception

forward-first  - DNS will first forward queries to a configured 
	         exception and if it doesn't get an answer 
		 before the request expires, it will forward to 
	         cached name servers (if any)

forward-last   - DNS will first forward queries to cached name 
		 servers (if any) and if it doesn't get an answer 
		 before the request expires, it will forward the 
		 query to a configured exception 
eod

ATTR: unit-of-work-max-duration
ATTRID: 189
ATTRTYPE: AT_RANGEINT(1-10)
ATTRDEFVAL: 1
ATTRVIZ: 3
ATTRDESC:: eod
Defines the maximum time in seconds that the server will allow to
elapse before interrupting a unit-of-work limited task.  This
attribute is currently only used for enhanced RR searches.
eod

ATTR: unit-of-work-max-count
ATTRID: 190
ATTRTYPE: AT_RANGEINT(100-1000)
ATTRDEFVAL: 500
ATTRVIZ: 3
ATTRDESC:: eod
Defines the number of RR's to search through before checking the
elapsed time for purposes of interrupting a unit-of-work limited
task.  This attribute is currently only used for enhanced RR
searches.
eod

ATTR: minimal-responses
ATTRID: 191
ATTRTYPE: AT_BOOL
ATTRDEFVAL: disabled
ATTRDESC:: eod
Controls whether the DNS server omits or includes records from
the authority and data sections of query responses when these 
records are not required. Enabling this attribute may improve
query performance such as when the DNS server is configured as
a caching server. 
eod

ATTR: sysquery-fork-limit
ATTRID: 192
ATTRTYPE: AT_RANGEINT(0-100)
ATTRDEFVAL: 5
ATTRVIZ: 3
ATTRDESC:: eod
Specifies the maximum number of sysquery calls in chasing
glueless NS records for each name query. 
eod

ATTR: ha-dns-failure-detection-timeout
ATTRID: 193
ATTRTYPE: AT_RANGETIME(30s-3h)
ATTRDEFVAL: 90s
ATTRVIZ: 3
ATTRDESC:: eod
Specifies the amount of time an HA server will wait for
its partner to send a Synchronization Pending Request 
before it assuming that there was some un-processed
failure and transitioning to Communications Interrupted
State.
eod

ATTR: optimize-zone-lookup
ATTRID: 194
ATTRTYPE: AT_BOOL
ATTRDEFVAL: true
ATTRVIZ: 3
ATTRDESC:: eod
Controls whether the DNS server will lookup a zone given a
FQDN by stripping off one label at a time or optimally, by 
skipping forward a certain number of labels based on the 
zone or subzone with the highest label count. Enabling this 
feature may improve query performance for authorative 
multi-label names such as IPv6 reverse names.
eod

ATTR: round-trip-time-limit
ATTRID: 195
ATTRTYPE: AT_RANGETIME(100s-1500s)
ATTRDEFVAL: 1000s
ATTRVIZ: 3
ATTRDESC:: eod
Specify the cap for the  maximum round trip time to prevent 
floating point overflow.
eod


# END OF DNS CLASS

CLASS: Zone
CLASSROOT: ZONE
CLASSID: 1201
CLASSNAME: 1
CLASSNAMEDESC:: eod
The name of Zone objects is the origin of the zone. Zone objects
cannot be renamed.
eod
CLASSVIZ: 5
CLASSPCV: 1.0.0
CLASSDEPRECATED: 7.0.0
CLASSDESC:: eod
The DNS Zone configuration object.
eod

ATTR: origin
ATTRID: 1
ATTRHDRNAME: AO_ZONE_ORIGIN
ATTRTYPE: AT_DNSNAME
ATTRMCDPATH: name
ATTRFLAGS: AF_REQUIRED, AF_IMMUTABLE, AF_UNIQUE
ATTRVIZ: 5
ATTRDESC:: eod
Specifies the fully-qualified name of the zone's root.  The zone name.
eod

ATTR: type
ATTRID: 2
ATTRHDRNAME: AO_ZONE_TYPE
ATTRTYPE: AT_ENUMSTR(primary, secondary)
ATTRMCDPATH: type
ATTRFLAGS: AF_REQUIRED, AF_IMMUTABLE
ATTRVIZ: 5
ATTRDESC:: eod
Specifies the type of role the server plays for this zone.
Usually you configure only one server as primary for a zone,
but multiple secondary servers that retrieve zone data through
zone transfers.
eod

ATTR: records
ATTRID: 3
ATTRHDRNAME: AO_ZONE_RECORDS
ATTRTYPE: AT_NLIST(AT_OBJ(RRSet))
# 1<<16 | 1206
ATTRVAL: 66742
ATTRMCDPATH: records
ATTRFEAT: (type == primary)
ATTRVIZ: 1
ATTRDESC:: eod
Kept in case we shift to a single-object encoding scheme
for zones with a small number of RRs.
eod

ATTR: state-records
ATTRID: 4
ATTRHDRNAME: AO_ZONE_STATE_RECORDS
ATTRTYPE: AT_NLIST(RRSet)
# 1<<16 | 1206
ATTRVAL: 66742
ATTRMCDPATH: state-records
ATTRVIZ: 3
ATTRDESC:: eod
Resource records received through dynamic update (for primary
zones) or zone transfer (for secondary zones).
eod

ATTR: server
ATTRID: 5
ATTRHDRNAME: AO_ZONE_SERVER
ATTRTYPE: AT_NAMEREF(DNSServer)
ATTRVAL: 1200
ATTRMCDPATH: server
ATTRVIZ: 1
ATTRDESC:: eod
The name of the DNS server for this zone, but since this
is a local Zone object there can only be one DNS server
for it -- the DNS server on this local cluster.
See the CCMZoneDistribution and CCMZone objects
for the current mechanism for mapping zones to
servers.
eod

ATTR: restrict-xfer
ATTRID: 6
ATTRHDRNAME: AO_ZONE_RESTRICT_XFER
ATTRTYPE: AT_BOOL
ATTRFLAGS: AF_FEATURE
ATTRDEFVAL: false
ATTRMCDPATH: restrict_xfer
ATTRVIZ: 5
ATTRDESC:: eod
Restricts sending zone transfers to a specific set of hosts.
If you restrict zone transfers, you need to use the
restrict-xfer-acl access control property to designate who is
allowed to perform zone transfers.
eod

ATTR: dynamic
ATTRID: 7
ATTRHDRNAME: AO_ZONE_ENABLE_UPDATES
ATTRTYPE: AT_BOOL
ATTRFLAGS: AF_FEATURE
ATTRDEFVAL: true
ATTRMCDPATH: enable_updates
ATTRFEAT: (type == primary)
ATTRVIZ: 5
ATTRDESC:: eod
Enables RFC 2136 dynamic updates to the zone.  The most typical
source of these updates is a DHCP server. The UIs also need this
attribute enabled in order to allow dynamic updates on the zone.
Defaults to enabled.
eod

ATTR: restricted-set
ATTRID: 8
ATTRHDRNAME: AO_ZONE_RESTRICTED_SET
ATTRTYPE: AT_NLIST(AT_IPADDR)
# AT_IPADDR = 4
ATTRVAL: 4
ATTRMCDPATH: restricted_set
# Is this really required?  -as 5/25/02 (Zone.restricted-set)
#ATTRFLAGS: AF_REQUIRED
ATTRDEFVAL: 0
ATTRFEAT: 6
ATTRVIZ: 1
DEPRECATED: 5.0
ATTRDESC:: eod
The set of IP addresses which may request zone transfers,
when "restrict-xfer" is enabled.  Addresses with zeros in the
least significant octets are treated as network numbers,
with implicit masks in octet multiples.
eod

ATTR: dynupdate-set
ATTRID: 9
ATTRHDRNAME: AO_ZONE_DYNUPDATE_SET
ATTRTYPE: AT_NLIST(AT_IPADDR)
# AT_IPADDR = 4
ATTRVAL: 4
ATTRMCDPATH: dyn_update_set
ATTRDEFVAL: 0
ATTRVIZ: 1
DEPRECATED: 4.0
ATTRDESC:: eod
The set of IP addresses from which dynamic updates will be
accepted, when "dynamic" is enabled.  Addresses with zeros in
the least significant octets are treated as network numbers,
with implicit masks in octet multiples.
eod

ATTR: ixfr
ATTRID: 10
ATTRHDRNAME: AO_ZONE_IXFR_ENABLE
ATTRTYPE: AT_BOOL
ATTRFLAGS: AF_FEATURE
ATTRMCDPATH: ixfr_enable
ATTRFEAT: (type == secondary)
ATTRVIZ: 5
ATTRDESC:: eod
Enables requesting incremental transfer for this zone.  When set,
to either true or false, it overrides the global "ixfr-enable"
value for this zone.

If you set incremental transfers, then this particular zone will
act differently than zones inheriting the server global value.
If you unset incremental transfers, Network Registrar uses the
server global ixfr value (and the operation of the GUI
specifically depends on this, since it has no way of setting
this per-zone feature).

Using the server global value (not setting this value per-zone)
gives the you an easy way of globally turning ixfr on or off,
or setting a general policy for your zones and specific exceptions
to the server global value.
eod

ATTR: notify
ATTRID: 11
ATTRHDRNAME: AO_ZONE_NOTIFY_ENABLE
ATTRTYPE: AT_BOOL
ATTRFLAGS: AF_FEATURE
ATTRMCDPATH: notify_enable
ATTRVIZ: 5
ATTRDESC:: eod
Enables notification of other authoritative servers when this
zone changes.  When set, to either true or false, it overrides the
global "notify" value for this zone.
eod

ATTR: notify-set
ATTRID: 12
ATTRHDRNAME: AO_ZONE_NOTIFY_LIST
ATTRTYPE: AT_NLIST(AT_IPADDR)
# AT_IPADDR = 4
ATTRVAL: 4
ATTRMCDPATH: notify_list
ATTRFEAT: 11
ATTRVIZ: 5
ATTRDESC:: eod
Lists additional servers to notify when the zone data
changes.  All servers listed in NS records for the zone, with the
exception of the server described by the "ns" property of the zone
(the mname field of the SOA record) receive notifications.
Servers listed in "notify-list" are also notified.
eod

# START experimental native attributes for values stored in SOA
# and NS records
ATTR: x-serial
ATTRID: 21
ATTRFLAGS: AF_IMMUTABLE
ATTRHDRNAME: AO_ZONE_SERIAL
ATTRTYPE: AT_INT
ATTRVIZ: 1

ATTR: x-fixname
ATTRID: 22
ATTRFLAGS: AF_IMMUTABLE
ATTRHDRNAME: AO_ZONE_FIXNAME
ATTRTYPE: AT_DNSNAME
ATTRVIZ: 1

ATTR: x-name
ATTRID: 23
ATTRFLAGS: AF_IMMUTABLE
ATTRHDRNAME: AO_ZONE_NAME
ATTRTYPE: AT_DNSNAME
ATTRVIZ: 1

ATTR: x-dbidx
ATTRID: 24
ATTRFLAGS: AF_IMMUTABLE
ATTRHDRNAME: AO_ZONE_DBIDX
ATTRTYPE: AT_INT
ATTRVIZ: 1

# END experimental native attributes for values stored in SOA and
# NS soa values
#

ATTR: ns
ATTRID: 25
ATTRTYPE: AT_DNSNAME
ATTRVIZ: 5
ATTRDESC:: eod
Displays the fully-qualified domain name of the primary name server
for this zone. This host is the original, or primary source, of
data for this zone.
eod

ATTR: person
ATTRID: 26
ATTRTYPE: AT_DNSNAME
ATTRVIZ: 5
ATTRDESC:: eod
Displays a domain name specifying the mailbox of the person
responsible for this zone.  The first label is a user or mail
alias, the rest of the labels are a mail destination.  A mailbox
of hostmaster@test.com would be represented as hostmaster.test.com.
eod

ATTR: refresh
ATTRID: 27
ATTRTYPE: AT_RANGETIME(1-2147483647)
ATTRFLAGS: AF_INITIALIZE
ATTRDEFVAL: 3h
ATTRVIZ: 5
ATTRDESC:: eod
Sets the number of seconds that a secondary server waits before
polling for zone changes and refreshing its zone data.
eod

ATTR: retry
ATTRID: 28
ATTRTYPE: AT_RANGETIME(1-2147483647)
ATTRFLAGS: AF_INITIALIZE
ATTRDEFVAL: 1h
ATTRVIZ: 1
ATTRDESC:: eod
Sets the number of seconds that a secondary server waits before
it retries polling for changes to zone data or it retries a zone
transfer that has encountered errors.

eod

ATTR: expire
ATTRID: 29
ATTRTYPE: AT_RANGETIME(1-2147483647)
ATTRFLAGS: AF_INITIALIZE
ATTRDEFVAL: 1w
ATTRVIZ: 5
ATTRDESC:: eod
Sets the number of seconds that a secondary server can continue
providing zone data without confirming that the data remains current.

eod

ATTR: minttl
ATTRID: 30
ATTRTYPE: AT_RANGETIME(0-2147483647)
ATTRFLAGS: AF_INITIALIZE
ATTRDEFVAL: 10m
ATTRVIZ: 5
ATTRDESC:: eod
Sets the minimum TTL value displayed in resource records for this
zone. Records with TTL values lower than the minttl are published
with this value.
eod

ATTR: nameservers
ATTRID: 31
ATTRTYPE: AT_NLIST(AT_DNSNAME)
# AT_DNSNAME = 35
ATTRVAL: 35
ATTRDESC:: eod
Lists the nameservers in this zone.
eod


ATTR: auth-servers
ATTRID: 101
ATTRHDRNAME: AO_ZONE_AUTH_SERVERS
ATTRTYPE: AT_NLIST(AT_IPADDR)
# AT_IPADDR = 4
ATTRVAL: 4
ATTRMCDPATH: value/server_set
# Is this really required?  -as 5/25/02 (Zone.auth-servers)
# Yes, this is required. All secondaries must have this - 8/21/02
# (jjc)
# But it is not required for primary zones, so the AF_REQUIRED is
# too strict
# ATTRFLAGS: AF_REQUIRED
ATTRFEAT: (type == secondary)
DEPRECATED: 5.0
ATTRVIZ: 1
ATTRDESC:: eod
The is the list of servers from which we will transfer data
for this secondary zone.
eod

ATTR: soattl
ATTRID: 32
ATTRTYPE: AT_RANGETIME(0-2147483647)
ATTRVIZ: 3
ATTRDESC:: eod
The ttl value to be applied to the zone's SOA rr.

eod
ATTR: nsttl
ATTRID: 33
ATTRTYPE: AT_RANGETIME(0-2147483647)
ATTRVIZ: 3
ATTRDESC:: eod
The ttl value to be applied to the zone's NS rrs.

eod
ATTR: defttl
ATTRID: 102
ATTRHDRNAME: AO_ZONE_DEFTTL
ATTRTYPE: AT_RANGETIME(0-2147483647)
ATTRMCDPATH: defttl
ATTRFEAT: (type == primary)
ATTRVIZ: 5
ATTRDEFVAL: 86400
ATTRDESC:: eod
Controls the default TTL value used for resource records in this
zone that do not specify a TTL.
eod

ATTR: checkpoint-interval
ATTRID: 103
ATTRHDRNAME: AO_ZONE_CHECKPOINT_INTERVAL
ATTRTYPE: AT_RANGETIME(3600-604800)
ATTRMCDPATH: checkpoint_interval
ATTRVIZ: 5
ATTRDESC:: eod
Sets the number of seconds that elapse between saves of zone data.
When the interval expires, Network Registrar takes a snapshot of
the zone data and records it in the zone checkpoint database.

eod

ATTR: scvg-enabled
ATTRID: 104
ATTRHDRNAME: AO_ZONE_SCAVENGE_ENABLED
ATTRTYPE: AT_BOOL
ATTRMCDPATH: scvg_enabled
ATTRDEFVAL: 0
ATTRFEAT: (type == primary)
ATTRVIZ: 5
ATTRDESC:: eod
Enables dynamic resource-record scavenging for the zone.
eod

ATTR: scvg-interval
ATTRID: 105
ATTRHDRNAME: AO_ZONE_SCAVENGE_INTERVAL
ATTRTYPE: AT_RANGETIME(3600-31536000)
ATTRMCDPATH: scvg_interval
ATTRFEAT: (type == primary)
ATTRVIZ: 5
ATTRDESC:: eod
Sets the period of time that must elapse before a DNS server
can remove an out-of-date address (A) record. An A record becomes
out-of-date once it ages past its initial creation date plus its
scvg-refresh-interval and scvg-no-refresh-interval. Default is 1w.

eod

ATTR: scvg-no-refresh-interval
ATTRID: 106
ATTRHDRNAME: AO_ZONE_SCAVENGE_NO_REFRESH_INTERVAL
ATTRTYPE: AT_RANGETIME(3600-31536000)
ATTRMCDPATH: scvg_no_refresh_interval
ATTRFEAT: (type == primary)
ATTRVIZ: 5
ATTRDESC:: eod
With scavenging enabled, sets the interval during which DNS
updates cannot increment an A record timestamp. After both
the no-refresh and refresh intervals expire, the record is a
candidate for scavenging. The value an range from one hour to
365 days. You can also set this attribute on a zone, and the
value set on the zone overrides he server setting. Default is 1w.

eod

ATTR: scvg-refresh-interval
ATTRID: 107
ATTRHDRNAME: AO_ZONE_SCAVENGE_REFRESH_INTERVAL
ATTRTYPE: AT_RANGETIME(3600-31536000)
ATTRMCDPATH: scvg_refresh_interval
ATTRFEAT: (type == primary)
ATTRVIZ: 5
ATTRDESC:: eod
With scavenging enabled, sets the interval during which DNS
updates can increment the A record timestamp. After both the
no-refresh and refresh intervals expire, the record is a
candidate for scavenging. The value can range from one hour
to 365 days. You can also set this  attribute on a zone, and
the value set on the zone overrides the server setting.
Default is 1w.
eod

ATTR: scvg-max-records-searched
ATTRID: 108
ATTRHDRNAME: AO_ZONE_SCAVENGE_MAX_RECORDS_SEARCHED
ATTRTYPE: AT_RANGEINT(1-2000000000)
ATTRMCDPATH: scvg_max_records_searched
ATTRFEAT: (type == primary)
ATTRVIZ: 3
ATTRDESC:: eod
Sets the  maximum number of records to search for out-of-date
A records.  These records are candidates for scavenging.

eod

ATTR: scvg-ignore-restart-interval
ATTRID: 109
ATTRHDRNAME: AO_ZONE_SCAVENGE_IGNORE_RESTART_INTERVAL
ATTRTYPE: AT_RANGETIME(7200-86400)
ATTRMCDPATH: scvg_ignore_restart_interval
ATTRFEAT: (type == primary)
ATTRVIZ: 5
ATTRDESC:: eod
Ensures that the server does not reset the scavenging time whenever
a server restarts. Within this attribute set, Network Registrar
ignores the time between when a server went down and the time it
restarts. This interval is normally short. The value can range from
two hours to one day.

With any time longer than the set time, Network Registrar
recalculates the scavenging period to allow for record updates
that cannot take place while the server is stopped. You can also set
this attribute on a zone, and the value set on the zone overrides
the server setting.
Default is 2h.

eod

ATTR: scvg-pause-interval
ATTRID: 110
ATTRHDRNAME: AO_ZONE_SCAVENGE_PAUSE_INTERVAL
ATTRTYPE: AT_RANGETIME(1-86400)
ATTRMCDPATH: scvg_pause_interval
ATTRFEAT: (type == primary)
ATTRVIZ: 3
ATTRDESC:: eod
The interval (in seconds) that scavenging will wait after
scavenging a set of records, before going onto the next set.
eod

ATTR: checkpoint-min-interval
ATTRID: 111
ATTRHDRNAME: AO_ZONE_CHECKPOINT_MIN_INTERVAL
ATTRTYPE: AT_RANGETIME(60-2700)
ATTRMCDPATH: checkpoint_min_interval
ATTRVIZ: 3
ATTRDESC:: eod
The minimum amount of time required (in seconds) between the time
the first checkpoint occurs and the second checkpoint starts.
This attribute applies only to zones with dynamic rrs.
eod

ATTR: scvg-max-records
ATTRID: 112
ATTRHDRNAME: AO_ZONE_SCAVENGE_MAX_RECORDS
ATTRTYPE: AT_RANGEINT(1-10000)
ATTRMCDPATH: scvg_max_records
ATTRFEAT: (type == primary)
ATTRVIZ: 3
ATTRDESC:: eod
Sets the  maximum number of zone records to search for scavenging
candidates.

eod

ATTR: MajorSerialNumber
ATTRID: 113
ATTRHDRNAME: AO_ZONE_MAJOR_NUMBER
ATTRTYPE: AT_INT
ATTRMCDPATH: MajorSerialNumber
ATTRVIZ: 3
ATTRDESC:: eod
Unique major version number of the zone. Indicates whether a zone
has been deleted and re-added.
eod

ATTR: MinorSerialNumber
ATTRID: 114
ATTRHDRNAME: AO_ZONE_MINOR_NUMBER
ATTRTYPE: AT_INT
ATTRMCDPATH: MinorSerialNumber
ATTRVIZ: 3
ATTRDESC:: eod
As the zone's minor version number, used to convey if some kind of
admin change (to the zone attributes and/or zone's RR composition)
has been applied on the zone. UI must increment this value when the
zone has been modified, causing the server to apply an incremental
load of the zone.
eod

ATTR: ZoneSerial
ATTRID: 115
ATTRHDRNAME: AO_ZONE_CONFIG_SERIAL
ATTRTYPE: AT_INT
ATTRMCDPATH: ZoneSerial
ATTRVIZ: 5
ATTRDESC:: eod
Displays an administratively specified serial number. Since serial
numbers must never regress, the value set here is accepted only if it
is greater than the actual (dynamic) serial number.
eod

ATTR: TableGenNumber
ATTRID: 116
ATTRHDRNAME: AO_ZONE_TABLE_GENNUM
ATTRTYPE: AT_INT
ATTRMCDPATH: TableGenNumber
ATTRVIZ: 3
ATTRDESC:: eod
The current MCD RR table generation number for this zones
configuration rrs.
eod

ATTR: update-acl
ATTRID: 117
ATTRHDRNAME: AO_ZONE_UPDATE_ACL
ATTRTYPE: AT_AMELST
ATTRMCDPATH: update-acl
ATTRDESC:: eod
Specifies the access control list for DNS updates to the zone,
defined as an address match element list. The access control
list is not applied to dynamic updates coming from the UIs. Updates
from them UIs are always allowed as long as the zone attribute
dynamic is enabled.
eod

ATTR: subzone-forward
ATTRID: 118
ATTRHDRNAME: AO_ZONE_SUBZONE_FORWARD
ATTRTYPE: AT_ENUMINT(normal=0, no-forward=1)
ATTRFLAGS: AF_PRINT_ALT
ATTRVIZ: 5
ATTRDEFVAL: normal
ATTRDESC:: eod
Specifies whether subzones use forwarders or not. When no-forward
is set, any query for the zone will not be sent to the forwarder.
This is an extended resolution exception.
eod

ATTR: full-reload-recovery-options
ATTRID: 119
ATTRHDRNAME: AO_ZONE_FULL_RELOAD_RECOVERY_OPTIONS
ATTRTYPE: AT_ENUMINT(abort-on-error=0, resume-roll-forward-on-err=1, remove-from-changeset-db=2, remove-dynamic-rrs=3)
ATTRMCDPATH: full_reload_recovery_options
ATTRFLAGS: AF_PRINT_ALT
ATTRVIZ: 3
ATTRDESC:: eod
This defines the option to use during zone configuration.
This option overrides the corresponding server level option.
abort-on-error, the default, specifies that full zone reload
should abort when encountered an error (while rolling-forward
changesets on top of the zone checkpoint).
resume-roll-forward-on-err requests that the server should
continue rolling forward the zone even though there was an
encountered error(s). remove-from-changeset-db specifies that the
zone should be removed from the changeset DB during server
startup/reload; this option may result in the loss of "recent"
RRs. Last, remove-dynamic-rrs causes the server to remove the zone
from both the checkpoint datastore and the changeset DB, causing
all dynamic RRs to be lost (static RRs shall be retained though).
eod

ATTR: restrict-xfer-acl
ATTRID: 120
ATTRHDRNAME: AO_ZONE_RESTRICT_XFER_ACL
ATTRTYPE: AT_AMELST
ATTRMCDPATH: restrict_xfer_acl
ATTRVIZ: 5
ATTRDESC:: eod
Contains the access control list (ACL) that designates which
devices can receive zone transfers from this zone.
eod

ATTR: master-servers
ATTRID: 121
ATTRHDRNAME: AO_ZONE_MASTER_SERVERS
ATTRTYPE: AT_NLIST(AT_IPKEY)
# AT_IPKEY = 56
ATTRVAL: 56
ATTRMCDPATH: master_servers
ATTRFEAT: (type == secondary)
ATTRVIZ: 5
ATTRDESC:: eod
For secondary zones, lists servers from which to transfer data.
You can append each server address with an optional TSIG key name
to configure secure zone transfers in the syntax addresskey. If
you use the zone name create secondary addr command to create the
secondary zone instead, the addr in that syntax becomes
the master-servers value.
eod

ATTR: upgrade-version
ATTRID: 122
ATTRTYPE: AT_INT
ATTRFLAGS: AF_IMMUTABLE
ATTRVIZ: 3
ATTRDESC:: eod
Supports DB upgrades. Records the latest (config DB)
upgrade version - to determine synchronicity with config DB.
Generally, used while upgrading to determine whether the
zone has successfully completed upgrading.
eod

ATTR: restrict-query-acl
ATTRID: 123
ATTRHDRNAME: AO_ZONE_RESTRICT_QUERY_ACL
ATTRTYPE: AT_AMELST
ATTRMCDPATH: restrict_query_acl
ATTRVIZ: 5
ATTRDESC:: eod
Restricts the queries that the DNS server for this zone must honor.
This list can contain host IPs, network addresses, TSIG keys and/or
(global) ACLs. Clients defined in this ACL list must be honored;
others must be refused. If missing, the zone inherits the global
restrict-query-acl value from the server configuration.
eod

ATTR: update-policy-list
ATTRID: 124
ATTRTYPE: AT_NLIST(AT_STRING)
ATTRVIZ: 5
ATTRDESC:: eod
Lists named update policies that this zone uses to process
DDNS updates.
eod

ATTR: state
ATTRID: 126
ATTRHDRNAME: AO_ZONE_STATE
ATTRTYPE: AT_FLAGSINT( normal=1, admin-disabled=2, unpublished=3, corrupt-zone-data=4, corrupt-rr-data=5, modifications-pending=6)
ATTRFLAGS: AF_PRINT_ALT,AF_IMMUTABLE
ATTRDESC:: eod
The server's state of the zone.

The possible zone states are
o normal - Zone is in normal operational state.
o admin-disabled - Zone was admistratively disabled.
o unpublished - Zone was just created or in the process of being
                created but has not yet been engaged. A server
                reload is necessary to engage the new zone.
o corrupt-zone-data - Zone attributes have some faulty data.
                Server can not allow the zone to become
                operational and is effectively disabled. Admin
                edits on the attributes shall be permitted; RR
                admin edits shall not. Zone shall not be exposed
                to external DNS requests.
o corrupt-rr-data - Zone has certain amount of faulty RRs. Server
                can not allow the zone to become operational and
                is effectively disabled.  Both admin edits on the
                zone's attributes and RRs shall be permitted. The
                zone, however, shall not be exposed to external
                DNS requests.
o modifications-pending - Server accepted administrative changes
                to the zone attributes. These changes have been
                persisted but have not been engaged. A server
                reload is required to engage these modifications.
eod

ATTR: PreTwisterMajorNumber
ATTRID: 127
ATTRHDRNAME: AO_ZONE_PRETWISTER_MAJOR_NUMBER
ATTRTYPE: AT_INT
ATTRFLAGS: AF_IMMUTABLE
ATTRMCDPATH: PreTwisterMajorNumber
ATTRVIZ: 1
ATTRDESC:: eod
Zone's major number as assigned prior to Twister upgrade. Used to
support Twister upgrades.
eod


ATTR: name-protection
ATTRID: 128
ATTRTYPE: AT_BOOL
#ATTRHDRNAME: AO_ZONE_NAME_PROTECTION
ATTRFLAGS: AF_FEATURE
ATTRDEFVAL: true
ATTRVIZ: 3
ATTRDESC:: eod
When enabled, RR name-sets (all RRs of the same name) are
protected from dynamic updates. When disabled, name-sets can be
altered by dynamic updates, provided update policies have been
configured to allow the update. Note, disabling name-protection
permits dynamic update changes on protected name-sets. This runs
the risk of introducing inconsistencies between actual RR
name-sets and the CCM's host-db; the host-db can diverge from the
actual state of RRs of the zone.
eod


ATTR: name-protection-default
ATTRID: 129
#ATTRHDRNAME: AO_ZONE_NAME_PROTECTION_DEFAULT
ATTRTYPE: AT_ENUMINT(unprotected=1, protected=2)
ATTRMCDPATH: name_protection_default
ATTRDEFVAL: protected
ATTRVIZ: 3
ATTRDESC:: eod
Determines the default setting for the name-protection attribute
when adding a new name.
eod

ATTR: exclude-from-ha-dns
ATTRID: 130
ATTRTYPE: AT_BOOL
ATTRDEFVAL: false
ATTRVIZ: 3
ATTRDESC:: eod
When enabled, the zone will excluded from HA DNS processing.
eod

#end of class zone

# Resource record validation
#
# The validation of resource records is a bit complex.  Each type
# has its own validation requirements.
# Between types the following rules apply:
#
# - No name may have a CNAME record and any other record,
#   including another CNAME record.
# - No name may have multiple records with identical type and data
#   (record equality is determined based on record-specific rules,
#   generally based on the presence of names in the record which
#   must have case-insensitive comparisons.)
# - SOA records may not appear except at the zone origin.
# - Records must not appear at or beneath subzone delegations
#   (which are indicated by the presence of an NS record at a name
#   other than the zone origin), except glue A records which are
#   required by the parent zone for locating subzone name servers.
# - Multiple WKS records may not co-exist on a name with identical
#   "address" and "protocol" fields (first 6 octets).
# - A zone may not contain records which are outside the zone.
#

CLASS: ResourceRecord
CLASSROOT: RESOURCERECORD
CLASSID: 1202
CLASSNAME: 1
CLASSVIZ: 1
CLASSNAMEDESC:: eod
The name of ResourceRecord objects is the name of the resource
record.  ResourceRecord objects cannot be renamed.
eod
CLASSDESC:: eod
A DNS resource record
eod

ATTR: name
ATTRID: 1
ATTRHDRNAME: AO_RESOURCERECORD_NAME
ATTRTYPE: AT_STRING
ATTRFLAGS: AF_REQUIRED
ATTRVIZ: 3
ATTRDESC:: eod
The resource record's domain name (owner name).
eod

ATTR: type
ATTRID: 2
ATTRHDRNAME: AO_RESOURCERECORD_TYPE
ATTRTYPE: AT_SHORT
ATTRFLAGS: AF_REQUIRED
ATTRVIZ: 5
ATTRDESC:: eod
Defines the resource record type.
eod

ATTR: class
ATTRID: 3
ATTRHDRNAME: AO_RESOURCERECORD_CLASS
ATTRTYPE: AT_SHORT
ATTRFLAGS: AF_IMMUTABLE, AF_REQUIRED
ATTRVIZ: 5
ATTRDEFVAL: 1
ATTRDESC:: eod
Defines the resource record class.
eod

ATTR: ttl
ATTRID: 4
ATTRHDRNAME: AO_RESOURCERECORD_TTL
ATTRTYPE: AT_RANGETIME(0-2147483647)
ATTRFLAGS: AF_REQUIRED
ATTRVIZ: 5
ATTRDESC:: eod
Sets the seconds of time-to-live for the resource record and
determines the length of time the client may cache the record.
eod

ATTR: value
ATTRID: 5
ATTRHDRNAME: AO_RESOURCERECORD_VAL
ATTRFLAGS: AF_REQUIRED
ATTRTYPE: AT_BLOB
ATTRVIZ: 5


CLASS: Host
CLASSROOT: HOST
CLASSID: 1203
CLASSVIZ: 3
CLASSNAME: 1
CLASSPCV: 1.0.0
CLASSDEPRECATED: 4.0.0
CLASSNAMEDESC:: eod
The name of Host objects is the name of the resource record.
Host objects cannot be renamed.
eod
CLASSDESC:: eod
A DNS host
eod

ATTR: name
ATTRID: 1
ATTRHDRNAME: AO_HOST_NAME
ATTRFLAGS: AF_REQUIRED
ATTRTYPE: AT_STRING
ATTRVIZ: 3
ATTRDESC:: eod
The domain name of the host.
eod

ATTR: addrs
ATTRID: 3
ATTRHDRNAME: AO_HOST_ADDRS
ATTRFLAGS: AF_REQUIRED
ATTRTYPE: AT_ARRAY(AT_IPADDR)
ATTRVIZ: 5
ATTRDESC:: eod
Lists addresses assigned to the host.
eod

ATTR: aliases
ATTRID: 4
ATTRHDRNAME: AO_HOST_ALIASES
ATTRTYPE: AT_ARRAY(AT_STRING)
ATTRVIZ: 5
ATTRDESC:: eod
Lists alias domain names for this host.
eod

CLASS: StaticPool
CLASSROOT: STPOOL
CLASSID: 1204
CLASSVIZ: 1
CLASSNAME: 1
CLASSNAMEDESC:: eod
The names of StaticPool objects are arbitrarily chosen by the
user, and must be unique.  There is no semantic value associated
with the name.
eod
CLASSDESC:: eod
A StaticPool object, containing address ranges and zone assignments
eod

ATTR: name
ATTRID: 1
ATTRHDRNAME: AO_STPOOL_NAME
ATTRTYPE: AT_STRING
ATTRMCDPATH: Name
ATTRVIZ: 3
ATTRDESC:: eod
The name of the static pool object.
eod

ATTR: addr
ATTRID: 2
ATTRHDRNAME: AO_STPOOL_NETADDR
ATTRTYPE: AT_IPADDR
ATTRFLAGS: AF_REQUIRED
ATTRMCDPATH: IPAddr
ATTRVIZ: 5
ATTRDESC:: eod
Displays the address of the subnet for which the static pool
keeps addresses.
eod

ATTR: mask
ATTRID: 3
ATTRHDRNAME: AO_STPOOL_NETMASK
ATTRTYPE: AT_MASK
ATTRFLAGS: AF_REQUIRED
ATTRMCDPATH: NetMask
ATTRVIZ: 5
ATTRDESC:: eod
Associates a subnet mask with the network address of the static pool.
eod

ATTR: dns-zone-name
ATTRID: 4
ATTRHDRNAME: AO_STPOOL_DNSZONENAME
ATTRFLAGS: AF_IMMUTABLE, AF_REQUIRED
ATTRTYPE: AT_STRING
ATTRMCDPATH: DnsZoneName
ATTRVIZ: 5
ATTRDESC:: eod
Designates the DNS zone where a static pool's resource records
should be added.
eod

ATTR: dns-reverse-zone-name
ATTRID: 5
ATTRHDRNAME: AO_STPOOL_DNSREVERSEZONENAME
ATTRTYPE: AT_STRING
ATTRFLAGS: AF_IMMUTABLE
ATTRMCDPATH: DnsReverseZoneName
ATTRVIZ: 5
ATTRDESC:: eod
Names the reverse DNS zone where a static pool's resource records
should be added.
eod

ATTR: dns-host-bytes
ATTRID: 6
ATTRHDRNAME: AO_STPOOL_DNSNUMBEROFHOSTBYTES
ATTRTYPE: AT_RANGEINT(1-4)
ATTRDEFVAL: 3
ATTRFLAGS: AF_IMMUTABLE, AF_INITIALIZE
ATTRMCDPATH: DnsNumberOfHostBytes
ATTRVIZ: 3
ATTRDESC:: eod
This number of the bytes in a pool's IP address
to use when forming in-addr.arpa names. The cluster forms names in
the in-addr zone by prepending dns-host-bytes of IP address (in
reverse order) to the dns-reverse-zone-name.
eod

ATTR: free-addresses
ATTRID: 7
ATTRHDRNAME: AO_STPOOL_FREEPOOLADDRESSES
ATTRTYPE: AT_INT
ATTRFLAGS: AF_IMMUTABLE
ATTRMCDPATH: FreeAddr
ATTRVIZ: 5
ATTRDESC:: eod
Specifies the number of addresses that are free for assignment
within the static pool.
eod

ATTR: total-addresses
ATTRID: 8
ATTRHDRNAME: AO_STPOOL_TOTALPOOLADDRESSES
ATTRTYPE: AT_INT
ATTRFLAGS: AF_IMMUTABLE
ATTRMCDPATH: TotalAddr
ATTRVIZ: 5
ATTRDESC:: eod
Displays the total number of addresses in the static pool.
eod

CLASS: PoolManager
CLASSROOT: POOLMANAGER
CLASSID: 1205
CLASSVIZ: 1
CLASSNAME: 1
CLASSNAMEDESC:: eod
The PoolManager doesn't really have a name.
eod
CLASSDESC:: eod
A StaticPool Manager object, maintains static pools.
eod

ATTR: name
ATTRID: 1
ATTRHDRNAME: AO_POOLMANAGER_NAME
ATTRTYPE: AT_STRING
ATTRMCDPATH: Name
ATTRVIZ: 3
ATTRDESC:: eod
The name of the static pool manager object.
eod

ATTR: pool-count
ATTRID: 2
ATTRHDRNAME: AO_POOLMANAGER_POOLCOUNT
ATTRTYPE: AT_INT
ATTRMCDPATH: PoolCount
ATTRVIZ: 5
ATTRDESC:: eod
Displays the total number of static pools.
eod


CLASS: RRSet
CLASSROOT: RRSET
CLASSID: 1206
CLASSNAME: 1
CLASSNAMEDESC:: eod
eod
CLASSVIZ: 5
CLASSPCV: 1.0.0
CLASSDEPRECATED: 7.0.0
CLASSDESC:: eod
A collection of DNS resource records with the same name (and class,
where class is INET and not HESIOD or CHAOS)
eod

ATTR: name
ATTRID: 1
ATTRHDRNAME: AO_RRSET_NAME
ATTRTYPE: AT_RDNSNAME
ATTRVIZ: 3
ATTRDESC:: eod
Specifies the common name of the records in this set.
eod

ATTR: flags
ATTRID: 2
ATTRHDRNAME: AO_RRSET_FLAGS
ATTRTYPE: AT_FLAGSINT(dynamic=1,whiteout=2)
ATTRVIZ: 3
ATTRDESC:: eod
Specifies the flags for this record set, copied from DNS server
internal code.  It isn't clear that they are significant at this
layer of abstraction, especially with the split of static and
dynamic RR lists.
eod

ATTR: static-rrs
ATTRID: 3
ATTRHDRNAME: AO_RRSET_STATRRS
ATTRTYPE: AT_NLIST(AT_PACK(SSIB*))
# AT_PACK = 36
ATTRVAL: 36
ATTRVIZ: 3
ATTRDESC:: eod
The actual RR data blobs for this name.  The blobs are of the form:
  type:  2 bytes
  class: 2 bytes
  ttl:   4 bytes
  data:  sz - 8 bytes
eod

ATTR: dynamic-rrs
ATTRID: 4
ATTRHDRNAME: AO_RRSET_DYNRRS
ATTRTYPE: AT_NLIST(AT_PACK(SSIB*))
# AT_PACK = 36
ATTRVAL: 36
ATTRVIZ: 3
ATTRDESC:: eod
The actual RR data blobs for this name.  The blobs are of the form:
  type:  2 bytes
  class: 2 bytes
  ttl:   4 bytes
  data:  sz - 8 bytes
eod

ATTR: zone
ATTRID: 5
ATTRHDRNAME: AO_RRSET_ZONE
#ATTRTYPE: AT_OBJREF(AT_OBJ(CCMZone))
ATTRTYPE: AT_OID
ATTRVAL: 1410
ATTRVIZ: 3
ATTRDESC:: eod
The oid of the zone that contains this RRSet.
eod

ATTR: rrs
ATTRID: 6
ATTRHDRNAME: AO_RRSET_RRS
ATTRTYPE: AT_NLIST(AT_PACK(SSIB*))
ATTRVIZ: 3
ATTRDESC:: eod
The actual RR data blobs for this name.  The blobs are of the form:
  type:  2 bytes
  class: 2 bytes
  ttl:   4 bytes
  data:  sz - 8 bytes
eod

CLASS: DNS_DB55ConversionTag
CLASSROOT: DNS_DB55CONVERSIONTAG
CLASSID: 1207
CLASSNAMEDESC:: eod
eod
CLASSVIZ: 3
CLASSDESC:: eod
Defines an object that specifies if the DNS DB(s) have been
(successfully) upgraded from pre-5.5 to 5.5 (or post 5.5). The MCD
config process checks this tag to determine the need of a (runtime)
5.5 DB conversion. This object is stored in MCD state and is only
used by the DNS configuration process. No UI should have visibility
to this.
eod

ATTR: conversion-start
ATTRID: 1
ATTRHDRNAME: AO_DNS_55CONVERSION_START_TIME
ATTRTYPE: AT_DATE
ATTRFLAGS: AF_REQUIRED
ATTRDESC:: eod
The date and time when the 5.5 DB conversion started.
eod

ATTR: conversion-stop
ATTRID: 2
ATTRHDRNAME: AO_DNS_55CONVERSION_STOP_TIME
ATTRTYPE: AT_DATE
ATTRFLAGS: AF_REQUIRED
ATTRDESC:: eod
The date and time when the 5.5 DB conversion successfully
completed.
eod

ATTR: conversion-status
ATTRID: 3
ATTRHDRNAME: AO_DNS_55CONVERSION_STATUS
ATTRTYPE: AT_ENUMINT(GOOD=0, FAILED=1, INCOMPLETE=2)
ATTRFLAGS: AF_REQUIRED
ATTRDESC:: eod
Status of the (last) 5.5 DB conversion attempt:
  0 - good,
  1 - failed,
  2 - incomplete.
eod

ATTR: conversion-attempts
ATTRID: 4
ATTRHDRNAME: AO_DNS_55CONVERSION_ATTEMPTS
ATTRTYPE: AT_INT
ATTRFLAGS: AF_REQUIRED
ATTRDESC:: eod
Number of 5.5 DB conversions attempts. After a successfull
conversion, minimum value should be 1.
eod

ATTR: upgraded-to-jacksprat
ATTRID: 5
ATTRHDRNAME: AO_DNS_55CONVERSION_JACKSPRAT_UPGRADED
ATTRTYPE: AT_ENUMINT(GOOD=0, FAILED=1, INCOMPLETE=2)
ATTRFLAGS: AF_REQUIRED
ATTRDESC:: eod
Indicates server's status of JackSprat upgrade.
Note, the server during the JackSprat upgrade, blobifies zone's
bookkeeping data in MCD state and removes residual (from the 5.5
upgrade) dynamic RRs in MCD state.
eod

ATTR: jacksprat-upgrade-time
ATTRID: 6
ATTRHDRNAME: AO_DNS_55CONVERSION_JACKSPRAT_UPGRADE_TIME
ATTRTYPE: AT_DATE
ATTRFLAGS: AF_REQUIRED
ATTRDESC:: eod
The date and time when the JackSprat upgrade (server side)
successfully completed.
eod

CLASS: ZoneBookkeeping
CLASSROOT: ZONEBOOKKEEPING
CLASSID: 1208
CLASSNAMEDESC:: eod
eod
CLASSVIZ: 3
CLASSDESC:: eod
Defines the object(s) representing zone bookkeeping information (as
stored in MCD state). The server maintains this information, on a
per zone basis, for data synchronization purposes. This bookkeeping
information is stored as blobs. This class is needed to access the
individual components in the blob.
eod

ATTR: major-version-number
ATTRID: 1
ATTRHDRNAME: AO_ZONEBOOKKEEPING_MAJOR
ATTRTYPE: AT_INT
ATTRDESC:: eod
eod

ATTR: minor-version-number
ATTRID: 2
ATTRHDRNAME: AO_ZONEBOOKKEEPING_MINOR
ATTRTYPE: AT_INT
ATTRDESC:: eod
eod

ATTR: prev-conf-gen-number
ATTRID: 3
ATTRHDRNAME: AO_ZONEBOOKKEEPING_PREV_CONF_GEN_NUMB
ATTRTYPE: AT_INT
ATTRDESC:: eod
eod

ATTR: default-ttl
ATTRID: 4
ATTRHDRNAME: AO_ZONEBOOKKEEPING_DEFAULT_TTL
ATTRTYPE: AT_INT
ATTRDESC:: eod
eod

ATTR: scavenge-base-time
ATTRID: 5
ATTRHDRNAME: AO_ZONEBOOKKEEPING_SCVG_BASE_TIME
ATTRTYPE: AT_INT
ATTRDESC:: eod
eod

ATTR: orig-serial
ATTRID: 6
ATTRHDRNAME: AO_ZONEBOOKKEEPING_ORIG_SERIAL
ATTRTYPE: AT_INT
ATTRDESC:: eod
eod

ATTR: attributes
ATTRID: 8
ATTRHDRNAME: AO_ZONEBOOKKEEPING_ATTRIBUTES
ATTRTYPE: AT_INT
ATTRDESC:: eod
eod

ATTR: version
ATTRID: 9
ATTRHDRNAME: AO_ZONEBOOKKEEPING_VERSION
ATTRTYPE: AT_INT
ATTRDESC:: eod
eod

ATTR: checkpoint-file-name
ATTRID: 10
ATTRHDRNAME: AO_ZONEBOOKKEEPING_CHKPT_FILENAME
ATTRTYPE: AT_STRING
ATTRDESC:: eod
eod

ATTR: last-xfer-check
ATTRID: 11
ATTRHDRNAME: AO_ZONEBOOKKEEPING_LAST_XFER_CHECK
ATTRTYPE: AT_TIME
ATTRDESC:: eod
eod

ATTR: ixfr-expire
ATTRID: 12
ATTRHDRNAME: AO_ZONEBOOKKEEPING_IXFR_EXPIRE
ATTRTYPE: AT_TIME
ATTRDESC:: eod
eod

ATTR: last-scavenge-time
ATTRID: 13
ATTRHDRNAME: AO_ZONEBOOKKEEPING_LAST_SCAVENGE_TIME
ATTRTYPE: AT_TIME
ATTRDESC:: eod
eod

ATTR: disable-mode
ATTRID: 14
ATTRHDRNAME: AO_ZONEBOOKKEEPING_DISABLE_MODE
ATTRTYPE: AT_INT
ATTRDESC:: eod
eod

ATTR: config-zone-data-oid
ATTRID: 15
ATTRHDRNAME: AO_ZONEBOOKKEEPING_CONFIG_ZONE_DATA_OID
ATTRTYPE: AT_OID
ATTRDESC:: eod
OID of zone configuration data, used to associate this zone
bookkeeping data with the zone configuration data.
eod

ATTR: promoted
ATTRID: 16
ATTRTYPE: AT_BOOL
ATTRDESC:: eod
Boolean stating whether or not a zone has been promoted from
secondary to primary.
eod

CLASS: DNSServerStats
CLASSID: 1209
CLASSPCV: 5.0.0
CLASSDESC:: eod
The general statistics available from the DNS server.
eod

ATTR: id
ATTRID: 1
ATTRTYPE: AT_STRING
ATTRDESC:: eod
Identifies this DNS Server.
eod

ATTR: config-recurs
ATTRID: 2
ATTRTYPE: AT_INT
ATTRDESC:: eod
Describes the recursion services offered by this name server.
Values are:
available(1) - performs recursion on requests from clients.
restricted(2) - recursion is performed on requests only from
certain clients, for example; clients on an access control list.
unavailable(3) - recursion is not available.
eod

ATTR: config-up-time
ATTRID: 3
ATTRTYPE: AT_TIME
ATTRDESC:: eod
Reports the time elapsed since the DNS Server process was started.
eod

ATTR: config-reset-time
ATTRID: 4
ATTRTYPE: AT_TIME
ATTRDESC:: eod
Reports the time elapsed since the DNS Server was last 
reset (restarted).
eod

ATTR: config-reset
ATTRID: 5
ATTRTYPE: AT_INT
ATTRDESC:: eod
Describes the name server state. Possible values are:
other(1) - server in some unknown state;
initializing(3) - server (re)initializing;
running(4) - server currently running.
eod

ATTR: counter-auth-ans
ATTRID: 6
ATTRTYPE: AT_INT
ATTRDESC:: eod
Reports the number of queries that were authoritatively answered.
eod

ATTR: counter-auth-no-names
ATTRID: 7
ATTRTYPE: AT_INT
ATTRDESC:: eod
Reports the number of queries for which 'authoritative no such name'
responses were made.
eod

ATTR: counter-auth-no-data-resps
ATTRID: 8
ATTRTYPE: AT_INT
ATTRDESC:: eod
Reports the number of queries for which 'authoritative no such data'
(empty answer) responses were made.
eod

ATTR: counter-non-auth-datas
ATTRID: 9
ATTRTYPE: AT_INT
ATTRDESC:: eod
Reports the number of queries that were non-authoritatively 
answered (cached data).
eod

ATTR: counter-non-auth-no-datas
ATTRID: 10
ATTRTYPE: AT_INT
ATTRDESC:: eod
Reports the number of queries that were non-authoritatively answered
with no data (empty answer).
eod

ATTR: counter-referrals
ATTRID: 11
ATTRTYPE: AT_INT
ATTRDESC:: eod
Reports the number of requests that were referred to other servers.
eod

ATTR: counter-errors
ATTRID: 12
ATTRTYPE: AT_INT
ATTRDESC:: eod
Reports the number of requests the server processed that were 
answered with errors (RCODE values other than 0 and 3). 
[Reference RFC-1035 section 4.1.1.]
eod

ATTR: counter-rel-names
ATTRID: 13
ATTRTYPE: AT_INT
ATTRDESC:: eod
Reports the number of requests received by the server for names that
are only 1 label long (i.e. in text form, with no internal dots).
eod

ATTR: counter-req-refusals
ATTRID: 14
ATTRTYPE: AT_INT
ATTRDESC:: eod
Reports the number of DNS requests refused by the server.
eod

ATTR: counter-req-unparses
ATTRID: 15
ATTRTYPE: AT_INT
ATTRDESC:: eod
Reports the number of requests received which were unparseable.
eod

ATTR: counter-other-errors
ATTRID: 16
ATTRTYPE: AT_INT
ATTRDESC:: eod
Reports the number of requests which were aborted for other 
(local) server errors.
eod

ATTR: counter-reset-time
ATTRID: 17
ATTRTYPE: AT_DATE
ATTRDESC:: eod
Reports the most recent time the server counters were reset
by the 'dns resetStats' command.
eod

ATTR: sample-time
ATTRID: 18
ATTRTYPE: AT_DATE
ATTRDESC:: eod
Reports the time the server collected the last set of 
sample statistics.
eod

ATTR: sample-interval
ATTRID: 19
ATTRTYPE: AT_TIME
ATTRDESC:: eod
Reports the sample interval used by the server when collecting the
last set of sample statistics.
eod

ATTR: stats-categories
ATTRID: 20
ATTRTYPE: AT_FLAGSINT(query=1, performance=2, security=3, errors=4, maxcounters=5, ha=6, ipv6=7, all=8, server=9)
ATTRDESC:: eod
Lists the valid specialized DNS server statistics categories
that are available:

    1 query
    2 performance
    3 security
    4 errors
    5 maxcounters
    6 ha
    7 ipv6
    8 all
    9 server
eod

ATTR: statistics-request-time
ATTRID: 21
ATTRTYPE: AT_DATE
ATTRDESC:: eod
Reports the time the server processed this request for statistics.
eod

ATTR: total-zones
ATTRID: 22
ATTRTYPE: AT_INT
ATTRDESC:: eod
Reports the total number of zones managed by the DNS server, 
including both primary and secondary zones.
eod

ATTR: total-rrs
ATTRID: 23
ATTRTYPE: AT_INT
ATTRDESC:: eod
Reports the total number of RRs in the server,
contained in both primary and secondary zones.
eod


CLASS: DNSServerPerformanceStats
CLASSID: 1210
CLASSPCV: 5.0.0
CLASSDESC:: eod
The activity statistics available from the DNS server
related to operational performance.
eod

ATTR: ipv4-packets-in
ATTRID: 1
ATTRTYPE: AT_INT
ATTRDESC:: eod
Reports the total number of IPv4 packets received.
eod

ATTR: ipv4-packets-out
ATTRID: 2
ATTRTYPE: AT_INT
ATTRDESC:: eod
Reports the total number of IPv4 packets sent.
eod

ATTR: updated-rrs
ATTRID: 3
ATTRTYPE: AT_INT
ATTRDESC:: eod
Reports the total number of RR's added and deleted, including 
updates from the CNR UIs, whether or not there were database 
errors.
eod

ATTR: update-packets
ATTRID: 4
ATTRTYPE: AT_INT
ATTRDESC:: eod
Reports the number of successful DNS updates.
eod

ATTR: ixfrs-out
ATTRID: 5
ATTRTYPE: AT_INT
ATTRDESC:: eod
Reports the number of successful outbound incremental transfers.
eod

ATTR: ixfrs-in
ATTRID: 6
ATTRTYPE: AT_INT
ATTRDESC:: eod
Reports the number of successful inbound incremental transfers, 
including incremental requests that resulted in full zone transfers.
eod

ATTR: ixfrs-full-resp
ATTRID: 7
ATTRTYPE: AT_INT
ATTRDESC:: eod
Reports the number of outbound full zone transfers in response to 
IXFR requests. These may have been due to IXFR errors, insufficient
serial history, or too many changes in the zone.
eod

ATTR: axfrs-out
ATTRID: 8
ATTRTYPE: AT_INT
ATTRDESC:: eod
Reports the number of successful outbound full zone transfers, 
including those counted in ixfrs-full-resp.
eod

ATTR: axfrs-in
ATTRID: 9
ATTRTYPE: AT_INT
ATTRDESC:: eod
Reports the number of successful inbound AXFRs.
eod

ATTR: queries
ATTRID: 10
ATTRTYPE: AT_INT
ATTRDESC:: eod
Reports the number of queries responded to. These include name 
queries, IXFR/AXFR responses, and query forward responses,
but exclude updates.
eod

ATTR: xfrs-out-at-limit
ATTRID: 11
ATTRTYPE: AT_INT
ATTRDESC:: eod
Reports the number of times that outbound transfers reached 
the concurrent limit.
eod

ATTR: xfrs-in-at-limit
ATTRID: 12
ATTRTYPE: AT_INT
ATTRDESC:: eod
Reports the number of times that inbound transfers reached the 
concurrent limit.
eod

ATTR: notifies-out
ATTRID: 13
ATTRTYPE: AT_INT
ATTRDESC:: eod
Reports the number of outbound notifies. Each notify packet sent
is counted separately.
eod

ATTR: notifies-in
ATTRID: 14
ATTRTYPE: AT_INT
ATTRDESC:: eod
Reports the number of inbound notifies. Each notify packet received
is counted separately.
eod


CLASS: DNSServerQueryStats
CLASSID: 1211
CLASSPCV: 5.0.0
CLASSDESC:: eod
The activity statistics available from the DNS server
related to DNS queries and responses.
eod

ATTR: auth-answers
ATTRID: 1
ATTRTYPE: AT_INT
ATTRDESC:: eod
Reports the number of queries that were authoritatively answered. 
ref RFC1611.
eod

ATTR: auth-no-names
ATTRID: 2
ATTRTYPE: AT_INT
ATTRDESC:: eod
Reports the number of queries for which authoritative-no-such-name 
responses were made. ref RFC1611.
eod

ATTR: auth-no-data-responses
ATTRID: 3
ATTRTYPE: AT_INT
ATTRDESC:: eod
Reports the number of queries for which authoritative-no-such-data
(empty answer) responses were made. ref RFC1611.
eod

ATTR: nonauth-answers
ATTRID: 4
ATTRTYPE: AT_INT
ATTRDESC:: eod
Reports the number of queries that were non-authoritatively 
answered (from cached data).  ref RFC1611.
eod

ATTR: nonauth-no-data-responses
ATTRID: 5
ATTRTYPE: AT_INT
ATTRDESC:: eod
Reports the number of queries that were non-authoritatively answered 
with no data. ref RFC1611.
eod

ATTR: referrals
ATTRID: 6
ATTRTYPE: AT_INT
ATTRDESC:: eod
Reports the number of requests that were referred to other servers.
ref RFC1611.
eod

ATTR: relative-name-requests
ATTRID: 7
ATTRTYPE: AT_INT
ATTRDESC:: eod
Reports the number of requests received by the server for names that 
are only one label long (i.e. in text form, with no internal dots). 
ref RFC1611.
eod

ATTR: refusals
ATTRID: 8
ATTRTYPE: AT_INT
ATTRDESC:: eod
Reports the number of queries refused.
eod

ATTR: lame-delegations
ATTRID: 9
ATTRTYPE: AT_INT
ATTRDESC:: eod
Reports the number of query lame delegations.
eod

ATTR: mem-cache-hits
ATTRID: 10
ATTRTYPE: AT_INT
ATTRDESC:: eod
Reports the number of mem-cache lookup hits.
eod

ATTR: mem-cache-misses
ATTRID: 11
ATTRTYPE: AT_INT
ATTRDESC:: eod
Reports the number of mem-cache lookup misses.
eod

ATTR: mem-cache-writes
ATTRID: 12
ATTRTYPE: AT_INT
ATTRDESC:: eod
Reports the number of mem-cache writes.
eod

ATTR: mem-cache-answers
ATTRID: 13
ATTRTYPE: AT_INT
ATTRDESC:: eod
Reports the number of queries entirely answered from the in-memory  
cache, without seeking additional answers from the cache-db or 
auth-db. Xfer, iquery, update, and notify queries are excluded.
eod

ATTR: cache-db-answers
ATTRID: 14
ATTRTYPE: AT_INT
ATTRDESC:: eod
Reports the number of queries answered from the cache-db, without 
seeking additional answers from the auth-db. Xfer, iquery, update, 
notify, and queries counted as mem-cache-answers are excluded.
eod

ATTR: cache-written-to-disk
ATTRID: 15
ATTRTYPE: AT_INT
ATTRDESC:: eod
Reports the number of cache name-set records written to disk.
eod

ATTR: query-timeout
ATTRID: 16
ATTRTYPE: AT_INT
ATTRDESC:: eod
Reports the number of user queries timed out with no response.
eod

ATTR: referral-query-succeeded
ATTRID: 17
ATTRTYPE: AT_INT
ATTRDESC:: eod
Reports the number of referral queries answered successfully.
eod

ATTR: resolution-queue-exceeded
ATTRID: 18
ATTRTYPE: AT_INT
ATTRDESC:: eod
Reports the number of times the resolution queue maximum size 
defined by resolution-queue-max-size was exceeded.
eod


ATTR: queries-dropped
ATTRID: 19
ATTRTYPE: AT_INT
ATTRDESC:: eod
Reports the number of non-error dropped packets. Queries
restricted by server, TSIG, or update policies are included, 
but DNS updates, xfer requests, and notifies are excluded.
eod

ATTR: inbound-xfer-requests
ATTRID: 20
ATTRTYPE: AT_INT
ATTRDESC:: eod
Reports the total number of secondary inbound zone transfer 
requests. All AXFR and IXFR requests are counted, including those
refused.
eod

ATTR: auth-db-responses
ATTRID: 21
ATTRTYPE: AT_INT
ATTRDESC:: eod
Reports the number of queries answered from the auth-db.
eod

ATTR: recursion-failures
ATTRID: 22
ATTRTYPE: AT_INT
ATTRDESC:: eod
Reports the number of queries that requested recursion, and failed.
eod


CLASS: DNSServerSecurityStats
CLASSID: 1212
CLASSPCV: 5.0.0
CLASSDESC:: eod
The activity statistics available from the DNS server
related to server authentication and authorization features,
such as TSIG and ACLs.
eod

ATTR: rcvd-tsig-packets
ATTRID: 1
ATTRTYPE: AT_INT
ATTRDESC:: eod
Reports the number of TSIG RR packets processed, if TSIG processing 
is enabled for the type of packet.
eod

ATTR: detected-tsig-bad-time
ATTRID: 2
ATTRTYPE: AT_INT
ATTRDESC:: eod
Reports the number of bad timestamps in incoming TSIG packets.
eod

ATTR: detected-tsig-bad-key
ATTRID: 3
ATTRTYPE: AT_INT
ATTRDESC:: eod
Reports the number of bad keynames (those with an invalid or 
unknown key) in incoming TSIG packets.
eod

ATTR: detected-tsig-bad-sig
ATTRID: 4
ATTRTYPE: AT_INT
ATTRDESC:: eod
Reports the number of bad signatures in incoming TSIG packets.
eod

ATTR: rcvd-tsig-bad-time
ATTRID: 5
ATTRTYPE: AT_INT
ATTRDESC:: eod
Reports the number of BADTIME errors received after sending a 
TSIG packet.
eod

ATTR: rcvd-tsig-bad-key
ATTRID: 6
ATTRTYPE: AT_INT
ATTRDESC:: eod
Reports the number of BADKEY errors received after sending a 
TSIG packet.
eod

ATTR: rcvd-tsig-bad-sig
ATTRID: 7
ATTRTYPE: AT_INT
ATTRDESC:: eod
Reports the number of BADSIG errors received after sending a 
TSIG packet.
eod

ATTR: unauth-xfer-reqs
ATTRID: 8
ATTRTYPE: AT_INT
ATTRDESC:: eod
Reports the number of ACL authorization failures in zone transfers.
eod

ATTR: unauth-update-reqs
ATTRID: 9
ATTRTYPE: AT_INT
ATTRDESC:: eod
Reports the number of ACL authorization failures in DNS updates.
Administrative RR updates (from CNR UIs) are excluded.
eod

ATTR: restrict-query-acl
ATTRID: 10
ATTRTYPE: AT_INT
ATTRDESC:: eod
Reports the number of ACL authorization failures in DNS queries.
eod

CLASS: DNSServerErrorsStats
CLASSID: 1213
CLASSPCV: 5.0.0
CLASSDESC:: eod
The activity statistics available from the DNS server
reporting errors encountered.
eod

ATTR: update-errors
ATTRID: 1
ATTRTYPE: AT_INT
ATTRDESC:: eod
Reports the total number of updates resulting in errors.
This excludes negative responses to update prerequisite checks,
and TSIG responses. Both update packets and updates
generated by the CNR UIs may be included in this count.
eod

ATTR: update-prereq-fail
ATTRID: 2
ATTRTYPE: AT_INT
ATTRDESC:: eod
Reports the total number of updates resulting in prerequisite 
failures.
eod

ATTR: ixfr-in-errors
ATTRID: 3
ATTRTYPE: AT_INT
ATTRDESC:: eod
Reports the total in-bound IXFR errors, excluding packet format 
errors.
eod

ATTR: ixfr-out-errors
ATTRID: 4
ATTRTYPE: AT_INT
ATTRDESC:: eod
Reports the total IXFR error responses sent, excluding packet 
format errors.
eod

ATTR: axfr-in-errors
ATTRID: 5
ATTRTYPE: AT_INT
ATTRDESC:: eod
Reports the total in-bound AXFR errors, excluding packet format 
errors.
eod

ATTR: axfr-out-errors
ATTRID: 6
ATTRTYPE: AT_INT
ATTRDESC:: eod
Reports the total AXFR error responses sent, excluding packet 
format errors.
eod

ATTR: sent-total-errors
ATTRID: 7
ATTRTYPE: AT_INT
ATTRDESC:: eod
Reports the total number of requests the server answered with errors
(RCODE values other than 0,3,6,7, and 8). ref RFC1611.
eod

ATTR: sent-format-errors
ATTRID: 8
ATTRTYPE: AT_INT
ATTRDESC:: eod
Reports the number of requests received that were unparseable. 
ref RFC1611.
eod

ATTR: sent-other-errors
ATTRID: 9
ATTRTYPE: AT_INT
ATTRDESC:: eod
Reports the number of requests that were aborted because of other 
local server errors. ref RFC1611.
eod

ATTR: sent-refusal-errors
ATTRID: 10
ATTRTYPE: AT_INT
ATTRDESC:: eod
Reports the number of requests that resulted in REFUSED. 
ref RFC1611.
eod

ATTR: rcvd-format-errors
ATTRID: 11
ATTRTYPE: AT_INT
ATTRDESC:: eod
Reports the number of responses received with FORMERR status.
eod


ATTR: query-error-packets
ATTRID: 12
ATTRTYPE: AT_INT
ATTRDESC:: eod
Reports the number of unresolved query responses that returned 
an error rcode.
eod

ATTR: xfer-in-auth-errors
ATTRID: 13
ATTRTYPE: AT_INT
ATTRDESC:: eod
Reports the number of secondary IXFR/AXFR requests that were
refused because of authorization errors.
eod

ATTR: xfer-failed-attempts
ATTRID: 14
ATTRTYPE: AT_INT
ATTRDESC:: eod
Reports the number of secondary IXFR/AXFR failures, excluding
authorization refusals.
eod

ATTR: referral-timeouts
ATTRID: 15
ATTRTYPE: AT_INT
ATTRDESC:: eod
Reports the total number of referral timeouts.
eod

ATTR: exceeded-max-dns-packets
ATTRID: 16
ATTRTYPE: AT_INT
ATTRDESC:: eod
Reports the number of times inbound packets exceeded the maximum 
DNS packets defined by max-dns-packets.
eod



CLASS: DNSServerMaxCounterStats
CLASSID: 1214
CLASSPCV: 5.0.0
CLASSDESC:: eod
The activity statistics available from the DNS server
reporting high-water values encountered by the server.
eod

ATTR: concurrent-xfrs-in
ATTRID: 1
ATTRTYPE: AT_INT
ATTRDESC:: eod
Reports the maximum number of concurrent threads processing 
inbound transfers during the last sampling period.
eod

ATTR: concurrent-xfrs-out
ATTRID: 2
ATTRTYPE: AT_INT
ATTRDESC:: eod
Reports the maximum number of concurrent threads processing 
outbound transfers during the last sampling period.
eod

ATTR:  ha-partner-no-resp
ATTRID: 3
ATTRTYPE: AT_TIME
ATTRDESC:: eod
Reports the total time in seconds, during the last sampling period, 
where the server's partner was not responding.
eod

ATTR:  ha-partner-no-resp-max
ATTRID: 4
ATTRTYPE: AT_TIME
ATTRDESC:: eod
Reports the maximum contiguous time in seconds, during the last 
sampling period, where the server's partner was not responding.
eod

ATTR:  ha-batch-count-limit
ATTRID: 5
ATTRTYPE: AT_INT
ATTRDESC:: eod
Reports the number of times the ha-dns-max-batch-count limit
was reached during the last sampling period.
eod

ATTR:  ha-rr-pending-list
ATTRID: 6
ATTRTYPE: AT_INT
ATTRDESC:: eod
Reports the maximum number of RRs in the pending List, waiting
acknowledgement from the HA DNS backup server, during the last 
sampling period.
eod

ATTR:  ha-rr-active-list
ATTRID: 7
ATTRTYPE: AT_INT
ATTRDESC:: eod
Reports the maximum number of RRs in the active list, waiting 
to be sent to the HA DNS backup server, during the last 
sampling period.
eod

ATTR:  ha-persisted-edit-list
ATTRID: 8
ATTRTYPE: AT_INT
ATTRDESC:: eod
Reports the maximum number of names persisted in the edit list 
database during the last sampling period.
eod

ATTR:  ha-update-latency-max
ATTRID: 9
ATTRTYPE: AT_TIME
ATTRDESC:: eod
Reports the maximum DNS update latency in seconds, during the
last sampling period. Latency is measured as the time an update 
remains in the pending List.
eod

ATTR: dns-concurrent-packets
ATTRID: 10
ATTRTYPE: AT_INT
ATTRDESC:: eod
Reports the maximum number of concurrent packets processed
by the DNS server during the sampling period.
eod


CLASS: DNS_ConfigDBUpgradeInfo
CLASSROOT: DNS_CONFIGDBUPGRADEINFO
CLASSID: 1215
CLASSNAMEDESC:: eod
eod
CLASSVIZ: 3
CLASSPCV: 7.0.0
CLASSDESC:: eod
Replacing DNS_DB55ConversionTag, this class provides status
information regarding the DB last upgrade attempt. The recorded
information is the last (DB) version number which the DB was
upgraded. The server checks this tag during configuration to
determine if an upgrade is required. The server knows its present
version number and, based on the information recorded in this
class, determines the appropriate DB conversion that is required.
Presently, this information is recorded in MCD (state);
eventually, it shall be moved to the (future) private
configuration DB. No UI should have visibility to this class!
eod

ATTR: version-number
ATTRID: 1
ATTRHDRNAME: AO_DNS_CONFIG_DB_UPGRADE_INFO_VERSION_NUMBER
ATTRTYPE: AT_INT
ATTRFLAGS: AF_REQUIRED
ATTRDESC:: eod
Version number of the last upgrade.
eod

ATTR: previous-version-number
ATTRID: 2
ATTRHDRNAME: AO_DNS_CONFIG_DB_UPGRADE_INFO_PREVIOUS_VERSION_NUMBER
ATTRTYPE: AT_INT
ATTRFLAGS: AF_REQUIRED
ATTRDESC:: eod
Version number prior to the last upgrade.
eod

ATTR: start-time
ATTRID: 3
ATTRHDRNAME: AO_DNS_CONFIG_DB_UPGRADE_INFO_START_TIME
ATTRTYPE: AT_DATE
ATTRFLAGS: AF_REQUIRED
ATTRDESC:: eod
The (start) date and time of the last DB upgrade.
eod

ATTR: stop-time
ATTRID: 4
ATTRHDRNAME: AO_DNS_CONFIG_DB_UPGRADE_INFO_STOP_TIME
ATTRTYPE: AT_DATE
ATTRFLAGS: AF_REQUIRED
ATTRDESC:: eod
The (stop) date and time of the last DB upgrade.
eod

ATTR: upgrade-status
ATTRID: 5
ATTRHDRNAME: AO_DNS_CONFIG_DB_UPGRADE_INFO_STATUS
ATTRTYPE: AT_ENUMINT(GOOD=0, FAILED=1, INCOMPLETE=2)
ATTRFLAGS: AF_REQUIRED
ATTRDESC:: eod
Status of the (last) upgrade attempt:
  0 - good, 1 - failed, 2 - incomplete.
eod

ATTR: upgrade-attempts
ATTRID: 6
ATTRHDRNAME: AO_DNS_CONFIG_DB_UPGRADE_INFO_ATTEMPTS
ATTRTYPE: AT_INT
ATTRFLAGS: AF_REQUIRED
ATTRDESC:: eod
Number of (last) DB upgrade attempts. After a successfull upgrade,
minimum value should be 1.
eod

CLASS: DNSConfigDBVersionInfo
CLASSROOT: DNSCONFIGDBVERSIONINFO
CLASSID: 1216
CLASSNAMEDESC:: eod
eod
CLASSVIZ: 3
CLASSPCV: 7.0.0
CLASSDESC:: eod
This class provides version information for the DNS server's
configuration DB.
eod

ATTR: version-number
ATTRID: 1
ATTRTYPE: AT_INT
ATTRFLAGS: AF_REQUIRED
ATTRDESC:: eod
Configuration DB version number, which effectively states the
DB generation. This attribute is generally used to check DB
compatibility and determines the feasibility and process of
upgrading.
eod

ATTR: major-number
ATTRID: 2
ATTRTYPE: AT_INT
ATTRFLAGS: AF_REQUIRED
ATTRDESC:: eod
Configuration DB major number, which should not be confused
with the version number. This major number is used to test
synchonization with the other server's DBs. This major number
should be in-sync with the major numbers of other DBs.
eod

ATTR: minor-number
ATTRID: 3
ATTRTYPE: AT_INT
ATTRFLAGS: AF_REQUIRED
ATTRDESC:: eod
Configuration DB minor number.
eod

CLASS: DnsInterface
CLASSID: 1217
CLASSVIZ: 5
CLASSNAME: 1
CLASSPCV: 7.0.0
CLASSDESC:: eod
A DNS server interface. When interfaces are configured, the server
default behavior to discover and bind to all interfaces is disabled.
eod

ATTR: name
ATTRID: 1
ATTRTYPE: AT_STRING
ATTRFLAGS: AF_REQUIRED,AF_UNIQUE,AF_IMMUTABLE
ATTRDESC:: eod
The name of the DNS server interface.
eod

ATTR: address
ATTRID: 2
ATTRTYPE: AT_SUBNET
ATTRDESC:: eod
Specifies the IP address and subnet mask of the DNS interface.
eod

ATTR: ip6address
ATTRID: 3
ATTRTYPE: AT_PREFIX
ATTRDESC:: eod
Specifies the IPv6 address and prefix length for one or more
DNS interfaces.
eod

ATTR: port
ATTRID: 4
ATTRTYPE: AT_RANGEINT(1-65535)
ATTRDEFVAL: 53
ATTRDESC:: eod
Specifies the UDP and TCP port number the DNS server listens on.
eod

CLASS: RRNameSet
CLASSROOT: RRNAMESET
CLASSID: 1218
CLASSNAME: 1
CLASSVIZ: 5
CLASSDEPRECATED: 7.0
CLASSDESC:: eod
A collection of DNS resource records with the same name (and class,
where class is INET and not HESIOD or CHAOS).
eod

ATTR: name
ATTRID: 1
ATTRTYPE: AT_RDNSNAME
ATTRHDRNAME: AO_RRNAMESET_NAME
ATTRVIZ: 5
ATTRDESC:: eod
The common DNS name of the records in this set.
eod

ATTR: zone
ATTRID: 2
ATTRTYPE: AT_OID
ATTRHDRNAME: AO_RRNAMESET_ZONE
ATTRVAL: 1410
ATTRVIZ: 3
ATTRDESC:: eod
The oid of the zone that contains this RR name-set.
eod

ATTR: rrs
ATTRID: 3
ATTRTYPE: AT_NLIST(AT_PACK(SSIB*))
ATTRDESC:: eod
The actual RR data blobs for this DNS name.  The blobs are of
the form:
  type:  2 bytes
  class: 2 bytes
  ttl:   4 bytes
  data:  sz - 8 bytes
eod

ATTR: protected-state
ATTRID: 4
ATTRTYPE: AT_ENUMINT(unprotected=1, protected=2, dont-care=0)
ATTRDEFVAL: protected
ATTRDESC:: eod
Indicates the protection state of the name-set. When protected,
the name-set is protected from dynamic updates, unless
name-protection is disabled for the zone. When unprotected, the
name-set is subject to dynamic update changes.
eod

ATTR: protected-rrs
ATTRID: 5
#ATTRHDRNAME: AO_RRSET_STATRRS
ATTRTYPE: AT_NLIST(AT_PACK(SSIB*))
ATTRVAL: 36
ATTRVIZ: 3
ATTRDESC:: eod
The actual RR data blobs for this name.  The blobs are of
the form:
  type:  2 bytes
  class: 2 bytes
  ttl:   4 bytes
  data:  sz - 8 bytes
eod

ATTR: unprotected-rrs
ATTRID: 6
#ATTRHDRNAME: AO_RRSET_DYNRRS
ATTRTYPE: AT_NLIST(AT_PACK(SSIB*))
ATTRVAL: 36
ATTRVIZ: 3
ATTRDESC:: eod
The actual RR data blobs for this name.  The blobs are of
the form:
  type:  2 bytes
  class: 2 bytes
  ttl:   4 bytes
  data:  sz - 8 bytes
eod

CLASS: RRFilter
CLASSROOT: RRFILTER
CLASSID: 1219
CLASSPCV: 7.0.0
CLASSDESC:: eod
A filter used to limit the set of RRs returned by the
DNS server, when querying the list of RRs in a zone.
eod

ATTR: rr-types
ATTRID: 1
ATTRTYPE: AT_PACK
ATTRDESC:: eod
Include only these RR types.
eod

ATTR: rr-name-prefix
ATTRID: 2
ATTRTYPE: AT_STRING
ATTRDESC:: eod
Include only names starting with this prefix.
eod

ATTR: protected-state
ATTRID: 3
ATTRTYPE: AT_ENUMINT(all=0, unprotected=1, protected=2)
ATTRDESC:: eod
Include only names with the specified protection state.  Type 'all'
will return protected and unprotected names.
eod

#
#
#

CLASS: DnsHAEditsDBConfig
CLASSROOT: DNSHAEDITSDBCONFIG
CLASSID: 1220
CLASSVIZ: 3
CLASSPCV: 7.0.0
CLASSDESC:: eod
This class defines the configuration data as stored in the HA
Edits-List DB (aka Changed-Names DB).
eod

ATTR: version
ATTRID: 1
ATTRTYPE: AT_INT
ATTRVIZ: 3
ATTRDESC:: eod
Current version of the HA Edits-List DB. This version would only
change to reflect internal "format/structure" changes of the DB.
eod

ATTR: MajorNumber
ATTRID: 2
ATTRTYPE: AT_INT
ATTRVIZ: 3
ATTRDESC:: eod
DNS server major number, used for consistency checking.
eod

ATTR: MinorNumber
ATTRID: 3
ATTRTYPE: AT_INT
ATTRVIZ: 3
ATTRDESC:: eod
DNS server minor number, used for consistency checking.
eod

#
# DnsHAStatus -- describes the HA servers status
#

CLASS: DnsHAStatus
CLASSROOT: DNSHASTATUS
CLASSID: 1222
CLASSNAME: 1
CLASSNAMEDESC:: eod
A DnsHAStatus object really has no name.
eod
CLASSVIZ: 5
CLASSPCV: 7.0.0
CLASSDESC:: eod
Defines the DHS server High-Availability (HA) role and
current status. The HA status is only relevant when the
server is configured in an HA pair.
eod

ATTR: Role
ATTRID: 1
ATTRTYPE: AT_ENUMINT(MAIN=0, BACKUP=1)
ATTRFLAGS: AF_REQUIRED, AF_IMMUTABLE
ATTRVIZ: 5
ATTRDESC:: eod
Specifies the HA role: (1) main HA server or (2) backup
HA server.
eod

ATTR: State
ATTRID: 2
ATTRTYPE: AT_ENUMINT(HA_NONE=0, HA_STARTUP=1, HA_NORMAL=2, HA_COMM_INTERRUPTED=3, HA_PARTNERDOWN=4, HA_SYNC=5, HA_SYNC_PENDING=6)
ATTRFLAGS: AF_REQUIRED, AF_IMMUTABLE
ATTRVIZ: 5
ATTRDESC:: eod
Specifies the HA server's state:
    0  HA_NONE
       HA is disabled

    1  HA_STARTUP
       Startup state

    2  HA_NORMAL
       Normal state

    3  HA_COMM_INTERRUPTED
       Communication-Interrupted state

    4  HA_PARTNER_DOWN
       Partner-Down state

    5  HA_SYNC
       Synchronization state

    6  HA_SYNC_PENDING
       Synchronization Pending state
	
eod

CLASS: DnsHAState
CLASSROOT: DNSHASTATE
CLASSID: 1223
CLASSNAME: 1
CLASSNAMEDESC:: eod
A DnsHAState object really has no name.
eod

CLASSVIZ: 3
CLASSPCV: 7.0.0
CLASSDESC:: eod
This object describes HA (runtime) state information.
eod

ATTR: role
ATTRID: 1
ATTRTYPE: AT_ENUMINT(NONE= 0, MAIN=1, BACKUP=2)

ATTRVIZ: 3
ATTRDESC:: eod
Specifies the HA role: (1) main HA server or (2) backup
HA server.
eod

ATTR: present-state
ATTRID: 2
ATTRTYPE: AT_ENUMINT(HA_NONE=0, HA_STARTUP=1, HA_NORMAL=2, HA_COMM_INTERRUPTED=3, HA_PARTNERDOWN=4, HA_SYNC=5, HA_SYNC_PENDING=6)
ATTRVIZ: 3
ATTRDESC:: eod
Specifies the present state of the HA server:
    HA_NONE: HA is disabled
    HA_STARTUP: the Startup state
    HA_NORMAL: the Normal state
    HA_COMM_INTERRUPTED: the Communication-Interrupted state
    HA_PARTNER_DOWN: the Partner-Down state
    HA_SYNC: the Synchronization state
    HA_SYNC_PENDING: the Synchronization Pending state
eod

ATTR: last-operable-state
ATTRID: 3
ATTRTYPE: AT_ENUMINT(HA_NONE=0, HA_NORMAL=2, HA_COMM_INTERRUPTED=3, HA_PARTNERDOWN=4)
ATTRVIZ: 3
ATTRDESC:: eod
The last 'operable' state (i.e. state which can accept RR edits
whether via DDNS updates, SCP RR adds/deletes/etc or HA RR-Update
messages:
    HA_NONE: HA is disabled
    HA_NORMAL: the Normal state
    HA_COMM_INTERRUPTED: the Communication-Interrupted state
    HA_PARTNER_DOWN: the Partner-Down state

eod

#===

CLASS: DNSServerHaStats
CLASSID: 1224
CLASSPCV: 7.0.0
CLASSDESC:: eod
The activity statistics available from the DNS server
related to High-Availability (HA) DNS protocol
operation.
eod

ATTR:  ha-comm-interrupted
ATTRID: 1
ATTRTYPE: AT_INT
ATTRDESC:: eod
Number of occurrences where the server enters the communication-
interrupted state (HA_STATE_COMMINTR).
eod

ATTR:  ha-partner-down
ATTRID: 2
ATTRTYPE: AT_INT
ATTRDESC:: eod
Number of occurrences where the server enters the partner-down
state (HA_STATE_PARTNERDOWN).
eod

ATTR:  ha-sync
ATTRID: 3
ATTRTYPE: AT_INT
ATTRDESC:: eod
Number of occurrences where the server enters the synchronization
state (HA_STATE_SYNC).
eod

ATTR:  ha-msg-connect-sent
ATTRID: 4
ATTRTYPE: AT_INT
ATTRDESC:: eod
Number of connection establishment request messages sent
(HA_DNS_ESTABLISH_CONNECTION).
eod

ATTR:  ha-msg-reconcile-sent
ATTRID: 5
ATTRTYPE: AT_INT
ATTRDESC:: eod
Number of zone reconciliation request messages sent
(HA_DNS_RECONCILIATION).
eod

ATTR:  ha-msg-heartbeat-sent
ATTRID: 6
ATTRTYPE: AT_INT
ATTRDESC:: eod
Number of heartbeat request messages sent (HA_DNS_HEARTBEAT).
eod

ATTR:  ha-msg-zonesync-sent
ATTRID: 7
ATTRTYPE: AT_INT
ATTRDESC:: eod
Number of zone synchronization request messages sent 
(HA_DNS_ZONE_SYNC).
eod

ATTR:  ha-msg-rrsync-sent
ATTRID: 8
ATTRTYPE: AT_INT
ATTRDESC:: eod
Number of rr-sync request messages sent (HA_DNS_RR_SYNC).
eod

ATTR:  ha-msg-rrupdate-sent
ATTRID: 9
ATTRTYPE: AT_INT
ATTRDESC:: eod
Number of rr-update request messages sent (HA_DNS_RR_UPDATE).
eod

ATTR:  ha-msg-resp-sent
ATTRID: 10
ATTRTYPE: AT_INT
ATTRDESC:: eod
Number of response messages sent. Response messages
are used to acknowledge all types of request messages.
eod

ATTR:  ha-msg-connect-recv
ATTRID: 11
ATTRTYPE: AT_INT
ATTRDESC:: eod
Number of connection establishment request messages received
(HA_DNS_ESTABLISH_CONNECTION).
eod

ATTR:  ha-msg-reconcile-recv
ATTRID: 12
ATTRTYPE: AT_INT
ATTRDESC:: eod
Number of zone reconciliation request messages received
(HA_DNS_RECONCILIATION).
eod

ATTR:  ha-msg-heartbeat-recv
ATTRID: 13
ATTRTYPE: AT_INT
ATTRDESC:: eod
Number of heartbeat request messages received (HA_DNS_HEARTBEAT).
eod

ATTR:  ha-msg-zonesync-recv
ATTRID: 14
ATTRTYPE: AT_INT
ATTRDESC:: eod
Number of zone synchronization request messages received
(HA_DNS_ZONE_SYNC).
eod

ATTR:  ha-msg-rrsync-recv
ATTRID: 15
ATTRTYPE: AT_INT
ATTRDESC:: eod
Number of rr-sync messages request received (HA_DNS_RR_SYNC).
eod

ATTR:  ha-msg-rrupdate-recv
ATTRID: 16
ATTRTYPE: AT_INT
ATTRDESC:: eod
Number of rr-update request messages received (HA_DNS_RR_UPDATE).
eod

ATTR:  ha-msg-resp-recv
ATTRID: 17
ATTRTYPE: AT_INT
ATTRDESC:: eod
Number of response messages received. Response messages
are used to acknowledge all types of request messages.
eod

ATTR:  ha-heartbeat-timeout
ATTRID: 18
ATTRTYPE: AT_INT
ATTRDESC:: eod
Number of heartbeat timeouts (ha-dns-poll-interval).
eod

ATTR:  ha-update-reject
ATTRID: 19
ATTRTYPE: AT_INT
ATTRDESC:: eod
Number of DNS updates rejected by the server.
eod

ATTR:  ha-zone-mismatch
ATTRID: 20
ATTRTYPE: AT_INT
ATTRDESC:: eod
Number of zones reporting a mismatch error
(HA_DNS_RESP_ERR_MISMATCH).
eod

ATTR:  ha-resp-servfail
ATTRID: 21
ATTRTYPE: AT_INT
ATTRDESC:: eod
Number of responses reporting a server failure error
(HA_DNS_RESP_ERR_SERVFAIL).
eod

ATTR:  ha-resp-inconsistent
ATTRID: 22
ATTRTYPE: AT_INT
ATTRDESC:: eod
Number of responses reporting an inconsistent server state
(HA_DNS_RESP_ERR_INCONSISTENT_STATE).
eod

ATTR:  ha-resp-unknown
ATTRID: 23
ATTRTYPE: AT_INT
ATTRDESC:: eod
Number of responses with an unknown message type
(HA_DNS_RESP_ERR_UNKNOWN_MSG_TYPE).
eod

ATTR:  ha-full-zone-resync
ATTRID: 24
ATTRTYPE: AT_INT
ATTRDESC:: eod
Number of zones requiring full-zone resynchronization for
nameset reconciliation.
eod

ATTR:  ha-update-private-req
ATTRID: 25
ATTRTYPE: AT_INT
ATTRDESC:: eod
Number of DNS updates received containing a private request RR.
eod

ATTR:  ha-update-private-resp
ATTRID: 26
ATTRTYPE: AT_INT
ATTRDESC:: eod
Number of DNS update responses sent containing a private response
RR.
eod

ATTR:  ha-sync-conflict
ATTRID: 27
ATTRTYPE: AT_INT
ATTRDESC:: eod
Number of zones with name conflicts during nameset reconciliation.
eod

ATTR:  ha-sync-discard-name
ATTRID: 28
ATTRTYPE: AT_INT
ATTRDESC:: eod
Number of name conflicts where one nameset must be discarded to
synchronize the zone.
eod

ATTR:  ha-sync-merge-name
ATTRID: 29
ATTRTYPE: AT_INT
ATTRDESC:: eod
Number of name conflicts which the namesets can be merged to
synchronize the zone.
eod

ATTR:  ha-update-latency-avg
ATTRID: 30
ATTRTYPE: AT_TIME
ATTRDESC:: eod
Average DNS update latency in seconds, for this reporting
interval.  Latency is measured as the time an update remains in
the Pending List.
eod

CLASS: DNSServerIPv6Stats
CLASSID: 1225
CLASSPCV: 7.0.0
CLASSDESC:: eod
The activity statistics available from the DNS server
related to IPv6 operation.
eod

ATTR:  ipv6-packets-in
ATTRID: 1
ATTRTYPE: AT_INT
ATTRDESC:: eod
Total number of ipv6 packets received.
eod

ATTR:  ipv6-packets-out
ATTRID: 2
ATTRTYPE: AT_INT
ATTRDESC:: eod
Total number of ipv6 packets sent.
eod

#
# the ZoneFilter class
#

CLASS: ZoneFilter
CLASSROOT: ZONEFILTER
CLASSID: 1226
CLASSPCV: 7.5.0
CLASSDESC:: eod
Limits the set of zones that are used when iterating on 
cursor requests across published zones in the DNS server.
eod

ATTR: zone-list
ATTRID: 1
ATTRTYPE: AT_NLIST(AT_DNSNAME)
ATTRDESC:: eod
Optionally, constrains the filter to a specified list of
zone names.  The zone-list takes precedence over any value
specified in zone-regexpr.
eod

ATTR: zone-regexpr
ATTRID: 2
ATTRTYPE: AT_STRING
ATTRDESC:: eod
Optionally, constrains the filter to zones that begin with
a common name using simple regular expressions.  If the zone-list
is also specified, it takes precedence over the zone-regexpr
value.
eod

ATTR: zone-flags
ATTRID: 3
ATTRTYPE:  AT_FLAGSINT(forward-zones=1,reverse-zones=2,primary-zones=3,secondary-zones=4,published=5,unpublished=6)
ATTRDEFVAL: 0
ATTRDESC:: eod
Optionally, constrains the filter to any combination of
forward, reverse, primary, secondary zones, published and
unpublished zones.  Default behavior is all published zones.
   1  forward-zones
   2  reverse-zones
   3  primary-zones
   4  secondary-zones
   5  published
   6  unpublished
eod

# end of ZoneFilter class


# CLASSID RANGE TFTP classes 1300 - 1309
CLASS: TFTPServer
CLASSROOT: TFTPSERVER
CLASSID: 1300
CLASSNAME: 1
CLASSNAMEDESC:: eod
In Network Registrar, there is only one TFTP server per cluster,
and TFTP servers are not referenced by name.
eod

CLASSVIZ: 5
CLASSPCV: 1.0.0
CLASSDESC:: eod
The TFTP server configuration object.
eod

ATTR: name
ATTRID: 1
ATTRHDRNAME: AO_TFTPSERVER_NAME
ATTRTYPE: AT_STRING
ATTRMCDPATH: name
ATTRDEFVAL: TFTP
ATTRVIZ: 3
ATTRDESC:: eod
Specifies the name of the TFTP server.
eod

ATTR: active-directory-domain
ATTRID: 2
ATTRHDRNAME: AO_TFTPSERVER_ACTIVE_DIRECTORY_DOMAIN
ATTRTYPE: AT_STRING
ATTRFLAGS: AF_REQUIRED
ATTRMCDPATH: TftpActiveDirectoryDomain
ATTRVIZ: 5
ATTRDESC:: eod
Specifies the name of an Active Directory Domain the TFTP server
will use to provide dynamic configuration file support.
eod

ATTR: default-device
ATTRID: 3
ATTRHDRNAME: AO_TFTPSERVER_DEFAULT_DEVICE
ATTRTYPE: AT_STRING
ATTRFLAGS: AF_REQUIRED
ATTRMCDPATH: TftpDefaultDevice
ATTRVIZ: 5
ATTRDESC:: eod
Specifies the name of the default disk device the TFTP server will
use when none is specified in the pathname contained in the TFTP
request.  This property is specifically to be used on NT to
specify a default drive letter.
eod

ATTR: docsis-access
ATTRID: 4
ATTRHDRNAME: AO_TFTPSERVER_DOCSIS_ACCESS
ATTRTYPE: AT_BOOL
ATTRFLAGS: AF_FEATURE
ATTRDEFVAL: false
ATTRMCDPATH: TftpDocsisAccess
ATTRVIZ: 1
DEPRECATED: 7.0
ATTRDESC:: eod
Specifies how the TFTP server should respond to DOCSIS file
requests from TFTP clients.  If this feature is disabled, the TFTP
server will refuse DOCSIS file requests.
eod

ATTR: read-access
ATTRID: 5
ATTRHDRNAME: AO_TFTPSERVER_READ_ACCESS
ATTRTYPE: AT_BOOL
ATTRFLAGS: AF_FEATURE, AF_REQUIRED
ATTRDEFVAL: true
ATTRMCDPATH: TftpReadAccess
ATTRVIZ: 5
ATTRDESC:: eod
Specifies how the TFTP server should respond to file read requests
from TFTP clients.  If this feature is disabled, the TFTP server
will refuse file read requests.
eod

ATTR: write-access
ATTRID: 6
ATTRHDRNAME: AO_TFTPSERVER_WRITE_ACCESS
ATTRTYPE: AT_BOOL
ATTRFLAGS: AF_FEATURE, AF_REQUIRED
ATTRDEFVAL: false
ATTRMCDPATH: TftpWriteAccess
ATTRVIZ: 5
ATTRDESC:: eod
Specifies how the TFTP server should respond to file write requests
from TFTP clients.  If this feature is disabled, the TFTP server
will refuse file write requests.
eod

ATTR: initial-background-timer-sleep-time
ATTRID: 7
ATTRHDRNAME: AO_TFTPSERVER_INTIAL_BACKGROUD_TIMER_SLEEP_TIME
ATTRTYPE: AT_RANGEINT(1-2147483647)
ATTRFLAGS: AF_REQUIRED
ATTRDEFVAL: 5
ATTRMCDPATH: TftpInitialBackgroundTimerSleepTime
ATTRVIZ: 3
ATTRDESC:: eod
Specifies the length of time the background timer thread will
sleep at server startup time.  This property should not be changed
by customers.
eod

ATTR: initial-packet-timeout
ATTRID: 8
ATTRHDRNAME: AO_TFTPSERVER_INITIAL_PACKET_TIMEOUT
ATTRTYPE: AT_RANGEINT(1-2147483647)
ATTRFLAGS: AF_REQUIRED
ATTRDEFVAL: 5
ATTRMCDPATH: TftpInitialPacketTimeOut
ATTRVIZ: 5
ATTRDESC:: eod
Specifies the initial length of time the TFTP server will wait
after sending a response to a client before declaring that response
timed-out and sending a retransmission to the client.
eod

ATTR: ldap-host-name
ATTRID: 9
ATTRHDRNAME: AO_TFTPSERVER_LDAP_HOST_NAME
ATTRTYPE: AT_STRING
ATTRFLAGS: AF_REQUIRED
ATTRDEFVAL: localhost
ATTRMCDPATH: TftpLdapHostName
ATTRVIZ: 5
ATTRDESC:: eod
Specifies the hostname or IP address of an LDAP server the TFTP
server will use to provide dynamic configuration file support.
eod

ATTR: ldap-initial-timeout
ATTRID: 10
ATTRHDRNAME: AO_TFTPSERVER_LDAP_INITIAL_TIMEOUT
ATTRTYPE: AT_RANGEINT(1-2147483647)
ATTRFLAGS: AF_REQUIRED
ATTRDEFVAL: 10
ATTRMCDPATH: TftpLdapInitialTimeOut
ATTRVIZ: 5
ATTRDESC:: eod
Specifies the initial length of time the TFTP server will wait
after sending a request to an LDAP server before declaring that
request timed-out and sending a retransmission to the server.
eod

ATTR: ldap-maximum-timeout
ATTRID: 11
ATTRHDRNAME: AO_TFTPSERVER_LDAP_MAXIMUM_TIMEOUT
ATTRTYPE: AT_RANGEINT(1-2147483647)
ATTRFLAGS: AF_REQUIRED
ATTRDEFVAL: 60
ATTRMCDPATH: TftpLdapMaximumTimeOut
ATTRVIZ: 5
ATTRDESC:: eod
Specifies the maximum length of time the TFTP server will wait
after transmitting the initial LDAP request before giving up
retrying on that request.
eod

ATTR: ldap-password
ATTRID: 12
ATTRHDRNAME: AO_TFTPSERVER_LDAP_PASSWORD
ATTRTYPE: AT_STRING
ATTRFLAGS: AF_REQUIRED
ATTRMCDPATH: TftpLdapPassword
ATTRVIZ: 5
ATTRDESC:: eod
Specifies the password the TFTP server will use when connecting to
an LDAP server.
eod

ATTR: ldap-port-number
ATTRID: 13
ATTRHDRNAME: AO_TFTPSERVER_LDAP_PORT_NUMBER
ATTRTYPE: AT_RANGEINT(1-65535)
ATTRFLAGS: AF_REQUIRED
ATTRDEFVAL: 389
ATTRMCDPATH: TftpLdapPortNumber
ATTRVIZ: 5
ATTRDESC:: eod
Specifies the port number the TFTP server will use when
communicating with an LDAP server.
eod

ATTR: ldap-root-dn
ATTRID: 14
ATTRHDRNAME: AO_TFTPSERVER_LDAP_ROOT_DN
ATTRTYPE: AT_STRING
ATTRFLAGS: AF_REQUIRED
ATTRMCDPATH: TftpLdapRootDN
ATTRVIZ: 5
ATTRDESC:: eod
Specifies the root distinguished name the TFTP server will use to
locate the root of the directory tree for dynamic configuration
file support.
eod

ATTR: ldap-use-ssl
ATTRID: 15
ATTRHDRNAME: AO_TFTPSERVER_LDAP_USE_SSL
ATTRTYPE: AT_BOOL
ATTRFLAGS: AF_FEATURE, AF_REQUIRED
ATTRDEFVAL: false
ATTRMCDPATH: TftpLdapUseSSL
ATTRVIZ: 5
ATTRDESC:: eod
Specifies whether or not the TFTP server will use SSL when
communicating with an LDAP server.  If this feature is disabled, the
TFTP server will not use SSL when communicating with LDAP.
eod

ATTR: ldap-user-name
ATTRID: 16
ATTRHDRNAME: AO_TFTPSERVER_LDAP_USER_NAME
ATTRTYPE: AT_STRING
ATTRFLAGS: AF_REQUIRED
ATTRMCDPATH: TftpLdapUserName
ATTRVIZ: 5
ATTRDESC:: eod
Specifies the user name the TFTP server will use when connecting
to an LDAP server.
eod

ATTR: log-file-count
ATTRID: 17
ATTRHDRNAME: AO_TFTPSERVER_LOG_FILE_COUNT
ATTRTYPE: AT_RANGEINT(1-2147483647)
ATTRFLAGS:
ATTRDEFVAL:
ATTRMCDPATH: TftpLogFileCount
ATTRVIZ: 3
ATTRDESC:: eod
Specifies the number of log files the TFTP server will maintain in
the server logs directory.
eod

ATTR: log-file-size
ATTRID: 18
ATTRHDRNAME: AO_TFTPSERVER_LOG_FILE_SIZE
ATTRTYPE: AT_STRING
ATTRFLAGS:
ATTRDEFVAL:
ATTRMCDPATH: TftpLogFileSize
ATTRVIZ: 3
ATTRDESC:: eod
Specifies the size of each log file that the TFTP server will
maintain in the server logs directory.
eod

ATTR: log-level
ATTRID: 19
ATTRHDRNAME: AO_TFTPSERVER_LOG_LEVEL
ATTRTYPE: AT_RANGEINT(0-4)
ATTRFLAGS: AF_REQUIRED
ATTRDEFVAL: 3
ATTRMCDPATH: TftpLogLevel
ATTRVIZ: 5
ATTRDESC:: eod
Specifies the level of verbosity the TFTP server will employ when
writing log messages to the TFTP server log file.  Each integer
value from 0 through 4 enables the following log levels: None,
Error, Warning, Information and Activity.
eod

ATTR: packet-trace-level
ATTRID: 20
ATTRHDRNAME: AO_TFTPSERVER_TRACE_LEVEL
ATTRTYPE: AT_RANGEINT(0-4)
ATTRFLAGS: AF_REQUIRED
ATTRDEFVAL: 0
ATTRMCDPATH: TftpTraceLevel
ATTRVIZ: 5
ATTRDESC:: eod
Specifies the level of verbosity the TFTP server will employ when
writing messages to the server trace file.  Each integer value
from 1 through 4 enables increasing levels of tracing.  Setting
packet trace level to 0 disables tracing.
eod

ATTR: max-inbound-file-size
ATTRID: 21
ATTRHDRNAME: AO_TFTPSERVER_MAXIMUM_INBOUND_FILE_SIZE
ATTRTYPE: AT_STRING
ATTRFLAGS: AF_REQUIRED
ATTRDEFVAL: 1024k
ATTRMCDPATH: TftpMaximumInboundFileSize
ATTRVIZ: 5
ATTRDESC:: eod
Specifies the maximum file size limit that the TFTP server will
enforce for a file written to the TFTP server.  Default units is in
kilobytes.  Use k, m or g to indicate kilobytes, megabytes or
gigabytes.
eod

ATTR: max-tftp-packets
ATTRID: 22
ATTRHDRNAME: AO_TFTPSERVER_MAXIMUM_NUMBER_OF_SESSIONS
ATTRTYPE: AT_RANGEINT(1-1500)
ATTRFLAGS: AF_REQUIRED
ATTRDEFVAL: 1024
ATTRMCDPATH: TftpMaximumNumberOfSessions
ATTRVIZ: 3
ATTRDESC:: eod
Specifies the maximum number of simultaneous TFTP packets the TFTP
server will support.  If this limit is reached, the server logs an
error message and drops subsequent TFTP requests until packets
free up.
eod

ATTR: max-udp-packet-size
ATTRID: 23
ATTRHDRNAME: AO_TFTPSERVER_MAXIMUM_UDP_PACKET_SIZE
ATTRTYPE: AT_RANGEINT(1-65535)
ATTRFLAGS: AF_REQUIRED
ATTRDEFVAL: 516
ATTRMCDPATH: TftpMaximumUdpPacketSize
ATTRVIZ: 3
ATTRDESC:: eod
Specifies the maximum UDP packet size the TFTP server will support.
eod

ATTR: min-socket-buffer-size
ATTRID: 24
ATTRHDRNAME: AO_TFTPSERVER_MINIMUM_SOCKET_BUFFER_SIZE
ATTRTYPE: AT_RANGEINT(1-2147483647)
ATTRFLAGS: AF_REQUIRED
ATTRDEFVAL: 65536
ATTRMCDPATH: TftpMinimumSocketBufferSize
ATTRVIZ: 5
ATTRDESC:: eod
Specifies the minimum socket buffer size the TFTP server will use
for the well known port on which it is listening for TFTP requests.
eod

ATTR: per-session-heap-size
ATTRID: 25
ATTRHDRNAME: AO_TFTPSERVER_PER_SESSION_HEAP_SIZE
ATTRTYPE: AT_RANGEINT(1-2147483647)
ATTRFLAGS: AF_REQUIRED
ATTRDEFVAL: 4096
ATTRMCDPATH: TftpPerSessionHeapSize
ATTRVIZ: 3
ATTRDESC:: eod
Specifies the initial size of the session heap allocated during
session creation.  This property should not be changed by
customers.
eod

ATTR: port-number
ATTRID: 26
ATTRHDRNAME: AO_TFTPSERVER_PORT_NUMBER
ATTRTYPE: AT_RANGEINT(1-65535)
ATTRFLAGS: AF_REQUIRED
ATTRDEFVAL: 69
ATTRMCDPATH: TftpPortNumber
ATTRVIZ: 5
ATTRDESC:: eod
Specifies the UDP port number the TFTP server will use to listen
for TFTP requests.
eod

ATTR: session-timeout
ATTRID: 27
ATTRHDRNAME: AO_TFTPSERVER_SESSION_TIMEOUT
ATTRTYPE: AT_RANGEINT(1-2147483647)
ATTRFLAGS: AF_REQUIRED
ATTRDEFVAL: 20
ATTRMCDPATH: TftpSessionTimeOut
ATTRVIZ: 5
ATTRDESC:: eod
Specifies the maximum length of time the TFTP server will wait
after transmitting the initial response before giving up retrying
on that response.  If no response is received from the client
within this timeout period, the TFTP session is terminated.
eod

ATTR: timer-queue-thread-heap-size
ATTRID: 28
ATTRHDRNAME: AO_TFTPSERVER_TIMER_QUEUE_THREAD_HEAP_SIZE
ATTRTYPE: AT_RANGEINT(1-2147483647)
ATTRFLAGS: AF_REQUIRED
ATTRDEFVAL: 2048
ATTRMCDPATH: TftpTimerQueueThreadHeapSize
ATTRVIZ: 3
ATTRDESC:: eod
Specifies the initial size of the timer queue thread heap.  This
property should not be changed by customers.
eod

ATTR: use-home-directory-as-root
ATTRID: 29
ATTRHDRNAME: AO_TFTPSERVER_USE_HOME_DIRECTORY_AS_ROOT
ATTRTYPE: AT_BOOL
ATTRFLAGS: AF_FEATURE, AF_REQUIRED
ATTRDEFVAL: false
ATTRMCDPATH: TftpUseHomeDirectoryAsRoot
ATTRVIZ: 5
ATTRDESC:: eod
Specifies whether or not the TFTP server will treat pathnames
contained within TFTP requests as if the paths were rooted at the
specified home directory.  If this feature is enabled, the TFTP
server will attempt to resolve both absolute and relative
pathnames to paths located beneath the specified home directory.
eod

ATTR: home-directory
ATTRID: 30
ATTRHDRNAME: AO_TFTPSERVER_HOME_DIRECTORY
ATTRTYPE: AT_STRING
ATTRFLAGS: AF_REQUIRED
ATTRMCDPATH: TftpHomeDirectory
ATTRVIZ: 5
ATTRDESC:: eod
Specifies a path to a home directory the TFTP server will use to
resolve TFTP requests.  If use-home-directory-as-root is disabled,
the home directory is used in conjunction with the paths specified
in the search-list to resolve TFTP requests.
eod

ATTR: search-list
ATTRID: 31
ATTRHDRNAME: AO_TFTPSERVER_SEARCH_LIST
ATTRTYPE: AT_STRING
ATTRFLAGS: AF_REQUIRED
ATTRMCDPATH: TftpSearchPath
ATTRVIZ: 5
ATTRDESC:: eod
Specifies a comma separated list of paths the TFTP server will use
to resolve TFTP requests.  If use-home-directory-as-root is
enabled, the paths in the search list are ignored and the home
directory is used to resolve all TFTP requests.
eod

ATTR: docsis-file-logging
ATTRID: 32
ATTRHDRNAME: AO_TFTPSERVER_DOCSIS_FILE_LOGGING
ATTRTYPE: AT_BOOL
ATTRFLAGS: AF_FEATURE
ATTRDEFVAL: false
ATTRMCDPATH: TftpDocsisFileLogging
ATTRVIZ: 1
DEPRECATED: 7.0
ATTRDESC:: eod
Specifies whether the TFTP server should log generated DOCSIS
files to disk.  If this feature is enabled, the TFTP server will
log each generated DOCSIS configuration file to a tftp
subdirectory within the server logs directory.
eod

ATTR: docsis-log-file-count
ATTRID: 33
ATTRHDRNAME: AO_TFTPSERVER_DOCSIS_LOG_FILE_COUNT
ATTRTYPE: AT_RANGEINT(1-2147483647)
ATTRDEFVAL: 100
ATTRMCDPATH: TftpDocsisLogFileCount
ATTRVIZ: 1
DEPRECATED: 7.0
ATTRDESC:: eod
Specifies the maximum number of DOCSIS configuration log files the
TFTP server will maintain in the tftp subdirectory within the
server logs directory.  Once this limit is reached, the TFTP
server will remove one DOCSIS log file for each new log file it
creates so as to not exceed the limit.
eod

ATTR: docsis-pathname-prefix
ATTRID: 34
ATTRHDRNAME: AO_TFTPSERVER_DOCSIS_PATHNAME_PREFIX
ATTRTYPE: AT_STRING
ATTRDEFVAL: /docsis
ATTRMCDPATH: TftpDocsisPathnamePrefix
ATTRVIZ: 1
DEPRECATED: 7.0
ATTRDESC:: eod
Specifies a pathname prefix the TFTP server will recognize as the
trigger to create a DOCSIS configuration file.  This prefix must
match the one the DHCP server is using to generate the DOCSIS
filename that DHCP sends to the TFTP client.
eod

ATTR: docsis-address-validation
ATTRID: 35
ATTRHDRNAME: AO_TFTPSERVER_DOCSIS_ADDRESS_VALIDATION
ATTRTYPE: AT_BOOL
ATTRFLAGS: AF_FEATURE
ATTRDEFVAL: true
ATTRMCDPATH: TftpDocsisAddressValidation
ATTRVIZ: 1
DEPRECATED: 7.0
ATTRDESC:: eod
Specifies whether the TFTP server should perform IP Address
validation on incoming DOCSIS configuration file requests.
eod

ATTR: csrc-configuration-file
ATTRID: 36
ATTRHDRNAME: AO_TFTPSERVER_CSRC_CONFIGURATION_FILE
ATTRTYPE: AT_STRING
ATTRFLAGS: AF_REQUIRED
ATTRMCDPATH: TftpCsrcConfigurationFile
ATTRVIZ: 5
ATTRDESC:: eod
Specifies the path to a configuration file the TFTP server will use
when loading the CSRC library.  The CSRC library enables the TFTP
server to generate DOCSIS modem configuration files.  The location
of the CSRC configuration file is typically
/CSRC_INSTALL_DIR/conf/csrc.cfg.
eod

ATTR: scp-port
ATTRID: 37
ATTRHDRNAME: AO_TFTPSERVER_SCP_PORT
ATTRTYPE: AT_RANGEINT(0-65535)
ATTRMCDPATH: scp-port
ATTRVIZ: 3
ATTRDESC:: eod
Specifies the scp port number to be used. If the requested port
number is in use, the server will select an alternate number to
use.
eod

ATTR: log-settings
ATTRID: 38
ATTRHDRNAME: AO_TFTPSERVER_VERBOSELOGGING
ATTRTYPE: AT_FLAGSINT( verbose=1, no-success-messages=2 )
ATTRFLAGS: AF_INITIALIZE
ATTRDEFVAL: verbose
ATTRMCDPATH: VerboseLogging
ATTRVIZ: 5
ATTRDESC:: eod
Enables the TFTP server to allow control over additional details
about the events listed in the log-settings. These details can 
help analyze a problem, but can also cause the log files
to fill up quickly if left enabled for a long period of time.

When log files fill up quickly, they also turn over frequently.
So you might lose important information.

By default, the TFTP server's logging is verbose.

The possible flags are:
   1  verbose
      Causes all the logging in the server to be active.
      A success message is printed to the log for
      each successful transfer.
   2  no-success-messages
      Causes the single line message that is normally logged
      for every successful read from or write to the TFTP server
      to not appear.  It affects logging only for successful 
      file reads from the TFTP server.
eod

ATTR: file-cache
ATTRID: 39
ATTRHDRNAME: AO_TFTPSERVER_FILE_CACHING
ATTRTYPE: AT_BOOL
ATTRFLAGS: AF_FEATURE
ATTRDEFVAL: false
ATTRMCDPATH: TftpFileCache
ATTRVIZ: 5
ATTRDESC:: eod
Specifies whether the TFTP server should perform file caching on
files located in the file-cache-directory.
eod

ATTR: file-cache-directory
ATTRID: 40
ATTRHDRNAME: AO_TFTPSERVER_CACHE_DIRECTORY
ATTRTYPE: AT_STRING
ATTRFLAGS: AF_FEATURE
ATTRMCDPATH: TftpCacheDirectory
ATTRVIZ: 5
ATTRDESC:: eod
Specifies a path to a cache directory the TFTP server will use to
find the files to put into cache.  Upon start up the TFTP server
will load all the files located in this directory into cache.
eod

ATTR: min-working-set-size
ATTRID: 41
ATTRHDRNAME: AO_TFTPSERVER_MINWORKINGSETSIZE
ATTRTYPE: AT_RANGEINT(1-2147483647)
ATTRMCDPATH: TftpMinWorkingSetSize
ATTRVIZ: 3
ATTRDESC:: eod
For NT platforms, defines the server's minimum working set size.
eod

ATTR: max-working-set-size
ATTRID: 42
ATTRHDRNAME: AO_TFTPSERVER_MAXWORKINGSETSIZE
ATTRTYPE: AT_RANGEINT(1-2147483647)
ATTRMCDPATH: TftpMaxWorkingSetSize
ATTRVIZ: 3

ATTR: file-cache-max-memory-size
ATTRID: 43
ATTRHDRNAME: AO_TFTPSERVER_FILE_CACHE_MAX_MEM_SIZE
ATTRTYPE: AT_RANGEINT(0-2147483647)
ATTRFLAGS: AF_FEATURE
ATTRDEFVAL: 32000
ATTRMCDPATH: TftpFileCacheMaxMemSize
ATTRVIZ: 5
ATTRDESC:: eod
Specifies the maximum number of bytes available to the server
for file-caching.
Valid range: 0-2147483647
eod

ATTR: write-allow-file-create
ATTRID: 44
ATTRTYPE: AT_BOOL
ATTRFLAGS: AF_FEATURE
ATTRDEFVAL: false
ATTRMCDPATH: TftpWriteAllowFileCreate
ATTRVIZ: 5
ATTRDESC:: eod
Specifies whether to allow file creates on a PUT.  If false and
write-access equals true, the file must exist on the server for the
PUT to succeed.  If true and write-access is true, then the file
does not need to exist on the server first and will be created on
a PUT.  max-inbound-file-size will apply a limit to the size of
the file.
eod

ATTR: max-tftp-sessions
ATTRID: 45
ATTRTYPE: AT_RANGEINT(1-1000)
ATTRFLAGS: AF_REQUIRED
ATTRDEFVAL: 512
ATTRMCDPATH: TftpMaximumNumberOfNewSessions
ATTRVIZ: 3
ATTRDESC:: eod
Specifies the maximum number of simultaneous TFTP sessions the TFTP
server will support.  If this limit is reached, the server logs an
error message and drops subsequent TFTP requests until one of the
current sessions has completed.
eod

ATTR: tftp-support
ATTRID: 46
ATTRTYPE: AT_ENUMINT(v4-only=1, v6-only=2, both=3)
ATTRDEFVAL: both
ATTRFLAGS: AF_PRINT_ALT
ATTRVIZ: 3
ATTRDESC:: eod
Determines which IP protocol or protocols the server listens on.

   1  v4-only     The server supports only IPv4 (IPv6
                  interface information is ignored).
   2  v6-only     The server supports only IPv6 (IPv4
                  interface information is ignored).
   3  both        The server supports both IPv4 and IPv6.
                  Default.
The server's configuration and the system's network interface
support impacts what will actually be used.
eod

#
# CLASS: TFTPServerStats
# Note that in processing this object (for the time being), the
# mcdsvr is highly dependent on the ordering of these attributes.
# If they got moved around at all or re-ordered, it could cause
# subtle inaccuracies in the reporting of stats.
#
CLASS: TFTPServerStats
CLASSID: 1301
CLASSDESC:: eod
The gneral statistics available from the TFTP server.
eod

ATTR: id
ATTRID: 1
ATTRTYPE: AT_STRING
ATTRDESC:: eod
A string that identifies the TFTP server.
eod

ATTR: server-start-time
ATTRID: 2
ATTRTYPE: AT_DATE
ATTRDESC:: eod
Integer representing the start time of the server.
eod

ATTR: server-reset-time
ATTRID: 3
ATTRTYPE: AT_DATE
ATTRDESC:: eod
Integer representing the reset time of the server.
eod

ATTR: server-state
ATTRID: 4
ATTRTYPE: AT_INT
ATTRDESC:: eod
Integer representing the state of the server.
eod

ATTR: server-time-since-start
ATTRID: 5
ATTRTYPE: AT_TIME
ATTRDESC:: eod
Time the server has been running since last start.
eod

ATTR: server-time-since-reset
ATTRID: 6
ATTRTYPE: AT_TIME
ATTRDESC:: eod
Time the server has been running since last reset(reload).
eod

ATTR: total-packets-in-pool
ATTRID: 7
ATTRTYPE: AT_INT
ATTRDESC:: eod
Number of total packets in pool.
eod

ATTR: total-packets-in-use
ATTRID: 8
ATTRTYPE: AT_INT
ATTRDESC:: eod
Total number of packets being used by the server.
eod

ATTR: total-packets-received
ATTRID: 9
ATTRTYPE: AT_INT
ATTRDESC:: eod
Total number of packets received by the server since start/reload.
eod

ATTR: total-packets-sent
ATTRID: 10
ATTRTYPE: AT_INT
ATTRDESC:: eod
Total number of packets server has sent since start/reload.
eod

ATTR: total-packets-drained
ATTRID: 11
ATTRTYPE: AT_INT
ATTRDESC:: eod
Total number of packets drained (read and discarded) since
last start/reload.  A packet is drained when the TFTP server
is overwhelmed and is using all its packets already, so there
are no more available to process the incoming packet.
eod

ATTR: total-packets-dropped
ATTRID: 12
ATTRTYPE: AT_INT
ATTRDESC:: eod
Total number of packets that server has dropped since start/reload.
This includes packets that are unknown to the server, malformed,
duplicated, drained, and so on (basically any packet that is
dropped for any reason).
eod

ATTR: total-packets-malformed
ATTRID: 13
ATTRTYPE: AT_INT
ATTRDESC:: eod
Total number of packets the server has received that were
malformed since start/reload.
eod

ATTR: total-read-requests
ATTRID: 14
ATTRTYPE: AT_INT
ATTRDESC:: eod
Total number of packets the server has received that were
read requests since start/reload.
eod

ATTR: total-read-requests-completed
ATTRID: 15
ATTRTYPE: AT_INT
ATTRDESC:: eod
Total number of read requests that were completed since
start/reload.
eod

ATTR: total-read-requests-refused
ATTRID: 16
ATTRTYPE: AT_INT
ATTRDESC:: eod
Total number of read requests that the server refused
since start/reload.
eod

ATTR: total-read-requests-ignored
ATTRID: 17
ATTRTYPE: AT_INT
ATTRDESC:: eod
Total number of read requests that the server ignored
since start/reload.
eod

ATTR: total-read-requests-timed-out
ATTRID: 18
ATTRTYPE: AT_INT
ATTRDESC:: eod
Total number of read requests that timed out since start/reload.
eod

ATTR: total-write-requests
ATTRID: 19
ATTRTYPE: AT_INT
ATTRDESC:: eod
The number of packets the server has received that were write
requests since start/reload.
eod

ATTR: total-write-requests-completed
ATTRID: 20
ATTRTYPE: AT_INT
ATTRDESC:: eod
Total number of write requests that were completed since
start/reload.
eod

ATTR: total-write-requests-refused
ATTRID: 21
ATTRTYPE: AT_INT
ATTRDESC:: eod
Total number of write requests that the server refused
since start/reload.
eod

ATTR: total-write-requests-ignored
ATTRID: 22
ATTRTYPE: AT_INT
ATTRDESC:: eod
Total number of write requests that the server ignored
since start/reload.
eod

ATTR: total-write-requests-timed-out
ATTRID: 23
ATTRTYPE: AT_INT
ATTRDESC:: eod
Total number of write requests that timed out since start/reload.
eod

ATTR: total-docsis-requests
ATTRID: 24
ATTRTYPE: AT_INT
ATTRDESC:: eod
The number of packets the server has received that were docsis
requests since start/reload.
eod

ATTR: total-docsis-requests-completed
ATTRID: 25
ATTRTYPE: AT_INT
ATTRDESC:: eod
Total number of docsis requests that were completed
since start/reload.
eod

ATTR: total-docsis-requests-refused
ATTRID: 26
ATTRTYPE: AT_INT
ATTRDESC:: eod
Total number of docsis requests that the server refused
since start/reload.
eod

ATTR: total-docsis-requests-ignored
ATTRID: 27
ATTRTYPE: AT_INT
ATTRDESC:: eod
Total number of docsis requests that the server ignored
since start/reload.
eod

ATTR: total-docsis-requests-timed-out
ATTRID: 28
ATTRTYPE: AT_INT
ATTRDESC:: eod
Total number of docsis requests that timed out since start/reload.
eod

ATTR: read-requests-per-second
ATTRID: 29
ATTRTYPE: AT_INT
ATTRDESC:: eod
Number of read requests per second.
eod

ATTR: write-requests-per-second
ATTRID: 30
ATTRTYPE: AT_INT
ATTRDESC:: eod
Number of write requests per second.
eod

ATTR: docsis-requests-per-second
ATTRID: 31
ATTRTYPE: AT_INT
ATTRDESC:: eod
Number of docsis requests per second.
eod

ATTR: total-session-heap-size
ATTRID: 32
ATTRTYPE: AT_INT
ATTRDESC:: eod
Size of session heap.
eod

ATTR: max-session-heap-size
ATTRID: 33
ATTRTYPE: AT_INT
ATTRDESC:: eod
Maximum size the session heap can grow to.
eod

#
# the rest of these attrs are not currently populated by the server
# these attrs complete the structure located in tftppublic.h
#
ATTR: dynamic-requests-per-second
ATTRID: 34
ATTRTYPE: AT_INT
ATTRDESC:: eod
Number of dynamic requests received per second.
eod


ATTR: total-dynamic-requests
ATTRID: 35
ATTRTYPE: AT_INT
ATTRDESC:: eod
The number of packets the server has received that were
dynamic requests since start/reload.
eod

ATTR: total-dynamic-requests-completed
ATTRID: 36
ATTRTYPE: AT_INT
ATTRDESC:: eod
Total number of dynamic requests that were completed
since start/reload.
eod

ATTR: total-dynamic-requests-refused
ATTRID: 37
ATTRTYPE: AT_INT
ATTRDESC:: eod
Total number of dynamic requests that the server refused
since start/reload.
eod

ATTR: total-dynamic-requests-ignored
ATTRID: 38
ATTRTYPE: AT_INT
ATTRDESC:: eod
Total number of dynamic requests that the server ignored
since start/reload.
eod

ATTR: total-dynamic-requests-timed-out
ATTRID: 39
ATTRTYPE: AT_INT
ATTRDESC:: eod
Total number of dynamic requests that timed out since start/reload.
eod

ATTR: time-from-received-to-start
ATTRID: 40
ATTRTYPE: AT_TIME
ATTRDESC:: eod
The time that has elapsed between receiving the packet to the start
of  processing it.
eod

ATTR: time-from-received-to-finish
ATTRID: 41
ATTRTYPE: AT_TIME
ATTRDESC:: eod
The time that has elapsed between receiving the packet to
finishing processing it.
eod

ATTR: time-from-start-to-finish
ATTRID: 42
ATTRTYPE: AT_TIME
ATTRDESC:: eod
The time that has elapsed between starting to process the packet
to finishing processing the packet.
eod

ATTR: last-stats-update
ATTRID: 43
ATTRTYPE: AT_TIME
ATTRDESC:: eod
The last time the statistics were updated.
eod

ATTR: last-read-requests
ATTRID: 44
ATTRTYPE: AT_TIME
ATTRDESC:: eod
A benchmark number, it's used to show what the total number of
TFTP read requests were the last time the statistics were retrieved
from the server. Does not hold across reloads.
eod

ATTR: last-write-requests
ATTRID: 45
ATTRTYPE: AT_TIME
ATTRDESC:: eod
A benchmark number, it's used to show what the total number of
TFTP write requests were the last time the statistics were
retrieved from the server. Does not hold across reloads.
eod

ATTR: last-docsis-requests
ATTRID: 46
ATTRTYPE: AT_TIME
ATTRDESC:: eod
A benchmark number, it's used to show what the total number of
TFTP docsis requests were the last time the statistics were
retrieved from the server. Does not hold across reloads.
eod

ATTR: last-dynamic-requests
ATTRID: 47
ATTRTYPE: AT_TIME
ATTRDESC:: eod
A benchmark number, it's used to show what the total number of
TFTP dynamic requests were the last time the statistics were
retrieved from the server. Does not hold across reloads.
eod

CLASS: OptionInformation
CLASSID: 1302
CLASSVIZ: 3
CLASSPCV: 4.0.0
CLASSDEPRECATED: 7.0.0
CLASSDESC:: eod
The object is used for export/import of the option information
(custom options, vendor options, and option data types).
eod

ATTR: optdescs
ATTRID: 1
ATTRTYPE: AT_NLIST(AT_OBJ(AttrDesc))
# 1<<16 | 1110
ATTRVAL: 66646
ATTRDESC:: eod
The option description objects, known as custom options.
eod

#
# includes nlist of OptionDataType-Field
#
ATTR: option-data-types
ATTRID: 2
ATTRTYPE: AT_NLIST(AT_OBJ(OptionDataType))
# 1<<16 | 1121
ATTRVAL: 66657

ATTRDESC:: eod
The option data type objects.
eod

#
# includes nlist of VendorSubOptions
#
ATTR: vendor-options
ATTRID: 3
ATTRTYPE: AT_NLIST(AT_OBJ(VendorOption))
# 1<<16 | 1123
ATTRVAL: 66659
ATTRDESC:: eod
The vendor option objects.
eod

#
# TftpInterface: configures network interfaces for the TFTP server
#

CLASS: TftpInterface
CLASSID: 1303
CLASSVIZ: 5
CLASSNAME: 1
CLASSDESC:: eod
A TFTP server interface. When interfaces
are configured, the server default behavior to
discover and bind to all interfaces is disabled.
eod

ATTR: name
ATTRID: 1
ATTRTYPE: AT_STRING
ATTRFLAGS: AF_REQUIRED,AF_UNIQUE,AF_IMMUTABLE
ATTRDESC:: eod
A user-assigned name for the interface.
eod

ATTR: address
ATTRID: 2
ATTRTYPE: AT_SUBNET
ATTRDESC:: eod
The IP address and subnet mask of an interface that the TFTP server
should use.
eod

ATTR: ip6address
ATTRID: 3
ATTRTYPE: AT_PREFIX
ATTRDESC:: eod
Specifies the IPv6 address and prefix length of one or more
interfaces that the TFTP server should use.
eod

ATTR: port-number
ATTRID: 4
ATTRTYPE: AT_RANGEINT(1-65535)
ATTRDEFVAL: 69
ATTRVIZ: 3
ATTRDESC:: eod
Specifies the UDP port number the TFTP server will use to listen
for TFTP requests.
eod


# CLASSID RANGE Central Configuration Manager (CCM) classes 1400 - 1599
# defined in ccm_datadict


# CLASSID RANGE CNRSNMP Server (CS) classes 1600 - 1699
#

#
# CNRSNMP Server class
#

CLASS: SNMPServer
CLASSROOT: SNMPSRV
CLASSID: 1600
CLASSNAME: 1
CLASSVIZ: 5
CLASSPCV: 7.0.0
CLASSDESC:: eod
Provides global configuration for the Network Registrar
SNMP server.
eod

ATTR: name
ATTRID: 1
ATTRTYPE: AT_STRING
ATTRDEFVAL: CNRSNMP
ATTRDESC:: eod
The name of the server (constant for now).
eod

ATTR: log-settings
ATTRID: 2
ATTRTYPE: AT_FLAGSINT(default=1, no-success-messages=2, incoming-packet-detail=3, outgoing-packet-detail=5, scp-detail=6, snmp-detail=7)
ATTRDEFVAL: default
ATTRDESC:: eod
Configures log messages. The server logs more or fewer messages 
depending on this parameter.
eod

ATTR: snmp-port
ATTRID: 3
ATTRVIZ: 3
ATTRTYPE: AT_RANGEINT(1-65535)
ATTRDEFVAL: 4444
ATTRDESC:: eod
The port to listen on for incoming SNMP queries.
eod
## 7/15/05 hgabriel: this is not used!
#ATTR: scp-port
#ATTRID: 4
#ATTRVIZ: 3
#ATTRTYPE: AT_RANGEINT(0-65535)
#ATTRDESC:: eod
#The port to listen on for incoming SCP messages. The default is
#for the server to select an arbitrary port.
#eod

ATTR: server-active
ATTRID: 5
ATTRTYPE: AT_BOOL
ATTRDEFVAL: true
ATTRDESC:: eod
If 'true', the server will run when it is started. If 'false', the
server will not run when it is started.
eod

ATTR: scp-retry-interval
ATTRID: 6
ATTRVIZ: 3
ATTRTYPE: AT_RANGETIME(1s-1h)
ATTRDEFVAL: 5s
ATTRDESC:: eod
The interval to use when trying to establish an SCP connection to
the co-located CCM server.
eod

ATTR: db-checkpt-interval
ATTRID: 7
ATTRVIZ: 3
ATTRTYPE: AT_RANGETIME(0-24h)
ATTRDEFVAL: 300
ATTRDESC:: eod
The interval between database checkpoints.
eod

ATTR: db-log-purge-interval
ATTRID: 8
ATTRVIZ: 3
ATTRTYPE: AT_RANGETIME(0-24h)
ATTRDEFVAL: 600
ATTRDESC:: eod
The interval between database logfile purges.
eod

ATTR: community
ATTRID: 9
ATTRTYPE: AT_STRING
ATTRDEFVAL: public
ATTRDESC:: eod
SNMP requests must present a matching community-string in order to
be processed by the SNMP server.
eod

ATTR: cache-ttl
ATTRID: 10
ATTRTYPE: AT_TIME
ATTRDEFVAL: 60
ATTRDESC:: eod
Controls how long CNR data can be cached by the SNMP server as it
responds to SNMP GETs.
eod

ATTR: trap-source-addr
ATTRID: 11
ATTRTYPE: AT_IPADDR
ATTRDESC:: eod
An optional address to use as the sender address in outgoing SNMP
trap packets.
eod

#
# Beginning of initial 'event' classes, representing the original
# CNR snmp traps. These will be used to pass 'event' information to
# the CNRSNMP server, which will then emit SNMP PDUs.
#

#
# server-start event class
#

CLASS: ServerStartEvent
CLASSID: 1601
CLASSVIZ: 5
CLASSPCV: 7.0.0
CLASSDESC:: eod
A 'server-start' event that the SNMP server uses to generate
an SNMP notification to its list of trap recipients.
eod

ATTR: server-class
ATTRID: 1
ATTRTYPE: AT_INT
ATTRDESC:: eod
The class id of the server sending the event.
eod

ATTR: time
ATTRID: 2
ATTRTYPE: AT_DATE
ATTRDESC:: eod
The time at which the server started.
eod

ATTR: server-addr
ATTRID: 3
ATTRTYPE: AT_IPADDR
ATTRDESC:: eod
An (optional) address representing the source server.
eod

#
# server-stop event class
#

CLASS: ServerStopEvent
CLASSID: 1602
CLASSVIZ: 5
CLASSPCV: 7.0.0
CLASSDESC:: eod
A 'server-stop' event that the SNMP server uses to generate
an SNMP notification to its list of trap recipients.
eod

ATTR: server-class
ATTRID: 1
ATTRTYPE: AT_INT
ATTRDESC:: eod
The class id of the server sending the event.
eod

ATTR: time
ATTRID: 2
ATTRTYPE: AT_DATE
ATTRDESC:: eod
The time at which the server stopped.
eod

ATTR: server-addr
ATTRID: 3
ATTRTYPE: AT_IPADDR
ATTRDESC:: eod
An (optional) address representing the source server.
eod

#
# free-address-low snmp event class
#

CLASS: FreeAddressLowEvent
CLASSID: 1603
CLASSVIZ: 5
CLASSPCV: 7.0.0
CLASSDESC:: eod
A 'low-address threshold' event sent
by a DHCP server, that the SNMP server uses to generate
an SNMP notification to its list of trap recipients.
eod

ATTR: time
ATTRID: 1
ATTRTYPE: AT_DATE
ATTRDESC:: eod
The time at which the event occurred.
eod

ATTR: server-addr
ATTRID: 2
ATTRTYPE: AT_IPADDR
ATTRVIZ: 1
DEPRECATED: 8.0.0
ATTRDESC:: eod
An (optional) address representing the source server.
eod

ATTR: scope-name
ATTRID: 3
ATTRTYPE: AT_STRING
ATTRDESC:: eod
The name of the CNR Scope experiencing the low-address-threshold
event.
eod

ATTR: value
ATTRID: 4
ATTRTYPE: AT_INT
ATTRDESC:: eod
The value at the time the event was triggered. The trigger value
is represented as a counter value.
eod

ATTR: threshold
ATTRID: 5
ATTRTYPE: AT_PERCENT
ATTRDESC:: eod
Specifies the configured threshold that was crossed.
eod

ATTR: network
ATTRID: 6
ATTRTYPE: AT_SUBNET
ATTRDESC:: eod
The network or lan-segment that the scope is part of.
eod

ATTR: type
ATTRID: 7
ATTRTYPE: AT_ENUMINT(scope=1, network=2, selection-tags=3)
ATTRFLAGS: AF_PRINT_ALT
ATTRDESC:: eod
Indicates whether the threshold was configured at the level of a
single scope, a group of scopes sharing the same lan-segment and
selection tags, or an entire group of scopes grouped together as
primary and secondary scopes.
eod

ATTR: type-desc
ATTRID: 8
ATTRTYPE: AT_STRING
ATTRDESC:: eod
Carries extra information about the grouping that the scope is part
of.
eod

#
# free-address-high event class
#

CLASS: FreeAddressHighEvent
CLASSID: 1604
CLASSVIZ: 5
CLASSPCV: 7.0.0
CLASSDESC:: eod
A 'high-address threshold' event, sent
by a DHCP server, that the SNMP server uses to generate
an SNMP notification to its list of trap recipients.
eod

ATTR: time
ATTRID: 1
ATTRTYPE: AT_DATE
ATTRDESC:: eod
The time at which the event occurred.
eod

ATTR: server-addr
ATTRID: 2
ATTRTYPE: AT_IPADDR
ATTRVIZ: 1
DEPRECATED: 8.0.0
ATTRDESC:: eod
An (optional) address representing the source server.
eod

ATTR: scope-name
ATTRID: 3
ATTRTYPE: AT_STRING
ATTRDESC:: eod
The name of the CNR Scope experiencing the high-address-threshold
event.
eod

ATTR: value
ATTRID: 4
ATTRTYPE: AT_INT
ATTRDESC:: eod
The free-address value at the time the event was triggered. The
trigger value is represented as a counter value.
eod

ATTR: threshold
ATTRID: 5
ATTRTYPE: AT_PERCENT
ATTRDESC:: eod
Specifies the configured threshold that was crossed.
eod

ATTR: network
ATTRID: 6
ATTRTYPE: AT_SUBNET
ATTRDESC:: eod
The network or lan-segment that the scope is part of.
eod

ATTR: type
ATTRID: 7
ATTRTYPE: AT_ENUMINT(scope=1, network=2, selection-tags=3)
ATTRFLAGS: AF_PRINT_ALT
ATTRDESC:: eod
Indicates whether the threshold was configured at the level of a
single scope, a group of scopes sharing the same lan-segment and
selection tags, or an entire group of scopes grouped together as
primary and secondary scopes.
eod

ATTR: type-desc
ATTRID: 8
ATTRTYPE: AT_STRING
ATTRDESC:: eod
Carries extra information about the grouping that the scope is part
of.
eod

#
# a 'dns-update-queue-too-big' event
#

CLASS: DnsQueueSizeEvent
CLASSID: 1605
CLASSVIZ: 5
CLASSPCV: 7.0.0
CLASSDESC:: eod
A 'dns-update-queue-too-big' event, sent by
the DHCP server, that the SNMP server uses to generate
an SNMP notification to its list of trap recipients.
eod

ATTR: time
ATTRID: 1
ATTRTYPE: AT_DATE
ATTRDESC:: eod
The time at which the event occurred.
eod

ATTR: server-addr
ATTRID: 2
ATTRVIZ: 1
DEPRECATED: 8.0.0
ATTRTYPE: AT_IPADDR
ATTRDESC:: eod
An (optional) address representing the source server.
eod

ATTR: count
ATTRID: 3
ATTRTYPE: AT_INT
ATTRDESC:: eod
The number of outstanding dns updates in the queue at the time the
event was triggered.
eod

#
# an 'other-server-not-responding' event
#

CLASS: OtherServerDownEvent
CLASSID: 1606
CLASSVIZ: 5
CLASSPCV: 7.0.0
CLASSDESC:: eod
An event triggered when a remote or partner
server stops responding, that the SNMP server uses to generate
an SNMP notification to its list of trap recipients.
eod

ATTR: server-class
ATTRID: 1
ATTRTYPE: AT_INT
ATTRDESC:: eod
The class-id of the CNR server sending the event.
eod

ATTR: time
ATTRID: 2
ATTRTYPE: AT_DATE
ATTRDESC:: eod
The time at which the event occurred.
eod

ATTR: server-addr
ATTRID: 3
ATTRTYPE: AT_IPADDR
ATTRVIZ: 1
DEPRECATED: 8.0.0
ATTRDESC:: eod
An (optional) address representing the source server.
eod

ATTR: other-server-addr
ATTRID: 4
ATTRTYPE: AT_IPADDR
ATTRDESC:: eod
The address of the remote server that has stopped responding.
eod

ATTR: related-server-type
ATTRID: 5
ATTRTYPE: AT_ENUMINT(DNS=1,LDAP=2,DHCP=3)
ATTRDESC:: eod
The type of remote server that has stopped responding.
eod

#
# an 'other-server-responding' event
#

CLASS: OtherServerUpEvent
CLASSID: 1607
CLASSVIZ: 5
CLASSPCV: 7.0.0
CLASSDESC:: eod
An event triggered when a remote or partner
server becomes responsive again, that the SNMP server uses to
generate an SNMP notification to its list of trap recipients.
eod

ATTR: server-class
ATTRID: 1
ATTRTYPE: AT_INT
ATTRDESC:: eod
The class-id of the CNR server sending the event.
eod

ATTR: time
ATTRID: 2
ATTRTYPE: AT_DATE
ATTRDESC:: eod
The time at which the event occurred.
eod

ATTR: server-addr
ATTRID: 3
ATTRTYPE: AT_IPADDR
ATTRVIZ: 1
DEPRECATED: 8.0.0
ATTRDESC:: eod
An (optional) address representing the source server.
eod

ATTR: other-server-addr
ATTRID: 4
ATTRTYPE: AT_IPADDR
ATTRDESC:: eod
The address of the remote server that has resumed responding.
eod

ATTR: related-server-type
ATTRID: 5
ATTRTYPE: AT_ENUMINT(DNS=1,LDAP=2,DHCP=3)
ATTRDESC:: eod
The type of remote server that has resumed responding.
eod

#
# class representing a 'duplicate-IP-address-detected' event
#

CLASS: DuplicateAddressEvent
CLASSID: 1608
CLASSVIZ: 5
CLASSPCV: 7.0.0
CLASSDESC:: eod
An event triggered when a duplicate DHCP address assignment is
detected, that the SNMP server uses to generate
an SNMP notification to its list of trap recipients.
eod

ATTR: time
ATTRID: 1
ATTRTYPE: AT_DATE
ATTRDESC:: eod
The time at which the event occurred.
eod

ATTR: server-addr
ATTRID: 2
ATTRTYPE: AT_IPADDR
ATTRVIZ: 1
DEPRECATED: 8.0.0
ATTRDESC:: eod
An (optional) address representing the source server.
eod

ATTR: address
ATTRID: 3
ATTRTYPE: AT_IPADDR
ATTRDESC:: eod
The address that triggered the event.
eod

ATTR: detected-by
ATTRID: 4
ATTRTYPE: AT_ENUMINT(dhcp-server=1,dhcp-client=2)
ATTRDESC:: eod
Indicates whether the DHCP server detected the presence of a
duplicate address (using a ping, e.g.), or a DHCP client detected
the duplicate (using ARP, e.g.).
eod

ATTR: mac-address
ATTRID: 5
ATTRTYPE: AT_MACADDR
ATTRDESC:: eod
The MAC address which caused a duplicate IP address to be detected.
eod

#
# an event representing the DHCP failover 'address-conflict' event
#

CLASS: AddressConflictEvent
CLASSID: 1611
CLASSVIZ: 5
CLASSPCV: 7.0.0
CLASSDESC:: eod
An event triggered in DHCP failover processing when both partners
appear to have leased an address to different
clients, that the SNMP server uses to generate
an SNMP notification to its list of trap recipients.
eod

ATTR: time
ATTRID: 1
ATTRTYPE: AT_DATE
ATTRDESC:: eod
The time at which the event occurred.
eod

ATTR: server-addr
ATTRID: 2
ATTRTYPE: AT_IPADDR
ATTRVIZ: 1
DEPRECATED: 8.0.0
ATTRDESC:: eod
An (optional) address representing the source server.
eod

ATTR: address
ATTRID: 3
ATTRTYPE: AT_IPADDR
ATTRDESC:: eod
The IP address that triggered the event.
eod

ATTR: partner-addr
ATTRID: 4
ATTRTYPE: AT_IPADDR
ATTRDESC:: eod
The address of the DHCP failover partner server.
eod

#
# an event representing a DHCP failover 'configuration-mismatch'
# event
#

CLASS: FailoverConfigErrEvent
CLASSID: 1609
CLASSVIZ: 5
CLASSPCV: 7.0.0
CLASSDESC:: eod
An event triggered in DHCP failover processing when one server
detects a configuration mismatch with its partner,
that the SNMP server uses to generate
an SNMP notification to its list of trap recipients.
eod

ATTR: time
ATTRID: 1
ATTRTYPE: AT_DATE
ATTRDESC:: eod
The time at which the event occurred.
eod

ATTR: server-addr
ATTRID: 2
ATTRTYPE: AT_IPADDR
ATTRVIZ: 1
DEPRECATED: 8.0.0
ATTRDESC:: eod
An (optional) address representing the source server.
eod

ATTR: partner-addr
ATTRID: 3
ATTRTYPE: AT_IPADDR
ATTRDESC:: eod
The address of the DHCP failover partner server.
eod

ATTR: error-type
ATTRID: 4
ATTRTYPE: AT_ENUMINT(mclt-error=1,hba-error=2,backup-percentage-error=3,server-address-error=4,config-error=5,internal-error=6)
ATTRDESC:: eod
The type of error that triggered the event:
  mclt-error
    The servers' MCLT configurations differ.
  hba-error
    The servers' load-balancing HBA configurations differ.
  backup-percentage-error
    The servers' backup-percentages differ.
  server-address-error
    A server received a failover message from a server not
    configured to be a failover partner.
  config-error
    A server received a binding-update message about a lease it is
    not configured with.
  internal-error
    A system, memory, or other internal error occurred.
eod

#
# SnmpInterface class - configures network interfaces for the CNR
# snmp server to use.
#

CLASS: SnmpInterface
CLASSID: 1610
CLASSVIZ: 5
CLASSNAME: 1
CLASSPCV: 7.0.0
CLASSDESC:: eod
An SNMP server interface. When interfaces
are configured, the server default behavior to
discover and bind to all interfaces is disabled.
eod

ATTR: name
ATTRID: 1
ATTRTYPE: AT_STRING
ATTRFLAGS: AF_REQUIRED,AF_UNIQUE,AF_IMMUTABLE
ATTRDESC:: eod
eod

ATTR: address
ATTRID: 2
ATTRTYPE: AT_SUBNET
ATTRDESC:: eod
The IP address and subnet mask of an interface that the SNMP server
should use.
eod

ATTR: snmp-port
ATTRID: 3
ATTRVIZ: 3
ATTRTYPE: AT_RANGEINT(1-65535)
ATTRDEFVAL: 4444
ATTRDESC:: eod
The port to listen on for incoming SNMP queries.
eod

#
# END of SnmpInterface class
#

#
# an event emitted when an ha dns partner is not communicating
#

CLASS: HaDnsPartnerDownEvent
CLASSID: 1612
CLASSVIZ: 5
CLASSPCV: 7.0.0
CLASSDESC:: eod
An event emitted when an HA DNS partner is not communicating,
that the SNMP server uses to generate
an SNMP notification to its list of trap recipients.
eod

ATTR: time
ATTRID: 1
ATTRTYPE: AT_DATE
ATTRDESC:: eod
The time at which the event occurred.
eod

ATTR: server-addr
ATTRID: 2
ATTRTYPE: AT_IPADDR
ATTRDESC:: eod
An (optional) address representing the source server.
eod

ATTR: partner-addr
ATTRID: 3
ATTRTYPE: AT_IPADDR
ATTRDESC:: eod
The address of the HA-DNS partner server.
eod

#
# an event emitted when interrupted communication with an
# ha dns partner is restored.
#

CLASS: HaDnsPartnerUpEvent
CLASSID: 1613
CLASSVIZ: 5
CLASSPCV: 7.0.0
CLASSDESC:: eod
An event emitted when interrupted communication with an HA DNS
partner is restored, that the SNMP server uses to generate an SNMP
notification to its list of trap recipients.
eod

ATTR: time
ATTRID: 1
ATTRTYPE: AT_DATE
ATTRDESC:: eod
The time at which the event occurred.
eod

ATTR: server-addr
ATTRID: 2
ATTRTYPE: AT_IPADDR
ATTRDESC:: eod
An (optional) address representing the source server.
eod

ATTR: partner-addr
ATTRID: 3
ATTRTYPE: AT_IPADDR
ATTRDESC:: eod
The address of the HA-DNS partner server.
eod

#
# indicates that a DNS secondary cannot reach any of its configured
# primaries to obtain a zone transfer.
#

CLASS: MastersNotRespondingEvent
CLASSID: 1614
CLASSVIZ: 5
CLASSPCV: 7.0.0
CLASSDESC:: eod
An event emitted when a DNS secondary cannot reach any of its
configured masters to obtain a zone transfer,
that the SNMP server uses to generate
an SNMP notification to its list of trap recipients.
eod

ATTR: time
ATTRID: 1
ATTRTYPE: AT_DATE
ATTRDESC:: eod
The time at which the event occurred.
eod

ATTR: server-addr
ATTRID: 2
ATTRTYPE: AT_IPADDR
ATTRDESC:: eod
An address representing the DNS server.
eod

ATTR: zone
ATTRID: 3
ATTRTYPE: AT_DNSNAME
ATTRDESC:: eod
The name of the zone that could not be transferred.
eod

ATTR: master-servers
ATTRID: 4
ATTRTYPE: AT_NLIST(AT_IPADDR)
ATTRDESC:: eod
The list of configured master server addresses.
eod

# Indicates that a DNS secondary reached any of its configured
# masters and obtained a zone transfer after encountering a
# 'not responding' condition involving that list of masters.
CLASS: MastersRespondingEvent
CLASSID: 1615
CLASSVIZ: 5
CLASSPCV: 7.0.0
CLASSDESC:: eod
An event emitted when a DNS secondary restored successful
communication with one of its masters and obtained a zone transfer,
that the SNMP server uses to generate
an SNMP notification to its list of trap recipients.
eod

ATTR: time
ATTRID: 1
ATTRTYPE: AT_DATE
ATTRDESC:: eod
The time at which the event occurred.
eod

ATTR: server-addr
ATTRID: 2
ATTRTYPE: AT_IPADDR
ATTRDESC:: eod
An address representing the DNS server.
eod

ATTR: zone
ATTRID: 3
ATTRTYPE: AT_DNSNAME
ATTRDESC:: eod
The name of the zone that was transferred.
eod

ATTR: master-servers
ATTRID: 4
ATTRTYPE: AT_NLIST(AT_IPADDR)
ATTRDESC:: eod
The list of configured master server addresses.
eod

#
# indicates that a DNS secondary was unable to reach any primaries,
# and that a zone has expired because the ttl has passed.
#

CLASS: SecondaryZoneExpiredEvent
CLASSID: 1616
CLASSVIZ: 5
CLASSPCV: 7.0.0
CLASSDESC:: eod
An event emitted when a DNS secondary was unable to reach any
masters, and that a zone has expired because the TTL has passed,
that the SNMP server uses to generate
an SNMP notification to its list of trap recipients.
eod

ATTR: time
ATTRID: 1
ATTRTYPE: AT_DATE
ATTRDESC:: eod
The time at which the event occurred.
eod

ATTR: server-addr
ATTRID: 2
ATTRTYPE: AT_IPADDR
ATTRDESC:: eod
An address representing the DNS server.
eod

ATTR: zone
ATTRID: 3
ATTRTYPE: AT_DNSNAME
ATTRDESC:: eod
The name of the zone that could not be transferred.
eod

ATTR: master-servers
ATTRID: 4
ATTRTYPE: AT_NLIST(AT_IPADDR)
ATTRDESC:: eod
The list of configured master server addresses.
eod

#
# indicates that a DNS slave was not able to reach any of its
# configured forwarders.
#

CLASS: DnsForwardersNotRespondingEvent
CLASSID: 1617
CLASSVIZ: 5
CLASSPCV: 7.0.0
CLASSDESC:: eod
An event emitted when a DNS slave was not able to reach any of its
configured forwarders, that the SNMP server uses to generate
an SNMP notification to its list of trap recipients.
eod

ATTR: time
ATTRID: 1
ATTRTYPE: AT_DATE
ATTRDESC:: eod
The time at which the event occurred.
eod

ATTR: server-addr
ATTRID: 2
ATTRTYPE: AT_IPADDR
ATTRDESC:: eod
An address representing the DNS server.
eod

ATTR: forwarders
ATTRID: 3
ATTRTYPE: AT_NLIST(AT_IPADDR)
ATTRDESC:: eod
The list of configured forwarder addresses.
eod

#
# indicates that a DNS slave was able to reach any of its
# configured forwarders, after encountering a 'forwarders not
# responding' condition.
#

CLASS: DnsForwardersRespondingEvent
CLASSID: 1618
CLASSVIZ: 5
CLASSPCV: 7.0.0
CLASSDESC:: eod
An event emitted when a DNS slave was able to reach any of its
configured forwarders after encountering a 'forwarders not
responding' condition, that the SNMP server uses to generate
an SNMP notification to its list of trap recipients.
eod

ATTR: time
ATTRID: 1
ATTRTYPE: AT_DATE
ATTRDESC:: eod
The time at which the event occurred.
eod

ATTR: server-addr
ATTRID: 2
ATTRTYPE: AT_IPADDR
ATTRDESC:: eod
An address representing the DNS server.
eod

ATTR: forwarders
ATTRID: 3
ATTRTYPE: AT_NLIST(AT_IPADDR)
ATTRDESC:: eod
The list of configured forwarder addresses.
eod

#
# indicates a configuration mismatch between two HA-DNS partners
#

CLASS: HaDnsConfigErrEvent
CLASSID: 1619
CLASSVIZ: 5
CLASSPCV: 7.0.0
CLASSDESC:: eod
An event emitted when an HA DNS server discovers that a
configuration mismatch with its partner exists which will prevent
DNS updates from being accepted for a zone, that the SNMP server
uses to generate an SNMP notification to its list of trap
recipients.
eod

ATTR: time
ATTRID: 1
ATTRTYPE: AT_DATE
ATTRDESC:: eod
The time at which the event occurred.
eod

ATTR: server-addr
ATTRID: 2
ATTRTYPE: AT_IPADDR
ATTRDESC:: eod
An (optional) address representing the source server.
eod

ATTR: partner-addr
ATTRID: 3
ATTRTYPE: AT_IPADDR
ATTRDESC:: eod
The address of the HA-DNS partner server.
eod

ATTR: zone
ATTRID: 4
ATTRTYPE: AT_DNSNAME
ATTRDESC:: eod
The name of the zone affected by the configuration error.
eod


CLASS: LeaseHistoryFilter
CLASSID: 1620
CLASSPCV: 7.0.0
CLASSDESC:: eod
A filter used to limit the set lease history records returned by
the server, when querying the CCM server for a list records.
eod

ATTR: ip-address
ATTRID: 1
ATTRTYPE: AT_IPADDR
ATTRDESC:: eod
If set, query the lease history database for a single
IP address match.
eod

ATTR: mac-address
ATTRID: 2
ATTRTYPE: AT_MACADDR
ATTRDESC:: eod
If set, query the lease history database for a single
MAC address match.
eod

ATTR: start-date
ATTRID: 3
ATTRTYPE: AT_DATE
ATTRDESC:: eod
The earliest date of lease histories to be displayed.
When unset, no filtering is applied by start date.
eod

ATTR: end-date
ATTRID: 4
ATTRTYPE: AT_DATE
ATTRDESC:: eod
The latest date of lease histories to be displayed.
When unset, no filtering is applied by end date.
eod

ATTR: vpn-id
ATTRID: 5
ATTRTYPE: AT_INT
# Encode attribute 4 of VPN(1127) as 4<<16 + 1127 == 263271
ATTRVAL: 263271
ATTRDEFVAL: 0
ATTRDESC:: eod
If set, filter lease history data by this VPN identifier.
If unset or 0, query applies to the global VPN.
eod

ATTR: all-vpns
ATTRID: 6
ATTRVIZ: 3
ATTRTYPE: AT_BOOL
ATTRDEFVAL: false
ATTRDESC:: eod
If true, return lease history records irrespective of their
VPN identifier.
If false, query records from the VPN specified in the vpn-id
attribute.
eod

ATTR: start-ip-address
ATTRID: 7
ATTRTYPE: AT_IPADDR
ATTRDESC:: eod
Specifies the starting IP address for query for a range
of data from the lease history database.
This value is ignored if the ip-address or mac-address
attributes are set (indicating a query for a single
IP or MAC address is desired).
eod

ATTR: end-ip-address
ATTRID: 8
ATTRTYPE: AT_IPADDR
ATTRDESC:: eod
Specifies the ending IP address for query for a range
of data from the lease history database.
This value is ignored if the ip-address or mac-address
attributes are set (indicating a query for a single
IP or MAC address is desired).
eod

#
# This class is used to represent the external view in the server
#

CLASS: DNSViewConfig
CLASSID: 1621
CLASSNAME: 1
CLASSVIZ: 5
CLASSDESC:: eod
A Dns View Config class defines the View properties.
eod

ATTR: name
ATTRID: 1
ATTRTYPE: AT_STRING
ATTRFLAGS: AF_REQUIRED, AF_UNIQUE
ATTRDESC:: eod
The name of the view.
eod

ATTR: id
ATTRID: 2
ATTRTYPE: AT_INT
ATTRFLAGS: AF_REQUIRED, AF_IMMUTABLE, AF_UNIQUE
ATTRDESC:: eod
The View's unique identifier.  This is a 32 bit value that is
associated with zones.
eod

ATTR: description
ATTRID: 3
ATTRTYPE: AT_STRING
ATTRDESC:: eod
Describes this view.
eod

ATTR: cluster
ATTRID: 4
ATTRTYPE: AT_OID
ATTRDESC:: eod
Identifies the remote cluster for this view.
eod

ATTR: last-sync-dbsn
ATTRID: 5
ATTRTYPE: AT_INT
ATTRDESC:: eod
The last successful sync dbsn for this view.
eod

ATTR: last-staged-dbsn
ATTRID: 6
ATTRTYPE: AT_INT
ATTRDESC:: eod
The last staged dbsn for this view. If last-staged-dbsn is greater
then last-sync-dbsn then there are staged changes for this view.
eod

ATTR: zone-template
ATTRID: 7
ATTRTYPE: AT_OID
ATTRDESC:: eod
The default zone template to use when creating zone for this view.
eod

#
# Class contains DNS Utilization Stats.
#
CLASS: DNSServerUtilizationStats
CLASSID: 1622
CLASSPCV: 7.0.0
CLASSDESC:: eod
The utilization statistics available from the DNS server.
eod

ATTR: total-A-records
ATTRID: 1
ATTRTYPE: AT_INT
ATTRDESC:: eod
Number of A records managed by the DNS Server.
eod

ATTR: total-AAAA-records
ATTRID: 2
ATTRTYPE: AT_INT
ATTRDESC:: eod
Number of A records managed by the DNS Server.
eod

#
# free-address-low6 snmp event class
#

CLASS: FreeAddressLow6Event
CLASSID: 1623
CLASSVIZ: 5
CLASSPCV: 8.0.0
CLASSDESC:: eod
The CNR class representing a DHCPv6 low-address threshold event sent
by a DHCP server.
eod

ATTR: time
ATTRID: 1
ATTRTYPE: AT_DATE
ATTRDESC:: eod
The time at which the event occurred.
eod

ATTR: link-name
ATTRID: 2
ATTRTYPE: AT_STRING
ATTRDESC:: eod
The name of the link or prefix, depending on 'type', experiencing the 
low-address-threshold event.
eod

ATTR: value
ATTRID: 3
ATTRTYPE: AT_INT
ATTRDESC:: eod
The value at the time the event was triggered. The trigger value
is represented as a counter value.
eod

ATTR: threshold
ATTRID: 4
ATTRTYPE: AT_PERCENT
ATTRDESC:: eod
Specifies the configured percent threshold that was crossed.
If threshold-count is populated, it should be used, otherwise
threshold-pct is to be used.
eod

ATTR: prefix-addr
ATTRID: 5
ATTRTYPE: AT_PREFIX
ATTRDESC:: eod
The address of this prefix.  This attribute is available only 
if the trap 'type' is prefix.
eod

ATTR: type
ATTRID: 6
ATTRTYPE: AT_ENUMINT(prefix=1, link=2, selection-tags=3)
ATTRFLAGS: AF_PRINT_ALT
ATTRDESC:: eod
Indicates whether the threshold was configured at the level of a
single prefix, an entire group of prefixes sharing the same link, 
or a group of prefixes sharing the same link and selection tags.
eod

ATTR: type-desc
ATTRID: 7
ATTRTYPE: AT_STRING
ATTRDESC:: eod
Extra information about the grouping that the prefix is part
of. For a single prefix, it is the prefix's address.
For link groupings, it is the link for the prefix.
For selection-tag groupings, it is the prefix's selection tags.
Note: Either the threshold-count or the threshold-pct (not both) will 
be set. If both happen to be set, threshold-count takes precedence. 
eod

#
# free-address-high6 event class
#

CLASS: FreeAddressHigh6Event
CLASSID: 1624
CLASSVIZ: 5
CLASSPCV: 8.0.0
CLASSDESC:: eod
The CNR class representing a DHCPv6 high-address threshold event sent
by a DHCP server.
eod

ATTR: time
ATTRID: 1
ATTRTYPE: AT_DATE
ATTRDESC:: eod
The time at which the event occurred.
eod

ATTR: link-name
ATTRID: 2
ATTRTYPE: AT_STRING
ATTRDESC:: eod
The name of the link, or prefix depending on 'type, experiencing the 
high-address-threshold event.
eod

ATTR: value
ATTRID: 3
ATTRTYPE: AT_INT
ATTRDESC:: eod
The value at the time the event was triggered. The trigger value
is represented as a counter value.
eod

ATTR: threshold
ATTRID: 4
ATTRTYPE: AT_PERCENT
ATTRDESC:: eod
Specifies the configured percentage threshold that was crossed.
If threshold-count is populated, it should be used, otherwise
threshold-pct is to be used.
eod

ATTR: prefix-addr
ATTRID: 5
ATTRTYPE: AT_PREFIX
ATTRDESC:: eod
The prefix address of the prefix.  This attribute is available 
only if the trap 'type' is prefix.
eod

ATTR: type
ATTRID: 6
ATTRTYPE: AT_ENUMINT(prefix=1, link=2, selection-tags=3)
ATTRFLAGS: AF_PRINT_ALT
ATTRDESC:: eod
Indicates whether the threshold was configured at the level of a
single prefix, an entire group of prefixes sharing the same link, 
or a group of prefixes sharing the same link and selection tags.
eod

ATTR: type-desc
ATTRID: 7
ATTRTYPE: AT_STRING
ATTRDESC:: eod
Extra information about the grouping that the prefix is part
of.  For a single prefix, it is the prefix's address.
For link groupings, it is the link for the scope.
For selection-tag groupings, it is the prefix's selection tags.
Note: Either the threshold-count or the threshold-pct (not both)
will be set. If both happen to be set, threshold-count takes 
precedence. 
eod


#
# duplicate-IP-address-v6-detected event class
#

CLASS: DuplicateAddress6Event
CLASSID: 1625
CLASSVIZ: 5
CLASSPCV: 8.0.0
CLASSDESC:: eod
An event, triggered when a duplicate DHCPv6 address assignment is
detected, that the SNMP server uses to generate
an SNMP notification to its list of trap recipients.
eod

ATTR: time
ATTRID: 1
ATTRTYPE: AT_DATE
ATTRDESC:: eod
The time at which the event occurred.
eod

ATTR: address
ATTRID: 2
ATTRTYPE: AT_IP6ADDR
ATTRDESC:: eod
The IPv6 address that triggered the event.
eod

ATTR: detected-by
ATTRID: 3
ATTRTYPE: AT_ENUMINT(dhcp-server=1,dhcp-client=2)
ATTRDESC:: eod
Indicates whether the DHCP server detected the presence of a duplicate
address (using a ping, e.g.), or a DHCP client detected the duplicate
(using Duplicate Address Detection (DAD), e.g.).
eod

ATTR: client-id
ATTRID: 4
ATTRTYPE: AT_BLOB
ATTRDESC:: eod
The (optional) Client Identifier option (DUID) for the client.
eod

ATTR: client-lookup-key
ATTRID: 5
ATTRTYPE: AT_BLOB
ATTRDESC:: eod
The (optional) lookup key for the client.
eod

ATTR: client-lookup-key-type
ATTRID: 6
ATTRTYPE: AT_INT
ATTRDESC:: eod
The (optional) type of lookup-key (AT_BLOB or AT_NSTRING).
eod

#
# duplicate-IP-prefix-v6-detected event class
#

CLASS: DuplicatePrefix6Event
CLASSID: 1626
CLASSVIZ: 5
CLASSPCV: 8.0.0
CLASSDESC:: eod
An event, triggered when a duplicate DHCPv6 prefix assignment is
detected, that the SNMP server uses to generate
an SNMP notification to its list of trap recipients.
eod

ATTR: time
ATTRID: 1
ATTRTYPE: AT_DATE
ATTRDESC:: eod
The time at which the event occurred.
eod

ATTR: prefix
ATTRID: 2
ATTRTYPE: AT_PREFIX
ATTRDESC:: eod
The IPv6 prefix that triggered the event.
eod

ATTR: detected-by
ATTRID: 3
ATTRTYPE: AT_ENUMINT(dhcp-server=1,dhcp-client=2)
ATTRDESC:: eod
Indicates whether the DHCP server detected the presence of a duplicate
prefix or a DHCP client detected the duplicate 
(using Duplicate Address Detection (DAD), e.g.).
eod

ATTR: client-id
ATTRID: 4
ATTRTYPE: AT_BLOB
ATTRDESC:: eod
The (optional) Client Identifier option (DUID) for the client.
eod

ATTR: client-lookup-key
ATTRID: 5
ATTRTYPE: AT_BLOB
ATTRDESC:: eod
The (optional) lookup key for the client.
eod

ATTR: client-lookup-key-type
ATTRID: 6
ATTRTYPE: AT_INT
ATTRDESC:: eod
The (optional) type of lookup-key (AT_BLOB or AT_NSTRING).
eod



