APNIC Home
APNIC Logo

Attributes of the APNIC Whois Database route-set object

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-set object:

    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-set will 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 information, see RFC 2650 - Using RPSL in Practice.

route-set template

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

route-set attributes

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

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

Mandatory attributes

Attributes

Function

Description

route-set*

Technical

The name of the route-set.

The route-set attribute may take two forms:

1. 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

2. 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 or your customers' routes. APNIC recommends the following format to allow you to manage multiple route-set objects for you and your customer networks:

<as-number>:RS-<organisation> 

Example:

AS1:RS-EXAMPLENET

descr

Administrative

A short description related to the object, including the organisation responsible for the route object.

Example:

Denied outbound and inbound routes

admin-c

Administrative

The NIC-handle of an on-site contact person or role object. There may be more than one admin-c listed.

In the web interface, the admin-c field contains a link to the person or role object the NIC-handle belongs to.

tech-c

Administrative

The NIC-handle of a technical contact person or role object. There may be more than one tech-c listed.

In the web interface, the tech-c field contains a link to the person or role object the NIC-handle belongs to.

mnt-by

Administrative

The identifier of a registered mntner object used for authorisation and authentication.

In the web interface, the mntner 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.

The changed attribute is not a network contact address, as it merely records who made the most recent change to the registration information. All APNIC addresses will initially record an APNIC address in this field, as APNIC creates the first database object.

source

Administrative

The name of the database from which the data was obtained.

Optional attributes

Attributes

Function

Description

members*

Technical

The members attribute lists the IPv6 routes that form the route-set. Members can be specified 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.

Note: if this attribute is used, the member objects should not include a reference to this route-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.

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

New in Whois v3.2.

mbrs-by-ref

Technical

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 include 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 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

Technical

Identifies a route-set object of which you wish this route to be a member.

Note: to be included as a member of the 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, section 8.1.

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 should be sent.

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.

See also:

Top  |  Database