------------------------------------------------------------------- APNIC Document identity Title: APNIC Network Template Description Short title: network-template-descr Document ref: APNIC-024 Version: 001 Date of original publication: 1 September 1995 Date of this version: 1 September 1995 Review scheduled: n/a Obsoletes: APNIC-016 Status: Expired Comments: n/a -------------------------------------------------------------------- APNIC-024 ========= APNIC Network Template Description Issued: September 1, 1995 Expires: January 31, 1996 This document describes the NETWORK template used in several APNIC application forms. As such, this document should be used as a companion to the document accompanying the application forms. APNIC application forms are structured as a series of records, where each record is composed of a series of tag: value pairs. As APNIC application forms are generally processed by machine, some aspects of an application form's format should not be altered. These aspects include lines beginning with #[ and the strings that compose the tags (e.g., the word before the colon). Altering these parts of an application form will likely lead to unpredictable results. When completing a template, please fill in the appropriate information (in type written English). Note that if you have blank fields, you may either remove them from the form or leave them blank when you submit your application. With a few exceptions, fields in the APNIC database are case insensitive (exceptions being netname:, admin-c:, and tech-c:). Please fill in the fields with proper capitalization and formatting as APNIC will provide none. It should be noted that information provided in a NETWORK template will be entered into the APNIC Registration database which is provided to the Internet community as an aide to the diagnosis and resolution of network related issues. As such, it is imperative that the information maintained within the APNIC Registration database should be kept as up to date as possible. If you have any questions regarding this template or any other aspect of APNIC application forms, please contact APNIC at hostmaster@apnic.net. Network Template Tag Descriptions --------------------------------- inetnum: In some forms, such as the APNIC IP Address Reassignment form, it is necessary to include the IP network address or addresses. The inetnum: attribute describes the range of IP address space this object gives information on. The syntax of this attribute can be either of the following: inetnum: 192.87.45.0 This indicates a /24 (one class C network number), which covers IP address space 192.87.45.0 up to 192.87.45.255. For backwards compatibility, the network number can be a class A (a /8 in the range of 0/8 to 127/8), class B (a /16 in the range of 128.0/16 to 191.255/16) or class C (a /24 in the range of 192.0.0/24 to 223.255.255/24). inetnum: 192.87.44.0 - 192.87.45.0 This indicates a /23 (a block of two class C network numbers), which covers IP address space 192.87.44.0 up to 192.87.45.255. The spaces between the beginning address, the dash ("-") and the end address of this classful range must be present. inetnum: 192.87.45.0 > 192.87.45.255 This notation represents a classless range of IP address space, and does not make any assumptions on the class (A, B or C) of this specific piece of address space. Where this above example covers exactly the same address space as the first classful class C example, it is only in this syntax possible to specify any other range of address space that is not aligned on the conventional class A, B or C boundaries. Again, the spaces between the start address, the greater-than sign (">") and the end address must be present. Please also note that in the dotted quad notation of IP addresses, all trailing zeros must be present. There should be exactly one inetnum: tag in application forms where an such a tag is required. Example: As above. netname: Please complete with an appropriate network name for the network to be numbered which is short and meaningful. The `netname' is used mainly for administrative purposes like consistency checking of the Internet Registry. You will most likely not see this name appear anywhere, but on forms like this. The network name should be written as a single word in less than 25 capital alphabetic letters only. Please do not use punctuation, special characters or a prefix or suffix of 'NET', 'LAN', etc (unless they are part of your company name). APNIC requests you append "-xx" where "xx" is the 2 letter ISO 3166 country code you will list in the country: field to the end of your network name, for example, "-JP". This will aide in guaranteeing uniqueness within the APNIC database. Please do not use domain names, such as FOO.COM, as the netname: has no relation with the domain name system. There should be exactly one netname: tag per NETWORK template. Example: netname: TBIT-JP descr: Please complete with a short description of the organization, including the location. The full postal address is not needed as this will be required in a person template. Please provide sufficient detail as to distinguish your organization from others in the APNIC database, i.e., "descr: Computer Center" is not sufficient. Also, please limit the number of descr: lines to 5. This tag is required for all NETWORK templates. Example: descr: Terabit Labs Inc. descr: Network Bugs Feeding Facility descr: Northtown country: Please give the two letter country code (ISO 3166) which is appropriate for the organisation. Do NOT provide the country name. Please see the table of ISO 3166 codes maintained on APNIC at ftp://archive.apnic.net/apnic/misc/iso-3166.txt if you do not know the appropriate ISO 3166 code for your country. We are aware listing a country may be ambiguous for networks crossing national boundaries, so choose the most appropriate country based on the location of the administrative contact. This tag is required for all NETWORK templates, with only one country: tag permited. Example: country: JP admin-c: Please provide the name or NIC handle of the person who is the administrative contact for the network. The NIC handle (if known) is greatly preferred and will result in minimal delays when processing your request. The administrative contact must be someone who is physically located at the site of the network. If you specify a name instead of a NIC Handle, please do not use formal titles like `Dr' or `Prof.' or `Sir' as the words which comprise a name is indexed and there are many people with the same titles. In addition, please do not add periods between the names or initials and list the name as you would be addressed in a letter salutation (e.g., given name followed by family name or family name followed by given name depending on the custom in your country). At least one admin-c: tag is required for all NETWORK templates. Example: admin-c: John E Doe or with a NIC handle (preferred) admin-c: JD1-HK tech-c: Please provide the name or NIC handle of the person who is the technical contact for the network. The NIC handle (if known) is greatly preferred and will result in minimal delays when processing your request. The technical contact need not be someone physically located at the site of the network, but must be someone who can resolve technical issues such as network problems. If you specify a name instead of a NIC Handle, please do not use formal titles like `Dr' or `Prof.' or `Sir' as the words which comprise a name is indexed and there are many people with the same titles. In addition, please do not add periods between the names or initials and list the name as you would be addressed in a letter salutation (e.g., given name followed by family name or family name followed by given name depending on the custom in your country). At least one tech-c: tag is required for all NETWORK templates. Example: tech-c: Mark A Smith or with a NIC handle (preferred) tech-c: MS4-NZ rev-srv: The rev-srv attribute contains the fully qualified domain name of the machine that runs a reverse domain name service for the address space. If there are multiple reverse name servers for this address space, they should all be specified on different lines. Only one hostname is allowed per line. You may have zero or more rev-srv: tags per NETWORK template. Example: rev-srv: ns.apnic.net rev-srv: ns.uu.net remarks: Status: optional, multiple lines allowed The remarks attribute contains any remarks about this address space that cannot be expressed in any of the other attributes. Although multiple lines are allowed, it should be only be used if it provides extra information to users of the database, and usage should be kept to a minimum. Example: remarks: will be returned to NIC 950101 changed: Please indicate the email address of the person who is completing the template, followed by the current date in the format of YYMMDD (YY is the last 2 digits of the current year, MM is the month and DD is the day, all values 0 filled). If you do not have email connectivity please leave blank and it will be filled in for you. Do not put "Please Assign" or similar for this field. If you have an email address, you should supply exactly one changed: tag per NETWORK template. Example: changed: johndoe@terabit.na 950225 notify: Please provide a electronic mailbox of who should be notified when this record changes. This can be useful if more than one person manage the same object. When a record is altered, either through the action of APNIC staff or via the database update mechanisms described in APNIC-019, an advisory email will be sent by the database system. If the update is not appropriate, you should immediately contact the APNIC database manager apnic-dbm@apnic.net. The format of this field is one RFC822 electronic mail address per line. Although multiple lines are allowed, usage should be kept to a minimum. Please put 'dbmon@apnic.net' into this field if you do not wish to be notified of changes. If you specify a mailbox other than dbmon@apnic.net, be sure that the person at the other end of the mailbox understands what the update advisories mean. There should be at least one notify: tag per NETWORK template. Example: notify: dbmon@apnic.net mnt-by: Please provide the APNIC allocated maintainer ID. The maintainer ID provides some level of control over who can update an object protected by a mnt-by: field. If you do not have a maintainer ID, you may either leave this field blank or apply for one using the APNIC Maintainer Object Request form found at: ftp://archive.apnic.net/apnic/docs/apnic-026.txt There can be zero or more mnt-by: tags per NETWORK template, however each maintainer object specified must already exist in the APNIC Registration database. Example: mnt-by: MAINT-FOO-JP source: Source of the information. For the purposes of APNIC forms, it will always be APNIC. This is information which is always required in the database, so it has been added to the forms already. Example: source: APNIC Acknowledgements ---------------- This document in derived in large part from documents written by the staff of the European Registry, RIPE-NCC .