rtr-set

Object Template

The object template includes information on how to complete the attribute values.

               Status       Instance     Search Status

rtr-set:       [mandatory]  [single]     [primary/lookup key]
descr:         [mandatory]  [multiple]   [ ]
members:       [optional]   [multiple]   [ ]
mp-members:    [optional]   [multiple]   [ ]
mbrs-by-ref:   [optional]   [multiple]   [inverse key]
remarks:       [optional]   [multiple]   [ ]
tech-c:        [mandatory]  [multiple]   [inverse key]
admin-c:       [mandatory]  [multiple]   [inverse key]
notify:        [optional]   [multiple]   [inverse key]
mnt-by:        [mandatory]  [multiple]   [inverse key]
mnt-lower:     [optional]   [multiple]   [inverse key]
changed:       [mandatory]  [multiple]   [ ]
source:        [mandatory]  [single]     [ ]

 

Attribute status

Mandatory

Attribute must be included in the object.  Failure to do so will result in errors.

Attribute Description
rtr-set The name of the set of routers. The rtr-set attribute may take two forms:

Non-hierarchical

A non-hierarchical rtr-set attribute must begin with ‘RTRS-‘.

EXAMPLE
RTRS-EXAMPLENET

Hierarchical

A hierarchical rtr-set attribute consists of rtr-set names and AS numbers separated by colons ‘:‘. There must
be at least one ‘set-name‘ within the hierarchical name that starts 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 routes specific to your own, your customers’, routes.
  • 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 A short description related to the object’s purpose.

EXAMPLE
Border and peering routers of Sparkynet

tech-c The NIC-handle of a technical contact ‘person’ or ‘role’ object.  As more than one person often fulfills a role function, there may be more than one tech-c listed.

  • In the web interface, the tech-c attribute contains a link to the ‘person’ or ‘role’ object to which the NIC-handle belongs to.
  • A technical contact (tech-c) must be a person responsible for the day-to-day operation of the network, but does not need to be physically located at the site of the network.
admin-c The NIC-handle of an on-site contact ‘person’ object. As more than one person often fulfills a role function, there may be more than one admin-c listed.

  • In the web interface, the admin-c attribute contains a link to the ‘person‘ object the NIC-handle belongs to.
  • An administrative contact (admin-c) must be someone who is physically located at the site of the network.
mnt-by Lists a registered ‘mntner’ used to authorize and authenticate changes to this object.

  • A ‘mntner’ object is a database object used to authorize updates to the APNIC database.
  • When your database details are protected by a ‘mntner’ object, then only persons with access to the security information of that ‘mntner’ object will be able to change details.
  • In the web interface, the mnt-by attribute contains a link to the specified ‘mntner’.
changed 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.
  • All APNIC delegated IP addresses will initially record an APNIC email address in this attribute, as APNIC creates the first database object.
  • Please use the address format specified in RFC 822 – Standard for the Format of ARPA Internet Text Message and provide the date format using one of the following two formats: YYYYMMDD or YYMMDD.
changed: hostmaster@sparkynet.com.wf 20010921

IMPORTANT! This is NOT to be used as a contact address.

source The database where the object is registered.

 

Optional

Attribute may be deleted from the object. To delete an optional attribute you must also remove the attribute from the object template.  Failure to do so will result in errors.

Attribute Description
members Explicitly lists IPv4 members of the rtr-set. Members of an rtr-set can be either: inet-rtr objects;
or other rtr-set objects.

  • If this attribute is used, the ‘inet-rtr’ 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 authorization failure.
mp-members 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 can be:

  • inet-rtr objects
  • other rtr-set objects
  • ipv4 address
  • ipv6 address
mbrs-by-ref 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-of attribute. 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 Information about the object that cannot be stated in other attributes. May include a URL or email address.
notify The email address to which notifications of changes to this object will be sent.

mnt-lower Sometimes there is a hierarchy of maintainers. In these cases, mnt-lower is used as well as ‘mnt-by’.

 

Generated

Attribute value is generated by the database.

Updating

You will soon be able to updated this object in MyAPNIC.

Instances of attribute allowed

Single
Attribute must appear only once in the object.
Multiple
Attribute may appear multiple times in the object. For example, you may wish to include more than one admin-c attribute.

 

Attribute search status

Primary key
Primary keys distinguish an object from all other objects in the database. To update a primary key, you must delete the entire object and them create a new object with the updated information.
Lookup key
Attribute can be queried in the database to return the object.  Please note, however, that a lookup key does not uniquely identify an object.
Inverse key
Attribute can be used when performing an inverse query using the -i flag. For example, the query

-i mntner <MNTNER-NAME>

will return all objects with the specified maintainer in the mnt-by attribute.

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 – Routing Policy Specification Language (RPSL),
section 5.5.