CSV File
On listing pages, you can download a CSV (Comma-separated values) file which contains the list of elements by clicking the "Export to CSV" button on each page.
You can edit the exported CSV file with a tool like text editor and import it again as authentication data on the System Settings > System Information page.
NoteCSV files exported on the Device > Active Device List page or the Switches > Active AMF Member List page have different format than the usual authentication data. It cannot be imported from the System Settings > System Information page.
Character Encoding
Downloaded CSV files are encoded in UTF-8.NoteWhen you upload a CSV file to AMF Security mini, please make sure that the file is encoded in UTF-8 if it contains non US-ASCII characters (If the file only contains US-ASCII characters, it is already in UTF-8 because US-ASCII is a subset of UTF-8 by its definition). If you upload the file in the encoding other than UTF-8, the upload fails with an error message.
Exportable Information
The following sections describe which elements are exported to a CSV file on each listing page.Conventions
In a CSV file, data fields are enclosed by a pair of double-quote (") characters and separated by a comma (,).NoteIn the example below, a half-width space is displayed after the comma (,) for screen display, but the CSV file actually exported does not include the half-width space after the comma.
Also, an arrow (↓) is displayed at the end of the line to distinguish the wrapping of the screen display and the line break of the actual data, but the CSV file actually exported does not have the arrow at the end of the line.
Importing a CSV file which contains data characters outside of double-quotes causes an error.
- A string in gray box represents a keyword (a reserved word). It should be written as it is (left untouched).
sesc.device ↓
- A string in violet box represents a variable data field (e.g. a string or a number).
(Device ID) ↓
- A string enclosed in square brackets ([ ]) is optional and can be omitted.
Device
A CSV file which can be exported on the Device > Device List page and can be imported as device definitions has the following format.◼ Example of an exported file
The default filename of an exported device list is "device.csv".
The first line is a comment line. The comment line is not required when importing a CSV file.
Device ID, Device Tag, Note and Interface are exported with the "device" in the "table" field, which means that the line is a record from the "device" table. Items consisting a security policy are exported with the "rule" in the "table" field, which means that the line is a record from the "rule" table.
"+","device","device_1","device_note","User_A","%ports","%port","00:00:5e:00:53:20","MAC_name","MAC_note" ↓
"+","rule","device_1","sesc.device","","pass","10","True","%options","m_location_name=1F","m_schedule_name=March Events","s_network_name=Sales" ↓
◼ Format
A basic format of a device record ("table" = "device") is as follows.
- Location - m_location_name= (Location ID)
- Switch Port - m_ofs_port= (Port Name)
- Schedule - m_schedule_name= (Schedule ID)
- Network - m_network_name= (Network ID)
Active Device List
The CSV file that can be exported from the Device > Active Device List page displays the MAC addresses status displayed on the screen. The format is different from normal device authentication data.It can not be imported from the System Settings > System Information page. Refer to Appendix's Creating Authentication Data from CSV for instructions on how to edit them with a tool such as text editor.
UnAuth Group
UnAuth Group list which can be exported on the Group > UnAuth Group List page and can be imported as the UnAuth Group definitions has the following format.◼ Example of an exported file
The default filename of an exported device list is "group.csv".
The first line is a comment line. The comment line is not required when importing a CSV file.
Group ID, Note and Enabled on the Group > Add UnAuth Group page are exported with the table name "group". Security policies are exported with the table name "rule".
"+","group","Event Guest","","fail","true" ↓
"+","rule","Event Guest","sesc.unauthGroup","","pass","30","True","%options","m_location_name=1F Conference Room","m_schedule_name=October Event","s_network_name=Guest" ↓
◼ Format
A basic format of a group record ("table" = "group") is as follows.
- Location - m_location_name= (Location ID)
- Schedule - m_schedule_name= (Schedule ID)
- Network - m_network_name= (Network ID)
AMF Member
Indicates the format of the CSV file that can be exported from the Switches > AMF Member List page or imported as AMF Member definitions.◼ Example of an exported file
The default filename of an exported device list is "switch.csv".
The first line is a comment line. The comment line is not required when importing a CSV file.
The Switches > AMF Member Add page are exported with the table name "switch".
"+","switch","AMF-Member1","#1FSwitch","-","" ↓
"+","switch","AMF-Member2","#1FSwitch","-","" ↓
AMF Member registration line is described in the following format.
Exporting Active AMF Member List to a CSV File
Export Active AMF Member List to a CSV File.- Open the Switches > Active AMF Member List page.
- Click the "Export to CSV" button at the top right corner of the page to download a CSV file.
The default filename of an exported CSV file is "amf_member_active.csv".
Network
Network list which can be exported on the Policy Settings > Network List page and can be imported as the network definitions has the following format.◼ Example of an exported file
The default filename of an exported device list is "network.csv".
The first line is a comment line. The comment line is not required when importing a CSV file.
The Policy Settings > Add Network page are exported with the table name "network".
"+","network","Sales","Sales Network","123" ↓
"+","network","Guest","Guest Network","30" ↓
◼ Format
A basic format of a network record ("table" = "network") is as follows.
Location
Location list which can be exported on the Policy Settings > Location List page and can be imported as the location definitions has the following format.◼ Example of an exported file
The default filename of an exported device list is "location.csv".
The first line is a comment line. The comment line is not required when importing a CSV file.
The Policy Settings > Add Location page are exported with the table name "location".
"+","location","1F","1F Area","%switch-names","AMF-Member" ↓
"+","location","1F Conference Room","1F Conference Room","%switch-names","AMF-Member_2" ↓
◼ Format
A basic format of a location record ("table" = "location") is as follows.
Schedule
Schedule list which can be exported on the Policy Settings > Schedule List page and can be imported as the schedule definitions has the following format.◼ Example of an exported file
The default filename of an exported device list is "schedule.csv".
The first line is a comment line. The comment line is not required when importing a CSV file.
The Policy Settings > Add Schedule page are exported with the table name "schedule".
"+","schedule","March Events","Sales meeting","2020-03-01 00:00:00","" ↓
"+","schedule","October Events","","2020-10-10 00:00:00","2020-10-31 00:00:00" ↓
◼ Format
A basic format of a schedule record ("table" = "schedule") is as follows.
Action
Action list which can be exported on the Policy Settings > Action List page and can be imported as the action definitions has the following format.◼ Example of an exported file
The default filename of an exported device list is "action.csv".
The first line is a comment line. The comment line is not required when importing a CSV file.
The Policy Settings > Add Action page and various conditions for the action are exported with the table name "action".
"+","action","Block Suspicious Device","sesc.action","Port Scan","drop","10","True","%options","m_device_mac=00:00:5E:00:53:01" ↓
A basic format of an action record ("table" = "action") is as follows.
- AMF Action - action_amf=(Action)
- Device MAC Address - m_device_mac= (Device MAC Address)
- Device IPv4 Address - m_device_ip= (Device IPv4 Address)
- Device - m_device_name= (Device ID)
- Device Tag - m_device_tag= (Device Tag)
- Location - m_location_name= (Location ID)
- Network - m_network_name= (Network ID)
- Pass/Quarantine VLAN ID - s_vlan_id= (Pass/Quarantine VLAN ID)
Downloading Authentication Data
Authentication data which can be downloaded from the System Settings > System Information page organizes all the data described above in the order required to restore whole data from the file.Data records are written out in the following order when all types of the data are registered.
- AMF Member
- Location
- Schedule
- Network
- Device
- UnAuth Group
- Action
◼ Example of an exported file
"+","switch","AMF-Member2","#1FSwitch","-","" ↓
"+","location","1F","1F Area","%switch-names","AMF-Member" ↓
"+","location","1F Conference Room","1F Conference Room","%switch-names","AMF-Member_2" ↓
"+","schedule","March Events","Sales meeting","2020-03-01 00:00:00","" ↓
"+","schedule","October Events","","2020-10-10 00:00:00","2020-10-31 00:00:00" ↓
"+","network","Sales","Sales Network","123" ↓
"+","network","Guest","Guest Network","30" ↓
"+","device","device_1","device_note","User_A","%ports","%port","00:00:5e:00:53:20","MAC_name","MAC_note" ↓
"+","rule","device_1","sesc.device","","pass","10","True","%options","m_location_name=1F","m_schedule_name=入社","s_network_name=Sales" ↓
"+","group","Event Guest","","fail","true" ↓
"+","rule","Event Guest","sesc.unauthGroup","","pass","30","True","%options","m_location_name=1F Conference Room","m_schedule_name=October Event","s_network_name=Guest" ↓
"+","action","Block Suspicious Device","sesc.action","Port Scan","drop","10","True","%options","m_device_mac=00:00:5e:00:53:01" ↓
Importing the CSV File
You can export authentication data to and import from a CSV file on the System Settings > System Information page.A CSV to upload can be either the one downloaded from the System Settings > System Information page, or the one exported from the individual element's listing pages.
When you import multiple CSV files exported from the different listing pages, make sure to import them in the following order.
- Security Policy Definitions
You can import Location, Network and Schedule in any order.
However, you must import the AMF Member definitions before importing the location definitions.
- Network
- AMF Member ⇒ Location
- Schedule
- Network
- Device and UnAuth Group Definitions
You can import Device and UnAuth Group data in any order.
- Device
- UnAuth Group
- Device
- Action Definitions
After importing the AMF Member, Security policies (Network, Location, Schedule), Device, and authentication data of UnAuth Group, import action definitions at the end.
If you import CSV files in wrong order and data reference by the imported data does not exist, an error occurs.
For example, when you are uploading a CSV file containing device records, if any of Location ID, Schedule ID, Network ID, Switch ID and Switch Port referenced by the devices' security policies are missing in AMF Security mini's database, the import fails and authentication data is not updated.
18 Jan 2021 10:56