route

Object Template

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

               Status       Instance     Search Status

route:         [mandatory]  [single]     [primary/lookup key]
descr:         [mandatory]  [multiple]   [ ]
country:       [optional]   [single]     [ ]
origin:        [mandatory]  [single]     [primary/inverse key]
holes:         [optional]   [multiple]   [ ]
member-of:     [optional]   [multiple]   [inverse key]
inject:        [optional]   [multiple]   [ ]
aggr-mtd:      [optional]   [single]     [ ]
aggr-bndry:    [optional]   [single]     [ ]
export-comps:  [optional]   [single]     [ ]
components:    [optional]   [single]     [ ]
remarks:       [optional]   [multiple]   [ ]
notify:        [optional]   [multiple]   [inverse key]
mnt-lower:     [optional]   [multiple]   [inverse key]
mnt-routes:    [optional]   [multiple]   [inverse key]
mnt-by:        [mandatory]  [multiple]   [inverse key]
changed:       [mandatory]  [multiple]   [ ]
source:        [mandatory]  [single]     [ ]

Example

route:          192.168.1.0/24
descr:          route object for 192.168.1.0/24
country:        AU
origin:         AS1234
mnt-lower:      MAINT-EXAMPLENET-AP
mnt-routes:     MAINT-EXAMPLENET-AP
mnt-by:         MAINT-EXAMPLENET-AP
changed:        abc@examplenet.com 20101231
source:         APNIC

 

Attribute status

Mandatory

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

Attribute
Description
route

The address prefix to be routed.

EXAMPLE
202.137.181.0/20
descr

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

origin

The AS number used to route the address prefix described in the route attribute.

  • The AS number must be registered in the APNIC Whois Database before it can be referenced in the route object.

Note: if the same address prefix is routed by more than one AS, that is, the network is multihomed, the origin attribute distinguishes between route objects with the same prefix in the route attribute.

EXAMPLE
AS1
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'.
EXAMPLE
mnt-by: MAINT-SPARKY-WF
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. 
  • 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.

  • Use APNIC for objects in the APNIC Database.
  • Please use UPPERCASE letters.

 

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
country

Two letter ISO 3166 code of the country or economy where the admin-c is based.

Please use UPPERCASE letters.

EXAMPLE
country: WF
holes

Lists address prefixes that are not reachable through the route.

  • Use this attribute to identify parts of the route object's address prefix that have not yet been assigned.
member of

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

inject

Specifies which routers perform the aggregation and when the routers should perform the aggregation.

aggr-mtd

Specifies how the route aggregate is generated.

aggr-bndry

TA set of Autonomous Systems which form the aggregation boundary.

  • If the aggr-bndry attribute is not included, the AS specified in the origin attribute is the sole aggregation boundary.
export-comps

Specifies an RPSL filter that matches the more specific routes that need to be exported outside the aggregation boundary.

components

The component routes used to form the aggregate.

remarks

General remarks related to the role object.  Remarks can include a URL or RFC 822 address (if
preceded by mailto:)

  • May include a URL or instructions on where to send abuse complaints.
notify

The email address to which notifications of changes to this object should be sent.

mnt-lower

If no 'mnt-routes' attribute is included, the registered 'mntner' object specified in the mnt-lower attribute is used to control the creation of more specific
route objects within the prefix covered by this route object.

mnt-routes

The identifier of a registered mntner object used to control the creation of route objects more specific than this route object.

Generated

Attribute value is generated by the database.

Updating

This object can be created and updated in MyAPNIC.

Learn how to create a route object

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 objects

Use route objects to help configure your network's routers. Route objects, in combination with the aut-num and other related objects, can be used to describe your routing policy in a compact form. This can help your network identify routing policy errors and omissions more easily than by reading long configuration files.

  • Use automated tools, such as IRRToolset, to retrieve information from the route objects to create router configuration files for different architectures.
  • Configuration files produced this way are less prone to errors than manually configured routers.
  • If your network needs are complex, there are optional advanced technical attributes that allow you to specify route aggregation.