Device file format
Devices are specified by the following device lines:
device_list_ver=8
device|ip|name|platform|admin|passwd|adom|desc|discover|reload|fwver|mr|patc h|build|branch_pt|interim|sn|has_hd|faz.quota|faz.perm|
The fields after reload are optional, and only need to be provided if discover is set to 0. The list in the text file should contain the following fields:
Field
Name Blank Allowed Description
ip No Device IP address.
name No Device name.
platform No The device type. For example, FortiGate, or the full platform name: FortiWiFi-60B.
admin No Administrator user name.
passwd Yes Administrator password.
adom Yes The ADOM into which this device should be imported. If this field is left blank, the device is imported into the current ADOM.
desc Yes Device description.
discover
 No Type 1 to automatically discover device, 0 otherwise.
Field
Name Blank Allowed Description
reload No Type 1 to reload the device configuration after importing it, 0 otherwise.
fwver No Firmware version.
mr No Major Release designation of the device. For example, GA, MR1, MR2.
patch No Patch level.
build No The four digit build number
branch_pt No The firmware branch point. You can find this information from the FortiOS CLI command get system status.
sn No Device serial number.
has_hd No Type 1 if the device has a hard disk, 0 if the device does not.
faz.quota No The disk log quota in MB.
faz.perm No The device permissions.
l DVM_PERM_LOGS : Permission to receive and store log messages
l DVM_PERM_DLP_ARCHIVE : Permission to receive and store DLP archive files
l DVM_PERM_QUARANTINE : Permission to receive and store quarantine files
l DVM_PERM_IPS_PKT_LOG : Permission to receive and store IPS packet log.
l Following the device line, there may be one or more “+meta” lines specifying metadata for the device (For more information, see Metadata file format ), or one or more “+vdom” lines specifying device VDOMs.
l VDOMs are specified by the following lines:
l +member|devname|vdom| +subgroup|groupname|
Field Name Blank Allowed Description
devname No Name of the device.
vdom Yes The VDOM of the device that belongs to this group. If this field is left empty, the VDOM refers to the root VDOM.
groupname
 No The name of the subgroup that belongs to this group.
Group file format
Device group are specified as follows: device_list_ver=8 group|name|desc|adom|
Field Name Blank Allowed Description
Name No Name of the group.
desc No Group description.
adom Yes The ADOM to which the group belongs. If the field is left blank, it refers to the ADOM from which the import operation is initiated.
One or more “+meta” lines describing metadata values for the group, or one or more lines describing group members and subgroups, may follow the group line. See Metadata file format .
+member|devname|vdom| +subgroup|groupname|
Field Name Blank Allowed Description
devname No Name of the device.
vdom Yes The VDOM of the device that belongs to this group. If this field is left empty, the VDOM refers to the root VDOM.
groupname No The name of the subgroup that belongs to this group.
Metadata file format
ADOMs, devices, and groups may have metadata associated with them. Their values are specified by +meta lines following the device, group, or ADOM. You can use multiple lines to specify multiple metadata values. +meta|name|value|
String transliterations
Certain fields, such as the description fields and metadata value fields, may contain characters with special meaning in this file format. In order to safely represent these characters, the following transliteration scheme is used:

non-printable character \xAA where AA is a two-digit hexadecimal number representing the byte value of the character.
Example text files
Here are three examples of what a text file might look like.
Example 1: Device
device_list_ver=8
# Device definitions. The lines beginning with ‘+’ are # associated with the device, and will cause an error if they # appear out-of-context. device|10.0.0.74|top|FortiGate|admin||root|My description.|1|1|
+meta|bogosity|10|
+vdom|vdom01|root|
+vdom|vdom02|root|
+vdom|vdom03|root| +vdom|vdom04|root|
device|10.0.0.75|bottom|FortiGate-400C|admin|password|adom01|Your description.|0|1|5.0|GA|FG400C2905550018|0|
+meta|bogosity|12|
+vdom|vdom01|adom01|
Example 2: ADOM
device_list_ver=8
# ADOM definitions. These are exported only from the root ADOM, # and can only be imported in the root ADOM. Import will abort # with an error if this is imported in a non-root ADOM.
# The lines beginning with ‘+’ are associated with the # last-defined ADOM, and will cause an error if they appear # out-of-context. adom|root|GMS|1| +meta|tag|my domain| adom|adom01|GMS|1| +meta|tag|your domain|
Example 3: Device group
device_list_ver=8
# Group definitions. Groups will be created in the order they
# appear here, so subgroups must be defined first, followed by # top-level groups. Only two levels of nesting are supported.
group|group01|My description.|root|
+member|bottom|| +member|top|vdom03| group|group02|Another description.|root|
+meta|supervisor|Philip J. Fry|
+member|top|vdom01|
+member|top|vdom02| +subgroup|group01| group|group03||adom01|
+meta|supervisor|Bender B. Rodriguez|