role

Object Template

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

               Status       Instance     Search Status

role:          [mandatory]  [single]     [lookup key]
address:        [mandatory]  [multiple]   [ ]
country:        [mandatory]  [single]     [ ]
phone:          [mandatory]  [multiple]   [ ]
fax-no:         [optional]   [multiple]   [ ]
e-mail:         [mandatory]  [multiple]   [lookup key]
admin-c:        [mandatory]  [multiple]   [inverse key]
tech-c:         [mandatory]  [multiple]   [inverse key]
nic-hdl:        [mandatory]  [single]     [primary/look-up key]
remarks:        [optional]   [multiple]   [ ]
notify:         [optional]   [multiple]   [inverse key]
abuse-mailbox:  [optional]   [multiple]   [inverse key]
mnt-by:         [mandatory]  [multiple]   [inverse key]
changed:        [mandatory]  [multiple]   [ ]
source:         [mandatory]  [single]     [ ]

 

Example

role:           D EXAMPLENETADMIN
address:        123 Example st.
address:        20097 Exampletown
country:        AU
phone:          +12 34 567890 000
fax-no:         +12 34 567890 010
e-mail:         noc@examplenet.com
admin-c:        ABC123-AP           
tech-c:         ABC123-AP           
nic-hdl:        DE345-AP    
remarks:        http://www.examplenet.com.au
notify:         hostmaster@examplenet.com.au 
mnt-by:         MAINT-EXAMPLENET-AP         
changed:        abc@examplenet.com 20101231                
source:         APNIC

person:         Albert Brooke Crichton
address:        123 Example st.
address:        20097 Exampletown
country:        AU
phone:          +12 34 567890 000
fax-no:         +12 34 567890 010
e-mail:         abc@examplenet.com
nic-hdl:        ABC123-AP
notify:         abc@examplenet.com
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
role The full name of an administrative, technical or zone contact person referenced in another object.

  • The role field consists of two components, each consisting of characters from the alphabet only.
  • Please note that there is no “-” character between the two components of the name.
EXAMPLE
APNIC DBM
address Full postal address for the role account.

  • You can use any combination of alphanumeric characters.
  • More than one line can be used.
EXAMPLE
address: 2 Pandora St Boxville
address: Wallis and Futuna Islands
phone Telephone number for the role function.

+ <international code> <area code> <phone #>
+ <international code> <area code> <phone #> ext.
EXAMPLE
phone: +681 368 0844 ext. 32
email The email address for the role account.

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.
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.
nic-hdl The NIC-handle of the ‘role‘ or person object.

The APNIC NIC-handle takes the format:

<Initials><0-999>-AP
Example:
SNOC100-AP

NIC-handle (Network Information Centre handle):
A unique alphanumeric character sequence that represents an entry in the APNIC Whois Database.  This newly generated handle is created depending on the initials in the name of the person/role object.

When creating a person/role object, set the value of the attribute to either:

– AUTO-1
The database will generate the NIC-handle based on the initials of the name in the person or ‘role’ attribute.

Syntax:
For 2 to 4 characters optionally followed by up to 5 digits with the suffix “-AP”.

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
fax-no The fax number for the role function.

+ <international code> <area code> <fax #>
EXAMPLE
fax-no: +681 367 1797
trouble Information on who to contact when there are problems.

Can be used to include details on where to send abuse complaints.

remarks Information about the object that cannot be stated in other attributes.  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.

Generated

Attribute value is generated by the database.

Updating

This object can be created and updated 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 role objects

Role objects have three main advantages:

  1. While certain roles within an organization may remain stable, the people performing those roles may change.
    Using a role object means that when people in the organization change, only the role object needs to be updated instead of all associated ‘inetnum’ and ‘aut-num’ objects.
  2. You can specify a generic email address for the role object.
    For example, noc@example.com, so network queries are sent to a mailbox that may be accessed by many people, instead of to an individual staff member’s mail box.
  3. Role objects have a ‘trouble’ field, which describe an additional email box you use for spam and network abuse reports.
    This can take the burden off a single person and allow abuse reports to be handled by your abuse team.