APNIC Home

route-set

Object Template

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

               Status       Instance     Search Status

route-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]
last-modified: [generated]  [single]     [ ]
source:        [mandatory]  [single]     [ ]

 

Attribute status

Mandatory

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

Attribute Description
route-set The name of a set of route-set. The route-set attribute may take two forms:

Non-hierarchical

A non-hierarchical route-set attribute must begin with ‘RS-‘.

  • Non-hierarchical route-set names should only be used to create route-set objects that can be used across many networks, for
    example, denied routes.
EXAMPLE
RS-DENIED-ROUTES

 

Hierarchical

A hierarchical route-set attribute consists of route-set names and AS numbers separated by colons ‘:‘. There
must be at least one ‘set-name‘ within the hierarchical name that starts with ‘RS-‘.

  • Hierarchical route-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 route-set objects for your network:
<as-number>: RS-<organization>

EXAMPLE
AS1: RS-EXAMPLENET
descr A short description related to the object, including the organization responsible for the ‘route’ object.

EXAMPLE
Denied outbound and inbound routes
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’.
last-modified It is a time stamp that is generated by the system to reflect when the object was last modified.

last-modified: 2018-08-30T07:50:19Z
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 The members attribute lists the IPv6 routes that form the route-set. Members can be specific as any of the following:

  • Address prefix range
  • Route-set name
  • Route-set name followed by a range operator
  • AS number
  • AS-set

In practice, it is probably most useful to specify route or route-set objects as members.

  • If this attribute is used, the ‘member’ object should not include a reference to this route-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. The ‘members’ attribute lists the IPv4 and IPv6 routes that form the route-set. Members can be specified as any of the following:

  • afi <afi-list> list of <address-prefix-range>
  • Route-set name
  • Route-set name followed by a range operator
mbrs-by-ref The identifier of a registered ‘mntner’ object that can be used to add members to the route-set indirectly. For example, use this attribute if you have created a route-set to hold all your customer routes and trust the customers to update and delete their routes as necessary.

  • To include an object as a member in this route-set, the ‘mntner’ specified in the mbrs-by-ref attribute must refer to this route-set in the appropriate object’s ‘member-of‘ attribute. This allows the ‘maintainer’ to choose which of the objects they maintain and 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 object to be a member of this route-set, use the keyword ANY.
  • If the mbrs-by-ref attribute is not used, the route-set will only include objects specified the ‘members’ attribute.
member-of Identifies a route-set object of which you wish this route to be a member. To be included as a member of this route-set , the
route-set object must specify the ‘maintainer‘ of the route object in the route-set object’s mbrs-by-ref attribute. For more information, see RFC 2622 – Routing Policy Specification Language (RPSL), section 8.1.
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 should 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 route-set objects

The route-set object allows you to group routes with similar properties. For example, instead of referring to many individual route objects in the import and
export attributes of the aut-num object, you can refer to a single route-set object. For example, by using the following route-setobject:

route-set  AS1:RS-CUSTOMERS
members:   202.137.181.0/22, 203.1.0.0/24, 203.2.0.0/23

… instead of using this long import statement:

import:  from AS1 accept {202.137.181.0/22, 203.1.0.0/24, 203.2.0.0

… you could replace it with this simple import statement:

import:  from AS1 accept AS1:RS-CUSTOMERS

If you use automated tools used to configure routers, the route objects associated with the route-set object will be returned, and all individual routes that form the route-setwill
be injected into your configuration files. You can also use route-set objects to specify routes your network will not accept, for example private IP address ranges such as 10/8. For more information,
see RFC 2650 – Using RPSL in Practice.