#
# a description of the CCM datastore schema in ao_datadict format
#

SCHEMA: 1.1.0
CLASS: CCMZone
CLASSID: 1410
CLASSNAME: 1
CLASSPCV: 4.0.0
CLASSDESC:: eod
A forward primary DNS zone.
Describes the configuration for a primary DNS
zone. CCMReverseZone is a similar class for reverse zones.
eod

ATTR: origin
ATTRID: 1
ATTRTYPE: AT_DNSNAME
ATTRFLAGS: AF_REQUIRED,AF_IMMUTABLE
ATTRDESC:: eod
Displays the fully-qualified name of the zone's root.  The zone name.
eod

ATTR: records
ATTRID: 2
ATTRTYPE: AT_NLIST(AT_OBJ(CCMRRSet))
# 0x10000 + classid(CCMRRSet)=1417
ATTRVAL: 66953
ATTRVIZ: 1
DEPRECATED: 7.0
ATTRDESC:: eod
If we ever try to manage lots of small zones (< 100 RRs or so,
maybe more), then it will be easier to manage the zone and its
RRs as a single object rather than as a related group of objects.

We will need to continue supporting zones with many thousands
of RRs, so we will never remove support for the more complex
and more scalable CCMRRSet/CCMZone model.
eod

ATTR: parent
ATTRID: 3
ATTRTYPE: AT_NAMEREF(CCMZone.origin)
ATTRVAL: 1410
ATTRVIZ: 1
DEPRECATED: 7.0
ATTRDESC:: eod
The name of the parent zone, not used since it is fairly easy to
find the most containing zone name.
eod

ATTR: restrict-xfer
ATTRID: 6
ATTRTYPE: AT_BOOL
ATTRDEFVAL: false
ATTRDESC:: eod
Limits sending zone transfers to a specific set of hosts. If
you restrict zone transfers, use the restrict-xfer-acl attribute
to specify the access control list that defines which servers
can perform zone transfers.
eod

ATTR: dynamic
ATTRID: 7
ATTRTYPE: AT_BOOL
ATTRDEFVAL: true
ATTRDESC:: eod
Enables RFC 2136 dynamic updates to the zone. The most typical source
of these updates is a DHCP server.
eod

ATTR: restricted-set
ATTRID: 8
ATTRTYPE: AT_NLIST(AT_IPADDR)
# AT_IPADDR = 4
ATTRVAL: 4
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

# Not used in 6.0
# ATTR: dynupdate-set
# ATTRID: 9
# ATTRTYPE: AT_NLIST(AT_IPADDR)

ATTR: notify
ATTRID: 11
ATTRTYPE: AT_BOOL
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
ATTRTYPE: AT_NLIST(AT_IPADDR)
# AT_IPADDR = 4
ATTRVAL: 4
ATTRDESC:: eod
Lists additional servers to notify of changes to this zone.  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

ATTR: update-acl
ATTRID: 13
ATTRTYPE: AT_AMELST
ATTRDESC:: eod
Specifies the access control list for DNS updates to the zone,
given as an address match element list. The access control list
is not applied to administrative edits managed through the CCM server.
eod

ATTR: template
ATTRID: 20
# AT_OBJREF(CCMZoneTemplate)
ATTRTYPE: AT_OID
ATTRVAL: 1424
ATTRVIZ: 1
DEPRECATED: 7.0
ATTRDESC:: eod
Identifies the zone template last applied to the zone.
eod

ATTR: serial
ATTRID: 21
ATTRTYPE: AT_INT
ATTRFLAGS: AF_REQUIRED
ATTRDESC:: eod
Displays an administratively specified serial number. The serial
number value must always increase; therefore, this serial number is
only applied to the zone if it is greater than the actual (dynamic)
serial number.
eod

ATTR: soattl
ATTRID: 30
ATTRTYPE: AT_DNSTTL
ATTRDESC:: eod
Displays the time-to-live (ttl) value applied to the SOA
resource record of the zone.
eod

ATTR: ns
ATTRID: 31
ATTRTYPE: AT_DNSNAME
ATTRFLAGS: AF_REQUIRED
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: 32
ATTRTYPE: AT_DNSNAME
ATTRFLAGS: AF_REQUIRED
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: 33
ATTRTYPE: AT_RANGETIME(1-2147483647)
ATTRFLAGS: AF_INITIALIZE
ATTRDEFVAL: 3h
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: 34
ATTRTYPE: AT_RANGETIME(1-2147483647)
ATTRFLAGS: AF_INITIALIZE
ATTRDEFVAL: 1h
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. The retry interval must be
less than (expire - refresh).
eod

ATTR: expire
ATTRID: 35
ATTRTYPE: AT_RANGETIME(1-2147483647)
ATTRFLAGS: AF_INITIALIZE
ATTRDEFVAL: 1w
ATTRDESC:: eod
Sets the number of seconds that a secondary server can continue
providing zone data without confirming that the data remains current.
The expire interval must be greater than the refresh interval.
eod

ATTR: minttl
ATTRID: 36
ATTRTYPE: AT_RANGETIME(0-2147483647)
ATTRFLAGS: AF_INITIALIZE
ATTRDEFVAL: 10m
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: defttl
ATTRID: 37
ATTRTYPE: AT_RANGETIME(0-2147483647)
ATTRFLAGS: AF_INITIALIZE, AF_REQUIRED
ATTRDEFVAL: 24h
ATTRDESC:: eod
Controls the default TTL value used for resource records in this
zone that do not specify a TTL.
eod

ATTR: nameservers
ATTRID: 38
ATTRTYPE: AT_NLIST(AT_DNSNAME)
# AT_DNSNAME = 35
ATTRVAL: 35
ATTRFLAGS: AF_REQUIRED
ATTRDESC:: eod
Lists the  nameservers for this zone.
eod

ATTR: nsttl
ATTRID: 39
ATTRTYPE: AT_DNSTTL
ATTRDESC:: eod
Displays the ttl value applied to the NS resource records of
the zone.
eod

ATTR: checkpoint-interval
ATTRID: 103
ATTRTYPE: AT_RANGETIME(1h-1w)
#ATTRTYPE: AT_RANGETIME(3600-604800)
ATTRDEFVAL: 3h
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
ATTRTYPE: AT_BOOL
ATTRDEFVAL: false
ATTRDESC:: eod
Enables dynamic resource-record scavenging for the zone. This
attribute removes stale records when clients are
configured to perform DNS updates but do not delete their
entries when they're no longer valid. If the DHCP server is used
to perform updates, it will also delete records when client
leases expire. Scavenging should not be enabled on these zones.
eod

ATTR: scvg-interval
ATTRID: 105
ATTRTYPE: AT_RANGETIME(1h-365d)
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
ATTRTYPE: AT_RANGETIME(1h-365d)
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 becomes 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-refresh-interval
ATTRID: 107
ATTRTYPE: AT_RANGETIME(1h-365d)
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
ATTRTYPE: AT_INT
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
ATTRTYPE: AT_RANGETIME(2h-24h)
ATTRDESC:: eod
Ensures that the server does not reset the scavenging time
whenever a server restarts. With 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
ATTRTYPE: AT_RANGETIME(1s-24h)
ATTRDESC:: eod
Sets the number of seconds the server waits after scavenging
one set of records before going to the next set.
eod

ATTR: checkpoint-min-interval
ATTRID: 111
ATTRTYPE: AT_RANGETIME(60-2700)
ATTRDESC:: eod
Specifies 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 resource records.
eod

ATTR: scvg-max-records
ATTRID: 112
ATTRTYPE: AT_RANGEINT(1-10000)
ATTRDESC:: eod
Sets the maximum number of records to remove from a zone during
its scavenging interval.
eod

ATTR: full-reload-recovery-options
ATTRID: 119
ATTRTYPE: AT_ENUMINT(abort-on-error=0, resume-roll-forward-on-err=1, remove-from-changeset-db=2, remove-dynamic-rrs=3)
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
eventhough 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 lost
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: owner
ATTRID: 120
ATTRTYPE: AT_OBJREF(CCMOwner)
ATTRVAL: 1416
ATTRDESC:: eod
Names the owner of this zone. Use the owner field to group
similarly owned zones and to limit administrative access.
eod

ATTR: dist-map
ATTRID: 121
ATTRTYPE: AT_OBJREF(CCMZoneDistribution)
ATTRVAL: 1423
ATTRDESC:: eod
Identifies the zone distribution map associated with the
specified zone. The zone distribution map describes which
primary and secondary DNS servers should provide DNS service
for this zone.
eod

ATTR: secondaries
ATTRID: 122
ATTRTYPE: AT_NLIST(AT_OBJREF(CCMServer))
# 2 << 16 | classid(CCMServer) 1421
ATTRVAL: 132493
ATTRVIZ: 1
DEPRECATED: 7.0
ATTRDESC:: eod
This is not used, now that we have the zone-distribution map to
handle the relationship between primary and secondary servers.
eod

ATTR: subzone-forward
ATTRID: 123
ATTRTYPE: AT_ENUMINT(normal=0, no-forward=1)
ATTRFLAGS: AF_PRINT_ALT
ATTRDEFVAL: normal
ATTRDESC:: eod
Specifies whether subzones use forwarders or not. When no-forward is
set, any query for the zone is not sent to the forwarder. This
is an extended resolution exception.
eod

ATTR: mcd-major
ATTRID: 124
ATTRTYPE: AT_INT
ATTRVIZ: 1
ATTRDESC:: eod
Unique major version number of the zone. Indicates whether a zone has
been deleted and re-added.
eod

ATTR: restrict-xfer-acl
ATTRID: 125
ATTRTYPE: AT_AMELST
ATTRDESC:: eod
Identifies the access control list designating who can receive
zone transfers from this zone.
eod

# 126 is master-servers for secondary zone

ATTR: cluster-id
ATTRID: 127
ATTRTYPE: AT_SHORT
ATTRFLAGS: AF_REFERENCE, AF_IMMUTABLE
# Encode attribute 11 of Cluster(1449) as 11<<16 + 1449 == 722345
ATTRVAL: 722345
ATTRVIZ: 1
DEPRECATED: 7.0
ATTRDESC:: eod
The id of the (local) cluster that is the primary DNS server for
this zone.  This attribute is set as part of replica data
propagation.
eod

ATTR: replica-deleted
ATTRID: 128
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: restrict-query-acl
ATTRID: 129
ATTRTYPE: AT_AMELST
ATTRDESC:: eod
Specifies the zone access control list (ACL) used to restrict
the queries that the DNS server for this zone accepts. This list
can contain host IPs, network addresses, TSIG keys, and (global)
ACLs.  Only queries from clients defined in the ACL are accepted.
If unset, the zone inherits the value of the server's
restrict-query-acl attribute.
eod

ATTR: import-file
ATTRID: 130
ATTRVIZ: 1
ATTRTYPE: AT_STRING
ATTRDESC:: eod
The file containing the RRs for this zone.
eod

ATTR: ixfr-base-file
ATTRID: 131
ATTRVIZ: 1
ATTRTYPE: AT_STRING
ATTRDESC:: eod
The file for ixfr-base.
eod

ATTR: ixfr-tmp-file
ATTRID: 132
ATTRVIZ: 1
ATTRTYPE: AT_STRING
ATTRDESC:: eod
The file for ixfr-tmp.
eod

ATTR: zone-rrdata
ATTRID: 133
ATTRVIZ: 1
DEPRECATED: 7.0
ATTRTYPE: AT_NLIST(AT_PACK(SSIB*))
ATTRDESC:: eod
An experimental attribute to hold the AT_PACK(SSIB*) type, class, ttl
and data records for the zone itself.  This is the same as the
static-rrs attribute of the RRSet with the name '@'.  It does
not contain the SOA or NS records that are stored and managed
as zone attributes.
eod

ATTR: update-policy-list
ATTRID: 134
ATTRTYPE: AT_NLIST(AT_STRING)
ATTRDESC:: eod
Lists the DNS update policies used to authorize or deny DNS
updates. This attribute is ignored if the update-acl attribute
is also set.
eod


ATTR: name-protection
ATTRID: 136
ATTRVIZ: 3
ATTRTYPE: AT_BOOL
ATTRDEFVAL: true
ATTRDESC:: eod
When enabled, protects RR name-sets (all RRs of the same name)
from dynamic updates. When disabled, dynamic updates can alter
name-sets, if update policies are configured to allow the
update.

Note: Disabling name-protection permits dynamic update changes
on protected name-sets. This introduces inconsistencies between
DNS RR name-sets and the CCM server's view of protected RRs and
hosts you must manually correct.
eod

# never used: 137 - name-protection-default

ATTR: latest-sync-dbsn
ATTRID: 138
ATTRTYPE: AT_INT
ATTRDEFVAL: 0
ATTRVIZ: 3
ATTRDESC:: eod
Indicates the DBSN value the last time this zone was successfully
synchronized from CCM to the DNS server or local cluster.
eod

ATTR: latest-staged-zone-edit-dbsn
ATTRID: 139
ATTRTYPE: AT_INT
ATTRDEFVAL: 0
ATTRVIZ: 3
ATTRDESC:: eod
Indicates the DBSN value the last time a staged edit to this zone
was successfully completed in CCM.

If the value of this attribute is greater than latest-sync-dbsn,
then there are staged edits to the zone data itself which are
pending synchronization to DNS or local cluster.
eod

ATTR: latest-staged-rr-or-host-edit-dbsn
ATTRID: 140
ATTRTYPE: AT_INT
ATTRDEFVAL: 0
ATTRVIZ: 3
ATTRDESC:: eod
Indicates the DBSN value the last time a staged edit to a
CCMHost or CCMRRSet associated with this zone was successfully
completed in CCM.

If the value of this attribute is greater than latest-sync-dbsn,
then there are staged edits to the zone's RRs or hosts which are
pending synchronization to DNS or local cluster.
eod

ATTR: region
ATTRID: 141
ATTRTYPE: AT_OBJREF(CCMRegion)
ATTRVAL: 1425
ATTRDESC:: eod
Associates a region with the specified object.  Use
the region field to group similarly located zones and
to limit administrative access.
eod

ATTR: parent-zone
ATTRID: 142
##ATTRTYPE: AT_NAMEREF(CCMZone)
ATTRTYPE: AT_DNSNAME
ATTRFLAGS: AF_IMMUTABLE
ATTRVIZ: 1
ATTRVAL: 1410
ATTRDESC:: eod
The name (origin) of the parent zone, if this zone was created
as a subzone.
eod

ATTR: view
ATTRID: 154
ATTRTYPE: AT_INT
ATTRVIZ: 1 # Not ready yet
ATTRDESC:: eod
Identifies the view for this zone, if not specified then
the default view (0) is used.
eod

ATTR: exclude-from-ha-dns
ATTRID: 155
ATTRTYPE: AT_BOOL
ATTRDEFVAL: FALSE
ATTRVIZ: 3
ATTRDESC:: eod
When enabled, the zone is excluded from HA DNS processing.
eod

#end of CCMZone

CLASS: CCMAddrBlock
CLASSID: 1411
CLASSNAME: 2
CLASSPCV: 4.0.0
CLASSDESC:: eod
Defines a block of IPv4 address space. Blocks may be nested
to segment or group blocks of address space, and may have
either additional CCMAddrBlock objects or CCMSubnet objects
as children.
eod

ATTR: parent
ATTRID: 1
# AT_OBJREF(CCMAddrBlock)
ATTRTYPE: AT_OID
ATTRVAL: 1411
ATTRDESC:: eod
Identifies the parent address block.
eod

ATTR: address
ATTRID: 2
ATTRTYPE: AT_SUBNET
ATTRFLAGS: AF_REQUIRED | AF_IMMUTABLE
ATTRDESC:: eod
Specifies the IP address and mask of the CCM address block,
which was set at creation. This defines the address range
of the block. Use the set command to redefine the address.
eod

# make this a vpn-id rather than an OID since we are
# using the 4 byte vpn id throughout the system
ATTR: vpn-id
ATTRID: 3
ATTRTYPE: AT_INT
ATTRFLAGS: AF_REFERENCE | AF_IMMUTABLE
# Encode attribute 4 of Namespace(1127) as 4<<16 + 1127 == 263271
ATTRVAL: 263271
ATTRDEFVAL: 0
ATTRDESC:: eod
Identifies the ID the VPN object used to support multiple
address spaces, such as in a managed VPN environment.
eod

ATTR: type
ATTRID: 4
ATTRTYPE: AT_NAMEREF(CCMAddrSpaceType)
ATTRVAL: 1446
ATTRDESC:: eod
Defines an addresss-block type, enabling you to group
address blocks that share common properties, such as their
associated scope template. This attribute names a
CCMAddrSpaceType object that contains more information about
the type.
eod

ATTR: region
ATTRID: 5
# AT_OBJREF(CCMRegion)
ATTRTYPE: AT_OID
ATTRVAL: 1425
ATTRDESC:: eod
Names the region associated with this address block. Use the
region field to group similarly located address blocks and to
limit administrative access.
eod

ATTR: owner
ATTRID: 6
# AT_OBJREF(CCMOwner)
ATTRTYPE: AT_OID
ATTRVAL: 1416
ATTRDESC:: eod
Names the owner of this address block. Use the owner field
to group similarly owned address blocks; to limit administrative
access; and to track allocation or delegation for ARIN
reporting purposes.
eod

ATTR: tags
ATTRID: 7
ATTRTYPE: AT_NLIST(AT_STRING)
# AT_STRING = 5
ATTRVAL: 5
ATTRVIZ: 1
ATTRDESC:: eod
The selection tags for this address block. Network Registrar
scopes that are allocated from address space within this address
block have these selection tags set.

eod

ATTR: disabled
ATTRID: 9
ATTRTYPE: AT_BOOL
ATTRVIZ: 1
ATTRDESC:: eod
Is this address block disabled?

Is this used?
eod

ATTR: rev-zones
ATTRID: 10
ATTRTYPE: AT_NLIST(AT_OBJREF(CCMReverseZone))
# 2 << 16 | classid(CCMReverseZone) 1427
ATTRVAL: 132499
ATTRVIZ: 1
ATTRDESC:: eod
What ReverseZones (if any) are associated with this address block.
There may be many reverse zones in the case of a non-octet (8, 16, 24)
network mask.  In the case of a /20 delegation, there will be 16
distinct class C ReverseZones associated with the AddrBlock.

This list can be calculated from the list of ReverseZone objects
and this blocks network address (all within the same vpn).
For now, we are going to specify that the relationship is maintained
at creation/deletion time for AddrBlocks and ReverseZones rather
than calculated at query time.

This is not used in 6.1.
eod

ATTR: source
ATTRID: 11
#ATTRTYPE: AT_OBJREF(CCMOwner)
ATTRTYPE: AT_OID
ATTRVAL: 1416
ATTRDESC:: eod
Points to the CCMOwner configuration object representing
the source for a top-level block allocated from a higher-level
source.
eod

ATTR: sink
ATTRID: 12
#ATTRTYPE: AT_OBJREF(CCMCluster|CCMOwner)
ATTRTYPE: AT_OID
ATTRVAL: 1449
ATTRDESC:: eod
Points to either the CCMOwner or CCMCluster for a
a leaf block delegated to a lower-level sink.

Delegated AddrBlocks (those with a non-null sink attribute)
cannot be further split into child address blocks or subnets.
eod

ATTR: description
ATTRID: 13
ATTRTYPE: AT_STRING
ATTRDESC:: eod
Describes how this address block is used.
eod

ATTR: scopetemplate
ATTRID: 14
#ATTRTYPE: AT_OBJREF(CCMScopeTemplate)
ATTRTYPE: AT_OID
ATTRVAL: 1426
ATTRVIZ: 1
DEPRECATED: 7.0
ATTRDESC:: eod
Specifies an optional scope template for use when creating
Scope objects from subnets allocated from this address block.
eod

# keep 15 and 16 free for commonality with CCMSubnet

ATTR: cluster-id
ATTRID: 17
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
Identifies 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: 18
ATTRTYPE: AT_BYTE
ATTRVIZ: 1
DEPRECATED: 7.0
ATTRDESC:: eod
A marker showing 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: forward-zone-name
ATTRID: 19
ATTRTYPE: AT_DNSNAME
ATTRDESC:: eod
Names the forward zone associated with this block.
eod

ATTR: reverse-zone-name
ATTRID: 20
ATTRTYPE: AT_DNSNAME
ATTRDESC:: eod
Names the reverse zone associated with this block.
eod

ATTR: report-state
ATTRID: 21
ATTRTYPE: AT_ENUMINT(available=0, internal=1, reallocated=2, reassigned=3)
ATTRFLAGS: AF_TRANSIENT
ATTRDESC:: eod
Transient report state of the CCM address block, provided
to make it easier for ARIN reporting and for clients to
filter the list of address blocks they display.
    0  available
    1  internal
    2  reallocated
    3  reassigned
eod

# CLASSID: 1412 is free
# it was previously CCMAdmin, which was moved to ao_datadict


CLASS: CCMAdminGroup
CLASSID: 1413
CLASSNAME: 1
CLASSPCV: 4.0.0
CLASSDESC:: eod
A named group of administrator roles. The role's association
with the group is specified by the CCMRoleInstance object.
CCMAdmin objects define the list of group(s) for which an
administrator is a member.
eod

ATTR: name
ATTRID: 1
ATTRTYPE: AT_STRING
ATTRFLAGS: AF_REQUIRED,AF_UNIQUE
ATTRDESC:: eod
Names this group of administrator roles.
eod

ATTR: desc
ATTRID: 2
ATTRTYPE: AT_STRING
ATTRDESC:: eod
Describes this group.
eod

#
# the failover-pair class
#

CLASS: CCMFailoverPair
CLASSID: 1414
CLASSPCV: 5.0.0
CLASSNAME: 1
CLASSDESC:: eod
Defines a DHCP failover pair. A CCMFailoverPair object defines
the main and backup clusters in the pair, and associated
failover attributes which must be synchronized. This class is
analogous to the CCMHaDnsPair class used to manage HA DNS pairs.
It is used to synchronize  configuration data on the main and backup
DHCP servers.

Each pair of main and backup clusters configured in a
CCMFailoverPair object must be unique. On a local cluster,
the localhost cluster must be either the main or backup in the pair.
eod

ATTR: name
ATTRID: 1
ATTRTYPE: AT_STRING
ATTRFLAGS: AF_REQUIRED,AF_UNIQUE, AF_IMMUTABLE
ATTRDESC:: eod
Names a failover pair.
eod

ATTR: main
ATTRID: 2
#ATTRTYPE: AT_OBJREF(CCMCluster)
ATTRTYPE: AT_OID
ATTRFLAGS: AF_REFERENCE
ATTRVAL: 1449
ATTRDESC:: eod
Identifies the cluster with the main server for a failover pair.
eod

ATTR: backup
ATTRID: 3
#ATTRTYPE: AT_OBJREF(CCMCluster)
ATTRTYPE: AT_OID
ATTRFLAGS: AF_REFERENCE
ATTRVAL: 1449
ATTRDESC:: eod
Identifies the cluster that contains the backup server for
a failover pair.
eod

#Not used for 6.1
#ATTR: propagate-scopes
#ATTRID: 4
#ATTRVIZ: 1
#ATTRTYPE: AT_BOOL
#ATTRDEFVAL: false

ATTR: poll-subnet-util-interval
ATTRID: 5
ATTRTYPE: AT_RANGETIME(0-365d)
ATTRDESC:: eod
Specifies how often to collect the subnet utilization data
from DHCP server for this cluster. If set to 0, no poll
occurs.
eod

ATTR: poll-subnet-util-retry
ATTRID: 6
ATTRTYPE: AT_RANGEINT(0-4)
ATTRDESC:: eod
Specifies how often to retry if the server fails to poll
the data.
eod

ATTR: poll-subnet-util-server-first
ATTRID: 7
ATTRTYPE: AT_ENUMINT(mainserver=0, backupserver=1)
ATTRFLAGS: AF_PRINT_ALT
ATTRDEFVAL: mainserver
ATTRDESC:: eod
Specifies which server to poll first:
    0  main server
    1  backup server
eod

ATTR: poll-lease-hist-interval
ATTRID: 8
ATTRTYPE: AT_RANGETIME(0-365d)
ATTRDESC:: eod
Specifies how often to collect lease history from the DHCP
server for this cluster. If set to 0, no poll occurs.
eod

ATTR: poll-lease-hist-retry
ATTRID: 9
ATTRTYPE: AT_RANGEINT(0-4)
ATTRDESC:: eod
Specifies how often to retry if the server fails to poll
the data.
eod

ATTR: poll-lease-hist-server-first
ATTRID: 10
ATTRTYPE: AT_ENUMINT(mainserver=0, backupserver=1)
ATTRFLAGS: AF_PRINT_ALT
ATTRDEFVAL: mainserver
ATTRDESC:: eod
Specifies which server to poll first:
    0  main server
    1  backup server
eod

ATTR: server-default
ATTRID: 11
ATTRTYPE: AT_BOOL
ATTRDEFVAL: false
ATTRVIZ: 1
DEPRECATED: 7.0
ATTRDESC:: eod
Specifies whether this is a server-level failover pair or
a scope-level failover pair.
eod

ATTR: cluster-id
ATTRID: 12
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
The cluster that this failover came from if it was propagated from
a local cluster.
eod

ATTR: replica-deleted
ATTRID: 13
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: poll-lease-hist-offset
ATTRID: 14
ATTRTYPE: AT_RANGETIME(0-24h)
ATTRDESC:: eod
Provides a fixed time of day for lease history polling.

This time is interpreted as a time of day offset, with 0 being
12 midnight, provided the polling interval is less than 24 hours,
and the offset value is less than the polling interval. If the
offset value is greater than the polling interval, or the
interval is greater than 24 hours, the offset will be ignored.

The scheduler for polling will ensure that the first polling
event occurs at the offset time. For example, if you set the
interval to 4 hours and the offset to 2am, the polling would
occur at 2am, 6am, 10am, 2pm, 6pm and 10pm.
eod

ATTR: poll-subnet-util-offset
ATTRID: 15
ATTRTYPE: AT_RANGETIME(0-24h)
ATTRDESC:: eod
Provides a fixed time of day for subnet utilization polling.

This time is interpreted as a time of day offset, with 0 being
12 midnight, provided the polling interval is less than 24 hours,
and the offset value is less than the polling interval. If the
offset value is greater than the polling interval, or the
interval is greater than 24 hours, the offset will be ignored.

The scheduler for polling will ensure that the first polling
event occurs at the offset time. For example, if you set the
interval to 4 hours and the offset to 2am, the polling would
occur at 2am, 6am, 10am, 2pm, 6pm and 10pm.
eod

ATTR: scopetemplate
ATTRID: 16
#ATTRTYPE: AT_OBJREF(CCMScopeTemplate)
ATTRTYPE: AT_OID
ATTRVAL: 1426
ATTRDESC:: eod
Associates a scope template with a specified failover pair.
eod

ATTR: main-server
ATTRID: 17
ATTRTYPE: AT_IPADDR
ATTRDESC:: eod
Controls the IP address used for the failover protocol on the
main server. If this value is unset, the address specified
for the main cluster is used. Cisco recommends setting
this attribute only if the server is configured with
different interfaces for configuration management and clients
requests. Always configure the failover protocol with the
interface used to serve clients.
eod

ATTR: backup-server
ATTRID: 18
ATTRTYPE: AT_IPADDR
ATTRDESC:: eod
Controls the IP address used for the failover protocol on the
backup server. If this value is unset, the address specified
for the backup cluster is used. Cisco recommends setting
this attribute only if the server is configured with
different interfaces for configuration management and clients
requests. Always configure the failover protocol with the
interface used to serve clients.
eod

ATTR: backup-pct
ATTRID: 19
ATTRTYPE: AT_PERCENT
ATTRDEFVAL: 10
ATTRVIZ: 5
ATTRDESC:: eod
Controls the percentage of available addresses that the main
server sends to the backup server.  Set this value
on the main server.  If it is set on a backup server, it is
ignored (to enable copying of configurations).

Unless you explicitly set this value on a scope and you disable
load balancing, the value set here becomes the default value.
eod

ATTR: failover
ATTRID: 20
ATTRTYPE: AT_BOOL
ATTRDEFVAL: enabled
ATTRDESC:: eod
Enables failover configuration. If you disable this attribute,
you turn off failover on attached subnets without changing
configuration fundamentals.
eod

ATTR: mclt
ATTRID: 21
ATTRTYPE: AT_TIME
ATTRDEFVAL: 3600
ATTRDESC:: eod
Sets the maximum client lead time in seconds. This attribute
controls how far ahead of the backup server that you can make
the client lease expiration. You must define this value on both
the main and backup servers, and make sure the value is
identical on both servers.
eod

ATTR: lease-period-factor
ATTRID: 22
ATTRTYPE: AT_INT100
ATTRDEFVAL: 1.50
ATTRVIZ: 3
ATTRDESC:: eod
Sets 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. This value must be greater than 1.00 for the
failover protocol to work properly. 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.
Define this attribute on the main server.  If it is defined on
a backup server, it is ignored (to enable copying of
configurations).
eod

ATTR: use-safe-period
ATTRID: 23
ATTRTYPE: AT_BOOL
ATTRFLAGS: AF_FEATURE
ATTRDEFVAL: false
ATTRDESC:: eod
Controls whether a server can enter PARTNER-DOWN state without
an operator command. If disabled, a server never enters
PARTNER-DOWN  without an operator command.

Define this attribute on the main server.  If it is defined
on a backup server, it is ignored (to enable copying of
configurations).
eod

ATTR: safe-period
ATTRID: 24
ATTRTYPE: AT_TIME
ATTRDEFVAL: 86400
ATTRDESC:: eod
Controls 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.  Define this attribute on the
main server.  If it is defined on a backup server, it is ignored
(to enable copying of configurations).
eod

ATTR: recover
ATTRID: 25
ATTRTYPE: AT_BOOL
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.
eod

ATTR: persist-lease-data-on-partner-ack
ATTRID: 26
ATTRTYPE: AT_BOOL
ATTRDEFVAL: true
ATTRDESC:: eod
Controls when the main server updates its database. Normally,
the main server updates its database when the backup server
ACKs it with what the backup knows.  Disabling this capability
speeds up the main server, but after a restart the main server
is out of sync with 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: load-balancing-backup-pct
ATTRID: 27
ATTRTYPE: AT_RANGEBYTE(30-70)
ATTRDEFVAL: 50
ATTRVIZ: 3
ATTRDESC:: eod
The percentage of the clients the backup server is to service
while in normal communication with the main server, if load
balancing (RFC 3074) is enabled for the failover pair. Default is
50. The allowed range is 30 to 70, and is typically based on the
relative processing power of the servers.

Percentage  Main Server HBA  Backup Server HBA
    30          0179           180255
    40          0153           154255
    50          0127           128255
    60          0102           103255
    70          076            77255
eod

ATTR: dynamic-bootp-backup-pct
ATTRID: 28
ATTRTYPE: AT_PERCENT
ATTRVIZ: 5
ATTRDESC:: eod
Determines the percentage of available addresses that the
main server sends to the backup server for scopes on which dynamic
BOOTP is 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 "backup-pct" is
used instead.  This parameter is separate from "backup-pct"
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: network-match-list
ATTRID: 29
ATTRTYPE: AT_NLIST(AT_OBJ(Subnet))
# 1<<16 | 1129
ATTRVAL: 66665
ATTRVIZ: 3
ATTRDESC:: eod
The list of primary subnet objects associated with this failover
relationship. The subnet objects define the VPNs and network
addresses to be included in this failover relationship. Any
primary scopes that fall within this match list, or secondary
scopes with a primary-subnet that falls within this match list
will be associated with this failover pair.
eod

ATTR: load-balancing
ATTRID: 30
ATTRTYPE: AT_BOOL
ATTRDEFVAL: false
ATTRFLAGS: AF_FEATURE
ATTRDESC:: eod
Determines whether load balancing (RFC 3074) is enabled on a failover
pair. The default is disabled. When enabled, the backup-pct is
ignored and the main and backup server evenly split the client
load and available leases for all scopes in the failover
relationship (that is, as if backup-pct were configured at 50%).
eod

CLASS: CCMHost
CLASSID: 1415
CLASSNAME: 1
CLASSPCV: 4.0.0
CLASSDESC:: eod
Defines a DNS host record. A CCMHost object is created for each
protected name that includes at least one A or AAAA record.
A CCMHost object can automatically maintain associated PTR and
CNAME records.
eod

ATTR: name
ATTRID: 1
ATTRTYPE: AT_RDNSNAME
ATTRDESC:: eod
Specifies the relative name of a host within its zone.
eod

ATTR: zone
ATTRID: 2
# ATTRTYPE: AT_OBJREF(CCMZone)
ATTRFLAGS: AF_REFERENCE
ATTRTYPE: AT_OID
ATTRVAL: 1410
ATTRDESC:: eod
Defines the zone object to which a host belongs.
eod

ATTR: addrs
ATTRID: 3
ATTRTYPE: AT_NLIST(AT_IPADDR)
# AT_IPADDR = 4
ATTRVAL: 4
ATTRDESC:: eod
Defines the IP address(es) associated with this Host.
eod

ATTR: aliases
ATTRID: 4
ATTRTYPE: AT_NLIST(AT_DNSNAME)
# AT_DNSNAME = 35
ATTRVAL: 35
ATTRDESC:: eod
Provides alternate DNS names for this host.

Note: The data stored here corresponds to CNAME RRs
stored elsewhere in a CCMRRSet.
eod

ATTR: rrs
ATTRID: 5
ATTRTYPE: AT_NLIST(AT_PACK(SSIB*))
# AT_PACK = 36
ATTRVAL: 36
ATTRVIZ: 1
DEPRECATED: 7.0
ATTRDESC:: eod
Provides the other (non-A) resource records for this host.
eod

ATTR: create-ptr-records
ATTRID: 6
ATTRTYPE: AT_BOOL
ATTRDEFVAL: true
ATTRDESC:: eod
Controls whether the management infrastructure creates, deletes,
or modifies PTR records in response to add, modify and delete
operations for this host.
eod

ATTR: ip6address-list
ATTRID: 7
ATTRTYPE: AT_NLIST(AT_IP6ADDR)
# AT_IP6ADDR = 38
ATTRVAL: 38
ATTRDESC:: eod
Defines the IPv6 address or addresses associated with this host.
eod


CLASS: CCMOwner
CLASSNAME: 1
CLASSID: 1416
CLASSPCV: 4.0.0
CLASSDESC:: eod
Defines an owner tag for address blocks, subnets or zones. Owners
can apply filter criteria or access constraints on server data.
An owner with a reference to a registered CCMOrganization object
is also used for ARIN reporting.
eod

ATTR: tag
ATTRID: 1
ATTRTYPE: AT_STRING
ATTRFLAGS: AF_REQUIRED,AF_UNIQUE
ATTRDESC:: eod
Displays a unique tag name for this owner. Typically, it is a short
name referring to this owner.
eod

ATTR: name
ATTRID: 2
ATTRTYPE: AT_STRING
ATTRFLAGS: AF_REQUIRED
ATTRDESC:: eod
Displays the full name, or printable name, for this owner.
eod

ATTR: contact
ATTRID: 3
ATTRTYPE: AT_STRING
ATTRDESC:: eod
Provides contact information for this owner.
eod

ATTR: scopetemplate
ATTRID: 4
#ATTRTYPE: AT_OBJREF(CCMScopeTemplate)
ATTRTYPE: AT_OID
ATTRFLAGS: AF_REFERENCE
ATTRVAL: 1426
ATTRVIZ: 1
DEPRECATED: 7.0
ATTRDESC:: eod
Specifies an optional scope template for use when creating scopes
from subnets that are associated with this owner.
eod

ATTR: organization
ATTRID: 5
ATTRTYPE: AT_NAMEREF(CCMOrganization)
ATTRVAL: 1509
ATTRDESC:: eod
Specifies the organization name required for ARIN reporting purposes.
eod

CLASS: CCMRRSet
CLASSID: 1417
CLASSPCV: 4.0.0
CLASSDESC:: eod
Specifies the set of DNS RRs in a single nameset. All RRs in the set
must have the same name, but differ in type or data.
eod

ATTR: name
ATTRID: 1
ATTRTYPE: AT_RDNSNAME
ATTRDESC:: eod
Specifies the relative name of the RRs with respect to the containing
zone.
eod

ATTR: flags
ATTRID: 2
ATTRTYPE: AT_FLAGSINT(dynamic=1,whiteout=2)
ATTRVIZ: 1
ATTRDESC:: eod
Is this used?
eod

ATTR: rrs
ATTRID: 3
ATTRTYPE: AT_NLIST(AT_PACK(SSIB*))
# AT_PACK = 36
ATTRVAL: 36
ATTRDESC:: eod
Lists RRs composing the RR name-set.

The actual RR data blobs for this name.  The blobs are of
the form:
   type:  (S)2 bytes unsigned short
   class: (S)2 bytes unsigned short
   ttl:   (I)4 bytes unsigned int32
   data:  (B*) sz - 8 bytes of data
eod

ATTR: dynamic-rrs
ATTRID: 4
ATTRTYPE: AT_NLIST(AT_PACK(SSIB*))
# AT_PACK = 36
ATTRVAL: 36
ATTRVIZ: 1
DEPRECATED: 7.0
ATTRDESC:: eod
Lists the dynamic RRs (updated with DDNS) for the RR.
Set either the static-rrs list or the dynamic-rrs list,
but not both.

The actual RR data blobs for this name.  The blobs are of
the form:
  type:  (S)2 bytes unsigned short
  class: (S)2 bytes unsigned short
  ttl:   (I)4 bytes unsigne int32
  data:  (B*) sz - 8 bytes of data
eod

ATTR: zone
ATTRID: 5
#ATTRTYPE: AT_OBJREF(AT_OBJ(CCMZone))
ATTRTYPE: AT_OID
ATTRVAL: 1410
ATTRDESC:: eod
Identifies the zone that contains this RRSet, as referenced by OID.
eod

ATTR: protected-state
ATTRID: 6
ATTRTYPE: AT_ENUMINT(unprotected=1, protected=2)
ATTRFLAGS: AF_PRINT_ALT
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: zone-origin
ATTRID: 7
ATTRTYPE: AT_DNSNAME
ATTRFLAGS: AF_TRANSIENT
ATTRDESC:: eod
The DNS server will populate this transient attribute for each
RR set returned from searches that may span multiple zones, or
that are specified by fully-qualified name, where the zone name
is not explicitly known.
eod

CLASS: CCMRoleInstance
CLASSID: 1419
CLASSNAME: 1
CLASSPCV: 4.0.0
CLASSDESC:: eod
An administrator role. A CCMRoleInstance object defines
the specific constraint values, such as a list of CCMOwners
or CCMRegions, that are applied to the functions
made available by the role's base role.
eod

ATTR: name
ATTRID: 1
ATTRTYPE: AT_STRING
ATTRFLAGS: AF_REQUIRED,AF_UNIQUE
ATTRDESC:: eod
Identifies the name of this role.
eod

ATTR: role
ATTRID: 2
ATTRTYPE: AT_STRING
ATTRFLAGS: AT_REQUIRED
ATTRDESC:: eod
Specifies the base role for this object.  The base role defines
operations, such as modifying a zone, that are allowed and
the further constraints on these operations. For example,
a constrained role could limit the list of zones to a specific
list of Owners.
eod

ATTR: groups
ATTRID: 3
ATTRTYPE: AT_NLIST(AT_STRING)
# AT_STRING = 5
ATTRVAL: 5
ATTRDESC:: eod
Lists the groups with which this role is associated.  Any member of
a listed group can perform the operations that the role allows.
eod

#deprecated attribute...
ATTR: admins-deprecated
ATTRID: 4
ATTRTYPE: AT_NLIST(AT_STRING)
ATTRVAL: 5
ATTRVIZ: 1
DEPRECATED:6.0.0
ATTRDESC:: eod
Deprecated in CNR version 6.1.1.

The specific admins that are associated with this role.  These
admins can play this role (can perform the operations
allowed by this role).
eod

ATTR: unconstrained
ATTRID: 5
ATTRTYPE: AT_BOOL
ATTRDEFVAL: false
ATTRDESC:: eod
Indicates that this role has no other constraints beyond
the list of operations it can perform.
eod

ATTR: read-only
ATTRID: 6
ATTRTYPE: AT_BOOL
ATTRDEFVAL: false
ATTRDESC:: eod
Indicates that all constraints associated with this role are
limited to read-only access.
eod

ATTR: sub-roles
ATTRID: 7
ATTRTYPE: AT_NLIST(AT_STRING)
# AT_STRING = 5
ATTRVAL: 5
ATTRVIZ: 5
ATTRDESC:: eod
Lists subroles associated with this role instance. If the
all-sub-roles attribute is unset, or if it is set to true,
then this attribute is ignored.  If the all-sub-roles
attribute is set to false, then this attribute specifies
the list of subroles for this role instance, and an administrator
associated with this role has authorization limited to the
 specified subroles.  If the admininistrator has multiple roles
in which the role attribute is the same, then subrole authorization
for that role should be taken to be the union of all the sets of
subroles from the individual role instances; and, if any of these
role instances has the all-sub-roles attribute set to true,
then subrole authorization for that role is for all sub-roles.
Also, if any role instance for a matching role has the unconstrained
attribute set to true, then subrole authorization for that role is
for all subroles.
eod

ATTR: all-sub-roles
ATTRID: 8
ATTRTYPE: AT_BOOL
ATTRDEFVAL: true
ATTRVIZ: 5
ATTRDESC:: eod
Controls whether to ignore the sub-role attribute for this attribute.
If this attribute is unset, or if it is set to true, then the server
ignores the value of the sub-roles attribute and this subrole is
authorized for all sub-roles.  If this attribute is false, then the
sub-roles attribute provides the list of subroles for which this
role instance is authorized.  If the unconstrained attribute
is set to true, then the values of this attribute and the
of the sub-roles attribute are ignored, and the sub-role
authorization for the role is for all sub-roles.
eod

# start HostAdmin Role Instance constraints
ATTR: zones
ATTRID: 11
ATTRTYPE: AT_NLIST(AT_DNSNAME)
# AT_DNSNAME = 35
ATTRVAL: 35
ATTRVIZ: 1
DEPRECATED: 7.0
ATTRDESC:: eod
The list of zones that can be managed.  This list is only
significant for base roles (such as host-admin) that can be
constrined by a list of zones.
eod

ATTR: owners
ATTRID: 12
ATTRTYPE: AT_NLIST(AT_OBJREF(CCMOwner))
# 2 << 16 | classid(CCMOwner) 1416
ATTRVAL: 132488
ATTRVIZ: 1
DEPRECATED: 7.0
ATTRDESC:: eod
The list of owners of objects that can be managed.  This
list is only significant for base roles (such as zone-admin)
that can be  constrined by a list of owners.
eod

ATTR: regions
ATTRID: 13
ATTRTYPE: AT_NLIST(AT_OBJREF(CCMRegion))
# 2 << 16 | classid(CCMRegion) 1425
ATTRVAL: 132497
ATTRVIZ: 1
DEPRECATED: 7.0
ATTRDESC:: eod
The list of regions for objects that can be managed.  This
list is only significant for base roles (such as zone-admin)
that can be  constrined by a list of regions.
eod

ATTR: ipranges
ATTRID: 14
ATTRTYPE: AT_NLIST(AT_IPPAIR)
# AT_IPPAIR = 28
ATTRVAL: 28
ATTRVIZ: 1
DEPRECATED: 7.0
ATTRDESC:: eod
The list of IP address ranges that can be used.  This
list is only significant for base roles (such as host-admin)
that can be  constrined by a list of IP ranges.  In the case
of the host-admin role, this list limits the addresses that
can be assigned to a Host.

If this attribute is empty or has no ranges, the role will
not be allowed to allocate IP addresses unless the use-any-range
attribute is set to true.
eod

ATTR: rrtypes
ATTRID: 15
ATTRTYPE: AT_BLOB
ATTRVIZ: 1
DEPRECATED: 7.0
ATTRDESC:: eod
Is this used?
eod

ATTR: host-regexpr
ATTRID: 16
ATTRTYPE: AT_STRING
ATTRVIZ: 1
DEPRECATED: 7.0
ATTRDESC:: eod
Enables the host-admin role to constrain the names of
the Hosts being added.
eod

ATTR: use-any-range
ATTRID: 17
ATTRTYPE: AT_BOOL
ATTRDEFVAL: false
ATTRVIZ: 1
DEPRECATED: 7.0
ATTRDESC:: eod
Indicates whether there are any IP range restrictions.
eod

ATTR: use-any-zone
ATTRID: 18
ATTRTYPE: AT_BOOL
ATTRDEFVAL: false
ATTRVIZ: 1
DEPRECATED: 7.0
ATTRDESC:: eod
Used to indicate that there are no zone restrictions.
eod

# Start ZoneAdmin Role Instance constraints
# shares zones and owners attributes with Host Admin
ATTR: zone-regexpr
ATTRID: 30
ATTRTYPE: AT_STRING
ATTRVIZ: 1
DEPRECATED: 7.0
ATTRDESC:: eod
Used to constrain the names of zones that can be viewed and
created.
eod

ATTR: use-any-owner
ATTRID: 31
ATTRTYPE: AT_BOOL
ATTRDEFVAL: false
ATTRVIZ: 1
DEPRECATED: 7.0
ATTRDESC:: eod
Used to indicate that there are no owner restrictions.
eod

ATTR: edit-owners
ATTRID: 32
ATTRTYPE: AT_BOOL
ATTRDEFVAL: false
ATTRVIZ: 1
DEPRECATED: 7.0
ATTRDESC:: eod
Used to indicate that the users in this role can edit owners.
eod

ATTR: access-secondary-zones
ATTRID: 33
ATTRTYPE: AT_BOOL
ATTRDEFVAL: false
ATTRVIZ: 1
DEPRECATED: 7.0
ATTRDESC:: eod
Used to indicate that the users in this role may access
secondary zones.
eod

ATTR: access-reverse-zones
ATTRID: 34
ATTRTYPE: AT_BOOL
ATTRDEFVAL: false
ATTRVIZ: 1
DEPRECATED: 7.0
ATTRDESC:: eod
Used to indicate that users in this role may access reverse zones.
eod

ATTR: by-zone
ATTRID: 35
ATTRTYPE: AT_BOOL
ATTRDEFVAL: false
ATTRVIZ: 1
DEPRECATED: 7.0
ATTRDESC:: eod
Used to indicated that the role is constrained by
zones (versus owners).
eod

ATTR: by-owner
ATTRID: 36
ATTRTYPE: AT_BOOL
ATTRDEFVAL: false
ATTRVIZ: 1
DEPRECATED: 7.0
ATTRDESC:: eod
Used to indicate that the role is constrained by
owners (versus zones).
eod

ATTR: use-any-region
ATTRID: 37
ATTRTYPE: AT_BOOL
ATTRDEFVAL: false
ATTRVIZ: 1
DEPRECATED: 7.0
ATTRDESC:: eod
Used to indicate that there are no region restrictions.
eod

ATTR: constraints
ATTRID: 42
ATTRTYPE: AT_NLIST(AT_OBJ(CCMConstraint))
ATTRDESC:: eod
The list of constraints for the role.
eod

CLASS: CCMSecondaryZone
CLASSID: 1420
CLASSNAME: 1
CLASSPCV: 4.0.0
CLASSDESC:: eod
Defines a secondary DNS zone. A CCMSecondaryZone object
describes the configuration for an authoritative secondary zone.
eod

ATTR: origin
ATTRID: 1
ATTRTYPE: AT_DNSNAME
ATTRFLAGS: AF_REQUIRED,AF_UNIQUE,AF_IMMUTABLE
ATTRDESC:: eod
Sets the fully-qualified name of the zone's root.
The zone name.
eod

ATTR: restrict-xfer
ATTRID: 6
ATTRTYPE: AT_BOOL
ATTRDEFVAL: false
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
property to specify the access control list of who is allowed to
perform zone transfers.
eod

ATTR: restricted-set
ATTRID: 8
ATTRTYPE: AT_NLIST(AT_IPADDR)
# AT_IPADDR = 4
ATTRVAL: 4
ATTRVIZ: 1
DEPRECATED: 4.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: ixfr
ATTRID: 10
ATTRTYPE: AT_BOOL
ATTRDESC:: eod
Enables incremental transfer requests for this zone.  When set, this
attribute overrides the dns server global "ixfr-enable" value.

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
ATTRTYPE: AT_BOOL
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
ATTRTYPE: AT_NLIST(AT_IPADDR)
# AT_IPADDR = 4
ATTRVAL: 4
ATTRDESC:: eod
Lists additional servers to notify of changes to this zone.
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) will receive notifications.
Servers listed in "notify-list" will also be notified.
eod

ATTR: auth-servers
ATTRID: 101
ATTRTYPE: AT_NLIST(AT_IPADDR)
# AT_IPADDR = 4
ATTRVAL: 4
ATTRVIZ: 1
DEPRECATED: 5.0
ATTRDESC:: eod
The is the list of servers from which we will transfer data
for this secondary zone.
eod

ATTR: checkpoint-interval
ATTRID: 103
ATTRTYPE: AT_RANGETIME(1h-1w)
ATTRDEFVAL: 3h
ATTRDESC:: eod
The interval (in seconds) to checkpoint the zone. This defines how
often the latest zone snapshot is recorded in the Zone Checkpoint DB.
eod

ATTR: checkpoint-min-interval
ATTRID: 111
ATTRTYPE: AT_RANGETIME(60-2700)
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: full-reload-recovery-options
ATTRID: 119
ATTRTYPE: AT_ENUMINT(abort-on-error=0, resume-roll-forward-on-err=1, remove-from-changeset-db=2, remove-dynamic-rrs=3)
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
eventhough 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 lost
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: subzone-forward
ATTRID: 123
ATTRTYPE: AT_ENUMINT(normal=0, no-forward=1)
ATTRFLAGS: AF_PRINT_ALT
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: mcd-major
ATTRID: 124
ATTRTYPE: AT_INT
ATTRVIZ: 1
ATTRDESC:: eod
Unique major version number of the zone. Indicates whether a zone has
been deleted and re-added.
eod

ATTR: restrict-xfer-acl
ATTRID: 125
ATTRTYPE: AT_AMELST
ATTRDESC:: eod
Designates who is allowed to receive zone transfers from this zone.
eod

ATTR: master-servers
ATTRID: 126
ATTRTYPE: AT_NLIST(AT_IPKEY)
# AT_IPKEY = 56
ATTRVAL: 56
ATTRFLAGS: AF_REQUIRED
ATTRDESC:: eod
Lists the servers from which Network Registrar transfers data
for this secondary zone. Each server IP can be followed with
an optional key name in order to configure secure zone transfers.

Validation: A list of one or more ip addresses with an optional
key name (format <ipaddress>[-<keyname>]).
eod

ATTR: cluster-id
ATTRID: 127
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
Sets the id of the (local) cluster that is the authoritative
source for this object.  This attribute is set during replica
data propagation.
eod

ATTR: replica-deleted
ATTRID: 128
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: restrict-query-acl
ATTRID: 129
ATTRTYPE: AT_AMELST
ATTRDESC:: eod
Zone Address Control List (ACL) used to restrict queries to be
honored by the DNS server on this zone. This list can contain host
IPs, network addresses, TSIG keys and/or (global) ACLs.  Those
clients defined in this ACL  list shall be honored; others shall be
refused. If missing, the zone inherits the value of the server's
restrict-query-acl attribute.
eod

ATTR: import-file
ATTRID: 130
ATTRVIZ: 1
ATTRTYPE: AT_STRING
ATTRDESC:: eod
The file containing the RRs for this zone.
eod

ATTR: ixfr-base-file
ATTRID: 131
ATTRVIZ: 1
ATTRTYPE: AT_STRING
ATTRDESC:: eod
The file for ixfr-base.
eod

ATTR: ixfr-tmp-file
ATTRID: 132
ATTRVIZ: 1
ATTRTYPE: AT_STRING
ATTRDESC:: eod
The file for ixfr-tmp.
eod

#end of CCMSecondaryZone

CLASS: CCMServer
CLASSID: 1421
CLASSPCV: 4.0.0
CLASSDESC:: eod
The configuration object representing a local server.
CCMServer objects for a given CCMCluster refer to the CCMCluster
object by its object identifier (OID). Remote connection attributes
(ip address, port, admin, and password) should be stored on the
CCMCluster object.
eod

ATTR: name
ATTRID: 1
ATTRTYPE: AT_STRING
ATTRFLAGS: AF_REQUIRED,AF_UNIQUE
ATTRDESC:: eod
The name of this server.
eod

ATTR: fqdn
ATTRID: 2
ATTRTYPE: AT_DNSNAME
ATTRDESC:: eod
The DNS name of this server, not used for contacting
the server.
eod

ATTR: ipaddr
ATTRID: 3
ATTRTYPE: AT_IPADDR
ATTRDESC:: eod
Specifies the IP address of the server.  Network Registrar uses
this attribute, rather than the fqdn, when connecting to the server.
eod

ATTR: admin
ATTRID: 4
ATTRTYPE: AT_STRING
ATTRDESC:: eod
Specifies the administrator identity used to contact this server.
eod

ATTR: password
ATTRID: 5
ATTRTYPE: AT_CLEARTEXT
ATTRFLAGS: AF_TRANSIENT
ATTRVAL: 9
ATTRDESC:: eod
Specifies the password used to authenticate the identity
stored in the admin attribute.

Caution: Use this clear-text value only within process
memory.  Use the corresponding password-secret instead.
eod

ATTR: type
ATTRID: 6
ATTRTYPE: AT_ENUMSTR(DNS, DHCP, TFTP, MCDSVR, TRAMP, CCM, CMTS,CNRAGENT, RIC, SNMP)
ATTRDESC:: eod
Defines the type of server.  Server types are:
    DNS
    DHCP
    TFTP
    MCDSVR
    TRAMP
    CCM
    CMTS
    CNRAGENT
    RIC
    SNMP
eod

ATTR: local
ATTRID: 7
ATTRTYPE: AT_BOOL
ATTRDESC:: eod
Specifies whether this server is running in the same cluster as
the CCM server that manages the CCMServer configuration object.
On a local cluster, this condition is true for the DHCP, DNS,
TFTP, CCM, SNMP, and CNRAGENT servers. On a regional cluster,
this is true for the CCM, SNMP, and RIC servers.
cluster.
eod

ATTR: scp-port
ATTRID: 8
ATTRTYPE: AT_INT
ATTRDESC:: eod
Specifies the port number used for SCP communications. When you
install Network Registrar, the default SCP port number is 1234.
eod

ATTR: password-secret
ATTRID: 9
ATTRTYPE: AT_SECRET
ATTRVAL: 5
ATTRDESC:: eod
Contains the secret representing the password used to
authenticate the identity stored in the admin attribute.
eod

ATTR: http-port
ATTRID: 10
ATTRTYPE: AT_INT
ATTRVIZ: 1
ATTRDESC:: eod
Specifies the port number used for HTTP communications. The
default port number is 8080.
eod

ATTR: cluster
ATTRID: 11
#ATTRTYPE: AT_OBJREF(CCMCluster)
ATTRTYPE: AT_OID
ATTRFLAGS: AF_REFERENCE
ATTRVAL: 1449
ATTRVIZ: 1
DEPRECATED: 7.0
ATTRDESC:: eod
Associates this cluster with a server.
eod

ATTR: cluster-id
ATTRID: 12
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
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: poll-subnet-util-interval
ATTRID: 13
ATTRTYPE: AT_RANGETIME(0-365d)
ATTRDESC:: eod
Specifies how often to collect the subnet utilization data
from  DHCP server for this cluster. If set to 0, no polling
occurs.
eod

ATTR: poll-subnet-util-retry
ATTRID: 14
ATTRTYPE: AT_INT(0-4)
ATTRDESC:: eod
Specifies how often to retry if it fails to poll the data.
eod

ATTR: poll-lease-hist-interval
ATTRID: 15
ATTRTYPE: AT_RANGETIME(0-365d)
ATTRDESC:: eod
Specifies how often to collect the lease history from
DHCP server for this cluster. If set to 0, no polling
occurs.
eod

ATTR: poll-lease-hist-retry
ATTRID: 16
ATTRTYPE: AT_INT(0-4)
ATTRDESC:: eod
Specifies how often to retry if polling fails.
eod

ATTR: poll-lease-hist-offset
ATTRID: 17
ATTRTYPE: AT_RANGETIME(0-24h)
ATTRDESC:: eod
Sets a fixed time of day for lease history polling.

This time is interpreted as a time of day offset, with 0 being
12 midnight, provided the polling interval is less than 24 hours,
and the offset value is less than the polling interval. If the offset
value is greater than the polling interval, or the interval is
greater than 24 hours, the offset will be ignored.

The scheduler for polling will ensure that the first polling event
occurs at the offset time. For example, if you set the interval to
4 hours and the offset to 2am, the polling would occur at 2am, 6am,
10am, 2pm, 6pm and 10pm.
eod

ATTR: poll-subnet-util-offset
ATTRID: 18
ATTRTYPE: AT_RANGETIME(0-24h)
ATTRDESC:: eod
Sets a fixed time of day for subnet utilization polling.

This time is interpreted as a time of day offset, with 0 being
12 midnight, provided the polling interval is less than 24 hours,
and the offset value is less than the polling interval. If the offset
value is greater than the polling interval, or the interval is
greater than 24 hours, the offset will be ignored.

The scheduler for polling will ensure that the first polling event
occurs at the offset time. For example, if you set the interval to
4 hours and the offset to 2am, the polling would occur at 2am, 6am,
10am, 2pm, 6pm and 10pm.
eod

ATTR: use-ssl
ATTRID: 19
ATTRTYPE: AT_ENUMSTR(disabled, optional, required)
ATTRDEFVAL: optional
ATTRDESC:: eod
Sets whether you want secure outbound connections to local
servers. This attribute is set to optional by default,
and it requires that you install the  Network Registrar
Communications Security Option installed to be effective.

    optional--attempts to make secure connections
    required--mandates that only secure connections occur

If not set, no attempt to make secure connections occurs.
eod

ATTR: scp-read-timeout
ATTRID: 20
ATTRTYPE: AT_TIME
ATTRDEFVAL: 1200
ATTRDESC:: eod
Limits the amount of time to wait for data when reading
an SCP message from this cluster.
eod

ATTR: atul-port
ATTRID: 21
ATTRTYPE: AT_RANGEINT(1-65535)
ATTRDESC:: eod
If present, this Network Registrar server is listening for
ATUL queries on this port.
eod

CLASS: CCMSubnet
CLASSID: 1422
CLASSNAME: 2
CLASSPCV: 4.0.0
CLASSDESC:: eod
Specifies a subnet in the address space that usually corresponds
to a DHCP scope or a configured subnet on a router interface.
eod

ATTR: parent
ATTRID: 1
# AT_OBJREF(CCMAddrBlock)
ATTRTYPE: AT_OID
ATTRVAL: 1411
ATTRDESC:: eod
Identifies the parent address block for this subnet.
eod

ATTR: address
ATTRID: 2
ATTRTYPE: AT_SUBNET
ATTRFLAGS: AF_REQUIRED | AF_IMMUTABLE
ATTRDESC:: eod
Sets the subnet address for this subnet. Stored as a network
address and a mask determining how large the range is.
eod

ATTR: vpn-id
ATTRID: 3
ATTRTYPE: AT_INT
ATTRFLAGS: AF_REFERENCE | AF_IMMUTABLE
# Encode attribute 4 of Namespace(1127) as 4<<16 + 1127 == 263271
ATTRVAL: 263271
ATTRDEFVAL: 0
ATTRDESC:: eod
Specifies the  VPN that contains the subnet address for this
subnet.
eod

ATTR: type
ATTRID: 4
ATTRTYPE: AT_NAMEREF(CCMAddrSpaceType)
ATTRVAL: 1446
ATTRDESC:: eod
Identifies the type of this subnet.  This attribute contains the
name of a CCMAddrSpaceType object that contains more information
about the type.

If this attribute is unset, the object is assumed to have the
same type as its parent.
eod

ATTR: region
ATTRID: 5
# AT_OBJREF(CCMRegion)
ATTRTYPE: AT_OID
ATTRVAL: 1425
ATTRDESC:: eod
Associates an object with a region. The object is referenced by
OID.  Use the region field to group similarly located objects
to limit access to objects by their region.

If this attribute is unset, the object is assumed to have the
same region as its parent.
eod

ATTR: owner
ATTRID: 6
# AT_OBJREF(CCMOwner)
ATTRTYPE: AT_OID
ATTRVAL: 1416
ATTRDESC:: eod
Identifies the owner of this object, referenced by OID.  Use the
owner field to group similarly owned objects and to limit access
to objects by their owner.

If this attribute is unset, the object is assumed to have the
same owner as its parent.
eod

ATTR: network
ATTRID: 7
# AT_OBJREF(CCMNetwork)
ATTRTYPE: AT_OID
ATTRVAL: 1430
ATTRVIZ: 1
ATTRDESC:: eod
Is this used?  We may be just using router interface rather
than network and router interface.
eod

ATTR: interface
ATTRID: 8
# AT_OBJREF(CCMRouterInterface)
ATTRTYPE: AT_OID
ATTRVAL: 1435
ATTRDESC:: eod
Assigns a subnet to a router interface.
eod

ATTR: reference-count
ATTRID: 9
ATTRTYPE: AT_INT
ATTRDEFVAL: 0
ATTRVIZ: 3
ATTRDESC:: eod
Identifies how many object attributes reference this
subnet. These references are:
  - Another subnet 'primary-subnet'.
  - A scope 'subnet'.
  - A scope 'primary-subnet', except when it is the same as
    the scope 'subnet'.
  - A CCMRouterInterface subnet, specified either as the
    'primary-subnet' or in the 'secondary-subnets' list.
eod

ATTR: auto-created
ATTRID: 10
ATTRTYPE: AT_BOOL
ATTRVIZ: 2
ATTRDESC:: eod
Was this subnet created by object (scope or router interface for now)
change propagation?
eod

ATTR: failoverpair
ATTRID: 11
#ATTRTYPE: AT_OBJREF(CCMFailoverPair|CCMCluster)
ATTRTYPE: AT_OID
ATTRVAL: 1414
ATTRDESC:: eod
For DHCP allocation, assigns a subnet to a CCMFailoverPair
or to a single CCMCluster object.
eod

ATTR: description
ATTRID: 13
ATTRTYPE: AT_STRING
ATTRDESC:: eod
Provides a description of this subnet.
eod


ATTR: scopetemplate
ATTRID: 14
#ATTRTYPE: AT_OBJREF(CCMScopeTemplate)
ATTRTYPE: AT_OID
ATTRVAL: 1426
ATTRVIZ: 1
DEPRECATED: 7.0
ATTRDESC:: eod
An optional scope template to be used when creating Scope objects
from this subnet.
eod

ATTR: state
ATTRID: 15
ATTRTYPE: AT_ENUMSTR(available, ric-allocated, dhcp-allocated, allocated, reclaiming)
ATTRDEFVAL: available
ATTRVIZ: 1
ATTRDESC:: eod
The state of this subnet, expressed as a string.
This attribute is no longer used.
eod

ATTR: dhcp-servers
ATTRID: 16
ATTRTYPE: AT_NLIST(AT_OBJ(CCMServer))
# 1 << 16 | classid(CCMServer) 1421
ATTRVAL: 66957
ATTRVIZ: 1
DEPRECATED: 7.0
ATTRDESC:: eod
This attribute is for handling extraordinary relationships between
Subnets and DHCP servers.  The expected configuration scenario will
have a Subnet associated with a FailoverPair and thus with 2 DHCP
servers.
eod

ATTR: cluster-id
ATTRID: 17
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
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: 18
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: forward-zone-name
ATTRID: 19
ATTRTYPE: AT_DNSNAME
ATTRDESC:: eod
Names the forward zone associated with this subnet.
eod

ATTR: reverse-zone-name
ATTRID: 20
ATTRTYPE: AT_DNSNAME
ATTRDESC:: eod
Names the reverse zone associated with this subnet.
eod

ATTR: primary-subnet
ATTRID: 21
ATTRTYPE: AT_SUBNET
ATTRDESC:: eod
Contains the subnet number of a subnet's primary subnet. Use
this attribute when multiple logical IP subnets are present
on the same physical network.
eod

ATTR: dns-host-bytes
ATTRID: 22
ATTRTYPE: AT_RANGEINT(1-4)
ATTRDESC:: eod
Determines the correct in-addr.arpa name to create, when
creating reverse zones from a subnet.  Based on this value
and the subnet size, either a new reverse zone is created,
or delegation records are put into the parent reverse zone.

If unset, the server synthesizes an appropriate value based on
the subnet size. This value parallels the dns-host-bytes
attribute in the Scope class.
eod

ATTR: subnet-state
ATTRID: 23
ATTRTYPE: AT_FLAGSINT(ric-allocated=1, dhcp-allocated=2, reclaiming=3)
ATTRDEFVAL: 0
ATTRFLAGS: AF_PRINT_ALT
ATTRDESC:: eod
Shows the current state of this subnet.
eod

ATTR: scope-ref-count
ATTRID: 24
ATTRTYPE: AT_INT
ATTRDEFVAL: 0
ATTRVIZ: 3
ATTRDESC:: eod
Identifies how many scopes reference this subnet.
These references are indicated by the scope 'subnet'
attribute.
eod

ATTR: scope-primary-ref-count
ATTRID: 25
ATTRTYPE: AT_INT
ATTRDEFVAL: 0
ATTRVIZ: 3
ATTRDESC:: eod
Identifies how many scopes that reference this subnet
also reference this subnet 'primary-subnet'. These
references are indicated by the scope 'primary-subnet',
except when it is the same as the scope 'subnet'.
eod


CLASS: CCMZoneDistribution
CLASSID: 1423
CLASSNAME: 1
CLASSPCV: 4.0.0
CLASSDESC:: eod
Defines the distribution map for a set of primary zones.
The CCMZoneDistribution object identifies the primary DNS
server or HA DNS pair and the group of secondary DNS servers that are
authoritative for this set of zones.
eod

ATTR: name
ATTRID: 1
ATTRTYPE: AT_STRING
ATTRFLAGS: AF_REQUIRED,AF_UNIQUE
ATTRDESC:: eod
Names this zone distribution map.
eod

ATTR: primary
ATTRID: 2
# ATTRTYPE: AT_OBJREF(CCMCluster|CCMHaDnsPair)
ATTRFLAGS: AF_REFERENCE
ATTRTYPE: AT_OID
ATTRVAL: 1449
ATTRDESC:: eod
Identifies the cluster or HA DNS pair serving the primary zones
associated with this zone distribution map.
eod

# DEPRECATED in CNR 6.1 - moved to the secondaries-list
ATTR: secondaries
ATTRID: 3
ATTRTYPE: AT_NLIST(AT_OBJREF(CCMServer))
# 2 << 16 | classid(CCMServer) 1421
ATTRVAL: 132493
ATTRVIZ: 1
DEPRECATED: 5.0

# never used
ATTR: ddns-updaters
ATTRID: 4
ATTRTYPE: AT_NLIST(AT_OBJREF(CCMCluster))
# 2 << 16 | classid(CCMCluster) 1449
ATTRVAL: 132521
ATTRVIZ: 1
DEPRECATED: 7.0

# DEPRECATED in CNR 6.1 - moved to the secondaries-list
ATTR: last-sync-dbsn
ATTRID: 5
ATTRTYPE: AT_INT
ATTRDEFVAL: 0
ATTRVIZ: 1
DEPRECATED: 5.0

# DEPRECATED in CNR 6.1 - converted to the master-servers list
ATTR: primary-addresses
ATTRID: 6
ATTRTYPE: AT_NLIST(AT_IPADDR)
# AT_IPADDR = 4
ATTRVAL: 4
ATTRVIZ: 1
DEPRECATED: 5.0

ATTR: secondaries-list
ATTRID: 7
ATTRTYPE: AT_NLIST(AT_OBJ(CCMZDSecondary))
# 1 << 16 | classid(CCMZDSecondary) 1457
ATTRVAL: 66993
ATTRFLAGS: AF_JAVADOC
ATTRVIZ: 3
ATTRDESC:: eod
Lists the servers with secondary zones associated
with this zone distribution map.
eod

ATTR: master-servers
ATTRID: 8
ATTRTYPE: AT_NLIST(AT_IPKEY)
# AT_IPADDR = 56
ATTRVAL: 56
ATTRDESC:: eod
Lists the master-servers to set when creating secondary
zone on secondary server.

Validation: A list of one or more ip addresses with an optional
key name (format <ipaddress>[-<keyname>]).
eod

ATTR: cluster-id
ATTRID: 9
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
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: 10
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: restrict-xfer
ATTRID: 11
ATTRTYPE: AT_ENUMINT(enable=1,disable=2,use-server-settings=3,use-primary-zone-settings=4)
ATTRFLAGS: AF_PRINT_ALT
ATTRDEFVAL: use-primary-zone-settings
ATTRDESC:: eod
Determines what settings to use to restrict zone transfers.

    1  enable
       Limits zone transfers to a specific set of hosts.
       If you limit zone transfer, you must then use the
       restrict-xfer-acl attribute to list the servers
       allowed to perform zone transfers.

    2  disable
       Places no restrictions on zone transfers.

    3  use-server-settings
       Use the server settings and unsets the value on
       secondary zones.

    4  use-primary-zone-settings
       Configures a secondary zone with the primary zone
       value.
eod

ATTR: restrict-xfer-acl
ATTRID: 12
ATTRTYPE: AT_AMELST
ATTRDESC:: eod
Configures the access control list that designates which devices
receive zone transfers from the specified zone. Use with the
restrict-xfer attribute if use-server-settings is set.
eod


ATTR: ixfr
ATTRID: 13
ATTRTYPE: AT_ENUMINT(enable=1,disable=2,use-server-settings=3)
ATTRFLAGS: AF_PRINT_ALT
ATTRDEFVAL: use-server-settings
ATTRDESC:: eod
Configures secondary zones to enable incremental transfer
requests. When set, this attribute overrides the dns server
global ixfr-enable value. Using the server global value
(not setting this value per-zone) enables you to easily globally
turn incremental transfers on or off or to set a set a general
policy for your zones and specific exceptions to the server
global value.

    1  enable
       Permits incremental transfers for this zone.

    2  disable
       Prohibits incremental transfers for this zone.

    3  use-server-settings
       Uses the server settings. Unset the value set on
       secondary zones.

If you set incremental transfers, then this zone acts
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).
eod

ATTR: notify
ATTRID: 14
ATTRTYPE: AT_ENUMINT(enable=1,disable=2,use-server-settings=3,use-primary-zone-settings=4)
ATTRFLAGS: AF_PRINT_ALT
ATTRDEFVAL: use-server-settings
ATTRDESC:: eod
Configures secondary zones to notify other authoritative servers when
there are zone changes.

    1  enable
       Allows notification of other authoritative servers when
       this zone changes. Overrides the global notify value
       for this zone.

    2  disable
       Disallows notification of other authoritative servers
       when this zone changes. Overrides the global notify value
       for this zone.

    3  use-server-settings
       Uses the server setting. Unset the value set on secondary
       zones.

    4  use-primary-zone-settings
       Uses the value set at the primary zone to configure the
       secondary zone.
eod

ATTR: notify-set
ATTRID: 15
ATTRTYPE: AT_NLIST(AT_IPADDR)
# AT_IPADDR = 4
ATTRVAL: 4
ATTRDESC:: eod
Provides an optional list of servers to notify when a secondary
zone changes. Use with the notify attribute to configure
secondary zones. 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 the notify-set attribute are
also notified.
eod

ATTR: restrict-query
ATTRID: 16
ATTRTYPE: AT_ENUMINT(use-map-settings=1,use-server-settings=2,use-primary-zone-settings=3)
ATTRFLAGS: AF_PRINT_ALT
ATTRDEFVAL: use-primary-zone-settings
ATTRDESC:: eod
Determines how to restrict zone queries.

    1  use-map-settings
       Uses the restrict-query-acl attribute to configure
       secondary zones.

    2  use-server-settings
       Uses the server settings. Unset the value on secondary
       zones.

    3  use-primary-zone-settings
       Uses the primary zone value to configure secondary zones.
eod

ATTR: restrict-query-acl
ATTRID: 17
ATTRTYPE: AT_AMELST
ATTRDESC:: eod
Configures the ACL that the zone uses to restrict queries.
The DNS server honors the restriction set on the zone. If the
restrict-query attribute is set to use-map-settings, use this
value to configure secondary zones. You can configure the ACL
to include any of the following:

    host IPs
    network addresses
    TSIG keys
    global ACLs

Those clients defined in this ACL list are given access; others
are refused. If missing, the zone inherits the value of the
server's restrict-query-acl attribute.
eod


CLASS: CCMZoneTemplate
CLASSID: 1424
CLASSNAME: 1
CLASSPCV: 4.0.0
CLASSDESC:: eod
Defines a template used to create new primary DNS zones.
Attributes are copied exactly as specified from the template
to the newly created CCMZone or CCMReverseZone object.
eod

ATTR: name
ATTRID: 1
ATTRTYPE: AT_STRING
ATTRFLAGS: AF_REQUIRED,AF_UNIQUE
ATTRDESC:: eod
Names this zone template.
eod

ATTR: serial
ATTRID: 2
ATTRTYPE: AT_INT
ATTRDESC:: eod
Sets the starting serial number of the zone. A DNS server uses
a serial number to indicate database changes. Increments to this
number trigger zone transfers to a secondary server.
eod

ATTR: ns
ATTRID: 3
ATTRTYPE: AT_STRING
ATTRDESC:: eod
Specifies the fully-qualified domain name (FQDN) of the
primary name server for the zone. This host is the original
or primary source of data for this zone.

Note: Network Registrar treats the value set here as a string
rather than a dnsname to enable encoding relative or absolute
names in this attribute.
eod

ATTR: person
ATTRID: 4
ATTRTYPE: AT_STRING
ATTRDESC:: eod
Specifies the mailbox for the hostmaster (person) in domain name
form. 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.

Note: Network Registrar treats the value set here as a string
rather than a dnsname to enable encoding relative or absolute
names in this attribute.
eod

ATTR: refresh
ATTRID: 5
ATTRTYPE: AT_RANGETIME(1-2147483647)
ATTRFLAGS: AF_INITIALIZE
ATTRDEFVAL: 3h
ATTRDESC:: eod
Sets the interval at which a secondary server contacts its
master server for changes to zone data. The interval is
defined in the servers SOA record and is also known as the
secondary refresh time.
eod

ATTR: retry
ATTRID: 6
ATTRTYPE: AT_RANGETIME(1-2147483647)
ATTRFLAGS: AF_INITIALIZE
ATTRDEFVAL: 1h
ATTRDESC:: eod
Sets the amount of time that a secondary server waits before
it retries polling for changes to zone data or it retries a zone
transfer that has encountered errors. The retry interval must be
less than the expire and refresh intervals. A good value is
between one-third and one-tenth of the refresh time.
eod

ATTR: expire
ATTRID: 7
ATTRTYPE: AT_RANGETIME(1-2147483647)
ATTRFLAGS: AF_INITIALIZE
ATTRDEFVAL: 1w
ATTRDESC:: eod
Sets the number of seconds that a secondary server can continue
providing zone data without confirming that the data remains
current. The expire interval must be greater than the refresh
interval.
eod

ATTR: minttl
ATTRID: 8
ATTRTYPE: AT_RANGETIME(0-2147483647)
ATTRFLAGS: AF_INITIALIZE
ATTRDEFVAL: 10m
ATTRDESC:: eod
Sets the minimum TTL value displayed in resource records for a
zone. Records with TTL values lower than the minttl are published
with this value.
eod

ATTR: nameservers
ATTRID: 9
# this is an AT_NLIST(AT_STRING) because we want to be able to
# encode relative or non-relative names here and the AT_DNSNAME
# encoding does not provide a bit for specifying whether the name
# relative or absolute.
ATTRTYPE: AT_NLIST(AT_STRING)
# AT_STRING = 5
ATTRVAL: 5
ATTRDESC:: eod
Lists the nameservers for a zone.
eod

ATTR: defttl
ATTRID: 10
ATTRTYPE: AT_RANGETIME(0-2147483647)
ATTRFLAGS: AF_INITIALIZE, AF_REQUIRED
ATTRDEFVAL: 24h
ATTRDESC:: eod
Controls the default TTL value used for resource records in a
zone that do not specify a TTL.
eod

ATTR: owner
ATTRID: 11
ATTRTYPE: AT_OBJREF(CCMOwner)
ATTRVAL: 1416
ATTRDESC:: eod
Identifies the owner of this zone. Use the owner field to group
similarly owned zones and to limit administrative access.
eod

ATTR: dist-map
ATTRID: 12
# AT_OBJREF(CCMZoneDistribution)
ATTRTYPE: AT_OID
ATTRVAL: 1423
ATTRDESC:: eod
Associates a zone distribution map with a zone. The map
describes the primary and secondary DNS servers that provide
DNS service for this zone.
eod

ATTR: secondaries
ATTRID: 13
ATTRTYPE: AT_NLIST(AT_OBJ(CCMServer))
# 1 << 16 | 1421
ATTRVAL: 66957
ATTRVIZ: 1
DEPRECATED: 7.0
ATTRDESC:: eod
This is not used, now that we have the zone-distribution map to
handle the relationship between primary and secondary servers.
eod

ATTR: restrict-xfer
ATTRID: 14
ATTRTYPE: AT_BOOL
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
property to specify the access control list of who is allowed to
perform zone transfers.
eod

ATTR: dynamic
ATTRID: 15
ATTRTYPE: AT_BOOL
ATTRDESC:: eod
Enables RFC 2136 dynamic updates to the zone.  The most typical source
of these updates is a DHCP server.
eod

ATTR: restricted-set
ATTRID: 16
ATTRTYPE: AT_NLIST(AT_IPADDR)
# AT_IPADDR = 4
ATTRVAL: 4
ATTRVIZ: 1
DEPRECATED: 4.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

# Not used in 6.0,
# ATTR: dynupdate-set
# ATTRID: 17
# ATTRTYPE: AT_NLIST(AT_IPADDR)

ATTR: notify
ATTRID: 18
ATTRTYPE: AT_BOOL
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 a zone.
eod

ATTR: notify-set
ATTRID: 19
ATTRTYPE: AT_NLIST(AT_IPADDR)
# AT_IPADDR = 4
ATTRVAL: 4
ATTRDESC:: eod
Lists additional servers to notify of changes to a zone.  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

ATTR: checkpoint-interval
ATTRID: 20
ATTRTYPE: AT_RANGETIME(1h-1w)
ATTRDEFVAL: 3h
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: 21
ATTRTYPE: AT_BOOL
ATTRDESC:: eod
Enables dynamic resource-record scavenging for the zone. Use
this feature to remove stale records that arise when clients are
configured to perform DNS updates, but do not delete their
entries when they are no longer valid. If the DHCP server
performs updates, it also delete records when client leases
expire. Scavenging should not be enabled on these zones.
eod

ATTR: scvg-interval
ATTRID: 22
ATTRTYPE: AT_RANGETIME(1h-365d)
ATTRDESC:: eod
Sets the seconds that DNS waits before removing (scavenging)
out-of-date resource records.
eod

ATTR: scvg-no-refresh-interval
ATTRID: 23
ATTRTYPE: AT_RANGETIME(1h-365d)
ATTRDESC:: eod
Sets the number of seconds during which DNS updates cannot increment
the zone timestamp.
eod

ATTR: scvg-refresh-interval
ATTRID: 24
ATTRTYPE: AT_RANGETIME(1h-365d)
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-max-records
ATTRID: 25
ATTRTYPE: AT_RANGEINT(1-10000)
ATTRDESC:: eod
Controls the maximum number of records to search at one time for
candidates to be scavenged.
eod

ATTR: scvg-ignore-restart-interval
ATTRID: 26
ATTRTYPE: AT_RANGETIME(2h-24h)
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.
eod

ATTR: scvg-pause-interval
ATTRID: 27
ATTRTYPE: AT_RANGETIME(1s-24h)
ATTRDESC:: eod
Controls the interval (in seconds) that scavenging will wait
after scavenging a set of records, before going onto the next
set.
eod

ATTR: scvg-max-records-searched
ATTRID: 28
ATTRTYPE: AT_INT
ATTRDESC:: eod
Sets the maximum number of records to be scavenged from the zone
during a scavenging interval.
eod

ATTR: checkpoint-min-interval
ATTRID: 29
ATTRTYPE: AT_RANGETIME(60-2700)
ATTRDESC:: eod
Controls the minimum time required (in seconds) between the
time the first zone checkpoint occurs and the second zone
checkpoint starts.  This attribute applies only to zones with
dynamic rrs.
eod

ATTR: soattl
ATTRID: 30
ATTRTYPE: AT_DNSTTL
ATTRDESC:: eod
Controls the ttl value applied to a zone's SOA resource record.
eod

ATTR: nsttl
ATTRID: 39
ATTRTYPE: AT_DNSTTL
ATTRDESC:: eod
Controls the ttl value applied to the zone's NS resource records.
eod

ATTR: update-acl
ATTRID: 40
ATTRTYPE: AT_AMELST
ATTRDESC:: eod
Specifies the access control list for DNS updates to a 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. The access control list is not applied
to administrative edits managed through the CCM server.
eod

ATTR: full-reload-recovery-options
ATTRID: 119
ATTRTYPE: AT_ENUMINT(abort-on-error=0, resume-roll-forward-on-err=1, remove-from-changeset-db=2, remove-dynamic-rrs=3)
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
eventhough 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 lost
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: subzone-forward
ATTRID: 123
ATTRTYPE: AT_ENUMINT(normal=0, no-forward=1)
ATTRFLAGS: AF_PRINT_ALT
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: restrict-xfer-acl
ATTRID: 125
ATTRTYPE: AT_AMELST
ATTRDESC:: eod
The access control list that designates who is allowed to receive
zone transfers from this zone.
eod

ATTR: restrict-query-acl
ATTRID: 129
ATTRTYPE: AT_AMELST
ATTRDESC:: eod
Zone Address Control List (ACL) used to restrict queries to be
honored by the DNS server on this zone. This list can contain host
IPs, network addresses, TSIG keys and/or (global) ACLs.  Those
clients defined in this ACL  list shall be honored; others shall be
refused. If unset, the zone inherits the value of the server's
restrict-query-acl attribute.
eod

ATTR: update-policy-list
ATTRID: 130
ATTRTYPE: AT_NLIST(AT_STRING)
ATTRDESC:: eod
An ordered list of DNS update policies that can be used to authorize
or deny DNS updates. This attribute will be ignored if update-acl
is also set.
eod

ATTR: name-protection
ATTRID: 136
ATTRVIZ: 3
ATTRTYPE: AT_BOOL
ATTRDEFVAL: true
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 will introduce
inconsistencies between DNS RR name-sets and the CCM server's view
of protected RRs and hosts that will need to be manually corrected.
eod

# never used: 137 - name-protection-default


ATTR: region
ATTRID: 141
ATTRTYPE: AT_OBJREF(CCMRegion)
ATTRVAL: 1425
ATTRDESC:: eod
The region associated with this object.  This region field is used
to group similarly located zones and can be
used to limit administrative access.
eod

#end of CCMZoneTemplate


CLASS: CCMRegion
CLASSNAME: 1
CLASSID: 1425
CLASSPCV: 4.0.0
CLASSDESC:: eod
An region tag for Address Blocks, Subnets or Zones. Regions can be
used to apply filter criteria or access constraints on server data.
eod

ATTR: tag
ATTRID: 1
ATTRTYPE: AT_STRING
ATTRFLAGS: AF_REQUIRED,AF_UNIQUE
ATTRDESC:: eod
The unique tag name for this region. Typically a short name
referring to this region.
eod

ATTR: name
ATTRID: 2
ATTRTYPE: AT_STRING
ATTRFLAGS: AF_REQUIRED
ATTRDESC:: eod
The full name or printable name for this region.
eod

ATTR: contact
ATTRID: 3
ATTRTYPE: AT_STRING
ATTRDESC:: eod
The contact information for this region.
eod

ATTR: scopetemplate
ATTRID: 4
#ATTRTYPE: AT_OBJREF(CCMScopeTemplate)
ATTRTYPE: AT_OID
ATTRFLAGS: AF_REFERENCE
ATTRVAL: 1426
ATTRVIZ: 1
DEPRECATED: 7.0
ATTRDESC:: eod
An optional scope template to be used when creating Scope objects
from subnets associated with this region.
eod

# begin CCMScopeTemplate class
CLASS: CCMScopeTemplate
CLASSID: 1426
CLASSNAME: 1
CLASSPCV: 4.0.0
CLASSDESC:: eod
A template for creating a Scope object from a
subnet address. Most attributes are copied literally
from the template to the newly created scope. Attributes
of type AT_EXPR or AT_TEXPR are evaluated as expressions
to generate a subnet-specific value for the corresponding
scope attribute.
eod

ATTR: name
ATTRID: 1
ATTRTYPE: AT_STRING
ATTRFLAGS: AF_REQUIRED,AF_UNIQUE
ATTRDESC:: eod
The name of this scope template.
eod

ATTR: policy
ATTRID: 5
ATTRTYPE: AT_NAMEREF(Policy)
ATTRVAL: 1102
ATTRDEFVAL: default
ATTRVIZ: 5
ATTRDESC:: eod
The name of the policy associated with this scope.
eod

ATTR: ping-timeout
ATTRID: 10
ATTRTYPE: AT_INT
ATTRVIZ: 5
ATTRFEAT: 11
ATTRDESC:: eod
The number of milliseconds the DHCP server should wait for ping
responses.  If you make this value too large, you will slow down the
lease offering processes. If you make this value too small, you will
reduce the effectiveness of pinging addresses before offering them.
eod

ATTR: ping-clients
ATTRID: 11
ATTRTYPE: AT_BOOL
ATTRFLAGS: AF_FEATURE
ATTRVIZ: 5
ATTRDESC:: eod
Controls whether the server should attempt to ping
addresses before offering leases.
eod

ATTR: dns-server-addr
ATTRID: 12
ATTRTYPE: AT_IPADDR
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
ATTRTYPE: AT_STRING
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
ATTRTYPE: AT_STRING
ATTRVIZ: 1
DEPRECATED: 7.0
ATTRFEAT: 16
ATTRDESC:: eod
The name of the inverse (in-addr.arpa) zone that is updated with
PTR and TXT records.
eod

ATTR: synthetic-name-stem
ATTRID: 15
ATTRTYPE: AT_STRING
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
ATTRTYPE: AT_ENUMBYTE(update-none=0, update-all=1, update-fwd-only=2, update-rev-only=3)
ATTRFLAGS: AF_FEATURE
ATTRVIZ: 1
DEPRECATED: 7.0
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: 17
ATTRTYPE: AT_BOOL
ATTRFLAGS: AF_FEATURE
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
ATTRTYPE: AT_BOOL
ATTRFLAGS: AF_FEATURE
ATTRVIZ: 1
DEPRECATED: 7.0
ATTRFEAT: 16
ATTRDESC:: eod
Controls whether the DNS server is updated before
the lease is granted.
eod

ATTR: dns-host-bytes
ATTRID: 19
ATTRTYPE: AT_RANGEINT(1-4)
ATTRFEAT: 16
ATTRDESC:: eod
This value tells DHCP how many of the bytes in a lease's 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 this is unset, the server will synthesize an appropriate value
based on the scope's subnet size.
eod

ATTR: bootp
ATTRID: 21
ATTRTYPE: AT_BOOL
ATTRFLAGS: AF_FEATURE
ATTRVIZ: 5
ATTRDESC:: eod
Controls whether the server will accept BOOTP requests
for this scope. If you want clients to always receive the
same addresses, you need to reserve IP addresses for all your
BOOTP clients.
eod

ATTR: dynamic-bootp
ATTRID: 22
ATTRTYPE: AT_BOOL
ATTRFLAGS: AF_FEATURE
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: renew-only
ATTRID: 33
ATTRTYPE: AT_BOOL
ATTRFLAGS: AF_FEATURE
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 will 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 it).
eod

ATTR: deactivated
ATTRID: 36
ATTRTYPE: AT_BOOL
ATTRFLAGS: AF_FEATURE
ATTRVIZ: 5
ATTRDESC:: eod
A deactivated scope will not extend leases to any clients. It treats
all of the addresses in its ranges as if they were individually
deactivated.
eod

ATTR: dns-rev-server-addr
ATTRID: 37
ATTRTYPE: AT_IPADDR
ATTRVIZ: 1
DEPRECATED: 6.2
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
ATTRTYPE: AT_BOOL
ATTRFLAGS: AF_FEATURE
ATTRVIZ: 5
ATTRDESC:: eod
Controls whether the server will accept DHCP requests
for this scope. Typically, this is only disabled when
bootp is enabled for that scope, to allow only a scope
to be used exclusively for BOOTP.
eod

ATTR: update-dns-for-bootp
ATTRID: 39
ATTRTYPE: AT_BOOL
ATTRFLAGS: AF_FEATURE
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.

'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: failover-main-server
ATTRID: 45
ATTRTYPE: AT_STRING
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
ATTRTYPE: AT_STRING
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
ATTRID: 54
ATTRTYPE: AT_ENUMINT(scope-enabled=1,scope-disabled=2,use-server-settings=3)
ATTRFLAGS: AF_PRINT_ALT
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 servers'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-??: trap features and properties
# DEPRECATED in 6.2
#

ATTR: trap-free-address-low
ATTRID: 55
ATTRTYPE: AT_BOOL
ATTRFLAGS: AF_FEATURE
ATTRVIZ: 1
DEPRECATED: 6.0
ATTRDESC:: eod
Send trap on FreeAddress below low threshold
eod

ATTR: trap-free-address-high
ATTRID: 56
ATTRTYPE: AT_BOOL
ATTRFLAGS: AF_FEATURE
ATTRVIZ: 1
DEPRECATED: 6.0
ATTRDESC:: eod
Send trap on FreeAddress above high threshold
eod

ATTR: trap-free-address-low-threshold
ATTRID: 57
ATTRTYPE: AT_STRING
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
ATTRTYPE: AT_STRING
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

#
# Embedded-policy will not be separate object in CCM
#

ATTR: embedded-policy
ATTRID: 59
ATTRTYPE: AT_OBJ(Policy)
ATTRMCDPATH: embedded-policy
ATTRVIZ: 5
ATTRDESC:: eod
The embedded policy object for this scope.
eod

ATTR: failover-backup-percentage
ATTRID: 60
ATTRTYPE: AT_INT
ATTRVIZ: 1
DEPRECATED: 7.0
ATTRDESC:: eod
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 in the main server.  If it is defined in a
backup server, it is ignored (to enable copying of
configurations).  If it is defined, the defined value will
override the server defined values for failover-backup-percentage
and failover-dynamic-bootp-backup-percentage, and the value
defined here is the value that will be used for this scope,
whether or not this scope supports dynamic-bootp.  If it is
defined as zero (0), then no addresses will be sent to the backup
server.  Since zero is a significant value, once defined, this
parameter must be unset in order for this scope to utilize the
server-wide default values for failover-backup-percentage or
failover-dynamic-bootp-backup-percentage.
eod

ATTR: vpn-id
ATTRID: 68
ATTRTYPE: AT_INT
ATTRDEFVAL: 0
ATTRDESC:: eod
The id of the dhcp vpn that contains this scope.  The
vpn-id of a scope must be initialized when the scope
is created, and cannot be edited once it is set.
eod

#
# For use with expressions
#
# the new (for JackSprat) list of ranges
# Calculated by ranges expression
ATTR: range-list
ATTRID: 71
ATTRTYPE: AT_NLIST(AT_OBJ(CCMRangeTemplate))
ATTRVIZ: 3

ATTR: scope-name
ATTRID: 74
ATTRTYPE: AT_EXPR
ATTRFLAGS: AF_PRINT_ALT
ATTRDESC:: eod
An expression to define the name of the scope object created
when using the scope template.
eod

ATTR: selection-tag-list
ATTRID: 75
ATTRTYPE: AT_NLIST(AT_STRING)
# AT_STRING = 5
ATTRVAL: 5
ATTRDESC:: eod
The list of selection tags to associate with a scope.
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
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: options-expr
ATTRID: 79
ATTRTYPE: AT_EXPR
ATTRFLAGS: AF_PRINT_ALT
ATTRDESC:: eod
An expression to define the list of embedded policy options
to be created for a scope object.
eod

ATTR: ranges-expr
ATTRID: 80
ATTRTYPE: AT_EXPR
ATTRFLAGS: AF_PRINT_ALT
ATTRDESC:: eod
An expression to define the list of scope ranges to be created
for a scope object.
eod

ATTR: offer-timeout
ATTRID: 81
ATTRTYPE: AT_TIME
ATTRDESC:: eod
If the server offers a lease to a client, but the offer is not
accepted, the server will wait the specified number of seconds before
making the lease 'available' again.
eod

ATTR: grace-period
ATTRID: 82
ATTRTYPE: AT_TIME
ATTRDESC:: eod
The length of time between the expiration of a lease and the time it
is made available for re-assignment.
eod

ATTR: router-host
ATTRID: 83
ATTRTYPE: AT_INT
ATTRDESC:: eod
This is use to create the ip address from the subnet to put it on the
router interface because router interface does not take network id.
It takes ipaddress and mask
eod

ATTR: ignore-declines
ATTRID: 84
ATTRTYPE: AT_BOOL
ATTRDESC:: eod
This attribute controls whether the DHCP server will process a
DHCPDECLINE request referencing an IP address in this scope.  If
this attribute is enabled, then the DHCP server will ignore all
declines which reference an IP address in this scope.  If this
attribute is not set, the DHCP server will set to UNAVAILABLE
every IP address which is referenced in a DHCPDECLINE message.
The default value is false, so that DHCPDECLINE messages are
processed normally, and the IP addresses referenced in these
DHCPDECLINE messages are set to UNAVAILABLE.
eod

ATTR: allocation-priority
ATTRID: 85
ATTRTYPE: AT_INT
ATTRDESC:: eod
You can use the allocation-priority to assign an ordering to scopes,
such that allocation of IP addresses will take place from acceptable
scopes with a higher priority until the IP addresses in all those
scopes are exhausted.  An allocation-priority of 0 is treated as not
having an allocation-proiority.  You can mix scopes with an
allocation-priority along with those without an allocation-priority
(or with an allocation-priority of 0, which is the same thing) in the
same network.  In this case, the scopes with an allocation priority
will be examined for acceptability prior to those scopes with no
allocation-priority (or an allocation-priority of 0).

If this attribute is not set (unset), then the allocation-priority of
the scope will be controlled by the DHCP server attribute
priority-address-allocation.  If priority-address-allocation is set
(and allocation-priority for the scope is not set (unset)), then the
allocation-priority for the scope will be the network number of the
scope.  If allocation-priority has been explicitly configured for a
scope, then for that scope the setting of priority-address-allocation
has no meaning.
eod

ATTR: allocate-first-available
ATTRID: 86
ATTRTYPE: AT_BOOL
ATTRDESC:: eod
This boolean attribute forces all allocation of new IP addresses from
this scope to be made from the first available IP address, rather than
the default of the "least recently used" IP address.

If this attribute is not set (unset), then the decision on whether to
allocate the first available IP address in the scope will be
controlled by the DHCP server attribute priority-address-allocation.
If priority-address-allocation is set (and allocate-first-available
for the scope is not set (unset)), then the scope will allocate
addresses as if allocate-first-available was set.  If
allocate-first-available has been explicitly configured (either
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: 87
ATTRTYPE: AT_IPADDR
ATTRVIZ: 1
DEPRECATED: 7.0
ATTRDESC:: eod
If allocate-first-available is configured, and this scope participates
in a failover relationship, this value is the IP address boundary
below which which the failover backup servers IP addresses are
allocated.  Normal client IP addresses are allocated in ascending
order, while the backup server's IP addresses are allocated in
decending order from this boundary.  If it is unset or zero, then
the boundary used for this allocation is 1/2 of the distance between
the first and last IP address configured in the ranges for this scope.
If there are no IP addresses available below this boundary, then the
first IP address available above this boundary is used.
eod

ATTR: auto-hostname-pattern
ATTRID: 88
ATTRTYPE: AT_STRING
ATTRVIZ: 3
ATTRDESC:: eod
The pattern for auto-generated host names for a scope.
The exact syntax of this pattern are still TBD.
eod

ATTR: free-address-config
ATTRID: 89
ATTRTYPE: AT_NAMEREF(AddrTrapConfig)
ATTRVAL: 1146
ATTRDESC:: eod
The free-address trap configuration to use for this individual scope.
eod

ATTR: backup-pct
ATTRID: 90
ATTRTYPE: AT_PERCENT
ATTRDESC:: eod
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 in the main server.  If it is
defined in a backup server, it is ignored (to enable copying
of configurations).  If it is defined, the defined value will
override the failover pair's defined values for backup-pct
and dynamic-bootp-backup-pct, and the value defined here is
the value that will be used for this scope, whether or not
this scope supports dynamic-bootp.  If it is set to zero (0),
no addresses will be sent to the backup server.  Since zero
is a significant value, once set, this parameter must be
unset in order for this scope to utilize 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 percentage is ignored and 50% is used.
eod

ATTR: scope-description-expr
ATTRID: 91
ATTRTYPE: AT_EXPR
ATTRFLAGS: AF_PRINT_ALT
ATTRVAL: 90
ATTRDESC:: eod
Defines an AT_STRING expression to apply to the description
on the scope object created when using the template.
eod

ATTR: description
ATTRID: 92
ATTRTYPE: AT_STRING
ATTRDESC:: eod
Describes the scope template.
eod

# end of CCMScopeTemplate


CLASS: CCMReverseZone
CLASSID: 1427
CLASSNAME: 1
CLASSPCV: 4.0.0
CLASSDESC:: eod
A reverse primary DNS zone.
A CCMReverseZone object describes the configuration for a primary DNS
zone in the in-addr.arpa or ip6.arpa name space. CCMZone is
a similar class for forward zones.
eod

ATTR: origin
ATTRID: 1
ATTRTYPE: AT_DNSNAME
ATTRFLAGS: AF_REQUIRED,AF_IMMUTABLE
ATTRDESC:: eod
The fully-qualified name of the zone's root.  The zone name.
eod

ATTR: records
ATTRID: 2
ATTRTYPE: AT_NLIST(AT_OBJ(CCMRRSet))
# 1 << 16 | classid(CCMRRSet) 1417
ATTRVAL: 66953
ATTRVIZ: 1
ATTRDESC:: eod
If we ever try to manage lots of small zones (< 100 RRs or so,
maybe more), then it will be easier to manage the zone and its
RRs as a single object rather than as a related group of objects.

We will need to continue supporting zones with many thousands
of RRs, so we will never remove support for the more complex
and more scalable CCMRRSet/CCMZone model.
eod

ATTR: parent
ATTRID: 3
ATTRTYPE: AT_NAMEREF(CCMZone.origin)
ATTRVAL: 1410
ATTRDESC:: eod
The name of the parent zone, not used since it is fairly easy to
find the most containing zone name.
eod

ATTR: restrict-xfer
ATTRID: 6
ATTRTYPE: AT_BOOL
ATTRDEFVAL: false
ATTRDESC:: eod
Restricts sending zone transfers to a specific set of hosts. If you
restrict zone transfers, you need to use the restricted-xfer-acl
property to list the servers that are allowed to perform zone
transfers.
eod

ATTR: dynamic
ATTRID: 7
ATTRTYPE: AT_BOOL
ATTRDEFVAL: true
ATTRDESC:: eod
Enables RFC 2136 dynamic updates to the zone.  The most typical source
of these updates is a DHCP server.
eod

ATTR: restricted-set
ATTRID: 8
ATTRTYPE: AT_NLIST(AT_IPADDR)
# AT_IPADDR = 4
ATTRVAL: 4
DEPRECATED: 4.0
ATTRVIZ: 1
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

# Not used in 6.0
# ATTR: dynupdate-set
# ATTRID: 9
# ATTRTYPE: AT_NLIST(AT_IPADDR)

ATTR: notify
ATTRID: 11
ATTRTYPE: AT_BOOL
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
ATTRTYPE: AT_NLIST(AT_IPADDR)
# AT_IPADDR = 4
ATTRVAL: 4
ATTRDESC:: eod
An optional list of additional servers to notify when this zone
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) will receive notifications.
Servers listed in "notify-list" will also be notified.
eod

ATTR: update-acl
ATTRID: 13
ATTRTYPE: AT_AMELST
ATTRDESC:: eod
The access control list for DNS updates to the zone, specified as an
address match element list. The access control list is not applied
to administrative edits managed through the CCM server.
eod

ATTR: template
ATTRID: 20
# AT_OBJREF(CCMZoneTemplate)
ATTRTYPE: AT_OID
ATTRVAL: 1424
ATTRVIZ: 1
DEPRECATED: 7.0
ATTRDESC:: eod
The zone template last applied to the zone.
eod

ATTR: serial
ATTRID: 21
ATTRTYPE: AT_INT
ATTRFLAGS: AF_REQUIRED
ATTRDESC:: eod
The administratively specified serial number. Note that the serial
number must always increase; therefore, this serial number is only
applied to the zone if it is more advanced than the actual (dynamic)
serial number.
eod

ATTR: soattl
ATTRID: 30
ATTRTYPE: AT_DNSTTL
ATTRDESC:: eod
The ttl value to be applied to the zone's SOA rr.
eod

ATTR: ns
ATTRID: 31
ATTRTYPE: AT_DNSNAME
ATTRFLAGS: AF_REQUIRED
ATTRDESC:: eod
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: 32
ATTRTYPE: AT_DNSNAME
ATTRFLAGS: AF_REQUIRED
ATTRDESC:: eod
A domain name which specifies 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: 33
ATTRTYPE: AT_RANGETIME(1-2147483647)
ATTRFLAGS: AF_INITIALIZE
ATTRDEFVAL: 3h
ATTRDESC:: eod
The refresh interval, in seconds, of the zone. Used by secondaries
as the period of polling for zone changes.
eod

ATTR: retry
ATTRID: 34
ATTRTYPE: AT_RANGETIME(1-2147483647)
ATTRFLAGS: AF_INITIALIZE
ATTRDEFVAL: 1h
ATTRDESC:: eod
The retry interval, in seconds, of the zone. Used by secondaries
as the period of retrying when polling for changes, or attempting
a zone transfer encounters errors. The retry interval must be less
than (expire - refresh).
eod

ATTR: expire
ATTRID: 35
ATTRTYPE: AT_RANGETIME(1-2147483647)
ATTRFLAGS: AF_INITIALIZE
ATTRDEFVAL: 1w
ATTRDESC:: eod
The expire interval, in seconds, of the zone.  The length of
time a secondary can continue to serve zone data without
confirmation that it is still current. The expire interval
must be greater than the refresh interval.
eod

ATTR: minttl
ATTRID: 36
ATTRTYPE: AT_RANGETIME(0-2147483647)
ATTRFLAGS: AF_INITIALIZE
ATTRDEFVAL: 10m
ATTRDESC:: eod
The minimum TTL value to expose in resource records for this zone.
Records with lower TTL values will be published with this value.
eod

ATTR: defttl
ATTRID: 37
ATTRTYPE: AT_RANGETIME(0-2147483647)
ATTRFLAGS: AF_INITIALIZE, AF_REQUIRED
ATTRDEFVAL: 24h
ATTRDESC:: eod
The default TTL value to be used in resource records for this zone
which do not specify a TTL.
eod

ATTR: nameservers
ATTRID: 38
ATTRTYPE: AT_NLIST(AT_DNSNAME)
# AT_DNSNAME = 35
ATTRVAL: 35
ATTRFLAGS: AF_REQUIRED
ATTRDESC:: eod
The list of nameservers for this zone.
eod

ATTR: nsttl
ATTRID: 39
ATTRTYPE: AT_DNSTTL
ATTRDESC:: eod
The ttl value to be applied to the zone's NS rrs.
eod

ATTR: checkpoint-interval
ATTRID: 103
ATTRTYPE: AT_RANGETIME(1h-1w)
ATTRDEFVAL: 3h
ATTRDESC:: eod
The interval (in seconds) to checkpoint the zone. This defines how
often the latest zone snapshot is recorded in the Zone Checkpoint DB.
eod

ATTR: scvg-enabled
ATTRID: 104
ATTRTYPE: AT_BOOL
ATTRDEFVAL: false
ATTRDESC:: eod
Enables dynamic resource-record scavenging for the zone. This
feature can be used to remove stale records when clients are
configured to perform DNS updates, but do not delete their
entries when they're no longer valid. Typically, the DHCP server
maintains responsibility for reverse zone updates, regardless.
Scavenging should not be enabled on zones updated by the DHCP
server.
eod

ATTR: scvg-interval
ATTRID: 105
ATTRTYPE: AT_RANGETIME(1h-365d)
ATTRDESC:: eod
The interval (in seconds) to schedule scavenging on the zone.
eod

ATTR: scvg-no-refresh-interval
ATTRID: 106
ATTRTYPE: AT_RANGETIME(1h-365d)
ATTRDESC:: eod
The interval (in seconds) in which the zone cannot have a
timestamp updated if it is to be scavenged.
eod

ATTR: scvg-refresh-interval
ATTRID: 107
ATTRTYPE: AT_RANGETIME(1h-365d)
ATTRDESC:: eod
The interval (in seconds) in which the zone can have a timestamp
updated.
eod

ATTR: scvg-max-records-searched
ATTRID: 108
ATTRTYPE: AT_INT
ATTRDESC:: eod
The maximum number of records to search at one time for
candidates to be scavenged.
eod

ATTR: scvg-ignore-restart-interval
ATTRID: 109
ATTRTYPE: AT_RANGETIME(2h-24h)
ATTRDESC:: eod
The interval (in seconds) for which a restart will not recalculate
a start scavenging time.
eod

ATTR: scvg-pause-interval
ATTRID: 110
ATTRTYPE: AT_RANGETIME(1s-24h)
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
ATTRTYPE: AT_RANGETIME(60-2700)
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
ATTRTYPE: AT_RANGEINT(1-10000)
ATTRDESC:: eod
The maximum number of records to be scavenged from the zone during a
scavenging interval.
eod

ATTR: full-reload-recovery-options
ATTRID: 119
ATTRTYPE: AT_ENUMINT(abort-on-error=0, resume-roll-forward-on-err=1, remove-from-changeset-db=2, remove-dynamic-rrs=3)
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
eventhough 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 lost
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: owner
ATTRID: 120
ATTRTYPE: AT_OBJREF(CCMOwner)
ATTRVAL: 1416
ATTRDESC:: eod
The owner of this zone. This owner field is used to group similarly
owned zones and can be used to limit administrative access.
eod

ATTR: dist-map
ATTRID: 121
ATTRTYPE: AT_OBJREF(CCMZoneDistribution)
ATTRVAL: 1423
ATTRDESC:: eod
The zone distribution map associated with this zone. The zone
distribution map describes the primary and secondary DNS servers that
should provide DNS service for this zone.
eod

ATTR: secondaries
ATTRID: 122
ATTRTYPE: AT_NLIST(AT_OBJREF(CCMCluster))
# 2 << 16 | classid(CCMCluster) 1449
ATTRVAL: 132521
ATTRVIZ: 1
ATTRDESC:: eod
This is not used, now that we have the zone-distribution map to
handle the relationship between primary and secondary servers.
eod

ATTR: subzone-forward
ATTRID: 123
ATTRTYPE: AT_ENUMINT(normal=0, no-forward=1)
ATTRFLAGS: AF_PRINT_ALT
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: mcd-major
ATTRID: 124
ATTRTYPE: AT_INT
ATTRVIZ: 1
ATTRDESC:: eod
Unique major version number of the zone. Indicates whether a zone has
been deleted and re-added.
eod

ATTR: restrict-xfer-acl
ATTRID: 125
ATTRTYPE: AT_AMELST
ATTRDESC:: eod
The access control list that designates who is allowed to receive
zone transfers from this zone.
eod

# 126 is master-servers in secondary zone

ATTR: cluster-id
ATTRID: 127
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
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: 128
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: restrict-query-acl
ATTRID: 129
ATTRTYPE: AT_AMELST
ATTRDESC:: eod
Zone Address Control List (ACL) used to restrict queries to be
honored by the DNS server on this zone. This list can contain host
IPs, network addresses, TSIG keys and/or (global) ACLs.  Those
clients defined in this ACL  list shall be honored; others shall be
refused. If missing, the zone inherits the value of the server's
restrict-query-acl attribute.
eod

ATTR: import-file
ATTRID: 130
ATTRVIZ: 1
ATTRTYPE: AT_STRING
ATTRDESC:: eod
The file containing the RRs for this zone.
eod

ATTR: ixfr-base-file
ATTRID: 131
ATTRVIZ: 1
ATTRTYPE: AT_STRING
ATTRDESC:: eod
The file for ixfr-base.
eod

ATTR: ixfr-tmp-file
ATTRID: 132
ATTRVIZ: 1
ATTRTYPE: AT_STRING
ATTRDESC:: eod
The file for ixfr-tmp.
eod

ATTR: zone-rrdata
ATTRID: 133
ATTRVIZ: 1
ATTRTYPE: AT_NLIST(AT_PACK(SSIB*))
ATTRDESC:: eod
An experimental attribute to hold the AT_PACK(SSIB*) type, class, ttl
and data records for the zone itself.  This is the same as the
static-rrs attribute of the RRSet with the name '@'.  It does
not contain the SOA or NS records that are stored and managed
as zone attributes.
eod


ATTR: update-policy-list
ATTRID: 134
ATTRTYPE: AT_NLIST(AT_STRING)
ATTRDESC:: eod
An ordered list of DNS update policies that can be used to authorize
or deny DNS updates. This attribute will be ignored if update-acl
is also set.
eod

ATTR: name-protection
ATTRID: 136
ATTRVIZ: 3
ATTRTYPE: AT_BOOL
ATTRDEFVAL: true
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 will introduce
inconsistencies between DNS RR name-sets and the CCM server's view
of protected RRs and hosts that will need to be manually corrected.
eod

# never used: 137 - name-protection-default

ATTR: latest-sync-dbsn
ATTRID: 138
ATTRTYPE: AT_INT
ATTRDEFVAL: 0
ATTRVIZ: 3
ATTRDESC:: eod
Indicates the DBSN value the last time this zone was successfully
synchronized from CCM to the DNS server or local cluster.
eod

ATTR: latest-staged-zone-edit-dbsn
ATTRID: 139
ATTRTYPE: AT_INT
ATTRDEFVAL: 0
ATTRVIZ: 3
ATTRDESC:: eod
Indicates the DBSN value the last time a staged edit to this zone was
successfully completed in CCM.
If the value of this attribute is greater than latest-sync-dbsn,
then there are staged edits to the zone data itself which are
pending synchronization to DNS or local cluster.
eod

ATTR: latest-staged-rr-or-host-edit-dbsn
ATTRID: 140
ATTRTYPE: AT_INT
ATTRDEFVAL: 0
ATTRVIZ: 3
ATTRDESC:: eod
Indicates the DBSN value the last time a staged edit to a CCMHost or
CCMRRSet associated with this zone was successfully completed in CCM.

If the value of this attribute is greater than latest-sync-dbsn,
then there are staged edits to the zone's RRs or hosts which are
pending synchronization to DNS or local cluster.
eod

ATTR: region
ATTRID: 141
ATTRTYPE: AT_OBJREF(CCMRegion)
ATTRVAL: 1425
ATTRDESC:: eod
The region associated with this object.  This region field is used
to group similarly located zones and can be used to limit
administrative access.
eod

ATTR: parent-zone
ATTRID: 142
##ATTRTYPE: AT_NAMEREF(CCMZone)
ATTRTYPE: AT_DNSNAME
ATTRFLAGS: AF_IMMUTABLE
ATTRVIZ: 1
ATTRVAL: 1410
ATTRDESC:: eod
The name (origin) of the parent zone, if this zone was created
as a subzone.
eod

ATTR: name-bytes
ATTRID: 150
ATTRTYPE: AT_ENUMINT(0,1,2,3,4)
ATTRDESC:: eod
The number of address bytes that should be used for a PTR record name
eod

ATTR: address
ATTRID: 151
ATTRTYPE: AT_SUBNET
ATTRVIZ: 1
ATTRDESC:: eod
Not used.  Perhaps useful to track the exact subnet associated with
this reverse zone.
eod

ATTR: vpn-id
ATTRID: 152
ATTRTYPE: AT_INT
ATTRVIZ: 1
ATTRDEFVAL: 0
ATTRDESC:: eod
Not used.  Would be used to specify the VPN that contained
the address.
eod

ATTR: ranges
ATTRID: 153
ATTRTYPE: AT_LIST(AT_BLOB)
ATTRVIZ: 1
ATTRDESC:: eod
Not used.  Perhaps useful to track the ranges of address for
this zone.
eod

ATTR: view
ATTRID: 154
ATTRTYPE: AT_INT
ATTRVIZ: 1 # Not ready yet
ATTRDESC:: eod
The view identifier for this zone, if not specified then default view
which is 0.
eod

ATTR: exclude-from-ha-dns
ATTRID: 155
ATTRTYPE: AT_BOOL
ATTRDEFVAL: FALSE
ATTRVIZ: 3
ATTRDESC:: eod
When enabled, the zone is excluded from HA DNS processing.
eod

#end of CCMReverseZone

CLASS: CCMIPRange
CLASSID: 1428
CLASSPCV: 4.0.0
CLASSDESC:: eod
A range of IP addresses within a subnet.
eod

ATTR: parent
ATTRID: 1
#ATTRTYPE: AT_OBJREF(CCMSubnet)
ATTRTYPE: AT_OID
ATTRVAL: 1422
ATTRDESC:: eod
The parent subnet for this range.
eod

ATTR: start
ATTRID: 2
ATTRTYPE: AT_IPADDR
ATTRDESC:: eod
The first address in the range.
eod

ATTR: end
ATTRID: 3
ATTRTYPE: AT_IPADDR
ATTRDESC:: eod
The last address in the range.
eod

ATTR: type
ATTRID: 4
ATTRTYPE: AT_ENUMSTR(dynamic, static, mixed)
ATTRDESC:: eod
The type of range, either static for static address
assignment or dynamic for DHCP controlled assignment.
eod

ATTR: scope
ATTRID: 5
#ATTRTYPE: AT_OBJREF(Scope)
ATTRTYPE: AT_OID
ATTRVAL: 1101
ATTRVIZ: 2
ATTRDESC:: eod
The current MCD (primary) Scope object associated with this range
eod

ATTR: backup-scope
ATTRID: 6
#ATTRTYPE: AT_OBJREF(Scope)
ATTRTYPE: AT_OID
ATTRVAL: 1101
ATTRVIZ: 2
ATTRDESC:: eod
The current MCD backup Scope object associated with this range.
Probably won't be used in 6.0, but is kept here as a hint about
handling main and backup scopes in a unified address space view.
eod

# make this a vpn-id rather than an OID since we are
# using the 4 byte vpn id throughout the system
ATTR: vpn-id
ATTRID: 7
ATTRTYPE: AT_INT
ATTRFLAGS: AF_REFERENCE
# Encode attribute 4 of Namespace(1127) as 4<<16 + 1127 == 263271
ATTRDEFVAL: 0
ATTRVAL: 263271
ATTRDESC:: eod
The VPN that contains this address range.
eod

# remove CCMReservation -- just use the Reservation object from
# cnr-datadict.
# CLASS: CCMReservation
# CLASSID: 1429

CLASS: CCMNetwork
CLASSID: 1430
CLASSNAME: 2
CLASSPCV: 7.0.0
CLASSDESC:: eod

This class is not persisted to the database. It is used to report
the relationship of primary and secondary subnets.

A network represents a group of IP subnets that are in the same
broadcast domain.  A common example 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 is also referred to as a LAN segment.
eod

ATTR: name
ATTRID: 1
ATTRFLAGS: AF_REQUIRED
ATTRTYPE: AT_STRING
ATTRDESC:: eod
The name of this network.
eod

ATTR: primary-subnet
ATTRID: 2
ATTRFLAGS: AF_TRANSIENT
ATTRTYPE: AT_OBJ(CCMSubnet)
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_TRANSIENT
# 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
ATTRFLAGS: AF_TRANSIENT
ATTRTYPE: AT_NLIST(AT_OBJ(CCMSubnet))
ATTRDESC:: eod
The list of secodary subnets in this network.
eod

ATTR: primary-address
ATTRID: 5
ATTRTYPE: AT_SUBNET
ATTRFLAGS: AF_TRANSIENT
ATTRDESC:: eod
The subnet address that identifies this network.
eod


CLASS: CCMRouter
CLASSID: 1431
CLASSNAME: 1
CLASSPCV: 5.0.0
CLASSDESC:: eod
A router object. A CCMRouter object is used to store connection
credentials for the router, if RIC management is used to keep the
router configuration in sync with the CCM server address space. A
CCMRouter may be referenced by several CCMRouterInterface objects.
eod

ATTR: name
ATTRID: 1
ATTRTYPE: AT_STRING
ATTRFLAGS: AF_IMMUTABLE, AF_UNIQUE, AF_REQUIRED
ATTRDESC:: eod
Names this router.
eod

ATTR: address
ATTRID: 2
ATTRTYPE: AT_IPADDR
ATTRFLAGS: AF_UNIQUE, AF_REQUIRED
ATTRDESC:: eod
Sets the management interface address for this router.
eod

ATTR: username
ATTRID: 3
ATTRTYPE: AT_STRING
ATTRDESC:: eod
Identifies the username to log in to this router.
eod

ATTR: password
ATTRID: 4
ATTRTYPE: AT_CLEARTEXT
ATTRFLAGS: AF_TRANSIENT
ATTRVAL: 5
ATTRDESC:: eod
Determines the password that authenticates the username.
Avoid this field in normal use and never send the password
over insecure links.  Use this field to provide the
clear-text password to the RIC server which intentionally
does not have access to the secret storage module.
eod

ATTR: password-secret
ATTRID: 5
ATTRTYPE: AT_SECRET
ATTRVAL: 4
ATTRDESC:: eod
Identifies the secret containing the clear-text password for
authenticating the username.
eod

ATTR: enable
ATTRID: 6
ATTRTYPE: AT_CLEARTEXT
ATTRFLAGS: AF_TRANSIENT
ATTRVAL: 7
ATTRDESC:: eod
Sets the enable password, in clear-text form. Avoid
this field in normal use and never send the password
over insecure links.  Use this field to provide the
clear-text password to the RIC server which intentionally
does not have access to the secret storage module.
eod

ATTR: enable-secret
ATTRID: 7
ATTRTYPE: AT_SECRET
ATTRVAL: 6
ATTRDESC:: eod
Identifies the secret containing the clear-text password
for enabling super-user access to the router.
eod

ATTR: owner
ATTRID: 8
# AT_OBJREF(CCMOwner)
ATTRTYPE: AT_OID
ATTRVAL: 1416
ATTRDESC:: eod
Controls the owner of this object.  This owner field
is used to group similarly owned routers and can be used
to limit administrative access.
eod

ATTR: region
ATTRID: 9
# AT_OBJREF(CCMRegion)
ATTRTYPE: AT_OID
ATTRVAL: 1425
ATTRDESC:: eod
Controls the region associated with this object.  This
region field is used to group similarly located routers
and can be used to limit administrative access.
eod

ATTR: type
ATTRID: 10
ATTRTYPE: AT_NAMEREF(CCMRouterType.name)
ATTRVAL: 1447
ATTRDESC:: eod
Specifies the type of the router.  This is needed so that
the RIC server can use the correct implementation of the
router-specific interface.
eod

ATTR: login-template
ATTRID: 11
ATTRTYPE: AT_NAMEREF(CCMRouterLoginTemplate.name)
ATTRVAL: 1454
ATTRDESC:: eod
Names an optional login template that to use
to further customize the RIC server's login and enable
interaction sessions.
eod

ATTR: login-temp-obj
ATTRID: 12
ATTRTYPE: AT_OBJ(CCMRouterLoginTemplate)
ATTRVAL: 1454
ATTRFLAGS: AF_TRANSIENT
ATTRDESC:: eod
Specifies the actual login template object.  This attribute
is used so that the CCM server can provide the login template
to the stateless RIC server.
eod

ATTR: scopetemplate
ATTRID: 13
#ATTRTYPE: AT_OBJREF(CCMScopeTemplate)
ATTRTYPE: AT_OID
ATTRVAL: 1426
ATTRVIZ: 1
DEPRECATED: 7.0
ATTRDESC:: eod
Specifies an optional scope template to used when creating
Scope objects from subnets allocated to this router.
eod

ATTR: interfaces
ATTRID: 17
ATTRTYPE: AT_NLIST(AT_OBJ(CCMRouterInterface))
# 1 << 16 | classid(CCMRouterInterface) 1435
ATTRVAL: 66971
ATTRFLAGS: AF_TRANSIENT
ATTRDESC:: eod
Lists objects describing the interfaces associated with
this router.  This is used when the RIC server is returning
information about a router and its interfaces, or when the
CCM server is returning a list of routers and interfaces for
the UI to display a tree of routers and interfaces.
eod

ATTR: use-ssh
ATTRID: 18
ATTRTYPE: AT_ENUMINT(disabled=0,optional=1,required=2)
ATTRDEFVAL: optional
ATTRDESC:: eod
Specifies whether the RIC server should (or must) use SSH
when communicating with the router.
eod

ATTR: description
ATTRID: 19
ATTRTYPE: AT_STRING
ATTRDESC:: eod
Describes this router.
eod

ATTR: device-timeout
ATTRID: 20
ATTRTYPE: AT_INT
ATTRDEFVAL: 60
ATTRDESC:: eod
Indicates the timeout in seconds. The maximum timeout RIC
server's communication handler will wait for data from the router.
eod

ATTR: virtual-router
ATTRID: 21
ATTRTYPE: AT_BOOL
ATTRDEFVAL: FALSE
ATTRFLAGS: AF_TRANSIENT
ATTRDESC:: eod
Indicates that the Router object is not managed by the
RIC server. This feature may be used when there is no network
connectivity to the router, or when synchronization with the
network configuration is not desired. A virtual router
configuration is stored in the CCM database, but no attempt is
made to push the configuration to the router, or to synchronize
any configuration changes from the router.
eod


# this never got used
# CLASS: CCMScope
# CLASSID: 1432

# This is confusing with CCMAddrInfo, which is what we are using
# CLASS: AddrInfo
# CLASSID: 1433

CLASS: CCMTask
CLASSID: 1434
CLASSPCV: 4.0.0
CLASSVIZ: 3

ATTR: id
ATTRID: 1
ATTRTYPE: AT_INT
ATTRVIZ: 1
ATTRDESC:: eod
The unique identifier of this task.
eod

ATTR: db-id
ATTRID: 2
ATTRTYPE: AT_INT
ATTRVIZ: 1
ATTRDESC:: eod
db-id -- 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)
ATTRVIZ: 1
ATTRDESC:: eod
The state of this task.
eod

ATTR: dbsn
ATTRID: 4
ATTRTYPE: AT_INT
ATTRVIZ: 1
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 | 6
ATTRVAL: 65542
ATTRVIZ: 1
ATTRDESC:: eod
The list of ScpMessage requests that should be performed.  This
is the actual encoding of the work to be done by this task.
eod

ATTR: resp-list
ATTRID: 8
ATTRTYPE: AT_NLIST(AT_OBJ(Message))
# 1 << 16 | 6
ATTRVAL: 65542
ATTRVIZ: 1
ATTRDESC:: eod
The corresponding list of ScpMessage responses for the requests
that were made when executing this task.
eod

CLASS: CCMRouterInterface
CLASSID: 1435
CLASSNAME: 1
CLASSPCV: 5.0.0
CLASSDESC:: eod
A router interface. A CCMRouterInterface object describes the
subnet configuration for an interface on the parent router.
eod

ATTR: name
ATTRID: 1
ATTRTYPE: AT_STRING
ATTRFLAGS: AF_IMMUTABLE, AF_REQUIRED
ATTRDESC:: eod
The name of the router interface.
eod

ATTR: router
ATTRID: 2
#ATTRTYPE: AT_OBJREF(CCMRouter)
ATTRTYPE: AT_OID
ATTRVAL: 1431
ATTRFLAGS: AF_REQUIRED
ATTRDESC:: eod
A reference by OID to the router that this interface is
part of.
eod

ATTR: primary-subnet
ATTRID: 3
ATTRTYPE: AT_IPNET
ATTRDESC:: eod
The primary subnet (and interface address) for this
interface.
eod

ATTR: secondary-subnets
ATTRID: 4
ATTRTYPE: AT_NLIST(AT_IPNET)
# AT_IPNET=27
ATTRVAL: 27
ATTRDESC:: eod
The list of secondary subnets (and interface addresses)
for this interface.
eod

# Not in use for 6.1
#ATTR: docsis-secret
#ATTRID: 5
#ATTRTYPE: AT_STRING

ATTR: mac-address
ATTRID: 6
ATTRTYPE: AT_MACADDR
ATTRFLAGS: AF_IMMUTABLE
ATTRDESC:: eod
The MAC address of this interface.
eod

ATTR: state
ATTRID: 7
ATTRTYPE: AT_BOOL
ATTRDESC:: eod
The enabled/disabled state of this interface.
eod

ATTR: cable-helper
ATTRID: 8
ATTRTYPE: AT_NLIST(AT_IPADDR)
# AT_IPADDR = 4
ATTRVAL: 4
ATTRDESC:: eod
The list of ip addresses stored as the cable-helper value
on the interface.
eod

ATTR: ip-helper
ATTRID: 9
ATTRTYPE: AT_NLIST(AT_IPADDR)
# AT_IPADDR = 4
ATTRVAL: 4
ATTRDESC:: eod
The list of ip addresses stored as the ip-helper value on
the interface.
eod

ATTR: description
ATTRID: 10
ATTRTYPE: AT_STRING
ATTRDESC:: eod
The description of this interface.
eod

ATTR: scopetemplate
ATTRID: 11
#ATTRTYPE: AT_OBJREF(CCMScopeTemplate)
ATTRTYPE: AT_OID
ATTRVAL: 1426
ATTRVIZ: 1
DEPRECATED: 7.0
ATTRDESC:: eod
An optional scope template to be used when creating Scope objects
for this interface.
eod

ATTR: failoverpair
ATTRID: 12
ATTRTYPE: AT_OID
ATTRVAL: 1414
ATTRVIZ: 1
DEPRECATED: 7.0
ATTRDESC:: eod
A reference by OID to the failover pair that is used for
the primary DHCP service.  If this is not set, the
failoverpair attribute on the router will be used.
eod

ATTR: secondary-failoverpair
ATTRID: 13
ATTRTYPE: AT_OID
ATTRVAL: 1414
ATTRVIZ: 1
DEPRECATED: 7.0
ATTRDESC:: eod
A reference by OID to the failover pair that is used for
the secondary DHCP service.  If this is not set, the
secondary-failoverpair attribute on the router will be used.
eod

ATTR: parent
ATTRID: 14
# ATTRTYPE: AT_OBJREF(CCMRouterInterface)
ATTRFLAGS: AF_REFERENCE
ATTRTYPE: AT_OID
ATTRVAL: 1435
ATTRDESC:: eod
The parent interface if we have sub-interfaces or bundled
interfaces configured on the router.
eod

ATTR: is-virtual
ATTRID: 15
ATTRTYPE: AT_BOOL
ATTRDEFVAL: false
ATTRDESC:: eod
Indication if this interface is a virtual sub-interface.
eod

ATTR: bundle-id
ATTRID: 16
ATTRTYPE: AT_INT
ATTRDESC:: eod
The id of the bundle for grouping bundled interfaces.
eod

ATTR: is-master
ATTRID: 17
ATTRTYPE: AT_BOOL
ATTRDEFVAL: false
ATTRDESC:: eod
Indication that this is the master interface in a bundle of
interfaces.
eod

ATTR: owner
ATTRID: 18
# AT_OBJREF(CCMOwner)
ATTRTYPE: AT_OID
ATTRVAL: 1416
ATTRVIZ: 1
DEPRECATED: 7.0
ATTRDESC:: eod
The owner of this object.  This owner field
is used to group similarly owned objects and can be used to
limit administrative access.
eod

ATTR: region
ATTRID: 19
# AT_OBJREF(CCMRegion)
ATTRTYPE: AT_OID
ATTRVAL: 1425
ATTRVIZ: 1
DEPRECATED: 7.0
ATTRDESC:: eod
The region associated with this object.  This region field is
used to group similarly located objects and can be used to limit
administrative access.
eod

ATTR: cable-dhcp-giaddr
ATTRID: 20
ATTRTYPE: AT_ENUMINT(policy=2, primary=1, not-present=0)
ATTRDEFVAL: not-present
ATTRDESC:: eod
The setting for giaddr selection in cable interfaces.
eod

CLASS: UserPreferences
CLASSID: 1436
CLASSNAME: 1
CLASSPCV: 7.5.0
CLASSDESC:: eod
The persisted set of per-user preferences.  These preferences
are correlated by name with the currently logged-in
administrator, i.e., Admin.name == UserPreferences.username.
eod

ATTR: username
ATTRID: 1
ATTRTYPE: AT_NAMEREF(Admin)
ATTRFLAGS: AF_REQUIRED, AF_UNIQUE, AF_REFERENCE
ATTRDESC:: eod
The name of the administrator for whom these settings are saved.
eod

ATTR: webui-list-pagesize
ATTRID: 2
ATTRTYPE: AT_RANGEINT(1-1000)
ATTRDEFVAL: 10
ATTRDESC:: eod
The pagesize to use when displaying list pages in the web UI.
eod

ATTR: webui-mode
ATTRID: 3
ATTRTYPE: AT_ENUMINT(Basic=0,Advanced=1,Expert=2)
ATTRFLAGS: AF_PRINT_ALT
ATTRDESC:: eod
The preferred mode for the webui at session startup.
If unset, value defaults to the webui-mode value
specified in the CCM server configuration.
eod

ATTR: dashboard-period
ATTRID: 4
ATTRTYPE: AT_ENUMINT(current=1,history=2)
ATTRDEFVAL: current
ATTRFLAGS: AF_PRINT_ALT
ATTRDESC:: eod
Specifies whether dashboard charts will be displayed
for the 'current' period or for the 'history' period.
The 'current' period starts with the timestamp
(now - CCMServerConfig.stats-history-sparse-age).
The 'history' period starts with the timestamp
(now - 24 hours).  The actual data displayed by the
dashboard may not contain data for the entire period
requested.
eod

ATTR: dashboard-auto-refresh-speed
ATTRID: 5
ATTRTYPE: AT_ENUMINT(disabled=0,slow=1,medium=2,fast=3)
ATTRDEFVAL: fast
ATTRFLAGS: AF_PRINT_ALT
ATTRDESC:: eod
Specifies a heuristic value for the frequency at which
the dashboard page will refresh itself.

A value of 'fast' indicates that the dashboard page
will refresh at the same rate as is specified in the
CCMServerConfig's stats-history-sample-interval attribute.
Values of 'medium' and 'slow' indicate that progressively
larger integral multiples of the CCM server's speed will be used.

A value of 'disabled' indicates that the dashboard page
will not auto-refresh.
eod

ATTR: dashboard-chart-click-style
ATTRID: 6
ATTRTYPE: AT_ENUMINT(enlarged=1,tabular=2,csv=3)
ATTRDEFVAL: enlarged
ATTRFLAGS: AF_PRINT_ALT
ATTRDESC:: eod
Specifies what style of chart will be presented
when the user clicks on a dashboard chart.
eod

ATTR: dashboard-chart-selections
ATTRID: 7
ATTRTYPE: AT_NLIST(AT_SHORT)
##ATTRDEFVAL: TBD
ATTRDESC:: eod
Specifies the charts to be displayed in the dashboard
as a list of their data dictionary class identifiers.
eod

ATTR: dashboard-show-legend
ATTRID: 8
ATTRTYPE: AT_BOOL
ATTRDEFVAL: true
ATTRDESC:: eod
This specifies whether dashboard chart image generation
should include a legend. If false, no legend is shown.
eod

#
# note that this class is not used in 6.2+; it's here because upgrades
# to 6.2 needed to know about it.
#

CLASS: CCMAddrSink
CLASSID: 1438
CLASSPCV: 5.0.0
CLASSDEPRECATED: 7.0.0
CLASSDESC:: eod
The contact and type information for a lower-level sink of
address space.  Examples include the CNR DHCP server, which
will be the only defined address sink in the JS release.

The CCMAddrSink object could contain information about:
  - how to contact the sink
  - what kind of data and what format to use for communication
eod

ATTR: name
ATTRID: 1
ATTRTYPE: AT_STRING
ATTRFLAGS: AF_UNIQUE, AF_REQUIRED
ATTRDESC:: eod
The name of this address destination.
eod

ATTR: server
ATTRID: 2
#ATTRTYPE: AT_OBJREF(CCMCluster)
ATTRTYPE: AT_OID
ATTRFLAGS: AF_REFERENCE
ATTRVAL: 1449
ATTRVIZ: 1
ATTRDESC:: eod
The server associated with this address destination.  This could be
used to report on utilization or make further requests for more
space.
eod

ATTR: type
ATTRID: 3
ATTRTYPE: AT_ENUMSTR(DHCP=1,CCM=2)
ATTRFLAGS: AF_REQUIRED, AF_IMMUTABLE
ATTRDESC:: eod
The type of address destination.  The type will determine
how utilization is queried and how address space is delegated.
eod

CLASS: CCMServerInfo
CLASSID: 1439
CLASSPCV: 4.0.0
CLASSDESC:: eod
Status information about a local server.
eod

ATTR: health
ATTRID: 1
ATTRTYPE: AT_INT
ATTRDESC:: eod
The health of the server as an abstract number from 1 to 10.
eod

ATTR: state
ATTRID: 2
ATTRTYPE: AT_ENUMINT(unknown=0,loaded=1,initialized=2,unconfigured=3,running=4,stopped=5,disabled=6,exiting=7,test-unknown=42)
ATTRDESC:: eod
The running state of this server as it moves through the
Network Registrar server state machine.
eod

ATTR: classid
ATTRID: 3
ATTRTYPE: AT_INT
ATTRDESC:: eod
The class id of the server.
eod

ATTR: pid
ATTRID: 4
ATTRTYPE: AT_INT
ATTRDESC:: eod
The process id (pid) of the server process.
eod


#
# Not used
# CLASS: CCMRangeTemplate
# CLASSID: 1440

# classids for log file, perhaps other stuff
CLASS: CCMCCMServer
CLASSID: 1441
CLASSVIZ: 1
CLASSDEPRECATED: 7.0.5

CLASS: CCMCCMServerStats
CLASSID: 1442
CLASSVIZ: 3

CLASS: CCMCnrAgent
CLASSID: 1443
CLASSVIZ: 3

CLASS: CCMCnrAgentStats
CLASSID: 1444
CLASSVIZ: 3

CLASS: CCMAddrInfo
CLASSID: 1445
CLASSPCV: 4.0.0
CLASSDESC:: eod
Information associated with an address. This class is used to report
DNS names and reservations associated with this address.
eod

ATTR: addr
ATTRID: 1
ATTRTYPE: AT_IPADDR
ATTRDESC:: eod
The IP address being described.
eod

ATTR: vpn-id
ATTRID: 2
ATTRTYPE: AT_INT
ATTRDEFVAL: 0
ATTRDESC:: eod
The VPN that qualifies the IP address being described.
eod

ATTR: flags
ATTRID: 3
ATTRTYPE: AT_FLAGSINT(named=1,reserved=2,manual=5)
ATTRDESC:: eod
Flags defining what information is valid in the information,
and what state the address is in.
  named    - it has a DNS name, !named ==> dynamic DNS update.
  reserved - it is reserved in DHCP for the specified MAC address.
  manual   - it is manually assigned and named.
eod

ATTR: macaddr
ATTRID: 4
ATTRTYPE: AT_MACADDR
ATTRDESC:: eod
The reserved mac address, if any for this address.
eod

ATTR: zone
ATTRID: 5
# AT_OBJREF(CCMZone)
ATTRTYPE: AT_OID
ATTRVAL: 1410
ATTRDESC:: eod
The zone that the name is relative to.
eod

ATTR: name
ATTRID: 6
ATTRTYPE: AT_RDNSNAME
ATTRDESC:: eod
The relative name, if any for this address.
eod

CLASS: CCMAddrSpaceType
CLASSID: 1446
CLASSPCV: 5.0.0
CLASSDESC:: eod
An address space type. A CCMAddrSpaceType object is used to
group similar address blocks or subnets that share common
properties, such as their associated scope template.
eod

ATTR: name
ATTRID: 1
ATTRTYPE: AT_STRING
ATTRFLAGS: AF_UNIQUE, AF_REQUIRED
ATTRDESC:: eod
The name of the address space type.  This is used in the
AddrBlock.type attribute to specify the type of a given address block.
eod

ATTR: description
ATTRID: 2
ATTRTYPE: AT_STRING
ATTRDESC:: eod
A description of the address space type.
eod

ATTR: scopetemplate
ATTRID: 3
#ATTRTYPE: AT_OBJREF(CCMScopeTemplate)
ATTRTYPE: AT_OID
ATTRVAL: 1426
ATTRDESC:: eod
An optional scope template to be used when creating Scope objects
from subnets allocated from address blocks of this type.
eod

ATTR: selection-tags
ATTRID: 4
ATTRTYPE: AT_NLIST(AT_STRING)
# AT_STRING=5
ATTRVAL: 5
ATTRDESC:: eod
The selection tags to use for Scopes of this address type.
eod

ATTR: client-class
ATTRID: 5
ATTRTYPE: AT_NAMEREF(ClientClass.name)
ATTRVAL: 1117
ATTRVIZ: 1
ATTRDESC:: eod
The client class name that should be associated with clients
using this address space type.

Does this make sense?
eod

ATTR: sub-interface-number
ATTRID: 6
ATTRTYPE: AT_INT
ATTRVIZ: 1
ATTRDESC:: eod
If MPLS VPNs and sub-interfaces are being used, it may be
useful to associate a constant sub-interface number with a
specific type of address type.  If so, this attribute should
contain the sub-interface number.

There is no product support for using this sub-interface number,
so this attribute is currently set to visibility 1.
eod


CLASS: CCMRouterType
CLASSID: 1447
CLASSPCV: 5.0.0
CLASSDESC:: eod
A router type. The list of supported router types
is dynamically maintained by the RIC server, based on the
installed set of classes that implement the iRouter interface.
eod

ATTR: name
ATTRID: 1
ATTRTYPE: AT_STRING
ATTRFLAGS: AF_UNIQUE, AF_REQUIRED
ATTRDESC:: eod
The name of this router type.
eod

ATTR: description
ATTRID: 2
ATTRTYPE: AT_STRING
ATTRDESC:: eod
The description of this router type.
eod

ATTR: java-class-name
ATTRID: 3
ATTRTYPE: AT_STRING
ATTRFLAGS: AF_REQUIRED
ATTRDESC:: eod
The java class name for an implementation of
com.cisco.cnr.ricsrv.IRouter that can communicate
with this type of router.
eod

ATTR: manufacturer
ATTRID: 4
ATTRTYPE: AT_STRING
ATTRDESC:: eod
The name of the manufacturer of this type of router.
eod

ATTR: router-os-version
ATTRID: 5
ATTRTYPE: AT_STRING
ATTRDESC:: eod
The OS version, as a string for this type of router.
eod

# Keep this class around so that we can provide low volume versions of the
# subnet utilization data as an ScpObj/aobj_h
CLASS: CCMSubnetUtilization
CLASSID: 1448
CLASSPCV: 5.0.0
CLASSDESC:: eod
Subnet Utilization history data reported by the DHCP server.
This class is not persisted.
eod

ATTR: timestamp
ATTRID: 1
ATTRTYPE: AT_DATE
ATTRDESC:: eod
The time when this utilization data was collected.
eod

ATTR: subnet
ATTRID: 2
ATTRTYPE: AT_IPNET
ATTRDESC:: eod
The subnet address and mask for this utilization report. This
needs to be attrid 2 for sorting to work.
eod

ATTR: vpn-id
ATTRID: 3
ATTRTYPE: AT_INT
ATTRDEFVAL: 0
ATTRDESC:: eod
The VPN that contains the subnet for this utilization report.
This needs to be attrid 3 for sorting to work.
eod


ATTR: low-active-dynamic
ATTRID: 4
ATTRTYPE: AT_INT
ATTRDESC:: eod
The lowest number of dynamic addresses in use recorded during this
reporting interval.
eod

ATTR: high-active-dynamic
ATTRID: 5
ATTRTYPE: AT_INT
ATTRDESC:: eod
The highest number of dynamic addresses in use recorded during this
reporting interval.
eod

ATTR: active-dynamic
ATTRID: 6
ATTRTYPE: AT_INT
ATTRDESC:: eod
The number of dynamic addresses that are in use by clients at the
end of this reporting interval. Addresses in the OFFERED, LEASED,
EXPIRED, RELEASED and PENDING-AVAILABLE states are considered active.
eod

ATTR: low-free-dynamic
ATTRID: 7
ATTRTYPE: AT_INT
ATTRDESC:: eod
The lowest number of free dynamic addresses recorded during this
reporting interval.
eod

ATTR: high-free-dynamic
ATTRID: 8
ATTRTYPE: AT_INT
ATTRDESC:: eod
The highest number of free dynamic addresses recorded during this
reporting interval.
eod

ATTR: free-dynamic
ATTRID: 9
ATTRTYPE: AT_INT
ATTRDESC:: eod
The number of dynamic addresses that are free and available for new
clients at the end of this reporting interval. Addresses in the
AVAILABLE and OTHER-AVAILABLE states are considered free.
eod

ATTR: low-active-reserved
ATTRID: 10
ATTRTYPE: AT_INT
ATTRDESC:: eod
The lowest number of active reserved addresses recorded during this
reporting interval.
eod

ATTR: high-active-reserved
ATTRID: 11
ATTRTYPE: AT_INT
ATTRDESC:: eod
The highest number of active reserved addresses recorded during this
reporting interval.
eod

ATTR: active-reserved
ATTRID: 12
ATTRTYPE: AT_INT
ATTRDESC:: eod
The number of active reserved addresses in use by clients at the
end of this reporting interval. Addresses in the OFFERED, LEASED,
EXPIRED, RELEASED and PENDING-AVAILABLE states are considered active.
eod

ATTR: local-vpn-id
ATTRID: 13
ATTRTYPE: AT_INT
ATTRDEFVAL: 0
ATTRDESC:: eod
The VPN id for the local server. This is used to aggregate subnet
utilization information from multiple DHCP servers that do not have
a coordinated set of VPN ids for their VPNs.
eod

ATTR: cluster-id
ATTRID: 14
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
The id of the local cluster that is the authoritative source
for this data. This attribute is set as part of the replica data
propagation.
eod

CLASS: CCMCluster
CLASSID: 1449
CLASSNAME: 1
CLASSPCV: 5.0.0
CLASSDESC:: eod
Defines a server cluster. A CCMCluster object contains the
configuration data associated with the cluster, including
remote connection information uch as IP address, port, admin,
and password.
eod

ATTR: name
ATTRID: 1
ATTRTYPE: AT_STRING
ATTRFLAGS: AF_REQUIRED,AF_UNIQUE
ATTRDESC:: eod
Names the cluster.
eod

ATTR: fqdn
ATTRID: 2
ATTRTYPE: AT_DNSNAME
ATTRDESC:: eod
Provides the fully qualified domain name of this server.
This attribute is not used to contact the cluster.
eod

ATTR: ipaddr
ATTRID: 3
ATTRTYPE: AT_IPADDR
ATTRFLAGS: AF_REQUIRED,AF_UNIQUE
ATTRDESC:: eod
Provides the IP address of this server.  This attribute,
rather than the fqdn is used to connect to the cluster.
eod

ATTR: admin
ATTRID: 4
ATTRTYPE: AT_STRING
ATTRDESC:: eod
Sets the administrator identity to use to contact this cluster.
eod

ATTR: password
ATTRID: 5
ATTRTYPE: AT_CLEARTEXT
ATTRFLAGS: AF_TRANSIENT
ATTRVAL: 7
ATTRDESC:: eod
Sets the password that authenticates the identity stored
in the admin attribute.  Do not use this clear-text value
except within process memory.  Use the corresponding
password-secret instead.
eod

ATTR: scp-port
ATTRID: 6
ATTRTYPE: AT_INT
ATTRDESC:: eod
Controls the port number used for SCP communications.
eod

ATTR: password-secret
ATTRID: 7
ATTRTYPE: AT_SECRET
ATTRVAL: 5
ATTRDESC:: eod
Sets the identifier of the secret representing the password that
authenticates the identity stored in the admin attribute.
eod

ATTR: http-port
ATTRID: 8
ATTRTYPE: AT_INT
ATTRVIZ: 5
ATTRDESC:: eod
Specifies the http-port to use for non-SSL-secured connections
to the web server for this cluster.
eod

ATTR: poll-replica-interval
ATTRID: 9
ATTRTYPE: AT_TIME
ATTRDEFVAL: 4h
ATTRDESC:: eod
Set the automatic replication interval; that is, how often
Network Registrar polls this server for replica data.
eod

ATTR: poll-replica-offset
ATTRID: 10
ATTRTYPE: AT_TIME
ATTRDEFVAL: 4h
ATTRDESC:: eod
Sets a fixed time of day for replica polling.

This time is interpreted as a time of day offset, with 0 being
12 midnight, provided that:
    the polling interval is less than 24 hours, and
    the offset value is less than the polling interval.

If the offset value is greater than the polling interval, or
the interval is greater than 24 hours, the offset is ignored.

The scheduler for polling ensures that the first polling event
occurs at the offset time. For example, if you set the interval
to 4 hours and the offset to 2am, the polling would occur at
2am, 6am,  10am, 2pm, 6pm and 10pm.
eod

ATTR: cluster-id
ATTRID: 11
ATTRTYPE: AT_SHORT
ATTRFLAGS: AF_UNIQUE, AF_IMMUTABLE
ATTRDESC:: eod
Identifies the local cluster that is the authoritative source
for this object.  This attribute is set as part of replica data
propagation.
eod

ATTR: local-servers
ATTRID: 12
ATTRTYPE: AT_NLIST(AT_OBJ(CCMServer))
# 1 << 16 | 1421
ATTRVAL: 66957
ATTRFLAGS: AF_TRANSIENT
ATTRDESC:: eod
Lists the servers associated with this cluster. This transient
attribute makes it easier for clients that want to show a tree
of clusters with their child servers to get all the information
in a single request.
eod

ATTR: poll-subnet-util-interval
ATTRID: 13
ATTRTYPE: AT_RANGETIME(0-365d)
ATTRDESC:: eod
Specifies how often to collect subnet utilization data from
the DHCP server for this cluster. If set to 0, polling does
not occur.
eod

ATTR: poll-subnet-util-retry
ATTRID: 14
ATTRTYPE: AT_RANGEINT(0-4)
ATTRDESC:: eod
Controls how often to retry if subnet utilization polling fails.
eod

ATTR: poll-lease-hist-interval
ATTRID: 15
ATTRTYPE: AT_RANGETIME(0-365d)
ATTRDESC:: eod
Specifies how often to collect the lease history from the DHCP
server for this cluster. If set to 0, polling does not occur.
eod

ATTR: poll-lease-hist-retry
ATTRID: 16
ATTRTYPE: AT_RANGEINT(0-4)
ATTRDESC:: eod
Controls how often to retry if lease history polling fails.
eod

ATTR: https-port
ATTRID: 17
ATTRTYPE: AT_INT
ATTRVIZ: 5
ATTRDESC:: eod
Controls the https-port to use for SSL-secured connections to
the webserver for this cluster.  This port is only used if the
value of the use-https-port attribute is true.
eod

ATTR: use-https-port
ATTRID: 18
ATTRTYPE: AT_BOOL
ATTRDEFVAL: false
ATTRVIZ: 5
ATTRDESC:: eod
Controls whether the https-port is used to make single sign-on
connections to the cluster.  If the value is false, or the
https-port attribute is not set, then the http-port is used.
eod

ATTR: shared-secret
ATTRID: 19
ATTRTYPE: AT_SECRET
ATTRDESC:: eod
Specifies the identifier for the secret shared between the
server storing this object and the cluster it represents.
This shared secret is used to generate single-sign-on
authentication tokens.
eod

ATTR: remote-id
ATTRID: 20
ATTRTYPE: AT_SHORT
ATTRDESC:: eod
Sets the ID on the remote cluster that refers back to the
local cluster. If there are two cluster objects on two servers
that share a secret and refer to each other, then the local ID =
the remote-id, the local remote ID = the remote ID, and the value
of the local shared secret = the value the remote shared secret.
eod

ATTR: replication-initialized
ATTRID: 21
ATTRTYPE: AT_BOOL
ATTRDEFVAL: false
ATTRVIZ: 5
ATTRDESC:: eod
Indicates whether data replication has already been initialized
on this cluster.
eod

ATTR: poll-lease-hist-offset
ATTRID: 22
ATTRTYPE: AT_RANGETIME(0-24h)
ATTRDESC:: eod
Provides a fixed time of day for lease history polling.

This time is interpreted as a time of day offset, with 0 being
12 midnight, provided the polling interval is less than 24 hours,
and the offset value is less than the polling interval. If the offset
value is greater than the polling interval, or the interval is
greater than 24 hours, the offset will be ignored.

The scheduler for polling will ensure that the first polling event
occurs at the offset time. For example, if you set the interval to
4 hours and the offset to 2am, the polling would occur at 2am, 6am,
10am, 2pm, 6pm and 10pm.
eod

ATTR: poll-subnet-util-offset
ATTRID: 23
ATTRTYPE: AT_RANGETIME(0-24h)
ATTRDESC:: eod
Provides a fixed time of day for subnet utilization polling.

This time is interpreted as a time of day offset, with 0 being
12 midnight, provided the polling interval is less than 24 hours,
and the offset value is less than the polling interval. If the offset
value is greater than the polling interval, or the interval is
greater than 24 hours, the offset will be ignored.

The scheduler for polling will ensure that the first polling event
occurs at the offset time. For example, if you set the interval to
4 hours and the offset to 2am, the polling would occur at 2am, 6am,
10am, 2pm, 6pm and 10pm.
eod

ATTR: use-ssl
ATTRID: 24
ATTRTYPE: AT_ENUMSTR(disabled, optional, required)
ATTRDEFVAL: optional
ATTRDESC:: eod
What security mode should we use when connecting to this cluster.
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: scp-read-timeout
ATTRID: 25
ATTRTYPE: AT_TIME
ATTRDEFVAL: 1200
ATTRDESC:: eod
The time limit for how long we should wait for data when
reading an SCP message from this cluster.
eod

ATTR: product-version
ATTRID: 26
ATTRTYPE: AT_PCV
ATTRDESC:: eod
The product version number of the cluster in major, minor, rev form.
This value is updated when the cluster is resynchronized.
eod

ATTR: compatibility-version
ATTRID: 27
ATTRTYPE: AT_PCV
ATTRVIZ: 3
ATTRDESC:: eod
The product compatibility version number of the cluster in major,
minor, rev form.  This value is for internal code use only.
This value is updated when the cluster is resynchronized.
eod

ATTR: restore-state
ATTRID: 28
ATTRFLAGS: AF_TRANSIENT, AF_PRINT_ALT
ATTRTYPE: AT_ENUMSHORT(active=0, deactivated=1, restoring=2)
ATTRDEFVAL: 0
ATTRDESC:: eod
Indicates whether the cluster has been deactivated or is in the
process of being restored from the replica db.
eod

ATTR: is-localhost
ATTRID: 29
ATTRTYPE: AT_BOOL
ATTRFLAGS: AF_IMMUTABLE
ATTRDEFVAL: false
ATTRVIZ: 3
ATTRDESC:: eod
Cluster object created by the CCM server.
This flag will be used by the UIs as a cue that the cluster should
not be deleted.
eod

ATTR: system
ATTRID: 30
ATTRTYPE: AT_BOOL
ATTRFLAGS: AF_IMMUTABLE
ATTRDEFVAL: false
ATTRVIZ: 3
ATTRDESC:: eod
This cluster object will be suppressed from UI listings
This flag will be used by the UIs as a cue that the cluster should
not be shown.
eod

ATTR: atul-port
ATTRID: 31
ATTRTYPE: AT_RANGEINT(0-65535)
ATTRDESC:: eod
if > 0, a process on this cluster is listening for ATUL protocol
queries on this port number.
eod

CLASS: CCMReplicaState
CLASSID: 1450
CLASSPCV: 5.0.0
CLASSDESC:: eod
Replica status information for a local cluster.
eod

ATTR: master
ATTRID: 1
ATTRTYPE: AT_SHORT
ATTRDESC:: eod
The master id value for the cluster. This is not quite the
same as the cluster id for the cluster containing the
master db.  Since there multiple authoritative databases
(CCM, MCD and SNMP) on a local cluster, the master-id needs
to encode both the cluster id and which database.

eod

ATTR: last-sync
ATTRID: 2
ATTRTYPE: AT_DATE
ATTRDESC:: eod
The time when we last successfully synchronized the replica
with the master datastore.  Getting a response that there
have been no changes on the master counts as a successful
synchronization.
eod

ATTR: last-sync-attempt
ATTRID: 3
ATTRTYPE: AT_DATE
ATTRDESC:: eod
The time when we last tried to synchronize the replica
with the master datastore.  This will differ from
the last-sync value if we have tried and failed to
synchronize since the last successful synchronization.
eod

ATTR: last-sync-status
ATTRID: 4
ATTRTYPE: AT_INT
ATTRDESC:: eod
The status of the last synchronization attempt.
eod

ATTR: dbsn
ATTRID: 5
ATTRTYPE: AT_INT
ATTRDESC:: eod
The DBSN of the master datastore when we last successfully
synchronized with it.
eod

ATTR: master-cluster
ATTRID: 6
#ATTRTYPE: AT_OBJREF(CCMCluster)
ATTRTYPE: AT_OID
ATTRFLAGS: AF_REFERENCE
ATTRVAL: 1449
ATTRDESC:: eod
The reference by OID to the CCMCluster object that
contains the master datastore.
eod

ATTR: poll-interval
ATTRID: 9
ATTRTYPE: AT_TIME
ATTRDEFVAL: 14400
ATTRDESC:: eod
The polling interval for this replica DB.
eod

ATTR: poll-offset
ATTRID: 10
ATTRTYPE: AT_TIME
ATTRDEFVAL: 0
ATTRDESC:: eod
Provides a fixed time of day for replica polling.

This time is interpreted as a time of day offset, with 0 being
12 midnight, provided the polling interval is less than 24 hours,
and the offset value is less than the polling interval. If the offset
value is greater than the polling interval, or the interval is
greater than 24 hours, the offset will be ignored.

The scheduler for polling will ensure that the first polling event
occurs at the offset time. For example, if you set the interval to
4 hours and the offset to 2am, the polling would occur at 2am, 6am,
10am, 2pm, 6pm and 10pm.
eod

ATTR: restore-state
ATTRID: 11
ATTRTYPE: AT_ENUMSHORT(active=0, deactivated=1, restoring=2)
ATTRDEFVAL: 0
ATTRFLAGS: AF_PRINT_ALT
ATTRDESC:: eod
Indicates whether the cluster has been deactivated or is in the
process of being restored from the replica db.
eod

CLASS: CCMServerConfig
CLASSID: 1451
CLASSPCV: 5.0.0
CLASSNAME: 52
CLASSDESC:: eod
The global configuration for a CCM server.
eod

ATTR: poll-subnet-util-interval
ATTRID: 1
ATTRTYPE: AT_RANGETIME(0-365d)
ATTRDEFVAL: 4h
ATTRDESC:: eod
This interval specifies how often to collect subnet
utilization from all the DHCP servers. If set to 0, polling
is disabled.
eod

ATTR: poll-subnet-util-retry
ATTRID: 2
ATTRTYPE: AT_RANGEINT(0-4)
ATTRDEFVAL: 1
ATTRDESC:: eod
The number of retries for a given polling interval, if polling fails.
eod

ATTR: trim-subnet-util-interval
ATTRID: 3
ATTRTYPE: AT_RANGETIME(0-365d)
ATTRDEFVAL: 1d
ATTRDESC:: eod
This interval specifies how often to trim the old subnet utilization
data. If set to 0 no automatic subnet utilization trimming occurs.
Changes to this setting will take effect on the next server restart.
eod

ATTR: trim-subnet-util-age
ATTRID: 4
ATTRTYPE: AT_RANGETIME(1d-365d)
ATTRDEFVAL: 24w
ATTRDESC:: eod
The age that we will allow a subnet-util 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. Changes to this setting
will take effect on the next server restart.
eod

ATTR: subnet-util-purge-dblog-interval
ATTRID: 5
ATTRTYPE: AT_RANGETIME(1-86400)
ATTRDEFVAL: 1h
ATTRVIZ: 3
ATTRDESC:: eod
Time interval (secs) of the subnet-util DB's trimming of its
unneeded Btree DB's log files. Changes to this setting will take
effect on the next server restart.
Note: Having a log trimming interval of less than 20 minutes
can cause mcdshadow backup failures.
eod

ATTR: subnet-util-dbcheckpoint-interval
ATTRID: 6
ATTRTYPE: AT_RANGETIME(1-1d)
ATTRDEFVAL: 900
ATTRVIZ: 3
ATTRDESC:: eod
The interval at which the subnet utilization database will
checkpoint, in seconds. Changes to this setting will take effect
on the next server restart.
eod

ATTR: subnet-util-dbcache-size
ATTRID: 7
ATTRTYPE: AT_INT
ATTRDEFVAL: 10000000
ATTRVIZ: 3
ATTRDESC:: eod
The subnet utilization database maintains a memory cache of
'subnet-util-dbcache-chunks' chunks of this size. That is, the memory
footprint of the database cache is the _product_ of these two
settings. Changes to this setting will take effect on the next
server restart.
eod

ATTR: subnet-util-dbcache-chunks
ATTRID: 8
ATTRTYPE: AT_INT
ATTRDEFVAL: 1
ATTRVIZ: 3
ATTRDESC:: eod
The subnet utilization database maintains a memory cache of
'subnet-util-dbcache-chunks' chunks of 'subnet-util-dbcache-size'
size.  That is, the memory footprint of the database cache is the
_product_ of these two settings. Changes to this setting will take
effect on the next server restart.
eod

ATTR: subnet-util-dblogfile-size
ATTRID: 9
ATTRTYPE: AT_INT
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. Changes to this
setting will take effect on the next server restart.
eod

ATTR: subnet-util-dblog-buffer-size
ATTRID: 10
ATTRTYPE: AT_INT
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. Changes to this setting will take effect on the
next server restart.
eod

ATTR: poll-lease-hist-interval
ATTRID: 11
ATTRTYPE: AT_RANGETIME(0-365d)
ATTRDEFVAL: 4h
ATTRDESC:: eod
This interval specifies how often to collect the lease history
information from all the DHCP servers. If set to 0, polling
is disabled.
eod

ATTR: poll-lease-hist-retry
ATTRID: 12
ATTRTYPE: AT_RANGEINT(0-4)
ATTRDEFVAL: 1
ATTRDESC:: eod
The number of retries for a given polling interval, if polling fails.
eod

ATTR: trim-lease-hist-interval
ATTRID: 13
ATTRTYPE: AT_RANGETIME(0-365d)
ATTRDEFVAL: 1d
ATTRDESC:: eod
This interval specifies how often to trim the old lease history data.
If set to 0 no automatic lease history trimming occurs.

If lease history collection and polling are enabled and this parameter
is set to 0, the lease history database will continue to grow without
bound. Changes to this setting will take effect on the next server
restart.
eod

ATTR: trim-lease-hist-age
ATTRID: 14
ATTRTYPE: AT_RANGETIME(1d-365d)
ATTRDEFVAL: 24w
ATTRDESC:: eod
The minimum length of time that we will keep a lease history record in
the lease history database.  Any lease history record older than this
time will be deleted when the next lease history database trimming
operation occurs.

If set to 0, all lease history data will be trimmed. Changes to this
setting will take effect on the next server restart.
eod

ATTR: lease-hist-purge-dblog-interval
ATTRID: 15
ATTRTYPE: AT_RANGETIME(1-86400)
ATTRDEFVAL: 1h
ATTRVIZ: 3
ATTRDESC:: eod
Time interval (secs) of the lease-hist DB's trimming of its
unneeded Btree DB's log files. Changes to this setting will
take effect on the next server restart.
Note: Having a log trimming interval of less than 20 minutes
can cause mcdshadow backup failures.
eod

ATTR: lease-hist-dbcheckpoint-interval
ATTRID: 16
ATTRTYPE: AT_RANGETIME(1-1d)
ATTRDEFVAL: 900
ATTRVIZ: 3
ATTRDESC:: eod
The interval at which the lease history database will checkpoint, in
seconds. Changes to this setting will take effect on the next server
restart.
eod

ATTR: lease-hist-dbcache-size
ATTRID: 17
ATTRTYPE: AT_INT
ATTRDEFVAL: 10000000
ATTRVIZ: 3
ATTRDESC:: eod
The lease history database maintains a memory cache of
'lease-hist-dbcache-chunks' chunks of this size. That is, the memory
footprint of the database cache is the _product_ of these two
settings. Changes to this setting will take effect on the next
server restart.
eod

ATTR: lease-hist-dbcache-chunks
ATTRID: 18
ATTRTYPE: AT_INT
ATTRDEFVAL: 1
ATTRVIZ: 3
ATTRDESC:: eod
The lease history database maintains a memory cache of
'lease-hist-dbcache-chunks' chunks of 'lease-hist-dbcache-size' size.
That is, the memory footprint of the database cache is the
product of these two settings. Changes to this setting will take
effect on the next server restart.
eod

ATTR: lease-hist-dblogfile-size
ATTRID: 19
ATTRTYPE: AT_INT
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. Changes to this
setting will take effect on the next server restart.
eod

ATTR: lease-hist-dblog-buffer-size
ATTRID: 20
ATTRTYPE: AT_INT
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. Changes to this setting will take effect on the
next server restart.
eod

ATTR: poller-event-threads
ATTRID: 21
ATTRTYPE: AT_RANGEINT(1-5)
ATTRDEFVAL: 2
ATTRDESC:: eod
This specifies how many threads that the poller will create.
Changes to this setting will take effect on the next server restart.
eod

ATTR: poll-lease-hist-offset
ATTRID: 22
#ATTRTYPE: AT_RANGETIME(0-24h)
ATTRTYPE: AT_RANGETIME(0-86400)
ATTRDESC:: eod
Provides a fixed time of day for lease history polling.

This time is interpreted as a time of day offset, with 0 being
12 midnight, provided the polling interval is less than 24 hours,
and the offset value is less than the polling interval. If the offset
value is greater than the polling interval, or the interval is
greater than 24 hours, the offset will be ignored.

The scheduler for polling will ensure that the first polling event
occurs at the offset time. For example, if you set the interval to
4 hours and the offset to 2am, the polling would occur at 2am, 6am,
10am, 2pm, 6pm and 10pm.
eod

ATTR: poll-subnet-util-offset
ATTRID: 23
#ATTRTYPE: AT_RANGETIME(0-24h)
ATTRTYPE: AT_RANGETIME(0-86400)
ATTRDESC:: eod
Provides a fixed time of day for subnet utilization polling.

This time is interpreted as a time of day offset, with 0 being
12 midnight, provided the polling interval is less than 24 hours,
and the offset value is less than the polling interval. If the offset
value is greater than the polling interval, or the interval is
greater than 24 hours, the offset will be ignored.

The scheduler for polling will ensure that the first polling event
occurs at the offset time. For example, if you set the interval to
4 hours and the offset to 2am, the polling would occur at 2am, 6am,
10am, 2pm, 6pm and 10pm.
eod

ATTR: next-cluster-id
ATTRID: 24
ATTRTYPE: AT_SHORT
ATTRVIZ: 3
ATTRDESC:: eod
Read-only attribute that specifies the next cluster-id to
be allocated for this server.
eod

ATTR: purge-dblog-interval
ATTRID: 25
ATTRTYPE: AT_RANGETIME(1-86400)
ATTRDEFVAL: 4h
ATTRVIZ: 3
ATTRDESC:: eod
Time interval (secs) of the CCM DB's trimming of its
unneeded Btree DB's log files. Changes to this setting will
take effect on the next server restart.
Note: Having a log trimming interval of less than 20 minutes
can cause mcdshadow backup failures.
eod

ATTR: dbcheckpoint-interval
ATTRID: 26
#ATTRTYPE: AT_RANGETIME(1-1d)
ATTRTYPE: AT_RANGETIME(1-86400)
ATTRDEFVAL: 3600
ATTRVIZ: 3
ATTRDESC:: eod
The interval at which the CCM database will checkpoint, in
seconds. Changes to this setting will take effect on the next
server restart.
eod

ATTR: subnet-util-db-max-txn-records
ATTRID: 27
ATTRTYPE: AT_INT
ATTRDEFVAL: 5000
ATTRVIZ: 3
ATTRDESC:: eod
The maximum number of records committed in each transaction for subnet
utilization db. Changes to this setting will take effect on the next
server restart.
eod

ATTR: lease-hist-db-max-txn-records
ATTRID: 28
ATTRTYPE: AT_INT
ATTRDEFVAL: 5000
ATTRVIZ: 3
ATTRDESC:: eod
The maximum number of records committed in each transaction for lease
history db. Changes to this setting will take effect on the next
server restart.
eod

ATTR: local-scp-read-timeout
ATTRID: 29
ATTRTYPE: AT_TIME
ATTRDEFVAL: 1200
ATTRVIZ: 3
ATTRDESC:: eod
The amount of time we will wait for data when reading a message from a
local server.  For remote servers, identified by a CCMCluster object,
use CCMCluster.scp-read-timeout.
eod

ATTR: lease-hist-detail
ATTRID: 30
ATTRTYPE: AT_BOOL
ATTRDEFVAL: true
ATTRDESC:: eod
If polling for lease history data, this causes CCM to ask for history
detail data when polling DHCP servers, and save the detail data when
it's returned. Changes to this setting will take effect on
the next server restart.
eod

ATTR: subnet-util-db-lock-count
ATTRID: 31
ATTRTYPE: AT_INT
ATTRDEFVAL: 15000
ATTRVIZ: 3
ATTRDESC:: eod
The maximum number of database transaction locks available.
Sometimes, particularly when processing a large configuration,
the number of records per database transaction can grow well
beyond this limit, but subnet-util-db-max-txn-records (default 5000)
will force these larger transactions to be processed in smaller
chunks. Set debug U=1 and stop the server to see the high water
mark for locks used. Changes to this setting will take effect on
the next server restart.
eod

ATTR: lease-hist-db-lock-count
ATTRID: 32
ATTRTYPE: AT_INT
ATTRDEFVAL: 15000
ATTRVIZ: 3
ATTRDESC:: eod
The maximum number of database transaction locks available.
Sometimes, particularly when processing a large configuration,
the number of records per database transaction can grow well
beyond this limit, but lease-hist-db-max-txn-records (default 5000)
will force these larger transactions to be processed in smaller
chunks. Set debug E=1 and stop the server to see the high water
mark for locks used. Changes to this setting will take effect on
the next server restart.
eod

ATTR: replica-db-max-txn-records
ATTRID: 33
ATTRTYPE: AT_INT
ATTRDEFVAL: 5000
ATTRVIZ: 3
ATTRDESC:: eod
The maximum number of records committed in each transaction for
replica db. Changes to this setting will take effect on the next
server restart.
eod


ATTR: replica-db-lock-count
ATTRID: 34
ATTRTYPE: AT_INT
ATTRDEFVAL: 15000
ATTRVIZ: 3
ATTRDESC:: eod
The maximum number of database transaction locks available.
Sometimes, particularly when processing a large configuration,
the number of records per database transaction can grow well
beyond this limit, but the replica-db-max-txn-records (default 5000)
will force these larger transactions to be processed in smaller
chunks. Set debug D=1 and stop the server to see the high water
mark for locks used. Changes to this setting will take effect on
the next server restart.
eod


ATTR: poll-replica-interval
ATTRID: 35
ATTRTYPE: AT_RANGETIME(0-365d)
ATTRDEFVAL: 4h
ATTRDESC:: eod
This interval specifies the default value of how often to poll
for configuration changes when replicating data from a local cluster.
eod

ATTR: poll-replica-offset
ATTRID: 36
ATTRTYPE: AT_RANGETIME(0-24h)
ATTRDEFVAL: 0
ATTRDESC:: eod
Provides a fixed time of day for replica polling.

This time is interpreted as a time of day offset, with 0 being
12 midnight, provided the polling interval is less than 24 hours,
and the offset value is less than the polling interval. If the offset
value is greater than the polling interval, or the interval is
greater than 24 hours, the offset will be ignored.

The scheduler for polling will ensure that the first polling event
occurs at the offset time. For example, if you set the interval to
4 hours and the offset to 2am, the polling would occur at 2am, 6am,
10am, 2pm, 6pm and 10pm.
eod

ATTR: atul-port
ATTRID: 37
ATTRTYPE: AT_RANGEINT(1-65535)
ATTRDEFVAL: 7543
ATTRDESC:: eod
Enables the CCM server to listen for incoming ATUL queries
on this UDP port. This attribute is used only by the
regional CCM server. Changes to this setting take effect
on the next server restart.
eod

ATTR: atul-support
ATTRID: 38
ATTRTYPE: AT_BOOL
ATTRFLAGS: AF_FEATURE
ATTRDEFVAL: false
ATTRDESC:: eod
Enables CCM support for the ATUL query protocol. The atul-port
parameter configures the port number to listen on for ATUL
queries. Changes to this setting take effect on the next server
restart.
eod

ATTR: regional-zone-edit-mode
ATTRID: 39
ATTRTYPE: AT_ENUMINT(staged=1, synchronous=2)
ATTRFLAGS: AF_PRINT_ALT
ATTRDEFVAL: 1
ATTRDESC:: eod
Indicates the default mode that regional clients should use
for DNS updates.

This default mode is overridden if a mode is specified in a given CCM
SCP message (in other words, by specific client request).  If
unset, clients should always present the choice of mode to the user.
eod

ATTR: local-zone-edit-mode
ATTRID: 40
ATTRTYPE: AT_ENUMINT(staged=1, synchronous=2)
ATTRFLAGS: AF_PRINT_ALT
ATTRDEFVAL: 2
ATTRDESC:: eod
Indicates the efault mode that local clients should use for DNS
updates.
This default mode is overridden if a mode is specified in a given CCM
SCP message (in other words, by specific client request).  If
unset, clients should always present the choice of mode to the user.
eod

ATTR: poll-db-checkpoint
ATTRID: 41
ATTRTYPE: AT_INT
ATTRDEFVAL: 10000
ATTRVIZ: 3
ATTRDESC:: eod
Sets the maximum number of records to receive before pausing
to force a database checkpoint and log purge.
eod

ATTR: trim-changeset-age
ATTRID: 42
ATTRTYPE: AT_RANGETIME(1d-3y)
ATTRDEFVAL: 1y
ATTRDESC:: eod
Sets the minimum age for a change log entry to be eligible
for trimming.
eod

ATTR: trim-changeset-interval
ATTRID: 43
ATTRTYPE: AT_RANGETIME(1d-1y)
ATTRVIZ: 3
ATTRDEFVAL: 1d
ATTRDESC:: eod
Sets the time interval that the change log trim function is run.
Changes to this setting take effect after the next scheduled
event.
eod

ATTR: trim-changeset-time
ATTRID: 44
#ATTRTYPE: AT_RANGETIME(0-24h)
ATTRTYPE: AT_RANGETIME(0-86400)
ATTRVIZ: 3
ATTRDEFVAL: 10800
ATTRDESC:: eod
Sets the time of day when the automated change log trim occurs.
Data is in seconds after midnight. Changes to this setting take
effect after the next scheduled event.

eod

ATTR: scope-edit-mode
ATTRID: 45
ATTRTYPE: AT_ENUMINT(staged=1, synchronous=2)
ATTRFLAGS: AF_PRINT_ALT
ATTRDEFVAL: 1
ATTRDESC:: eod
Indicates the default mode that web UI and CLI clients use
for DHCP edits:

    1  staged
       Edits are written to the database but are not immediately
       forwarded to the DHCP server; that is, they remain
       unpublished by DHCP.

    2  synchronous
       Edits are written to the database and are immediately
       forwarded for publishing to the DHCP server.
eod

ATTR: trim-changeset-db-max-size
ATTRID: 46
ATTRTYPE: AT_INT
ATTRVIZ: 3
ATTRDEFVAL: 0
ATTRDESC:: eod
The maximum number of change set objects allowed in any one
data base after executing the change log trim function.
If this value is set to zero, there is no trimming based on
size, only age is considered.
eod

ATTR: stats-history-sample-interval
ATTRID: 47
ATTRTYPE: AT_RANGETIME(0-10m)
ATTRVIZ: 3
ATTRDEFVAL: 10
ATTRDESC:: eod
This interval specifies how often to poll the DHCP and DNS protocol
servers for their current statistics.
If 0 < value < 10 (seconds), polling will occur at 10 second
intervals. If set to 0 then don't poll (all other stats-history~
attributes are then ignored).
eod

ATTR: stats-history-max-samples
ATTRID: 48
ATTRTYPE: AT_RANGEINT(60-5000)
ATTRVIZ: 3
ATTRDEFVAL: 2160
ATTRDESC:: eod
This interval specifies the total number of statistics history
samples to keep in memory.
eod

ATTR: stats-history-sparse-age
ATTRID: 49
ATTRTYPE: AT_RANGETIME(0-1d)
ATTRVIZ: 3
ATTRDEFVAL: 2h
ATTRDESC:: eod
This number indicates that history statistics older than this should
be retained by CCM at a sparser interval.
eod

ATTR: stats-history-sparse-retain-interval
ATTRID: 50
ATTRTYPE: AT_RANGETIME(1m-1h)
ATTRVIZ: 3
ATTRDEFVAL: 1m
ATTRDESC:: eod
This interval specifies the sparsity interval at which to retain
server history data older than stats-history-sparse-age.
eod

ATTR: webui-mode
ATTRID: 51
ATTRTYPE: AT_ENUMINT(Basic=0,Advanced=1,Expert=2)
ATTRDEFVAL: Basic
ATTRFLAGS: AF_PRINT_ALT
ATTRDESC:: eod
Sets the mode for the web UI at session startup:

    0  basic
    1  advanced
    2  expert
eod

ATTR: name
ATTRID: 52
ATTRTYPE: AT_STRING
ATTRDEFVAL: CCM
ATTRVIZ: 3
ATTRDESC:: eod
An optional name for this server.
eod

# classids for the RIC server and its stats

CLASS: CCMRICServer
CLASSID: 1452
CLASSVIZ: 1
CLASSDESC:: eod
A placeholder class for the RIC Server.
eod

CLASS: CCMRICStats
CLASSID: 1453
CLASSVIZ: 1
CLASSDESC:: eod
A placeholder class for the RIC Server's stats.
eod

CLASS: CCMRouterLoginTemplate
CLASSID: 1454
CLASSPCV: 5.0.0
CLASSDESC:: eod
A router login template. A CCMRouterLoginTemplate object can be
used with router types that allow for customizable prompts in the
RIC server processing that accesses the remote router.
eod

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

ATTR: username-prompt
ATTRID: 2
ATTRTYPE: AT_STRING
ATTRDESC:: eod
The string that is used as the username prompt by the router.
eod

ATTR: password-prompt
ATTRID: 3
ATTRTYPE: AT_STRING
ATTRDESC:: eod
The string that is used as the user password prompt by the router.
eod

ATTR: login-prompt
ATTRID: 4
ATTRTYPE: AT_STRING
ATTRFLAGS: AF_REQUIRED
ATTRDESC:: eod
The string that is used as the login prompt by the router.
eod

ATTR: ena-pass-prompt
ATTRID: 5
ATTRTYPE: AT_STRING
ATTRDESC:: eod
The string that is used as the enable password prompt by the router.
eod

ATTR: enable-prompt
ATTRID: 6
ATTRTYPE: AT_STRING
ATTRFLAGS: AF_REQUIRED
ATTRDESC:: eod
The string that is used as the prompt by the router in enable mode.
eod

CLASS: CCMSubnetUtilizationState
CLASSID: 1455
CLASSPCV: 5.0.0
CLASSDESC:: eod
The status of subnet utilization polling for a local cluster or
failover pair.
eod

ATTR: remote-oid
ATTRID: 1
ATTRTYPE: AT_OID
ATTRDESC:: eod
The actual remote server or failoverpair that is being polled.
This can be CCMServer or FailoverPair.
eod

ATTR: last-sync
ATTRID: 2
ATTRTYPE: AT_DATE
ATTRDESC:: eod
Specifies the time of the last successful synchronization
with this server.
eod

ATTR: last-sync-attempt
ATTRID: 3
ATTRTYPE: AT_DATE
ATTRDESC:: eod
Specifies the time of the last successful synchronization
attempt.
eod

ATTR: last-sync-status
ATTRID: 4
ATTRTYPE: AT_INT
ATTRDESC:: eod
What was the status from our last synchronization attempt?
Unset or 0 implies OK.
eod

ATTR: main-server-sync
ATTRID: 5
ATTRTYPE: AT_BOOL
ATTRDESC:: eod
Indicates whether data is polled from main server or not.
eod

ATTR: last-sync-all
ATTRID: 6
ATTRTYPE: AT_DATE
ATTRDESC:: eod
Specifies the time of the last successful synchronization
of all main data with this server.
eod

CLASS: CCMLeaseHistoryState
CLASSID: 1456
CLASSPCV: 5.0.0
CLASSDESC:: eod
The status of lease history polling for a local cluster or
failover pair.
eod

ATTR: remote-oid
ATTRID: 1
ATTRTYPE: AT_OID
ATTRDESC:: eod
The actual remote server or failoverpair that is being polled.
This can be CCMServer or FailoverPair.
eod

ATTR: last-sync
ATTRID: 2
ATTRTYPE: AT_DATE
ATTRDESC:: eod
Specifies the time of the last successful synchronization
with this server.
eod

ATTR: last-sync-attempt
ATTRID: 3
ATTRTYPE: AT_DATE
ATTRDESC:: eod
Specifies the time of the last successful synchronization
attempt.
eod

ATTR: last-sync-status
ATTRID: 4
ATTRTYPE: AT_INT
ATTRDESC:: eod
What was the status from our last synchronization attempt?
Unset or 0 implies OK.
eod

ATTR: main-server-sync
ATTRID: 5
ATTRTYPE: AT_BOOL
ATTRDESC:: eod
Indicates whether data is polled from main server or not.
eod

ATTR: last-sync-all
ATTRID: 6
ATTRTYPE: AT_DATE
ATTRDESC:: eod
Specifies the time of the last successful synchronization
with this server for all main data.
eod

CLASS: CCMZDSecondary
CLASSID: 1457
CLASSPCV: 5.0.0
CLASSDESC:: eod
A secondary DNS server in a zone distribution map. The list of
CCMZDSecondary objects in a CCMZoneDistribution map is embedded
in the CCMZoneDistribution object.
eod

ATTR: secondary
ATTRID: 1
#ATTRTYPE: AT_OBJREF(CCMCluster)
ATTRTYPE: AT_OID
ATTRFLAGS: AF_REFERENCE
ATTRVAL: 1449
ATTRDESC:: eod
The cluster with the secondary server that this object
describes.
eod

ATTR: master-servers
ATTRID: 2
ATTRTYPE: AT_NLIST(AT_IPKEY)
# AT_IPKEY=56
ATTRVAL: 56

ATTRDESC:: eod
This is the list of master-servers to set when creating secondary
zone on secondary server.

Validation: A list of one or more ip addresses with an optional
key name (format <ipaddress>[-<keyname>]).
eod

ATTR: last-sync-dbsn
ATTRID: 3
ATTRTYPE: AT_INT
ATTRFLAGS: AF_INITIALIZE
ATTRDEFVAL: 0
ATTRVIZ: 3
ATTRDESC:: eod
This is used for internal logic.
eod

ATTR: restrict-xfer
ATTRID: 4
ATTRTYPE: AT_ENUMINT(enable=1,disable=2,use-server-settings=3)
ATTRFLAGS: AF_PRINT_ALT
ATTRDESC:: eod
If use-server-settings is set, unset the value on secondary zones.
If unset, use the zone distribution map value to configure
secondary zones.

Configure secondary zones to restrict sending zone transfers to a
specific set of hosts. If you restrict zone transfers, you need
to use the restrict-xfer-acl property to specify the access control
list of who is allowed to perform zone transfers.
eod

ATTR: restrict-xfer-acl
ATTRID: 5
ATTRTYPE: AT_AMELST
ATTRDESC:: eod
If restrict-xfer is enabled, use this value to configure secondary
zones.

The access control list that designates who is allowed to receive
zone transfers from this zone.
eod


ATTR: ixfr
ATTRID: 6
ATTRTYPE: AT_ENUMINT(enable=1,disable=2,use-server-settings=3)
ATTRFLAGS: AF_PRINT_ALT
ATTRDESC:: eod
If use-server-settings is set then unset the value on secondary zones.
If unset, use the zone distribution map value to configure
secondary zones.

Configure secondary zones to enable incremental transfer requests for
the zone.  When set, this attribute overrides the dns server global
"ixfr-enable" value. Using the server global value (not setting this
value per-zone) gives the you an easy way to globally turn ixfr on or
off, or set a general policy for your zones and specific exceptions
to the server global value.
eod

ATTR: notify
ATTRID: 7
ATTRTYPE: AT_ENUMINT(enable=1,disable=2,use-server-settings=3)
ATTRFLAGS: AF_PRINT_ALT
ATTRDESC:: eod
If use-server-settings is set, unset the value on secondary zones.
If unset, use the zone distribution map value to configure
secondary zones.

Configure secondary zones to enable notify to other authoritative
servers when the zone changes.  When set to enable or disable,
it overrides the global "notify" value for this zone.
eod

ATTR: notify-set
ATTRID: 8
ATTRTYPE: AT_NLIST(AT_IPADDR)
# AT_IPADDR = 4
ATTRVAL: 4
ATTRDESC:: eod
If notify is enabled, use this value to configure secondary zones.

An optional list of additional servers to notify when the zone
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) will receive notifications.
Servers listed in "notify-list" will also be notified.
eod

ATTR: restrict-query
ATTRID: 9
ATTRTYPE: AT_ENUMINT(use-map-settings=1,use-server-settings=2)
ATTRFLAGS: AF_PRINT_ALT
ATTRDESC:: eod
If use-server-settings is set, unset the restrict-query-acl on
secondary zones.
If use-map-settings is set, use the restrict-query-acl.
If unset, use the zone distribution map value to determine
how restrict-query-acl is configured on secondary zones.
eod


ATTR: restrict-query-acl
ATTRID: 10
ATTRTYPE: AT_AMELST
ATTRDESC:: eod
If restrict-query is set to use-map-settings, use this
value to configure secondary zones. If unset, use the zone
distribution map value to configure secondary zones.

The zone Address Control List (ACL) used to restrict queries to be
honored by the DNS server on this zone. This list can contain host
IPs, network addresses, TSIG keys and/or (global) ACLs.  Those
clients defined in this ACL  list shall be honored; others shall be
refused. If missing, the zone inherits the value of the server's
restrict-query-acl attribute.
eod


#
# Placeholder class for the cnr tomcat/http server.
#
CLASS: Tomcat
CLASSID: 1460
CLASSVIZ: 3
CLASSDESC:: eod
Placeholder class for the cnr tomcat/http server.
eod

###############################################################################
# Begin Webui display classes
###############################################################################

CLASS: CCMScpClassDisplayFormat
CLASSID: 1500
CLASSVIZ: 3
CLASSDESC:: eod
A display format description for generic handling of an ScpObj of a
particular ScpClass.
eod

ATTR: name
ATTRID: 1
ATTRTYPE: AT_STRING
ATTRFLAGS: AF_UNIQUE, AF_REQUIRED
ATTRDESC:: eod
The value of this attribute must be the name of the ScpClass for
the ScpObj being displayed.
eod

ATTR: display-name
ATTRID: 2
ATTRTYPE: AT_STRING
ATTRDESC:: eod
An optional display name for the ScpClass.  If not specified, the
name attribute will be used instead.
eod

ATTR: partial-tag
ATTRID: 3
ATTRTYPE: AT_STRING
ATTRDESC:: eod
An optional partial-tag identifying a display format for the ScpClass.
The same ScpClass may have multiple display formats in the same
context, each identified with a different partial-tag.
(Or, a display format may have no partial-tag specified, in which case
it is taken to be a display format for the entire ScpClass.)
If a partial-tag is specified, only those attributes specifically
called out in the display format will be displayed (so as to avoid
having to explicitly suppress those attributes which are not to be
included in this partial display format).
eod

## ATTRIDs 4-8 available for future use

ATTR: context
ATTRID: 9
ATTRTYPE: AT_ENUMINT(all=0, local=1, regional=2)
ATTRFLAGS: AF_REQUIRED, AF_PRINT_ALT
ATTRDEFVAL: all
ATTRDESC:: eod
Specifies the server context for which this class display
format is valid.
eod

ATTR: groups
ATTRID: 10
ATTRTYPE: AT_NLIST(CCMScpClassDisplayGroup)
ATTRFLAGS: AF_REQUIRED
ATTRDESC:: eod
The ordered list of display groups for the class.  At least one group
must be specified.
eod

CLASS: CCMScpClassDisplayGroup
CLASSID: 1501
CLASSVIZ: 3
CLASSDESC:: eod
A format description for a group of attributes of a particular
ScpClass.  This class is not intended for to be instantiated
independently; rather, it should always be embedded within
an instance of the CCMScpClassDisplayFormat class.
eod

ATTR: name
ATTRID: 1
ATTRTYPE: AT_STRING
ATTRFLAGS: AF_UNIQUE, AF_REQUIRED
ATTRDESC:: eod
The name of the display group of ScpClass attributes.
eod

ATTR: display-name
ATTRID: 2
ATTRTYPE: AT_STRING
ATTRDESC:: eod
An optional display name for the group.  If not specified, the
name attribute will be used instead.
eod

ATTR: no-banner
ATTRID: 3
ATTRTYPE: AT_BOOL
ATTRDEFVAL: false
ATTRDESC:: eod
If true, then no banner line should be displayed for the group.
Thus, neither the group name nor its display-name would be shown.
This option would likely be used where all the attributes in a
class fall into one layout group, and that group cannot be hidden.
eod

ATTR: visibility
ATTRID: 4
ATTRTYPE: AT_ENUMINT(excluded=0, debug=1, edit=2, add=3)
ATTRFLAGS: AF_REQUIRED, AF_PRINT_ALT
ATTRDESC:: eod
The visibility for the group.  Note that groups which have
add visibility are also visible for edit and debug; those which have
edit visibility are also visible for debug (but not for add); and
excluded groups are never shown.
eod

ATTR: expansion
ATTRID: 5
ATTRTYPE: AT_ENUMINT(collapsed=0, edit=1, add=2, cannotHide=3)
ATTRFLAGS: AF_REQUIRED, AF_PRINT_ALT
ATTRDEFVAL: collapsed
ATTRDESC:: eod
The expansion for the group.  This attribute does not override
the value of the visibility attribute.  It specifies how the
group should be displayed, if it is visible.  A group with
cannotHide expansion displays no show/hide toggle.  A group
with add expansion is expanded in add and edit pages.  A group
with edit expansion is expanded in edit pages and collapsed in
add pages.  A group with collapsed expansion is shown initially
in collapsed state (but has a show/hide control and so may be
expanded).
eod

ATTR: readonly
ATTRID: 6
ATTRTYPE: AT_BOOL
ATTRDEFVAL: false
ATTRDESC:: eod
Determines whether all the attributes belonging to this group are
to be displayed in a readonly (non-editable) manner.
eod

ATTR: no-header
ATTRID: 7
ATTRTYPE: AT_BOOL
ATTRDEFVAL: false
ATTRDESC:: eod
If true, then no header line should be displayed for the group.
Thus, the headings "Attribute", "Value", "Data Type", etc., are
suppressed.
eod

ATTR: selection-tag-list
ATTRID: 8
ATTRTYPE: AT_NLIST(AT_STRING)
# AT_STRING = 5
ATTRVAL: 5
ATTRDESC:: eod
The list of selection tags to associate with this group.
If unset, group is displayed in accordance with the other
group settings (i.e., display-name, no-banner, no-header,
visibility, expansion, readonly).  If set, then at least one
of the specified tags must match those supplied by the
caller; then group is displayed in accordance with the other
group settings (i.e., display-name, no-banner, no-header,
visibility, expansion, readonly); otherwise, the group
is suppressed.
eod

## ATTRID 9 available for future use

ATTR: attributes
ATTRID: 10
ATTRTYPE: AT_NLIST(CCMScpClassDisplayAttribute)
ATTRFLAGS: AF_REQUIRED
ATTRDESC:: eod
The ordered list of display attributes for the group.  At least one
attribute must be specified.
eod

## ATTRIDs 11-19 available for future use

ATTR: alt-desc
ATTRID: 20
ATTRTYPE: AT_STRING
ATTRDESC:: eod
An optional descriptive string which should be suitable for display
to an end user.  For example, in a GUI, this could be text to
display in a tool-tip.
eod

CLASS: CCMScpClassDisplayAttribute
CLASSID: 1502
CLASSVIZ: 3
CLASSDESC:: eod
A format description for a single attribute of a particular
ScpClass.  This class is not intended for to be instantiated
independently; rather, it should always be embedded within
an instance of the CCMScpClassDisplayGroup class.
eod

ATTR: name
ATTRID: 1
ATTRTYPE: AT_STRING
ATTRFLAGS: AF_UNIQUE, AF_REQUIRED
ATTRDESC:: eod
The name of ScpClass attribute.
eod

ATTR: display-name
ATTRID: 2
ATTRTYPE: AT_STRING
ATTRDESC:: eod
An optional display name for the attribute.  If not specified, the
name attribute will be used instead.
eod

## ATTRIDs 3-5 available for future use

ATTR: readonly
ATTRID: 6
ATTRTYPE: AT_BOOL
ATTRDEFVAL: false
ATTRDESC:: eod
Determines whether an attribute is displayed in a readonly
(non-editable) manner.
eod

ATTR: ignore-viz
ATTRID: 7
ATTRTYPE: AT_BOOL
ATTRDEFVAL: false
ATTRDESC:: eod
Determines whether an attribute is displayed regardless
of its datadict visibility (i.e., its ATTRVIZ value).
eod

ATTR: custom-control
ATTRID: 8
ATTRTYPE: AT_BOOL
ATTRDEFVAL: false
ATTRDESC:: eod
Determines whether an attribute is to be processed and/or displayed
using a user-supplied Java Method -- if false or unset,
attribute will be processed and/or displayed generically.
eod

ATTR: process-method-name
ATTRID: 9
ATTRTYPE: AT_STRING
ATTRDESC:: eod
If specified, gives name of user-supplied Java Method
to process HTML submitted by this custom-control.
eod

ATTR: display-method-name
ATTRID: 10
ATTRTYPE: AT_STRING
ATTRDESC:: eod
If specified, gives name of user-supplied Java Method
to display HTML for this custom-control in a form.
eod

ATTR: placeholder
ATTRID: 11
ATTRTYPE: AT_BOOL
ATTRDEFVAL: false
ATTRDESC:: eod
If true, indicates that this attribute name does not correspond
to an actual attribute in the corresponding class, but that this
name is to be used (in conjunction with the custom-control
attributes) to embed special processing in a generic page.
eod

ATTR: submit-change
ATTRID: 12
ATTRTYPE: AT_BOOL
ATTRDEFVAL: false
ATTRDESC:: eod
If true, indicates that a submit action should be included
in the generic control for this attribute.
eod

ATTR: boolean-true
ATTRID: 13
ATTRTYPE: AT_STRING
ATTRDESC:: eod
If the display attribute is of type AT_BOOL, specifies the string
to display for the boolean TRUE value, instead of the datadict
string.
eod

ATTR: boolean-false
ATTRID: 14
ATTRTYPE: AT_STRING
ATTRDESC:: eod
If the display attribute is of type AT_BOOL, specifies the string
to display for the boolean FALSE value, instead of the datadict
string.
eod

ATTR: full-width
ATTRID: 15
ATTRTYPE: AT_BOOL
ATTRDEFVAL: false
ATTRDESC:: eod
If true, indicates that a the control for this attribute occupies
the full width of the display: i.e., any additional columns
(data type, default value, unset) should be subsumed.
eod

## ATTRIDs 16-19 available for future use

ATTR: alt-desc
ATTRID: 20
ATTRTYPE: AT_STRING
ATTRDESC:: eod
An optional short descriptive string which should be suitable for
display to an end user.  For example, in a GUI, this could be text to
display in a tool-tip.
If this attribute is not set, the UI could choose to display the
dictionary ATTRDESC for the underlying datadict attribute.
eod

#
# FileSearchResult - returns results from searches into
# text files, used initially for searches in CNR server log files.
#

CLASS: FileSearchResult
CLASSID: 1503
CLASSPCV: 7.0.0
CLASSDESC:: eod
The text lines matching a search criteria. A FileSearchResult object
is used to report results from searches into server log files.
eod

ATTR: file
ATTRID: 1
ATTRTYPE: AT_STRING
ATTRDESC:: eod
The name of the file where the match was found.
eod

ATTR: match-index
ATTRID: 2
ATTRTYPE: AT_INT
ATTRDESC:: eod
The index of the matching line in the list of 'lines'.
eod

ATTR: lines
ATTRID: 3
ATTRTYPE: AT_NLIST(AT_STRING)
ATTRDESC:: eod
An array of lines of text from the file, probably including some
context on either side of the line that matched the client's query.
eod

ATTR: match-line-number
ATTRID: 4
ATTRTYPE: AT_INT
ATTRDESC:: eod
The line number of the matching line in the log file.
eod

ATTR: log-number
ATTRID: 5
ATTRTYPE: AT_INT
ATTRDESC:: eod
If returning results from a server's log file, this specifies which
of the server's logs this result comes from. This is included because
the file name may be interesting for display, but the file index may
be necessary to do further navigation.
eod

ATTR: match-line-offset
ATTRID: 6
ATTRTYPE: AT_INT
ATTRDESC:: eod
The file offset of the matching line in the log file.
eod

# end FileSearchResult class

#
# CCMDatabaseInfo -- information about server 'databases'
#     available at a cluster
#

CLASS: CCMDatabaseInfo
CLASSID: 1504
CLASSNAME: 1
CLASSPCV: 7.0.0
CLASSDESC:: eod
The database identifier associated with a local cluster
database.
eod

ATTR: name
ATTRID: 1
ATTRTYPE: AT_STRING
ATTRDESC:: eod
The server or database name.
eod

ATTR: id
ATTRID: 2
ATTRTYPE: AT_INT
ATTRDESC:: eod
The dbid associated with the database.
eod

#
# CLASS: CCMHaDnsPair
#

CLASS: CCMHaDnsPair
CLASSID: 1505
CLASSNAME: 1
CLASSPCV: 7.0.0
CLASSDESC:: eod
A High-Availability (HA) DNS pair. A CCMHaDnsPair object defines the
main and backup clusters in the pair, and associated HA attributes
which must be synchronized. This class is analogous to the
CCMFailoverPair class used to manage DHCP failover pairs. It is used
to synchronize the configuration data on the main and backup DNS
servers.

A local cluster is limited to a single CCMHaDnsPair object, and the
localhost cluster must be either the main or backup in the pair.
eod

ATTR: name
ATTRID: 1
ATTRTYPE: AT_STRING
ATTRFLAGS: AF_REQUIRED,AF_UNIQUE
ATTRDESC:: eod
The name of the DNS HA pair relationship.
eod

ATTR: main
ATTRID: 2
#ATTRTYPE: AT_OBJREF(CCMCluster)
ATTRTYPE: AT_OID
ATTRFLAGS: AF_REFERENCE
ATTRVAL: 1449
ATTRDESC:: eod
The cluster reference for the main server in this DNS HA
pair relationship.
eod

ATTR: backup
ATTRID: 3
#ATTRTYPE: AT_OBJREF(CCMCluster)
ATTRTYPE: AT_OID
ATTRFLAGS: AF_REFERENCE
ATTRVAL: 1449
ATTRDESC:: eod
The cluster reference for the backup server in this DNS HA
pair relationship.
eod

## The following attrs are direct counterparts to
## the DNSServer class attrs which must be synchronized
## for HA pair synchronization

ATTR: ha-dns
ATTRID: 4
ATTRTYPE: AT_BOOL
ATTRFLAGS: AF_FEATURE
ATTRDEFVAL: true
ATTRDESC:: eod
This attribute enables/disables HA on the DNS server.
eod

ATTR: ha-dns-port
ATTRID: 5
ATTRTYPE: AT_INT
ATTRVIZ: 3
ATTRDEFVAL: 653
ATTRDESC:: eod
This attribute specifies the TCP port number used for HA
servers communication. The value of this attribute must
be consistent for both HA servers.
eod

ATTR: ha-dns-main-server
ATTRID: 6
ATTRTYPE: AT_IPADDR
ATTRDESC:: eod
The IP address to use for the HA DNS protocol on the main server.
If this value is unset, the address specified for the main cluster
will be used. In general, it should only be set if the server is
configured with different interfaces for configuration management
and update requests. The HA DNS protocol should always be
configured with the interface used to service updates.
eod

ATTR: ha-dns-backup-server
ATTRID: 7
ATTRTYPE: AT_IPADDR
ATTRDESC:: eod
The IP address to use for the HA DNS protocol on the backup server.
If this value is unset, the address specified for the backup cluster
will be used. In general, it should only be set if the server is
configured with different interfaces for configuration management
and update requests. The HA DNS protocol should always be
configured with the interface used to service updates.
eod

ATTR: ha-dns-poll-interval
ATTRID: 8
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 the server received
a request or response from its partner was more than
ha-dns-comm-timeout.
On the HA backup server, this is the interval at which
the HA server sends a heartbeat request.
eod

ATTR: ha-dns-comm-timeout
ATTRID: 9
ATTRTYPE: AT_RANGETIME(1-300)
ATTRVIZ: 3
ATTRDEFVAL: 30
ATTRDESC:: eod
This time interval specifies the amount of time which is allowed
between sending a HA message and a successful acknowledgement from
the HA partner. Expirarion of this time interval causes the HA
server to assume its partner is unreachable, triggering a HA state
transition (into Communication-Interrupted state)
eod

ATTR: ha-dns-max-batch-count
ATTRID: 10
ATTRTYPE: AT_RANGEINT(100-10000)
ATTRVIZ: 3
ATTRDEFVAL: 1000
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: 11
ATTRTYPE: AT_RANGEINT(25-100)
ATTRVIZ: 3
ATTRDEFVAL: 100
ATTRDESC:: eod
This value defines a percentage that the HA server uses to
allow its edit 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

## end of DNSServer "ha-dns" attrs

CLASS: CCMDnsUpdateMap
CLASSID: 1506
CLASSNAME: 1
CLASSPCV: 7.0.0
CLASSDESC:: eod
The DNS update map for a simple DHCP/DNS server pair.
A CCMDnsUpdateMap object defines the DHCP server or pair
that will be performing updates to a single DNS server or pair.
All scopes serviced by the DHCP server or pair, and all primary
zones serviced by the DNS server or pair will be configured
for DNS updates when a DNS update map is applied.

More complex relationships between zones and DNS update clients
must be manually configured.
eod

ATTR: name
ATTRID: 1
ATTRTYPE: AT_STRING
ATTRFLAGS: AF_REQUIRED, AF_UNIQUE
ATTRDESC:: eod
The name of this managed DNS update configuration.
eod

ATTR: dhcp-servers
ATTRID: 2
ATTRTYPE: AT_OID(CCMCluster|CCMFailoverPair)
ATTRFLAGS: AF_REQUIRED
ATTRDESC:: eod
The DHCP server or DHCP failover pair associated with
this configuration.
eod

ATTR: dns-servers
ATTRID: 3
ATTRTYPE: AT_OID(CCMCluster|CCMHaDnsPair)
ATTRFLAGS: AF_REQUIRED
ATTRDESC:: eod
The DNS server or HA pair associated with
this configuration.
eod

ATTR: dhcp-policy-selector
ATTRID: 4
ATTRTYPE: AT_ENUMINT(use-named-policy=1,use-client-class-embedded-policy=2,use-scope-embedded-policy=3)
ATTRFLAGS: AF_REQUIRED
ATTRDEFVAL: use-named-policy
ATTRDESC:: eod
Indicates how to find the DHCP Policy to which to attach the
DnsUpdateConfig referenced in the dns-config attribute. If a
named-policy or client-class-embedded-policy is selected,
the referenced policy and/or client-class must be preconfigured
on the DHCP servers before the map is applied. If
scope-embedded-policy is selected, it is applied to all scopes
on the DHCP servers. A new embedded policy is created if one
does not exist when the map is applied.
eod

ATTR: dhcp-client-class
ATTRID: 5
ATTRTYPE: AT_NAMEREF(ClientClass)
ATTRVAL: 1117
ATTRDESC:: eod
If dhcp-policy-selector=use-client-class-policy, this attribute
specifies the named client-class embedded policy which
should specify the DnsUpdateConfig referenced in this map.
A new embedded policy will be created if one does not exist
when the map is applied.
eod

ATTR: dhcp-named-policy
ATTRID: 6
ATTRTYPE: AT_NAMEREF(Policy)
ATTRVAL: 1102
ATTRDESC:: eod
If dhcp-policy-selector=use-named-policy, this attribute
specifies the named policy which should specify the DnsUpdateConfig
referenced in this map.
eod

ATTR: dns-config
ATTRID: 7
ATTRTYPE: AT_NAMEREF(DnsUpdateConfig)
ATTRVAL: 1145
ATTRFLAGS: AF_REQUIRED
ATTRDESC:: eod
The DnsUpdateConfig object associated with this configuration.
eod

ATTR: dns-update-policy-list
ATTRID: 8
ATTRTYPE: AT_NLIST(AT_NAMEREF(UpdatePolicy))
ATTRVAL: 60
ATTRDESC:: eod
The list of DNS update policies to apply to zones referenced by the
DnsUpdateConfig in this map.  If the attribute dns-update-acl
is set, then this attribute is ignored.

If neither attribute is set, then a simple update-acl will be
constructed enabling just the dhcp-servers to perform dns updates,
using the IP address(es) of the single DHCP server or failover pair,
and, if specified, the server-key from the DnsUpdateConfig referenced
in the dns-config attribute.
eod

ATTR: dns-update-acl
ATTRID: 9
ATTRTYPE: AT_AMELST
ATTRDESC:: eod
The update-acl to apply to zones referenced by the
DnsUpdateConfig in this map.  If this attribute is set, then the
value (if any) of the dns-update-policy-list attribute is ignored.

If neither attribute is set, then a simple update-acl will be
constructed enabling just the dhcp-servers to perform dns updates,
using the IP address(es) of the single DHCP server or failover pair,
and, if specified, the server-key from the DnsUpdateConfig referenced
in the dns-config attribute.
eod


## Start address space report classes

CLASS: CCMPointOfContact
CLASSID: 1507
CLASSNAME: 1
CLASSPCV: 7.0.0
CLASSDESC:: eod
A point of contact, as required for ARIN reporting purposes.
A CCMPointOfContact object is usually associated with
a CCMOrganization object.
eod

ATTR: name
ATTRID: 1
ATTRTYPE: AT_STRING
ATTRFLAGS: AF_REQUIRED, AF_UNIQUE, AF_IMMUTABLE
ATTRDESC:: eod
The unique arbitrary name for this point of contact.
eod

ATTR: handle
ATTRID: 2
ATTRTYPE: AT_STRING
ATTRFLAGS: AF_UNIQUE
ATTRDESC:: eod
The unique handle for this point of contact. This value is assigned
by ARIN when a point of contact is registered.
eod

ATTR: type
ATTRID: 3
ATTRTYPE: AT_ENUMINT(person = 0, role = 1)
ATTRFLAGS: AF_REQUIRED
ATTRDEFVAL: person
ATTRDESC:: eod
The type for this point of contact.
eod

ATTR: last-name
ATTRID: 4
ATTRTYPE: AT_STRING
ATTRFLAGS: AF_REQUIRED
ATTRDESC:: eod
The last name.
eod

ATTR: first-name
ATTRID: 5
ATTRTYPE: AT_STRING
ATTRFLAGS: AF_REQUIRED
ATTRDESC:: eod
The first name.
eod

ATTR: middle-name
ATTRID: 6
ATTRTYPE: AT_STRING
ATTRDESC:: eod
The middle name.
eod

ATTR: additional-info
ATTRID: 7
ATTRTYPE: AT_STRING
ATTRDESC:: eod
Additional name (e.g. Jr.) for this point of contact.
eod

ATTR: company-name
ATTRID: 8
ATTRTYPE: AT_STRING
ATTRDESC:: eod
The name of the company if the point of contact type is a Role.
eod

ATTR: address
ATTRID: 9
ATTRTYPE: AT_STRING
ATTRDESC:: eod
The street address for this point of contact.
eod

ATTR: city
ATTRID: 10
ATTRTYPE: AT_STRING
ATTRDESC:: eod
The city for this point of contact.
eod

ATTR: state
ATTRID: 11
ATTRTYPE: AT_STRING
ATTRDESC:: eod
The state for this point of contact.
eod

ATTR: postal-code
ATTRID: 12
ATTRTYPE: AT_STRING
ATTRDESC:: eod
The postal code for this point of contact.
eod

ATTR: country-code
ATTRID: 13
ATTRTYPE: AT_STRING
ATTRDESC:: eod
The country code for this point of contact.
eod

ATTR: phone-list
ATTRID: 14
ATTRTYPE: AT_NLIST(AT_OBJ(CCMPhoneInfo))
ATTRDESC:: eod
The list of telephone entries for this point of contact.
eod

ATTR: email-address
ATTRID: 15
ATTRTYPE: AT_NLIST(AT_STRING)
ATTRDESC:: eod
The list of email addresses for this point of contact.
eod

ATTR: description
ATTRID: 16
ATTRTYPE: AT_STRING
ATTRDESC::eod
A text description for this point of contact.
eod

CLASS: CCMPhoneInfo
CLASSID: 1508
CLASSNAME: 1
CLASSPCV: 7.0.0
CLASSDESC:: eod
Phone information, as required for ARIN reporting purposes.
A list of CCMPhoneInfo objects in embedded in a CCMPointOfContact
object when used for ARIN reporting.
eod

ATTR: phone-number
ATTRID: 1
ATTRTYPE: AT_STRING
ATTRFLAGS: AF_UNIQUE, AF_REQUIRED
ATTRDESC:: eod
The telephone number.
eod

ATTR: phone-extension
ATTRID: 2
ATTRTYPE: AT_STRING
ATTRDESC:: eod
The internal extension, if applicable.
eod

ATTR: phone-type
ATTRID: 3
ATTRTYPE: AT_ENUMINT(office=0, mobile=1, fax=2, pager=3)
ATTRDEFVAL: optional
ATTRDESC:: eod
The type of telephone number.
eod

ATTR: description
ATTRID: 4
ATTRTYPE: AT_STRING
ATTRDESC::eod
An optional text description.
eod


CLASS: CCMOrganization
CLASSID: 1509
CLASSNAME: 1
CLASSPCV: 7.0.0
CLASSDESC:: eod
An organization that manages address space, as required for
ARIN reporting purposes. A CCMOrganization object is usually
associated with a CCMOwner object.
eod

ATTR: name
ATTRID: 1
ATTRTYPE: AT_STRING
ATTRFLAGS: AF_REQUIRED, AF_UNIQUE, AF_IMMUTABLE
ATTRDESC::eod
The name of the organization.
eod

ATTR: handle
ATTRID: 2
ATTRTYPE: AT_STRING
ATTRFLAGS: AF_UNIQUE
ATTRDESC::eod
The handle of the organization. This attribute is assigned by ARIN
when the Organization is registered. It is a unique id in ARIN
database and is required on all ARIN reports.
eod

ATTR: address
ATTRID: 3
ATTRTYPE: AT_STRING
ATTRDESC::eod
Identifies the street address for this organization.
eod

ATTR: city
ATTRID: 4
ATTRTYPE: AT_STRING
ATTRDESC::eod
Identifies the city where this organization is located.
eod

ATTR: state
ATTRID: 5
ATTRTYPE: AT_STRING
ATTRDESC::eod
Identifies the state where this organization is located.
eod

ATTR: postal-code
ATTRID: 6
ATTRTYPE: AT_STRING
ATTRDESC::eod
Identifies the postal code for this organization.
eod

ATTR: country-code
ATTRID: 7
ATTRTYPE: AT_STRING
ATTRDESC::eod
Identifies the country code for this organization.
eod

ATTR: admin-poc
ATTRID: 8
ATTRFLAGS: AF_REQUIRED
ATTRTYPE: AT_NAMEREF(CCMPointOfContact)
ATTRVAL: 1507
ATTRDESC::eod
Specifies the admin point of contact within the organization.
Only one point of contact can be designated as the admin-poc.
The admin-poc provides oversight of organization records
and all of its resourses.
eod

ATTR: technical-poc-list
ATTRID: 9
ATTRFLAGS: AF_REQUIRED
ATTRTYPE: AT_NLIST(AT_NAMEREF(CCMPointOfContact))
ATTRVAL: 1507
ATTRDESC::eod
Lists the technical points of contact within the organization.
The technical POCs provide day-to-day management of resources.
Each organization must have at least one techincal POC.
eod

ATTR: noc-poc-list
ATTRID: 10
ATTRTYPE: AT_NLIST(AT_NAMEREF(CCMPointOfContact))
ATTRVAL: 1507
ATTRDESC::eod
Lists the points of contact responsible for the
network operating center.
eod

ATTR: abuse-poc-list
ATTRID: 11
ATTRTYPE: AT_NLIST(AT_NAMEREF(CCMPointOfContact))
ATTRVAL: 1507
ATTRDESC::eod
Lists the points of contact responsible for abuse
reporting.
eod

ATTR: additional-information
ATTRID: 12
ATTRTYPE: AT_STRING
ATTRDESC::eod
Specifies additional information related to this organization.
eod

ATTR: description
ATTRID: 13
ATTRTYPE: AT_STRING
ATTRDESC::eod
Provides an optional description for this organization.
eod

ATTR: referral-server
ATTRID: 14
ATTRTYPE: AT_STRING
ATTRDESC::eod
Provides server information using standard URL format and syntax.
Organizations using an RWhois server to report utilization,
must provide this server information. Refer to RFC 2396 for
detailed information.

To be accepted, values must
be in the form:
    rwhois://rwhois.example.net:4321/
or
    rwhois.example.net:4343
eod


## End of Address space report classes


CLASS: CCMConstraint
CLASSID: 1510
CLASSPCV: 7.0.0
CLASSDESC:: eod
A constraint that can be applied to a role.
The list of CCMConstraint objects for a role is embedded in
the CCMRoleInstance object.
eod

ATTR: zones
ATTRID: 1
ATTRTYPE: AT_NLIST(AT_DNSNAME)
# AT_DNSNAME = 35
ATTRVAL: 35
ATTRDESC:: eod
Lists the forward zones that can be managed.  This list is only
significant for base roles (such as host-admin) that can be
constrained by a list of zones.
eod

ATTR: owners
ATTRID: 2
ATTRTYPE: AT_NLIST(AT_OBJREF(CCMOwner))
# 2 << 16 | classid(CCMOwner) 1416
ATTRVAL: 132488
ATTRDESC:: eod
Lists owners of objects that can be managed.  This list is only
significant for base roles that can be constrained by a list of
owners.

If unset, the user is unconstrained with respect to owners.
eod

ATTR: regions
ATTRID: 3
ATTRTYPE: AT_NLIST(AT_OBJREF(CCMRegion))
# 2 << 16 | classid(CCMRegion) 1425
ATTRVAL: 132497
ATTRDESC:: eod
Lists regions for objects that can be managed.  This list is
only significant for base roles that can be constrained by
a list of regions.

If unset, the user is unconstrained with respect to regions.
eod

ATTR: ipranges
ATTRID: 4
ATTRTYPE: AT_NLIST(AT_IPPAIR)
# AT_IPPAIR = 28
ATTRVAL: 28
ATTRDESC:: eod
Lists IP address ranges that can be used.  This list is only
significant for base roles such as host-admin that can be
constrained by a list of IP ranges. In the case of the
host-admin role, this list limits the addresses that can be
assigned to a host.

If unset, the user is unconstrained with respect to IP ranges.
eod

ATTR: host-regexpr
ATTRID: 5
ATTRTYPE: AT_STRING
ATTRDESC:: eod
Constrains the names of the hosts that can be
added, modified, deleted, or viewed.
eod

ATTR: zone-regexpr
ATTRID: 6
ATTRTYPE: AT_STRING
ATTRDESC:: eod
Constrains the names of forward zones that can be
added, modified, deleted, or viewed.
eod

ATTR: all-secondary-zones
ATTRID: 7
ATTRTYPE: AT_BOOL
ATTRDEFVAL: true
ATTRDESC:: eod
Indicates that the users may access all secondary zones.
eod

ATTR: all-reverse-zones
ATTRID: 8
ATTRTYPE: AT_BOOL
ATTRDEFVAL: true
ATTRDESC:: eod
Indicates that users may access all reverse zones.
eod

ATTR: read-only
ATTRID: 9
ATTRTYPE: AT_BOOL
ATTRDEFVAL: false
ATTRDESC:: eod
Indicates that user access for this constraint is read only.
If the role is set for read-only then this attributeis ignored,
and all constraints are treated as read-only.
eod

ATTR: description
ATTRID: 10
ATTRTYPE: AT_STRING
ATTRDESC:: eod
An optional description for this constraint.
eod


ATTR: all-forward-zones
ATTRID: 11
ATTRTYPE: AT_BOOL
ATTRDEFVAL: true
ATTRDESC:: eod
Indicates that there are no forward zone restrictions.
eod


CLASS: WebuiSetupInterview
CLASSID: 1511
CLASSVIZ: 3
CLASSPCV: 7.5.0
CLASSDESC:: eod
Collects user setup data from a sequence of basic interview
pages. The entire class is transient (that is, never persisted);
so the UI must populate the class with existing
Network Registrar configurations before  displaying it,
and must persist Network Registrar configuration changes
when setup action is completed (finished).
eod

ATTR: change-password
ATTRID: 1
ATTRTYPE: AT_BOOL
ATTRFLAGS: AF_FEATURE
ATTRDEFVAL: true
ATTRDESC:: eod
Indicates whether this installation will run the DHCP server.
eod

ATTR: new-password
ATTRID: 2
ATTRTYPE: AT_CLEARTEXT
ATTRDESC:: eod
The new password, if change-password was true.
eod

ATTR: new-password-verify
ATTRID: 3
ATTRTYPE: AT_CLEARTEXT
ATTRDESC:: eod
User must type the new password twice.
eod

ATTR: enable-dhcp
ATTRID: 4
ATTRTYPE: AT_BOOL
ATTRFLAGS: AF_FEATURE
ATTRDEFVAL: true
ATTRDESC:: eod
Indicates whether this installation will run the DHCP server.
eod

ATTR: enable-dns
ATTRID: 5
ATTRTYPE: AT_BOOL
ATTRFLAGS: AF_FEATURE
ATTRDEFVAL: true
ATTRDESC:: eod
Indicates whether this installation will run the DNS server.
eod

ATTR: enable-dns-update
ATTRID: 6
ATTRTYPE: AT_BOOL
ATTRFLAGS: AF_FEATURE
ATTRDEFVAL: true
ATTRDESC:: eod
Indicates whether this installation will dynamically update
DNS in coordination with DHCP.
eod

ATTR: enable-tftp
ATTRID: 7
ATTRTYPE: AT_BOOL
ATTRFLAGS: AF_FEATURE
ATTRDEFVAL: false
ATTRDESC:: eod
Indicates whether this installation will run the TFTP server.
eod

ATTR: enable-dhcp-failover
ATTRID: 8
ATTRTYPE: AT_BOOL
ATTRFLAGS: AF_FEATURE
ATTRDEFVAL: true
ATTRDESC:: eod
Indicates whether this installation will run DHCP failover.
eod

ATTR: dhcp-failover-role
ATTRID: 9
ATTRTYPE: AT_ENUMINT(main=1,backup=2)
ATTRFLAGS: AF_PRINT_ALT
ATTRDEFVAL: main
ATTRDESC:: eod
If DHCP failover is enabled, tells
whether this installation will serve as the
main or the backup server in that relationship.
eod

ATTR: dhcp-define-cos
ATTRID: 10
ATTRTYPE: AT_BOOL
ATTRFLAGS: AF_FEATURE
ATTRDEFVAL: false
ATTRDESC:: eod
If true, user will define classes of service.
eod

ATTR: dhcp-server-logging-mode
ATTRID: 11
ATTRTYPE: AT_ENUMINT(normal-operations=0,high-performance=1,debugging=2,customized=3)
ATTRFLAGS: AF_PRINT_ALT
ATTRDEFVAL: normal-operations
ATTRDESC:: eod
User selectable mode for server logging options.
This will translate into pre-selected server logging
configurations for normal-operations, high-performance,
or debugging; customized mode will prompt the user to
configure individual server log settings.
eod

ATTR: dhcp-send-snmp-traps
ATTRID: 12
ATTRTYPE: AT_BOOL
ATTRFLAGS: AF_FEATURE
ATTRDEFVAL: false
ATTRDESC:: eod
If true, DHCP server will emit user-designated traps.
eod

ATTR: dhcp-failover-partner-cluster
ATTRID: 13
#ATTRTYPE: AT_OBJREF(CCMCluster)
ATTRTYPE: AT_OID
ATTRFLAGS: AF_REFERENCE
ATTRVAL: 1449
ATTRDESC:: eod
The cluster for the dhcp failover partner.
This will be a custom control.
eod

ATTR: dhcp-failover-do-load-balancing
ATTRID: 14
ATTRTYPE: AT_BOOL
ATTRFLAGS: AF_FEATURE
ATTRDEFVAL: true
ATTRDESC:: eod
If true, load-balancing will be set to 50%.
eod

ATTR: dhcp-assign-cos-from-incoming-packet
ATTRID: 15
ATTRTYPE: AT_BOOL
ATTRFLAGS: AF_FEATURE
ATTRDEFVAL: false
ATTRDESC:: eod
If true, we will present text about configuring
DHCPServer.client-class-lookup-id expression.
If false, user will register clients individually.
eod

ATTR: dhcp-classes-of-service
ATTRID: 16
ATTRTYPE: AT_NLIST(AT_OBJ(WebuiSetupClassOfService))
# 1<<16 | 1532
ATTRVAL: 67068
ATTRDESC:: eod
A list of DHCP class of service meta-data.
eod

ATTR: dhcp-traps-enabled
ATTRID: 17
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)
ATTRDESC:: eod
Determines the traps that the DHCP server is configured to send out.
No default.
eod

ATTR: default-free-address-config-name
ATTRID: 18
ATTRTYPE: AT_STRING
ATTRDEFVAL: global
ATTRDESC:: eod
A unique name for the global address trap config.
eod

ATTR: default-free-address-config-mode
ATTRID: 19
ATTRTYPE: AT_ENUMINT(scope=1,network=2,selection-tags=3)
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.

The 'network' mode causes all of the scopes configured by this
object to aggregate their free-address levels if they share a
'primary-subnet'.

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.
eod

ATTR: default-free-address-config-low-threshold
ATTRID: 20
ATTRTYPE: AT_PERCENT
ATTRDEFVAL: 20%
ATTRDESC:: eod
The free-address level at which a low-threshold trap will be
generated, and the 'high' threshold will be re-enabled.
eod

ATTR: default-free-address-config-high-threshold
ATTRID: 21
ATTRTYPE: AT_PERCENT
ATTRDEFVAL: 25%
ATTRDESC:: eod
The level at which the 'low' threshold will be re-enabled, and the
high-threshold trap will be generated.
eod

ATTR: dns-server-role
ATTRID: 22
ATTRTYPE: AT_ENUMINT(primary=1,secondary=2,caching=3)
ATTRFLAGS: AF_PRINT_ALT
ATTRDEFVAL: primary
ATTRDESC:: eod
Indicates whether this DNS installation will function
as a DNS primary server, a DNS secondary server, or a
DNS caching server.
eod

ATTR: enable-ha-dns
ATTRID: 23
ATTRTYPE: AT_BOOL
ATTRFLAGS: AF_FEATURE
ATTRDEFVAL: true
ATTRDESC:: eod
Indicates whether this installation will run HA DNS.
eod

ATTR: ha-dns-role
ATTRID: 24
ATTRTYPE: AT_ENUMINT(main=1,backup=2)
ATTRFLAGS: AF_PRINT_ALT
ATTRDEFVAL: main
ATTRDESC:: eod
Indicates whether this installation will serve as the
main or the backup server in HA DNS.
eod

ATTR: dns-caching-allow-queries-to-root-servers
ATTRID: 25
ATTRTYPE: AT_BOOL
ATTRFLAGS: AF_FEATURE
ATTRDEFVAL: false
ATTRDESC:: eod
If true, and server is a caching server, queries
are allowed to internet root servers.
eod

ATTR: dns-server-logging-mode
ATTRID: 26
ATTRTYPE: AT_ENUMINT(normal-operations=0,high-performance=1,debugging=2,customized=3)
ATTRFLAGS: AF_PRINT_ALT
ATTRDEFVAL: normal-operations
ATTRDESC:: eod
User selectable mode for server logging options.
This will translate into pre-selected server logging
configurations for normal-operations, high-performance,
or debugging; customized mode will prompt the user to
configure individual server log settings.
eod

ATTR: dns-send-snmp-traps
ATTRID: 27
ATTRTYPE: AT_BOOL
ATTRFLAGS: AF_FEATURE
ATTRDEFVAL: false
ATTRDESC:: eod
If true, DNS server will emit user-designated traps.
eod

ATTR: ha-dns-partner-cluster
ATTRID: 28
#ATTRTYPE: AT_OBJREF(CCMCluster)
ATTRTYPE: AT_OID
ATTRFLAGS: AF_REFERENCE
ATTRVAL: 1449
ATTRDESC:: eod
The cluster for the HA DNS partner.
eod

ATTR: dns-restrict-query-acl
ATTRID: 29
ATTRTYPE: AT_AMELST
ATTRDEFVAL: any
ATTRDESC:: eod
Provides a global access control list (ACL) used to limit
device queries that the DNS server honors. 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: dns-restrict-xfer-acl
ATTRID: 30
ATTRTYPE: AT_AMELST
ATTRDEFVAL: none
ATTRDESC:: eod
The default access control list that designates who is allowed to
receive zone transfers. Setting the restrict-xfer-acl on a zone
overrides this setting.
eod

ATTR: dns-forwarders
ATTRID: 31
ATTRTYPE: AT_NLIST(AT_IPADDR)
# AT_IPADDR = 4
ATTRVAL: 4
ATTRDESC:: eod
The forwarders list for this DNS server.
eod

ATTR: dns-resolution-exceptions
ATTRID: 32
ATTRTYPE: AT_NLIST(AT_OBJ(AddrSet))
# 1<<16 | 50
ATTRVAL: 65586
ATTRDESC:: eod
The resolution exception list for this DNS server.
eod

ATTR: dns-secondary-servers
ATTRID: 33
ATTRTYPE: AT_NLIST(AT_OBJREF(CCMCluster))
ATTRFLAGS: AF_REFERENCE
ATTRDESC:: eod
The list of secondary servers (clusters) for the zone
distribution for this server.
eod

ATTR: dns-traps-enabled
ATTRID: 34
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
The traps that this server is configured to emit.
eod

ATTR: dns-update-dhcp-servers
ATTRID: 35
ATTRTYPE: AT_OID(CCMCluster|CCMFailoverPair)
ATTRDESC:: eod
The DHCP server or DHCP failover pair associated with
this configuration.
eod

ATTR: dns-update-dns-servers
ATTRID: 36
ATTRTYPE: AT_OID(CCMCluster|CCMHaDnsPair)
ATTRDESC:: eod
The DNS server or HA pair associated with
this configuration.
eod

ATTR: dns-update-forward-zone-name
ATTRID: 37
ATTRTYPE: AT_NAMEREF(CCMZone.origin)
ATTRVAL: 1410
ATTRDESC:: eod
Designates the DNS forward zone used to add a DHCP client's host
name (A record).
eod

ATTR: dns-update-use-server-key
ATTRID: 38
ATTRTYPE: AT_BOOL
ATTRFLAGS: AF_FEATURE
ATTRDEFVAL: true
ATTRDESC:: eod
If true, DNS server will use the TSIG key specified in
dns-update-server-key to secure DNS update transactions.
eod

ATTR: dns-update-server-key
ATTRID: 39
ATTRTYPE: AT_NAMEREF(Key)
ATTRVAL: 54
ATTRDESC:: eod
Specifies the TSIG key used to process all dynamic DNS updates for
server-addr.
eod

ATTR: dhcp-complex-failover-info
ATTRID: 40
ATTRTYPE: AT_STRING
ATTRDESC:: eod
An existing complex Failover configuration was detected. Please
select the Advanced tab to verify and complete the DHCP Failover
configuration after completing the remaining configuration steps.
eod

ATTR: dns-complex-ha-info
ATTRID: 41
ATTRTYPE: AT_STRING
ATTRDESC:: eod
An existing complex High-Availability DNS configuration was
detected. Please select the Advanced tab to verify and complete
the High-Availability DNS configuration after completing the
remaining configuration steps.
eod

ATTR: dhcp-assign-cos-from-incoming-packets-info
ATTRID: 42
ATTRTYPE: AT_STRING
ATTRDESC:: eod
<A HREF="#top"
onClick="showHelp('setup-dhcp-assign-cos-incoming-packets-info')">
Please refer to the detailed help for configuring Classes of
Service based on Incoming Packets.</A>
eod

#
# SystemStats class, used to return basic stats about the host
# on which CNR is running.
#
CLASS: SystemStats
CLASSID: 1512
CLASSPCV: 7.5.0
CLASSDESC:: eod
System-wide statistics about the host running
Network Registrar. This typically includes things
like memory, CPU, and disk-space utilization.
eod

ATTR: data-path
ATTRID: 1

ATTRTYPE: AT_STRING
ATTRDESC:: eod
The path to the Network Registrar data directory.
eod

ATTR: data-total-space
ATTRID: 2
ATTRTYPE: AT_INT
ATTRDESC:: eod
The size of the partition that holds the Network Registrar
data directory, in megabytes.
eod

ATTR: data-free-space
ATTRID: 3
ATTRTYPE: AT_INT
ATTRDESC:: eod
Tracks the free space on the partition that holds the
Network Registrar data directory, in megabytes.
eod

ATTR: logs-path
ATTRID: 4
ATTRTYPE: AT_STRING
ATTRDESC:: eod
Identifies the path to the Network Registrar logs directory.
eod

ATTR: logs-total-space
ATTRID: 5
ATTRTYPE: AT_INT
ATTRDESC:: eod
Tracks the size of the partition holding the Network Registrar
logs directory, in megabytes.
eod

ATTR: logs-free-space
ATTRID: 6
ATTRTYPE: AT_INT
ATTRDESC:: eod
Tracks the free space on the partition holding the
Network Registrar logs directory, in megabytes.
eod

ATTR: last-good-backup
ATTRID: 7
ATTRTYPE: AT_DATE
ATTRDESC:: eod
Gives the time at which the last successful nightly database
backup finished.
eod

ATTR: server-stats
ATTRID: 8
ATTRTYPE: AT_NLIST(AT_OBJ(ServerSystemStats))
ATTRVAL: 1513
ATTRDESC:: eod
Lists statistics objects, one for each Network Registrar
server, holding information about each server's use of
system resources.
eod

ATTR: statistics-request-time
ATTRID: 9
ATTRTYPE: AT_DATE
ATTRDESC:: eod
Gives the time at which the statistics were collected.
eod

#
# ServerSystemStats: represents basic stats about a single process -
# usually a Network Registrar server process.
#
CLASS: ServerSystemStats
CLASSID: 1513
CLASSPCV: 7.5.0
CLASSDESC:: eod
Provides information about one Network Registrar server's use of 
system resources.
eod

ATTR: name
ATTRID: 1
ATTRTYPE: AT_STRING
ATTRDESC:: eod
Names the server.
eod

ATTR: server-type
ATTRID: 2
ATTRTYPE: AT_INT
ATTRDESC:: eod
Specifies the type of server, represented as its schema 
class id.
eod

ATTR: pid
ATTRID: 3
ATTRTYPE: AT_INT
ATTRDESC:: eod
Identifies the server's process id.
eod

ATTR: cpu-utilization
ATTRID: 4
ATTRTYPE: AT_TIME
ATTRDESC:: eod
Describes the server's CPU utilization, in seconds.
eod

ATTR: memory-utilization
ATTRID: 5
ATTRTYPE: AT_INT
ATTRDESC:: eod
Describes the server's resident memory size, in KBytes.
eod

ATTR: vm-utilization
ATTRID: 6
ATTRTYPE: AT_INT
ATTRDESC:: eod
Describes the server's virtual memory utilization, in KBytes.
eod

CLASS: ScheduledTask
CLASSID: 1514
CLASSNAME: 1
CLASSPCV: 7.5.0
CLASSDESC:: eod
Schedules a task to execute at a specified  interval.
eod

ATTR: name
ATTRID: 1
ATTRTYPE: AT_STRING
ATTRFLAGS: AF_REQUIRED,AF_UNIQUE
ATTRDESC:: eod
Names the task.
eod

ATTR: description
ATTRID: 2
ATTRTYPE: AT_STRING
ATTRDESC:: eod
Provides a description for this task.
eod

ATTR: sync-object-oid
ATTRID: 3
ATTRTYPE: AT_OID
ATTRDESC:: eod
Associates an object identifier for the HA DNS pair, DHCP 
failover pair, zone distribution map, or DNS update map
with this task.  This attribute is only relevant for 
task-types sync-dhcp-pair, sync-dns-pair, sync-zd-map, 
or sync-dns-update-map.
eod

# NOTE: because the names of the tasks are part of the ui, there's
# a table mapping enum values to names in the scp library. please
# keep this enum and that table in sync.

ATTR: task-type
ATTRID: 4
ATTRFLAGS: AF_PRINT_ALT, AF_REQUIRED, AF_IMMUTABLE
ATTRTYPE: AT_ENUMINT(dhcp-reload=1,dns-reload=2,sync-dhcp-pair=3,sync-dns-pair=4,sync-zd-map=5,sync-dns-update-map=6)
ATTRDESC:: eod
Controls the type of task to be scheduled:

    1. dhcp-reload
       a. Reload the local DHCP server.

    2. dns-reload
       a. Reload the local DNS server.

    3. sync-dhcp-pair
       a. Reload main DHCP server.
       b. If reload successful, sync failover configuration
          from main to backup.
       c. If sync successful, reload backup DHCP server.

    4. sync-dns-pair
       a. Reload main DNS server.
       b. If reload successful, sync HA pair configuration
          from main to backup.
       c. If sync successful, reload backup DNS server.

    5. sync-zd-map
       a. Reload primary DNS server, or HA main server.
       b. If reload successful, sync zone distribution map.
       c. If sync successful, reload HA backup DNS server
          (if configured).
       d. If reload successful, reload secondary server(s).
       
    6. sync-dns-update-map
       a. Sync dns update map to DHCP and DNS servers.
       b. If sync successful, reload local and remote server(s).
eod

ATTR: schedule-interval
ATTRID: 5
ATTRFLAGS: AF_REQUIRED
ATTRTYPE: AT_RANGETIME(1h-30d)
ATTRDESC:: eod
Specifies how often this task should be performed.
eod

ATTR: schedule-offset
ATTRID: 6
ATTRTYPE: AT_RANGETIME(0-24h)
ATTRDESC:: eod
Provides a fixed time of day for this task.

This time is interpreted as a time of day offset from
12 midnight, provided schedule-interval is less than 24 hours,
and the offset value is less than the interval. If the offset
value is greater than the interval, or the interval is
greater than 24 hours, the offset will be ignored.

The scheduler for the task will ensure that the first scheduled
task occurs at the offset time. For example, if you set the 
interval to 4 hours and the offset to 2am, the task would occur
at 2am, 6am, 10am, 2pm, 6pm and 10pm. Note you cannot specify
a start time of midnight.
eod

ATTR: last-status
ATTRID: 7
ATTRTYPE: AT_RETCODE
ATTRFLAGS: AF_PRINT_ALT
ATTRDESC:: eod
Provides the most recent status recorded when executing 
this task.
eod

ATTR: last-error-list
ATTRID: 8
ATTRTYPE: AT_NLIST(AT_OBJ(RemoteRequestStatus))
ATTRDESC:: eod
Lists the errors recorded if the most recent task execution
failed.
eod

ATTR: enabled
ATTRID: 9
ATTRTYPE: AT_BOOL
ATTRDEFVAL: true
ATTRDESC:: eod
Indicates whether a task is enabled to run. If false,
the task will not run. This attribute may be used
to temorarily disable a task, without deleting it.
eod

## User Selectable Dashboard View Classes

CLASS: DhcpServerActivityRequestChart
CLASSID: 1515
CLASSPCV: 7.5.0
CLASSDESC:: eod
Stacked area trend chart.
eod

CLASS: DhcpBufferCapacityChart
CLASSID: 1516
CLASSPCV: 7.5.0
CLASSDESC:: eod
Absolute value line series trend chart.
eod

CLASS: DhcpFailoverStatusChart
CLASSID: 1517
CLASSPCV: 7.5.0
CLASSDESC:: eod
Table (with rate line series trend charts).
eod

CLASS: DhcpGeneralIndicatorsChart
CLASSID: 1518
CLASSPCV: 7.5.0
CLASSDESC:: eod
Table.
eod

CLASS: DhcpResponseLatencyChart
CLASSID: 1519
CLASSPCV: 7.5.0
CLASSDESC:: eod
Rate shaded area stacked series trend chart.
eod

CLASS: DhcpTopUtilizedScopeAggregationChart
CLASSID: 1520
CLASSPCV: 7.5.0
CLASSDESC:: eod
Table.
eod

CLASS: DhcpDnsUpdateActivityChart
CLASSID: 1521
CLASSPCV: 7.5.0
CLASSDESC:: eod
Table.
eod

CLASS: DnsCachingQueriesChart
CLASSID: 1522
CLASSPCV: 7.5.0
CLASSDESC:: eod
Rate shaded area stacked series trend chart.
eod

CLASS: DnsForwardsCachingChart
CLASSID: 1523
CLASSPCV: 7.5.0
CLASSDESC:: eod
Rate shaded area stacked series trend chart.
eod

CLASS: DnsGeneralIndicatorsChart
CLASSID: 1524
CLASSPCV: 7.5.0
CLASSDESC:: eod
Table.
eod

CLASS: DnsInboundZoneTransfersChart
CLASSID: 1525
CLASSPCV: 7.5.0
CLASSDESC:: eod
Rate shaded area stacked series trend chart.
eod

CLASS: DnsNetworkHealthChart
CLASSID: 1526
CLASSPCV: 7.5.0
CLASSDESC:: eod
Rate line series trend chart.
eod

CLASS: DnsOutboundZoneTransfersChart
CLASSID: 1527
CLASSPCV: 7.5.0
CLASSDESC:: eod
Rate shaded area stacked series trend chart.
eod

CLASS: DnsRelatedServersHealthChart
CLASSID: 1528
CLASSPCV: 7.5.0
CLASSDESC:: eod
Rate line series trend chart.
eod

CLASS: HostJvmMemUtilizationChart
CLASSID: 1529
CLASSPCV: 7.5.0
CLASSDESC:: eod
Rate line series trend chart.
eod

CLASS: HostSystemUtilizationChart
CLASSID: 1530
CLASSPCV: 7.5.0
CLASSDESC:: eod
Table.
eod

CLASS: SubnetUtilizationFilter
CLASSID: 1531
CLASSPCV: 7.0.7
CLASSDESC:: eod
Limits the set of subnet utilization records a server returns
when querying the CCM server for a list of records.
eod

ATTR: subnet-address
ATTRID: 1
ATTRTYPE: AT_SUBNET
ATTRDESC:: eod
If set, queries the subnet utilization database for the
specified subnet address.
If unset, queries the subnet utilization database for all subnets.
This attribute is ignored if the subnet-object attribute
is set.
eod

ATTR: start-date
ATTRID: 2
ATTRTYPE: AT_DATE
ATTRDESC:: eod
Sets the earliest date of subnet utilizations to display.
When unset, no filtering is applied by start date.
eod

ATTR: end-date
ATTRID: 3
ATTRTYPE: AT_DATE
ATTRDESC:: eod
Sets the latest date of subnet utilizations to display.
When unset, no filtering is applied by end date.
eod

ATTR: vpn-id
ATTRID: 4
ATTRTYPE: AT_INT
ATTRDEFVAL: 0
ATTRDESC:: eod
If set, filters subnet utilization data by this VPN identifier.
If unset or 0, the query applies to the global VPN.
This attribute is ignored if the subnet-object attribute
is set.
eod

ATTR: all-vpns
ATTRID: 5
ATTRVIZ: 3
ATTRTYPE: AT_BOOL
ATTRDEFVAL: false
ATTRDESC:: eod
If true, returns subnet utilization records regardless of 
VPN identifier, ignoring any setting in the vpn-id attribute.
If false, queries records from the VPN specified in the vpn-id
attribute.
This attribute is ignored if the subnet-object attribute
is set.
eod

ATTR: subnet-object
ATTRID: 6
ATTRTYPE: AT_OBJ(CCMSubnet)
ATTRDESC:: eod
If set, queries the subnet utilization database for the
specified subnet object, ignoring any settings in the
subnet-address or vpn-id attributes.
If unset, queries the subnet utilization database as specified
by the subnet-address and/or vpn-id attributes.
eod

CLASS: WebuiSetupClassOfService
CLASSID: 1532
CLASSNAME: 1
CLASSVIZ: 3
CLASSPCV: 7.5.0
CLASSDESC:: eod
Represents the DHCP class-of-service in the WebuiSetupInterview 
class to represent the name of a DHCP class-of-service, and, 
optionally, a forward zone name for DNS update use.
This class is never persisted.
eod

ATTR: name
ATTRID: 1
ATTRTYPE: AT_STRING
ATTRFLAGS: AF_REQUIRED
ATTRDESC:: eod
Names this DHCP class-of-service.
eod

ATTR: dns-update-forward-zone
ATTRID: 2
ATTRTYPE: AT_DNSNAME
ATTRDESC:: eod
Names the forward zone to use for DNS update. This attribute
is optional.
eod

#
# LicenseUtilization
#
CLASS: LicenseUtilization
CLASSID: 1533
CLASSNAME: 1
CLASSVIZ: 5
CLASSPCV: 7.5.0
CLASSDESC:: eod
Encapsulates the utilization numbers for each licensed feature.
eod

ATTR: feature-type
ATTRID: 1
ATTRTYPE: AT_ENUMINT(regional-cluster=2, router=4, ipv4-node=5, ipv6-node=6, ip-node=7, ip-node-sme=8)
ATTRFLAGS: AF_PRINT_ALT
ATTRVIZ: 5
ATTRDESC:: eod
Identifies the license feature type. Network Registrar 7.0 uses
only the ip-node license type.

The actual integer values listed are present only to be
identical to the values used in the License class.
eod

ATTR: right-to-use
ATTRID: 2
ATTRTYPE: AT_INT
ATTRFLAGS:
ATTRDESC:: eod
Specifies the number of purchased licenses for this feature.
eod

ATTR: utilized-nodes
ATTRID: 3
ATTRTYPE: AT_INT
ATTRFLAGS:
ATTRDESC:: eod
Specifies the number of nodes in use.
eod

CLASS: DhcpServerActivityResponseChart
CLASSID: 1534
CLASSPCV: 7.5.0
CLASSDESC:: eod
Stacked area trend chart.
eod
