Académique Documents
Professionnel Documents
Culture Documents
NIOS 6.5
for Infoblox Core Network Services Appliances
Copyright Statements
© 2012, Infoblox Inc.— All rights reserved.
The contents of this document may not be copied or duplicated in any form, in whole or in part, without the prior
written permission of Infoblox, Inc.
The information in this document is subject to change without notice. Infoblox, Inc. shall not be liable for any
damages resulting from technical errors or omissions which may be present in this document, or from use of this
document.
This document is an unpublished work protected by the United States copyright laws and is proprietary to Infoblox,
Inc. Disclosure, copying, reproduction, merger, translation, modification, enhancement, or use of this document by
anyone other than authorized employees, authorized users, or licensees of Infoblox, Inc. without the prior written
consent of Infoblox, Inc. is prohibited.
For Open Source Copyright information, refer to the Infoblox Administrator Guide.
Trademark Statements
Infoblox, the Infoblox logo, Grid, NIOS, bloxTools, NetMRI and PortIQ are trademarks or registered trademarks of
Infoblox Inc.
All other trademarked names used herein are the properties of their respective owners and are used for identification
purposes only.
Company Information
Infoblox is located at:
4750 Patrick Henry Drive
Santa Clara, CA 95054-1851, USA
Web: www.infoblox.com
support.infoblox.com
Phone: 408.625.4200
Toll Free: 888.463.6259
Outside North America: +1.408.716.4300
Fax: 408.625.4201
Product Information
Hardware Models: Trinzic 800, 1400, 2200, and 4000 series; Infoblox-250-A, -550-A, -1050-A, -1550-A, -1552-A,
-1852-A, -2000, -2000-A, -4010, and -4030
Document Number: 400-0463-000 Rev. A
Document Updated: July 23, 2012
Warranty Information
Your purchase includes a 90-day software warranty and a one year limited warranty on the Infoblox appliance, plus
an Infoblox Warranty Support Plan and Technical Support. For more information about Infoblox Warranty information,
refer to the Infoblox Web site, or contact Infoblox Technical Support.
Preface
This preface describes the document conventions of this guide, and provides information about how to find
additional product information, including accessing Infoblox Technical Support. It includes the following sections:
• Document Overview on page 4
— Documentation Conventions on page 4
• Related Documentation on page 4
• Customer Care on page 5
— User Accounts on page 5
— Software Upgrades on page 5
— Technical Support on page 5
Document Overview
The CSV import reference provides general guidelines and file format information about CSV import. It was last
updated on July 23, 2012. For updated documentation, visit our Support site at
http://www.infoblox.com/en/support/support-center-login.html
Documentation Conventions
The text in this guide follows the following style conventions.
Style Usage
bold Indicates examples of the field names.
data Signifies the data in a CSV file.
Related Documentation
Other Infoblox appliance documentation:
• Infoblox NIOS Administrator Guide
• Infoblox IBOS Administrator Guide
• Infoblox API Documentation
• Infoblox CSV Import Reference
• Infoblox Installation Guide for the Trinzic 800 Appliances
• Infoblox Installation Guide for the Trinzic 1400 Appliances
• Infoblox Installation Guide for the Trinzic 2200 Appliances
• Infoblox Installation Guide for the Infoblox-4010 Appliance
• Infoblox Installation Guide for the Infoblox-4030 Appliance
• Quick Start Guide for Installing vNIOS Software on Riverbed Services Platforms
• Quick Start Guide for Installing vNIOS Software on Cisco Application eXtension Platforms
• Infoblox Installation Guide for vNIOS Software on VMware
• Infoblox Installation Guide for vNIOS on Microsoft 2008 R2 for Hyper-V
• Quick Start Guide for Installing vIBOS Software on VMware Platforms
• Infoblox Safety Guide
To provide feedback on any of the Infoblox technical documents, please e-mail techpubs@infoblox.com.
Customer Care
This section addresses user accounts, software upgrades, licenses and warranties, and technical support.
User Accounts
The Infoblox appliance ships with a default user name and password. Change the default admin account password
immediately after the system is installed to safeguard its use. Make sure that the NIOS appliance has at least one
administrator account with superuser privileges at all times, and keep a record of your account information in a safe
place. If you lose the admin account password, and did not already create another superuser account, the system will
need to be reset to factory defaults, causing you to lose all existing data on the NIOS appliance. You can create new
administrator accounts, with or without superuser privileges. For more information, refer to the Infoblox Administrator
Guide.
Software Upgrades
Software upgrades are available according to the Terms of Sale for your system. Infoblox notifies you when an
upgrade is available. Register immediately with Infoblox Technical Support at
http://www.infoblox.com/en/support/product-registration.html to maximize your Technical Support.
Technical Support
Infoblox Technical Support provides assistance via the Web, e-mail, and telephone. The Infoblox Support web site at
http://www.infoblox.com/en/support/support-center-login.html provides access to product documentation and
release notes, but requires the user ID and password you receive when you register your product online at:
http://www.infoblox.com/en/support/product-registration.html.
General Guidelines
Follow these rules to start a data file:
• Do not use UTF-8 characters in the CSV file name.
• Specify the version number in the first line of the data file. For example, enter “version 1.0” in the first line.
• Use a new line to enter data for each row. Separate each data field with a supported separator, such as a
comma, semicolon, space, or tab.
• Do not include blank lines in the data file
• Field names: Specify the field names in the second line. You can include multiple rows of field names as long as
you define the fields before the data. The first column in the field name row must be defined as “Header.” The
rest of the columns are field names of the data. Columns without a field name are ignored. If multiple field
names are specified, the latest field names are used to import the data.
• Use the overwrite function, not the merge function, to overwrite existing data. When you use the merge function,
the appliance does not overwrite existing data, even if the data file contains new data.
• When you import a small file, the appliance processes the import quickly. Under this circumstance, the
appliance may generate an error message when you try to stop the import because the import is completed
before you can stop it.
• When you stop an import, the appliance finishes importing the data row that it is currently processing before it
stops the import.
• The error files of the last two imports are stored on the appliance. You can download these files using the API
import_id method. For information, refer to the Infoblox API Documentation.
• When you use Microsoft Excel to create or view a data file, ensure that you review the settings of the file. Some
data, such as dates, may show up in a different format depending on your settings.
• All operations triggered by a CSV import are recorded in the audit log.
Note: If you want to modify a required field XXX (for either the overwrite or merge function), you must add a
corresponding field, _new_XXX, to include the new value. For example, “fqdn” is a required field in an A
record. If you want to update this field, you must include a new field “_new_fqdn” and define the new
value here. The appliance overwrites the existing data in the required field using the values you specify in
the new field.
• When you perform an overwrite function, you must define all boolean and integer data types in each supported
object type in order for the appliance to overwrite existing data.
• You can perform a CSV import of an object even if it has been scheduled for addition, modification, or deletion.
• Inherited fields: The appliance uses the following conventions to override inherited fields:
— When a value is specified in a field, the appliance overrides the inherited value with the new value.
— When a value is set to “ “ or an empty value, the appliance does not override the inherited value.
— When a value is set to a string with a value of \<empty\>, the appliance overrides the inherited value with an
empty value.
• Extensible attributes: A field name of EA-XXX indicates an extensible attribute, where XXX is the attribute name.
The value of an extensible attribute can be a string, a list, an integer, an email address, a URL, or a date in
YYYY-MM-DD format. Note that extensible attributes do not support time zones. Following are some examples:
• “EA-Site” is a predefined string type for locations. It can have a value of “Santa Clara”.
• “EA-User” is a user defined list type for employee types. It can have a list of values, such as
“Local,Remote,Temp”. Note that only one value can be specified when importing the extensible attribute.
• “EA-Building” is a predefined integer type for building numbers. It can have a value of “5”.
• “EA-TechPubs” is a user defined email address type. It can have a value of “techpubs@infoblox.com”.
• “EA-IB” is a user defined URL type. It can have a value of “www.infoblox.com”.
• “EA-Date” is a user defined date type attribute. It can have a value of “2010-11-20”.
• Admin permissions: A field name of ADMGRP-XXX indicates the admin permission of a specific admin group,
where XXX is the name of the admin group. The value of an admin permission can be a string or a list of strings
with subtypes. If there is a single value in the permission, use RW, RO, or DENY. If there is a subtype in the
permission, use a list format, such as “RW, ARecord/RO”.
• DHCP options: A field name of OPTION-XXX-nn indicates a DHCP option, where XXX is the vendor name of the
option and nn is the option number. If the option is of the DHCP vendor class, you can omit -XXX in the field
name. For example, OPTION-1 implies vendor class = DHCP and option number = 1, and OPTION-CISCO-122
implies vendor class = CISCO and option number = 122.
A B C D E
In CSV File Example 1, the field name HEADER-NETWORK identifies the first row as a header row for the Network
objects. The field names ADDRESS, NETMASK, EA-Gateway, and EA-Secondary Address (in rows B1 to E1) tell NIOS
how to interpret a row of network data in the CSV file. Each row of data that begins with “Network” in column A is
identified as a network data row. Therefore, NIOS interprets rows 3 and 4 as network data rows, in which column B
contains the network addresses, column C contains the network masks, and columns D and E contain extensible
attribute values for gateway and secondary address.
Similarly, the field name HEADER-HostRecord identifies the second row as a header row for the Host Record objects.
This header declaration tells NIOS that for each subsequent row of data that begins with “HostRecord” in column A,
column B contains the FQDN of the host, and column C contains the host address. Therefore, NIOS interprets rows 5
and 6 as host record data rows that contain the FQDNs of the hosts in column B and the host addresses in column C.
Alternatively, you can organize the information in CSV File Example 1 so that the data rows immediately follow the
header rows, as shown in CSV File Example 2.
A B C D E
You can also specify multiple header declarations for the same object type, as shown in CSV File Example 3. In this
example, you specify the field names (in row 1) and data (in rows 2 and 3) to modify the extensible attributes
(EA-Gateway and EA-Secondary Address) of two network addresses. You then specify the field names (in row 4) and
data (in rows 5 and 6) to add new extensible attributes (EA-Gateway and EA-Host Range) of two other network
addresses.
A B C D E
The examples in this section are illustrated using tables that resemble spreadsheet layouts. However, all other
examples in this appendix use the comma separated value text file format. For example, the following is the CSV file
notation equivalent of CSV File Example 2 on page 10.
HEADER-NETWORK,ADDRESS*,NETMASK*,EA-Gateway,EA-Secondary Address
NETWORK,10.251.133.128,255.255.255.192,10.251.133.129
NETWORK,10.176.80.255,255.255.252.0,10.176.80.1,172.16.213.0
HEADER-HostRecord,FQDN*,ADDRESSES
HostRecord,host1.dhcp.corp100.com,172.20.2.21
HostRecord,host2.dhcp.corp100.com,172.20.2.22
Note: All inherited fields follow the override conventions described in Data Specific Guidelines on page 8.
view String No DNS view views If no view is specified, the Default view is used.
_new_prefix String No Add this field to overwrite the prefix field when
you select the overwrite or merge option.Use
the hostname of the grid member in this field.
Example: infoblox.localdomain
external_primaries Server list No External primary Data must be in the following format:
Primary “name/ip/stealth/use_2x_tsig/
use_tsig/tsig_name/tsig_key/
tsig_key_algorithm”.
Only name and ip are required fields. If no
value is specified for stealth, use_2x_tsig, and
use_tsig, the default value FALSE is used. If
either use_2x_tsig or use_tsig is TRUE,
tsig_name and tsig_key are required. If no
value is specified for tsig_key_algorithm, the
default value is HMAC-MD5. If both
use_2x_tsig and use_tsig are TRUE, only
use_tsig = TRUE and the tsig key name and key
are imported.
Example: "ext1.test.com/1.1.1.1/FALSE"
external_secondaries Server list No External secondaries Data must be in the following format:
Secondary “name/ip/stealth/use_2x_tsig/use_
tsig/tsig_name/tsig_key/
tsig_key_algorithm”. Only name and ip are
required fields. If no value is specified for
stealth, use_2x_tsig, and use_tsig, the default
value FALSE is used. If either use_2x_tsig or
use_tsig is TRUE, tsig_name and tsig_key are
required. If no value is specified for
tsig_key_algorithm, the default value is
HMAC-MD5. If both use_2x_tsig and use_tsig
are TRUE, only use_tsig = TRUE and the tsig key
name and key are imported.
Example: "sec1.com/1.1.1.1/FALSE/FALSE/
FALSE/foo/sdfssdf86ew"
soa_refresh Unsigned No Refresh soa_refresh When you modify this field to override an
integer inherited value, you must include values for all
SOA timer fields. The appliance updates all the
SOA timers when you update any of them.
soa_retry Unsigned No Retry soa_retry Ensure that you include this field when you
integer override the soa_refresh field.
soa_expire Unsigned No Expire soa_expire Ensure that you include this field when you
integer override the soa_refresh field.
soa_default_ttl Unsigned No Default TTL soa_default_ttl Ensure that you include this field when you
integer override the soa_refresh field.
soa_negative_ttl Unsigned No Negative- soa_negative_ttl Ensure that you include this field when you
integer caching TTL override the soa_refresh field.
update_forwarding ACL No Allow updates forward_to Data must be in the following formats:
from... ip address/permission
Permission network/network cidr/permission
table ANY/permission
TSIG-XXX/permission
Permission can be ALLOW or DENY
If the first value is not Any or TSIG-, it is
assumed to be an IP or network address.
Example:
"10.0.0.10/Allow,11.0.0.0/16/Deny,TSIG-foo
/sdfdsfwhsdgfsw8sdf/Allow"
notify_delay Unsigned No notify_delay This field specifies the seconds of delay the
integer notify messages are sent to the secondaries.
The valid value is between 5 and 86400
seconds.
Example: 10
Examples
This section contains examples of how to create data files for DNS zones. All examples use comma as the separator.
You can use other supported separators, such as semicolon, space, or tab.
header-authzone,fqdn*,zone_format*,external_secondaries,grid_primary,
grid_primary_stealth
authzone,100.0.0.0/8,IPV4,ns2.com/2.2.2.2/False/False/False/None/None,ns3.com/2.2.2.2/
False/False/False/None/None,FALSE
A Record
fqdn FQDN Yes Name name This field combines the A record name
and the zone name to form the FQDN.
Example: a1.corp100.com
view String No DNS View views If no view is specified, the Default view is
used.
Examples
This section contains examples of how to create data files for A records. All examples use comma as the separator.
You can use other supported separators, such as semicolon, space, or tab.
Adding an A Record
This example shows how to add an A record, bind_a.corp100.com, with the extensible attribute Site = Infoblox, and
the permission, DNS_Adams = RO.
header-arecord,address*,fqdn*,ADMGRP-DNS_Admins,EA-Site
arecord,100.0.0.1,bind_a.corp100.com,RO,Infoblox
AAAA Record
fqdn FQDN Yes Name zone This field combines the AAAA record
name and the zone name to form the
FQDN. Example: aaaa1.corp100.com
view String No DNS View views If no view is specified, the Default view is
used. Example: Default
Examples
This section contains examples of how to create data files for AAAA records. All examples use comma as the
separator. You can use other supported separators, such as semicolon, space, or tab.
CNAME Record
fqdn FQDN Yes Alias zone This field combines the CNAME record
name and the zone name to form the
FQDN. Example: c1.corp100.com
view String No DNS View views If no view is specified, the Default view is
used. Example: Default
Examples
This section contains examples of how to create data files for CNAME records. All examples use comma as the
separator. You can use other supported separators, such as semicolon, space, or tab.
DNAME Record
fqdn FQDN Yes Alias zone This field combines the DNAME record
name and the zone name to form the
FQDN. Example: d1.corp100.com
view String No DNS View views If no view is specified, the Default view is
used. Example: Default
Examples
This section contains examples of how to create data files for DNAME records. All examples use comma as the
separator. You can use other supported separators, such as semicolon, space, or tab.
MX Record
fqdn FQDN Yes Mail zone This field combines the MX record name
Destination and the zone name to form the FQDN.
Example: MX1.corp100.com
view String No DNS View views If no view is specified, the Default view is
used. Example: Default
Examples
This section contains examples of how to create data files for MX records. All examples use comma as the separator.
You can use other supported separators, such as semicolon, space, or tab.
Adding an MX Record
This example shows how to add an MX record, bind_mx.corp100.com, with a mail exchanger, exchange.corp100.com
and priority = 20.
header-mxrecord,fqdn*,mx*,priority*
mxrecord,bind_mx.corp100.com,exchange.corp100.com,20
NAPTR Record
fqdn FQDN Yes Domain name This field combines the domain name and
the zone name to form the FQDN.
Example: aptr1.corp100.com
view String No DNS View views If no view is specified, the Default view is
used. Example: Default
_new_order Unsigned integer No Add this field to overwrite the order field
when you select the overwrite or merge
option.
flags String Yes Flags flags You can leave this field empty.
Example: U
services String Yes Service services You can leave this field empty.
Example: SIP+D2U
regexp String Yes REGEX regexp You can leave this field empty.
Example: http://([^/:]+)!\1!i
ttl Unsigned integer No TTL ttl This is an inherited field. For information,
see Data Specific Guidelines on page 8.
Example: 28800
Examples
This section contains examples of how to create data files for NPATR records. All examples use comma as the
separator. You can use other supported separators, such as semicolon, space, or tab.
This example shows how to override the preference of an existing NAPTR record from 20 to 25 and replacement from
corp200.com to corp300.com.
header-naptrrecord,fqdn*,order*,preference*,_new_preference,replacement*,_new_replacem
ent
naptrrecord,bind_naptr.corp100.com,10 20 25,corp200.com,corp300.com
NS Record
fqdn FQDN Yes Zone name This field combines the domain name
and the zone name to form the FQDN.
Example: test.corp100.com
view String No DNS View views If no view is specified, the Default view
is used. Example: Default
zone_nameservers Server list Yes Name server list addresses Data must be in the following format:
“IPAddress1/auto_create_ptr1,
IPAddress2/auto_create_ptr2”
Example: “10.0.0.4/TRUE,
10.0.0.44/FALSE, 10.0.0.55/TRUE”
Examples
This section contains examples of how to create data files for NS records. All examples use comma as the separator.
You can use other supported separators, such as semicolon, space, or tab.
Adding an NS Record
This example shows how to add an NS record corp100.com in the Default DNS view with DNAME (name server) =
ns1.corp100.com, name server address = 100.0.0.101, and TRUE for adding a PTR Record.
header-nsrecord,fqdn*,view,dname*,zone_nameservers*
nsrecord,corp100.com,default,ns1.corp100.com,“100.0.0.101/TRUE”
This example shows how to add an NS record corp200.com in the Internal DNS view with DNAME (name server) =
ns1.corp200.com and two name server addresses: 200.0.0.101 with TRUE for adding a PTR Record and 200.0.0.102
with TRUE for adding a PTR record.
header-nsrecord,fqdn*,view,dname*,zone_nameservers*
nsrecord,corp200.com,Internal,ns1.corp200.com,“200.0.0.101/TRUE,200.0.0.102/TRUE”
PTR Record
Field Name Data Type Required Associated GUI Field Associated PAPI Usage and Guidelines
(Yes/No) Object
fqdn FQDN No Domain Name name This field is required if you do not use
zone the address field. Either the IP address
or FQDN is required. Example:
10.0.0.10.in.addr.arpa
view String No DNS View views If no view is specified, the Default view
is used. Example: Default
address IP address No IP Address ipv4addr This field is required if you do not use
ipv6addr the fqdn field. Either the IP address or
FQDN is required. Example: 10.0.0.11
If the PTR record belongs to a
forward-mapping zone, this field is
empty.
Examples
This section contains examples of how to create data files for PTR records. All examples use comma as the separator.
You can use other supported separators, such as semicolon, space, or tab.
TXT Record
fqdn FQDN Yes Name name This field combines the record name and
zone the zone name to form the FQDN.
Example: t1.corp100.com
view String No DNS View views If no view is specified, the Default view is
used. Example: Default
text String No Text text You can leave this field empty.
Examples
This section contains examples of how to create data files for TXT record data import. All examples use comma as the
separator. You can use other supported separators, such as semicolon, space, or tab.
SRV Record
fqdn FQDN Yes Service name This field combines the service name and the
zone zone name to form the FQDN.
Example: _http._tcp.corp100.com
view String No DNS View views If no view is specified, the Default view is
used. Example: Default
_new_port Unsigned No Add this field to overwrite the port field when
integer you select the overwrite or merge option.
_new_target Domain name No Add this field to overwrite the target field
when you select the overwrite or merge
option.
ttl Unsigned No TTL ttl This is an inherited field. For information, see
integer Data Specific Guidelines on page 8.
Example: 28800
Examples
This section contains examples of how to create data files for SRV records. All examples use comma as the separator.
You can use other supported separators, such as semicolon, space, or tab.
Host Record
If only one IPv4 address is specified in the host record, you can add DHCP options to the host address.
fqdn FQDN Yes Name name This field combines the host record name and
zone the zone name to form the FQDN.
Example: h2.corp100.com
_new_fqdn FQDN No Add this field to overwrite the fqdn field when
you select the overwrite or merge option.
view String No DNS View views If no view is specified, the Default view is used.
Example: Default
addresses IP address or IP No IP Addresses ipv4addr You must specify a value in this field or in the
address list ipv6_addresses field. Example: ‘1.2.3.4’ or
“1.2.3.4, 5.6.7.8”. If there are multiple
addresses in the host record, use HostAddress
to specify the parameters for each address. For
information, see IPv4 Host Address on page 32
and IPv6 Host Address on page 34.
ipv6_addresses IP address or IP No IP Addresses ipv6addr You must specify a value in this field or in the
address list addresses field. If there are multiple addresses
in the host record, use HostAddress to specify
the parameters for each address. For
information, see IPv4 Host Address on page 32
and IPv6 Host Address on page 34.
_new_configure_for_ Boolean No Enable in DNS configure_for_ Add this field to overwrite the
dns dns configure_for_dns field when you select the
overwrite or merge option.
ttl Unsigned No TTL ttl This is an inherited field. For information, see
integer Data Specific Guidelines on page 8.
Example: 28800
mac_address MAC address No MAC Address mac_address This field applies to the host address. This is
required if the IP address is configured for DHCP.
Example: aA:Bb:c2:DD:E1:FF
configure_for_dhcp Boolean No DHCP check box configure_for_ This field applies to the host address.
dhcp Example: TRUE
deny_bootp Boolean No Deny BOOTP deny_bootp This field applies to the host address.
Requests Example: FALSE
boot_file String No Boot File boot_file This field applies to the host address.
boot_server String No Boot Server boot_server This field applies to the host address.
next_server String No Next Server next_server This field applies to the host address.
lease_time Unsigned No Lease Time lease_time This field applies to the host address.
integer
pxe_lease_time_ Boolean No Enable PXE This field applies to the host address.
enabled Lease Time
pxe_lease_time Unsigned No PXE Lease Time pxe_lease_time This field applies to the host address.
integer
domain_name FQDN No Domain Name domain_name This field applies to the host address.
domain_name_ IP list No Name Server This field applies to the host address.
servers Example: “5.6.7.8,1.2.3.4”
match_option String No match_client This field applies to the host address. Data must
be in the following format:
MAC_ADDRESS/RESERVED
ignore_dhcp_param Boolean No Ignore ignore-dhcp_ This field applies to the host address.
_request_list Optionalist option_list_
request
OPTION-1 String No Custom DHCP options This field applies to the host address.
Options Example: ‘255.0.0.0’ name implies
vendor_class=’DHCP’ (default)
OPTION-XXXX-200 Option No Custom DHCP options This field applies to the host address.
information Options Example: ’dfdfdfd’ name implies
vendor_class=’XXXX’, optioncode/number 200
Examples
This section contains examples of how to create data files for host records. All examples use comma as the separator.
You can use other supported separators, such as semicolon, space, or tab.
Field Name Data Type Required Associated GUI Associated PAPI Usage and Guidelines
(Yes/No) Field Method
view String No DNS View views If no view is specified, the Default view is used.
Example: Default
mac_address MAC address No MAC Address mac_address This is required if the IP address is configured
for DHCP. Example: aA:Bb:c2:DD:E1:FF
OPTION-1 String No Custom DHCP options This is an example of a DHCP option. For
Options information, see Data Specific Guidelines on
page 8.
Example: ‘255.0.0.0’ implies
vendor_class=’DHCP’ (default)
OPTION-XXXX-200 Option No Custom DHCP options This is an example of a DHCP option. For
information Options information, see Data Specific Guidelines on
page 8.
Example: ’dfdfdfd’ name implies
vendor_class=’XXXX’, optioncode/number 200
Examples
This section contains examples of how to create data files for host addresses. All examples use comma as the
separator. You can use other supported separators, such as semicolon, space, or tab.
view String No DNS View view If no view is specified, the Default view is
used. Example: Default
_new_address IPv6 address No Add this field to overwrite the address field
when you select the overwrite or merge
option.
_new_ipv6_prefix IPv6 prefix No Add this field to overwrite the ipv6_prefix field
when you select the overwrite or merge
option.
OPTION-7 Integer No Custom DHCP override_ This is an example of a DHCP option. For
Options options information, see Data Specific Guidelines on
page 8.
Example: ‘12’ name implies option space =
‘DHCPv6’, option code/number 7
OPTION-XXXX-200 Option No Custom DHCP override_ This is an example of a DHCP option. For
information Options options information, see Data Specific Guidelines on
page 8.
Example: ’dfdfdfd’ name implies
vendor_class=’XXXX’, option
code/number 200
Examples
This section contains examples of how to create data files for IPv6 host addresses. All examples use comma as the
separator. You can use other supported separators, such as semicolon, space, or tab.
type String Yes type You can use this field for NXDOMAIN rules or
blacklist rules. Valid value is NXDOMAIN or
BLACKLIST.
Example: NXDOMAIN
Examples
This section contains examples of how to create data files for NXDOMAIN and blacklist rulesets. All examples use
comma as the separator. You can use other supported separators, such as semicolon, space, or tab.
NXDOMAIN Rule
parent String Yes Name nxdomain_rules This field indicates the ruleset to which the
NXDOMAIN rule belongs. Example:
nxdomain-ruleset1
pattern String Yes Pattern pattern Use this to match domain names. You cannot
use the characters * and ,, in the domain
name. Example: foo
action String Yes Action action The valid value is PASS, MODIFY or REDIRECT.
Example: PASS
Examples
This section contains examples of how to create data files for NXDOMAIN rules. All examples use comma as the
separator. You can use other supported separators, such as semicolon, space, or tab.
Blacklist Rule
domain_name String Yes Domain Name Use this to match domain names. You
cannot use the characters * and ,, in the
domain name. The domain name cannot
exceed 255 characters. Example:
www.foo.com
action String Yes Action blacklist_action The valid value is PASS or REDIRECT.
Example: PASS
Examples
This section contains examples of how to create data files for blacklist rules. All examples use comma as the
separator. You can use other supported separators, such as semicolon, space, or tab.
Field Name Data Type Required Associated GUI Associated PAPI Usage and Guidelines
(Yes/No) Field Method
clients Access No Name clients Valid values are IPv4 and IPv6 addresses and
control list networks only. The default value is ‘Any’.
Example: 2000::/64/Allow
mapped Access No Mapped IPv4 mapped Valid values are IPv4 addresses and networks
control list Address -> only. The default value is ‘Any’.
Name Example: 10.0.0.0/8/Allow
exclude Access No Excluded IPv6 exclude Valid values are IPv6 addresses and networks
control list Address -> only. The default is ‘None’.
Name Example: 2000::/Allow
Examples
This section contains examples of how to create data files for DNS64 synthesis groups. All examples use comma as
the separator. You can use other supported separators, such as semicolon, space, or tab.
IPv4 Network
Field Name Data Type Required Associated GUI Associated PAPI Usage and Comments
(Yes/No) Field Method
network_view String No Network View network_view If no view is specified, the Default view is
used. Example: Default
ddns_ttl Unsigned No DDNS Update TTL ddns_ttl This is an inherited field. For information,
integer see Data Specific Guidelines on page 8.
Example: 1200
enable_thresholds Boolean No Enable DHCP enable_dhcp_ When you set this field to TRUE, you must
Thresholds thresholds enter values in the
range_high_water_mark and
range_low_water_mark fields. You cannot
leave those fields empty. Otherwise, the
appliance generates an error.
enable_threshold_ Boolean No Enable Email enable_email_ When you use the merge function, the
email_ warnings Warnings warnings appliance preserves the existing value in
this field. When you use the overwrite
function, you must include a value (TURE
or FALSE). Otherwise, the appliance
generates an error.
Example: TRUE
enable_threshold_ Boolean No Enable SNMP enable_snmp_ When you use the merge function, the
snmp_ warnings Warnings warnings appliance preserves the existing value in
this field. When you use the overwrite
function, you must include a value (TURE
or FALSE). Otherwise, the appliance
generates an error.
Example: TRUE
range_high_water Integer No High Water Mark high_water_mark When you set enable_thresholds to TRUE,
_mark you must enter values in this field and in
the range_low_water_mark field. You
cannot leave these fields empty.
Otherwise, the appliance generates an
error.
Example: 80
range_low_water_ Integer No Low Water Mark low_water_mark When you set enable_thresholds to TRUE,
mark you must enter values in this field and in
the range_high_water_mark field. You
cannot leave these fields empty.
Otherwise, the appliance generates an
error.
Example: 10
recycle_leases Boolean No Lease Deletion recycle_leases This field is set to TRUE by default. Ensure
that you use the overwrite option if you
want to change the value to FALSE.
Merging data from an import preserves the
default value.
OPTION-1 String No Custom DHCP options This is an example of a DHCP option. For
Options information, see Data Specific Guidelines
on page 8.
Example: ‘255.0.0.0’ name implies
vendor_class=’DHCP’ (default)
OPTION-XXXX-200 Option No Custom DHCP options This is an example of a DHCP option. For
information Options information, see Data Specific Guidelines
on page 8.
Example: ’dfdfdfd’ name implies
vendor_class=’XXXX’, option
code/number 200
Examples
This section contains examples of how to create data files for networks. All examples use comma as the separator.
You can use other supported separators, such as semicolon, space, or tab.
IPv6 Network
Examples
This section contains examples of how to create data files for IPv6 networks. All examples use comma as the
separator. You can use other supported separators, such as semicolon, space, or tab.
Field Name Data Type Required Associated GUI Associated PAPI Usage and Guidelines
(Yes/No) Field Method
network_view String No Network View network_view If no view is specified, the Default view is
used. Example: Default
OPTION-1 String No Custom DHCP options This is an example of a DHCP option. For
Options information, see Data Specific Guidelines
on page 8.
Example: ‘255.0.0.0’ name implies
vendor_class=’DHCP’ (default)
Examples
This section contains examples of how to create data files for shared networks. All examples use comma as the
separator. You can use other supported separators, such as semicolon, space, or tab.
Field Name Data Type Required Associated GUI Associated PAPI Usage and Guidelines
(Yes/No) Field Method
network_view String No Network View network_view If no view is specified, the Default view is
used. Example: Default
OPTION-7 Integer No Custom DHCP override_ This is an example of a DHCP option. For
Options options information, see Data Specific Guidelines
on page 8.
Example: ‘12’ name implies option space =
‘DHCPv6’, option code/number 7
OPTION-XXXX-200 Option No Custom DHCP override_ This is an example of a DHCP option. For
information Options options information, see Data Specific Guidelines
on page 8.
Example: ’dfdfdfd’ name implies
vendor_class=’XXXX’, option
code/number 200
network_view String No Network View network_view If no view is specified, the Default view is
used. Example: Default
enable_thresholds Boolean No Enable DHCP enable_dhcp_ When you set this field to TRUE, you must
Thresholds thresholds enter values in the
range_high_water_mark and
range_low_water_mark fields. You
cannot leave those fields empty.
Otherwise, the appliance generates an
error.
enable_threshold_ Boolean No Enable Email enable_email_ When you use the merge function, the
email_ warnings Warnings warnings appliance preserves the existing value in
this field. When you use the overwrite
function, you must include a value (TURE
or FALSE). Otherwise, the appliance
generates an error.
Example: TRUE
enable_threshold_ Boolean No Enable SNMP enable_snmp_ When you use the merge function, the
snmp_ warnings Warnings warnings appliance preserves the existing value in
this field. When you use the overwrite
function, you must include a value (TURE
or FALSE). Otherwise, the appliance
generates an error.
Example: TRUE
range_high_water_ Integer No High Water Mark high_water_mark When you set enable_thresholds to TRUE,
mark you must enter values in this field and in
the range_low_water_mark field. You
cannot leave these fields empty.
Otherwise, the appliance generates an
error.
Example: 80
range_low_water_mark Integer No Low Water Mark low_water_mark When you set enable_thresholds to TRUE,
you must enter values in this field and in
the range_high_water_mark field. You
cannot leave these fields empty.
Otherwise, the appliance generates an
error.
Example: 10
recycle_leases Boolean No Lease Deletion recycle_leases This field is set to TRUE by default. Ensure
that you use the overwrite option if you
want to change the value to FALSE.
Merging data from an import preserves
the default value.
exclusion_ranges IP address No Exclusion Ranges exclude This field indicates the start to end
range address range. You can also include a
comment. The valid format is start
address-end address/comment.
Example: “10.1.0.200-10.1.0.254/’The
range for printers’,10.2.3.3-10.2.3.30/”
OPTION-2 Integer No Custom DHCP options This is an example of a DHCP option. For
Options information, see Data Specific Guidelines
on page 8.
Example: 50
OPTION-1 String No Custom DHCP options This is an example of a DHCP option. For
Options information, see Data Specific Guidelines
on page 8.
Example: ‘255.0.0.0’ name implies
vendor_class=’DHCP’ (default)
OPTION-XXXX-200 Option No Custom DHCP options This is an example of a DHCP option. For
information Options information, see Data Specific Guidelines
on page 8.
Example: ’dfdfdfd’ name implies
vendor_class=’XXXX’, option
code/number 200
Examples
This section contains examples of how to create data files for DHCP ranges. All examples use comma as the separator.
You can use other supported separators, such as semicolon, space, or tab.
Field Name Data Type Required Associated GUI Associated PAPI Usage and Guidelines
(Yes/No) Field Object
parent String No Select Network network This field is required when address_type
is ‘PREFIX’.
Example: 2000::/16
ipv6_start_prefix IPv6 address No Prefix Delegated ipv6_start_prefix This field is required if address_type is
prefix Start ‘PREFIX’ or ‘BOTH’.
Example: 2000:1111::
ipv6_end_prefix IPv6 address No Prefix Delegated ipv6_end_prefix This field is required if address_type is
prefix End ‘PREFIX’ or ‘BOTH’.
Example: 2000:1111::
network_view String No Network View network_view If no view is specified, the Default view is
used. Example: Default
exclusion_ranges IP address No Exclusion Ranges exclude This field indicates the start to end
range address range. You can also include a
comment. The valid format is: start
address-end address/comment.
Example: “2000::1-2000::5/’The range
for printers’”
recycle_leases Boolean No Lease Deletion recycle_leases This field is set to TRUE by default. Ensure
that you use the overwrite option if you
want to change the value to FALSE.
Merging data from an import preserves
the default value.
Note: You can use the fixed address header to import reservations. When you import a reservation, you must specify
00:00:00:00:00:00 in the mac_address field.
Field Name Data Type Required Associated GUI Associated PAPI Usage and Guidelines
(Yes/No) Field Object
network_view String No Network View network_view If no view is specified, the Default view is
used. Example: Default
mac_address MAC No MAC Address mac This field is required if match_option =
address Yes for MAC_ADDRESS, or if you are importing a
reservation reservation. For reservations, you must
enter 00:00:00:00:00:00 in this field.
Example: aa:bb:cc:dd:ee:ff
OPTION-2 Integer No Custom DHCP options This is an example of a DHCP option. For
Options information, see Data Specific
Guidelines on page 8.
Example: 50
OPTION-1 String No Custom DHCP options This is an example of a DHCP option. For
Options information, see Data Specific
Guidelines on page 8.
Example: ‘255.0.0.0’ name implies
vendor_class=’DHCP’ (default)
OPTION-XXXX-200 Option No Custom DHCP options This is an example of a DHCP option. For
information Options information, see Data Specific
Guidelines on page 8.
Example: dfdfdfd’ name implies
vendor_class=’XXXX’, option
code/number 200
Examples
This section contains examples of how to create data files for IPv4 fixed addresses. All examples use comma as the
separator. You can use other supported separators, such as semicolon, space, or tab.
Field Name Data Type Required Associated GUI Associated PAPI Usage and Guidelines
(Yes/No) Field Object
address_type Enumeration No Address address_type Valid values are ADDRESS, PREFIX, and
BOTH. If no value is specified, ADDRESS
(default) is used.
Example: PREFIX
parent String No Select Network network This field is required when address_type
is ‘PREFIX’.
Example: 2000::/16
ipv6_prefix IPv6 address No Prefix Delegated ipv6prefix This field is required if address_type is
prefix ‘PREFIX’ or ‘BOTH’.
Example: 2000:1111::
network_view String No Network View network_view If no view is specified, the Default view is
used. Example: Default
OPTION-7 Integer No Custom DHCP override_ This is an example of a DHCP option. For
Options options information, see Data Specific Guidelines
on page 8.
Example: ‘12’ name implies option space
= ‘DHCPv6’, option code/number 7
OPTION-XXXX-200 Option No Custom DHCP override_ This is an example of a DHCP option. For
information Options options information, see Data Specific Guidelines
on page 8.
Example: ’dfdfdfd’ name implies
vendor_class=’XXXX’, option
code/number 200
Examples
This section contains examples of how to create data files for IPv6 fixed addresses. All examples use comma as the
separator. You can use other supported separators, such as semicolon, space, or tab.
Field Name Data Type Required Associated GUI Field Associated PAPI Usage and Guidelines
(Yes/No) Object
Examples
This section contains examples of how to create data files for DHCP MAC filters. All examples use comma as the
separator. You can use other supported separators, such as semicolon, space, or tab.
Examples
This section contains examples of how to create data files for DHCP MAC filters. All examples use comma as the
separator. You can use other supported separators, such as semicolon, space, or tab.
Option Filter
Field Name Data Type Required Associated GUI Associated PAPI Usage and Guidelines
(Yes/No) Field Method
OPTION-2 Integer No Custom DHCP option_list This is an example of a DHCP option. For
Options information, see Data Specific Guidelines
on page 8.
Example: 50
OPTION-1 String No Custom DHCP options_list This is an example of a DHCP option. For
Options information, see Data Specific Guidelines
on page 8.
Example: ‘255.0.0.0’ name implies
vendor_class=’DHCP’ (default)
Examples
This section contains examples of how to create data files for option filters. All examples use comma as the separator.
You can use other supported separators, such as semicolon, space, or tab.
Field Name Data Type Required Associated GUI Associated PAPI Usage and Guidelines
(Yes/No) Field Object
parent Option filter Yes Option Filter filter The name of the parent option
Name filter. Example: Option filter 1
match_option String Yes Match Option num Example: OPTION-1 (option space
is DHCP)
Examples
This section contains examples of how to create data files for option filter match rules. All examples use comma as
the separator. You can use other supported separators, such as semicolon, space, or tab.
Examples
This section contains examples of how to create data files for relay agent filters. All examples use comma as the
separator. You can use other supported separators, such as semicolon, space, or tab.
NAC Filter
Field Name Data Type Required Associated GUI Field Associated PAPI Usage and Guidelines
(Yes/No) Object
expression Option list No Match the following expression To include the option list in the Matching
rule the following rules table in Grid Manager,
you must enclose the expression in
brackets.
Example:
(Sophos.ComplianceState="Compliant"
AND RADIUS.ServerError="TRUE")
Examples
This section contains examples of how to create data files for NAC filters. All examples use comma as the separator.
You can use other supported separators, such as semicolon, space, or tab.
Field Name Data Type Required Associated GUI Field Associated PAPI Usage and Guidelines
(Yes/No) Object
Examples
This section contains examples of how to create data files for option spaces. All examples use comma as the
separator. You can use other supported separators, such as semicolon, space, or tab.
Field Name Data Type Required Associated GUI Field Associated PAPI Usage and Guidelines
(Yes/No) Object
type String Yes Options: Type type Use any of the following values: T_FLAG,
T_STRING, T_TEXT, T_IP_ADDRESS,
T_ARRAY_IP_ADDRESS, T_DOMAIN,
T_ARRAY_DOMAIN, T_UINT8,T_UINT16,
T_UINT32, T_INT8, T_INT16
Example: T_TEXT
Examples
This section contains examples of how to create data files for option definitions. All examples use comma as the
separator. You can use other supported separators, such as semicolon, space, or tab.
type String Yes Options: Type type Use any of the following values:
'T_ARRAY_DOMAIN', 'T_ARRAY_INT16',
'T_ARRAY_INT32', 'T_ARRAY_INT8',
'T_ARRAY_IP_ADDRESS','T_ARRAY_IP_AD
DRESS_PAIR','T_ARRAY_UINT16',
'T_ARRAY_UINT32', 'T_ARRAY_UINT8',
'T_DOMAIN', 'T_FLAG',
'T_FLAG_IP_ADDRESS', 'T_FLAG_TEXT',
'T_INT16', 'T_INT32', 'T_INT8',
'T_IP_ADDRESS', 'T_STRING', 'T_TEXT',
'T_UINT16', 'T_UINT32', 'T_UINT8',
'T_UINT8_1_2_4_8'
Example: T_INT8
Note: When you import an upgrade group and its distribution and upgrade schedules, you cannot control the
activation and deactivation of the schedules. You can activate and deactivate the schedules through the GUI
after the import.
Field Name Data Type Required Associated GUI Associated PAPI Usage and Guidelines
(Yes/No) Field Object/Name
time_zone String No Time Zone time_zone The value in this field applies to
both distribution_time and
upgrade_time. If you do not specify
a time zone, the Grid level time zone
is used.
distribution_time Time No Start distribution_time Enter the distribution start date and
Distribution time in YYYY-MM-DDTHH:MM:SS
(Date/Time) format.
upgrade_time Time No Start Upgrade upgrade_time Enter the upgrade start date and
time in YYYY-MM-DDTHH:MM:SS
format.