Attributes of APNIC Whois Database router set (rtr-set) objects

Using rtr-set objects

The rtr-set object allows you to groups routers (inet-rtr objects) with similar properties. For example, instead of updating individual router configurations, you could use automated tools to update the configuration of all routers listed in the rtr-set object. This helps to avoid different configurations resulting from individual updates of routers across your network.

This object is most useful for larger, more complex networks with many routers or networks running their own RPSL databases to manage their internal network.

For more information, see RFC 2622, section 5.5.

rtr-set template

To view the rtr-set object, see APNIC Whois Database object templates.

rtr-set attributes

The following describe the mandatory and optional attributes in an rtr-set object.

Mandatory attributes
Optional attributes

Note: Attributes marked with an asterisk (*) now support four-byte AS number syntax. For more information see the ASN resource guide.

Mandatory attributes

Attribute	Function	Description
rtr-set*	Technical	The name of the set of routers. The rtr-setattribute may take two forms: 1. Non-hierarchical A non-hierarchical rtr-set attribute must begin with 'RTRS-'. Example: RTRS-EXAMPLENET 2. Hierarchical A hierarchical rtr-set attribute consists of rtr-set names and AS numbers separated by colons ':'. At least one set-name within the hierarchical name must start with 'RTRS-'. All the set name components of a hierarchical rtr-set name have to be rtr-set names. Hierarchical rtr-set names should be used when creating sets of routers specific to your own or your customers' routers. APNIC recommends the following format to allow you to manage multiple rtr-set objects for your network: <as-number>:RTRS-<description> Example: AS1:RTRS-EXAMPLENET-FUTUNA-SITE
descr	Administrative	A short description related to the object's purpose. Example: Border and peering routers of Sparkynet
tech-c	Administrative	The NIC-handle of a technical person or role object. In the web interface, the tech-c attribute contains a link to the person or role object to which the NIC-handle belongs.
admin-c	Administrative	The NIC-handle of an on-site contact person or role object. In the web interface, the admin-c attribute contains a link to that person or role object to which the NIC-handle belongs.
mnt-by	Administrative	The identifier of a registered mntner object used for authorisation and authentication. In the web interface, the mnt-by attribute contains a link to the specified mntner.
changed	Administrative	The email address of who last updated the database object and the date it occurred. Every time a change is made to a database object, this attribute will show the email address of the person who made those changes. This is not to be used as a contact address.
source	Administrative	The name of the database from which the data was obtained.

Top

Optional attributes

Attribute	Function	Description
members*	Technical	Explicitly lists IPv4 members of the rtr-set. Members of an rtr-set can be: inet-rtr objects other rtr-set objects If this attribute is used, the inet-rtr or rtr-set objects referred to should not include a reference to this rtr-set object in their own member-of attributes. Attempts to do so will result in an authorisation failure.
mp-members*	Technical	This attribute performs the same function as the members attribute above. The difference is that mp-members allows both IPv4 and IPv6 address families to be specified. Explicitly lists IPv4 or IPv6 members of the rtr-set. Members of an rtr-set can be: inet-rtr objects other rtr-set objects ipv4 address ipv6-address New in Whois v3.2.
mbrs-by-ref	Technical/ administrative	The identifier of a registered mntner object that can be used to add members to the rtr-set indirectly. To include an inet-rtr or rtr-set object as a member in this rtr-set, the mntner specified in the mbrs-by-ref attribute must refer to this rtr-set in the appropriate inet-rtr or rtr-set object's member-ofattribute. This allows the maintainer to choose which of the objects they maintain should be part of the set. If the maintainer chooses not to list the set in the member-of attribute of an object, that object will not be included in the set. To allow any inet-rtr or rtr-set object to be a member of this rtr-set, use the keyword ANY. If the mbrs-by-ref attribute is not used, the rtr-set will only include objects specified the members attribute.
remarks	Administrative	General remarks. May include a URL or email address.
notify	Administrative	The e-mail address to which notifications of changes to an object will be sent. When this attribute contains dbmon@apnic.net, it means APNIC staff are notified of changes to the object.
mnt-lower	Administrative	Sometimes there is a hierarchy of maintainers. In these cases, mnt-lower is used as well as mnt-by. New in Whois v3.2.