Difference between revisions of "Manual:Flashfig"

From MikroTik Wiki
Jump to: navigation, search
m (Protected "Manual:Flashfig" ([edit=sysop] (indefinite) [move=sysop] (indefinite)))
m (small clarifications and correct minor spelling / grammar errors)
Line 3: Line 3:
 
==Description==
 
==Description==
  
Flashfig is an application for mass router configuration. It can be used by MikroTik distributors, ISPs or any other companies who need to apply RouterOS configuration to many routers in shortest possible time.  
+
Flashfig is an application for mass router configuration. It can be used by MikroTik distributors, ISPs or any other companies who need to apply RouterOS configuration to many routers in the shortest possible time.  
  
  
Flashfig applies MikroTik RouterOS '''configuration''' to any RouterBOARD within '''3 seconds'''. You can "flashfig" batch of routers, the only thing you need - '''connect''' RouterBOARD to network and '''power''' it.
+
Flashfig applies MikroTik RouterOS '''configuration''' to any RouterBOARD within '''3 seconds'''. You can "flashfig" a batch of routers, the only thing you need is to '''connect''' RouterBOARD to network running Netinstall and to '''power''' it up.
  
  
Flashfig runs on a Windows computer, Flashfig is available within [http://www.mikrotik.com/download/netinstall-4.5b.zip Netinstall].
+
Flashfig only runs on a Windows computer, Flashfig is available from [http://www.mikrotik.com/download downloads] page.
  
  
Flashfig is supported by all [http://www.routerboard.com RouterBOARDs]. It works between computer with Flashfig and RouterBOARD in the same broadcast domain (direct Ethernet network connection is required).  
+
Flashfig is supported by all [http://www.routerboard.com RouterBOARDs]. It works between a Windows computer with Flashfig and a RouterBOARD in the same broadcast domain (direct Layer 2 Ethernet network connection is required).  
  
Flashfig support is enabled on every new RouterBOARD by default from factory (RouterBOARDs manufactured after March 2010). For older models, Flashfig can be enabled via RouterBOOT or from MikroTik RouterOS console.
+
Flashfig support is enabled on every new RouterBOARD manufactured since March 2010 by default from the factory. For older models, Flashfig can be enabled via RouterBOOT or from MikroTik RouterOS console.
  
  
After Flashfig is used once on a brand new RouterBOARD, it is disabled to avoid unwanted reconfiguation at later time. To use Flashfig a second time on the same router, you need to enable it in Bootloader settings.
+
After Flashfig is used once on a brand new RouterBOARD, it is disabled to avoid unwanted reconfiguration at a later time. To use Flashfig a second time on the same router, you need to enable it in Bootloader settings.
  
If RouterOS ''reset-configuration'' command is used later, Flashfig configuration is not loaded, but RouterOS default configuration.
+
If RouterOS ''reset-configuration'' command is used later, Flashfig configuration is not loaded, but the RouterOS default configuration. (To permanently overwrite factory default configuration, use Netinstall process not FlashFig).
  
 
Flashfig diagram shows the procedure of Flashfig,
 
Flashfig diagram shows the procedure of Flashfig,
Line 26: Line 26:
 
==Flashfig Example==
 
==Flashfig Example==
 
   
 
   
This is a step by step example of how to use Flashfig to set typical MikroTik RouterOS configuration to RouterBOARD.  
+
This is a step by step example of how to use the Flashfig process to set a MikroTik RouterOS configuration to a 'factory fresh' RouterBOARD.  
  
 
====Introduction====
 
====Introduction====
  
Flashfig is available from Netinstall,
+
Flashfig is available from within the Netinstall program,
  
 
[[File:Flashfig.png]]
 
[[File:Flashfig.png]]
Line 38: Line 38:
 
The Windows computer must be equipped with the following ports and contain the following files:
 
The Windows computer must be equipped with the following ports and contain the following files:
  
* Ethernet port;  
+
* A working Ethernet port;  
* The .rsc file(s) with MikroTik RouterOS configuration (the same as export/import file);  
+
* Valid .rsc file(s) with MikroTik RouterOS configuration similar to an export/import file. (Be aware of the text editor's treatment of CR/LF characters!);  
* The latest NetInstall/Flashfig program available from the [http://www.mikrotik.com/download.html downloads] page;
+
* Always use the latest NetInstall/Flashfig program available from the [http://www.mikrotik.com/download.html downloads] page;
  
 
The RouterBOARD:
 
The RouterBOARD:
  
* Flashfig is supported by first boot of RouterBOARD;
+
* Flashfig is supported by the first time boot of RouterBOARD;
  
 
====Pre-Configuration====
 
====Pre-Configuration====
Line 51: Line 51:
  
 
* Run Flashfig;
 
* Run Flashfig;
* Prepare '''.rsc''' file, '''.rsc''' file is regular/import file, it accepts valid MikroTik RouterOS CLI commands. You can create .rsc file by any text-editor program (Notepad, Texteditor, TextEdit, Microsoft Word, OpenOffice Writer);
+
* Prepare '''.rsc''' file, '''.rsc''' file is regular/import file, it accepts valid MikroTik RouterOS CLI commands. You can create .rsc file with any text-editor program (Notepad, Texteditor, TextEdit, Microsoft Word, OpenOffice Writer);
  
 
[[File:Flashfig2.png]]
 
[[File:Flashfig2.png]]
  
* Assign '''Boot Client Address''', which should be address from the same subnet as configured on laptop Ethernet interface,
+
* Assign '''Boot Client Address''', which should be an address within the same subnet as that configured on the computer's Ethernet interface,
  
 
[[File:Flashfig3.png]]
 
[[File:Flashfig3.png]]
  
* '''Browse''' for '''.rsc''' MikroTik RouterOS configuration file to apply to RouterBOARD, highlight the file and '''Select''' to approve it,
+
* '''Browse''' for '''.rsc''' MikroTik RouterOS configuration file to apply to the RouterBOARD, highlight the file and '''Select''' to approve it,
  
 
[[File:Flashfig4.png]]
 
[[File:Flashfig4.png]]
  
* Activate Flashfig server, now it is ready to Flashfig. Note, any RouterBOARD will be flashfiged within the network, which is powered on with boot-device configured to '''flash-boot''' or '''flash-boot-once-then-nand''',
+
* Activate Flashfig server, now it is ready to Flashfig. Note, any RouterBOARD will be flashfig'ed within the network, when they are powered on with boot-device configured to '''flash-boot''' or '''flash-boot-once-then-nand''',
  
  
Line 84: Line 84:
 
====Connect====
 
====Connect====
  
Connect RouterBOARD and Flashfig computer to the same Local Area Network.
+
Connect Ether1 of RouterBOARD and Flashfig computer to the same Local Area Network.
  
 
====Run Flashfig====
 
====Run Flashfig====
  
* Plug power for RouterBOARD
+
* Plug in power for RouterBOARD
  
 
* Check the status on Flashfig program,
 
* Check the status on Flashfig program,
Line 94: Line 94:
 
[[File:Flashfig6.png]]
 
[[File:Flashfig6.png]]
  
Log shows "RouterBOARD Flashfigged" and RouterBOARD should make sound/LED signal, now it is safe to unplug the router.
+
Log shows "RouterBOARD Flashfigged" and RouterBOARD should make a sound and flash LED - it is now safe to unplug the router.
  
* Flashig '''configuration''' was applied to the RouterBOARD and  it is '''ready''' to be used in production.
+
* Flashfig '''configuration''' was applied to the RouterBOARD and  it is '''ready''' to be used in production with this new config.
  
 
[[Category:Manual]]
 
[[Category:Manual]]
 
[[Category:Routerboard]]
 
[[Category:Routerboard]]

Revision as of 12:35, 18 March 2016

Version.png

Applies to RouterOS: v4

Description

Flashfig is an application for mass router configuration. It can be used by MikroTik distributors, ISPs or any other companies who need to apply RouterOS configuration to many routers in the shortest possible time.


Flashfig applies MikroTik RouterOS configuration to any RouterBOARD within 3 seconds. You can "flashfig" a batch of routers, the only thing you need is to connect RouterBOARD to network running Netinstall and to power it up.


Flashfig only runs on a Windows computer, Flashfig is available from downloads page.


Flashfig is supported by all RouterBOARDs. It works between a Windows computer with Flashfig and a RouterBOARD in the same broadcast domain (direct Layer 2 Ethernet network connection is required).

Flashfig support is enabled on every new RouterBOARD manufactured since March 2010 by default from the factory. For older models, Flashfig can be enabled via RouterBOOT or from MikroTik RouterOS console.


After Flashfig is used once on a brand new RouterBOARD, it is disabled to avoid unwanted reconfiguration at a later time. To use Flashfig a second time on the same router, you need to enable it in Bootloader settings.

If RouterOS reset-configuration command is used later, Flashfig configuration is not loaded, but the RouterOS default configuration. (To permanently overwrite factory default configuration, use Netinstall process not FlashFig).

Flashfig diagram shows the procedure of Flashfig, Flashfigdiagramm.png

Flashfig Example

This is a step by step example of how to use the Flashfig process to set a MikroTik RouterOS configuration to a 'factory fresh' RouterBOARD.

Introduction

Flashfig is available from within the Netinstall program,

Flashfig.png

Requirements

The Windows computer must be equipped with the following ports and contain the following files:

  • A working Ethernet port;
  • Valid .rsc file(s) with MikroTik RouterOS configuration similar to an export/import file. (Be aware of the text editor's treatment of CR/LF characters!);
  • Always use the latest NetInstall/Flashfig program available from the downloads page;

The RouterBOARD:

  • Flashfig is supported by the first time boot of RouterBOARD;

Pre-Configuration

Windows Computer
  • Run Flashfig;
  • Prepare .rsc file, .rsc file is regular/import file, it accepts valid MikroTik RouterOS CLI commands. You can create .rsc file with any text-editor program (Notepad, Texteditor, TextEdit, Microsoft Word, OpenOffice Writer);

Flashfig2.png

  • Assign Boot Client Address, which should be an address within the same subnet as that configured on the computer's Ethernet interface,

Flashfig3.png

  • Browse for .rsc MikroTik RouterOS configuration file to apply to the RouterBOARD, highlight the file and Select to approve it,

Flashfig4.png

  • Activate Flashfig server, now it is ready to Flashfig. Note, any RouterBOARD will be flashfig'ed within the network, when they are powered on with boot-device configured to flash-boot or flash-boot-once-then-nand,


Flashfig5.png

RouterBOARD
  • Flashfig mode is enabled on every RouterBOARD from factory by default, which means no configuration is required on RouterBOARD.
  • If Flashfig is not enabled on your router, access the RouterBOARD with Winbox/Console and set the configuration,
/system routerboard settings set boot-device=flash-boot

or use more preferable option,

/system routerboard settigs set boot-device=flash-boot-once-then-nand

Your router is now ready for Flashfig.

Connect

Connect Ether1 of RouterBOARD and Flashfig computer to the same Local Area Network.

Run Flashfig

  • Plug in power for RouterBOARD
  • Check the status on Flashfig program,

Flashfig6.png

Log shows "RouterBOARD Flashfigged" and RouterBOARD should make a sound and flash LED - it is now safe to unplug the router.

  • Flashfig configuration was applied to the RouterBOARD and it is ready to be used in production with this new config.