Boot Options
In This Chapter
This chapter provides information about configuring boot option parameters.
Topics in this chapter include:
System Initialization
Depending on the chassis, the primary copy of 7705 SAR OS software is located either on a removable compact flash card that is shipped with the 7705 SAR router or in the router on-board flash memory. The compact flash (cf3) contains a copy of the 7705 SAR OS image, the bootstrap file, and the boot option file (BOF). The compact flash can also be used to store configurations and executable images. These configurations and images can also be stored at an FTP file location.
The following chassis have removable compact flash cards:
- 7705 SAR-8
- 7705 SAR-18
- 7705 SAR-H
- 7705 SAR-M
All other chassis have an integrated flash memory device that cannot be removed.
 | Note:
In most cases you must have a console connection in order to access the node when there is no network connectivity to the node. Some commands can be given to the node through the ACO/LT button before there is network connectivity. See Automatic Discovery Protocol. Also refer to the appropriate chassis installation guide, “Automatic Discovery Protocol”. |
Starting a 7705 SAR begins with hardware initialization (a reset or power cycle). By default, the system searches the compact flash (cf3) for the boot.ldr file (also known as the boot loader or bootstrap file). The boot.ldr file is the image that reads and executes the system initialization commands configured in the BOF. The default value to initially search for the boot.ldr file on cf3 cannot be modified.
The following is an example of console display output when the boot.ldr file cannot be located on cf3.
When the bootstrap image is loaded, the BOF is read to obtain the location of the image and configuration files. The BOF must be located on the same compact flash drive as the boot.ldr file.
Figure 4 displays the system initialization sequence.
Figure 4: System Initialization - Part 1
Figure 5 displays the compact flash directory structure and file names.
Figure 5: Files on the Compact Flash
Files on the compact flash are:
- bof.cfg — boot option file
- boot.ldr — bootstrap image
- config.cfg — default configuration file
- TIMOS-m.n.Yz:m — major release numbern — minor release numberY: A — alpha releaseB — beta releaseM — maintenance releaseR — released softwarez — version number
- both.tim — CSM image file
Configuration and Image Loading
When the system executes the boot.ldr file, the initialization parameters from the BOF are processed. Three locations can be configured for the system to search for the files that contain the runtime image. The locations can be local or remote. The first location searched is the primary image location. If not found, the secondary image location is searched, and lastly, the tertiary image location is searched.
If the BOF cannot be found or loaded, then the system enters a console message dialog session prompting the user to enter alternate file locations and file names.
When the runtime image is successfully loaded, control is passed from the bootstrap loader to the image. Depending on the options in the BOF file, the runtime image loads the configuration in one of two ways.
If ADP is enabled, no configuration files are processed at startup. Instead, ADP discovers the node configuration from the network and the primary-config file is generated based on the configuration discovered by ADP. Any existing primary-config file is backed up, then overwritten.
If ADP is not enabled, the runtime image attempts to locate the configuration file as configured in the BOF. Like the runtime image, three locations can be configured for the system to search for the configuration file. The locations can be local or remote. The first location searched is the primary configuration location. If not found, the secondary configuration location is searched, and lastly, the tertiary configuration location is searched.
The configuration file includes chassis, CSM, adapter card and port configurations, as well as system, routing, and service configurations.
Figure 6 displays the boot sequence.
Figure 6: System Initialization - Part 2
Figure 7 shows the boot sequence if Automatic Discovery Protocol (ADP) is run on the system.
Figure 7: System Initialization With ADP
The following displays an example of BOF output.
Persistence
The BOF persist parameter can specify whether the system should preserve system indexes when a save command is executed. During a subsequent boot, the index file is read along with the configuration file. As a result, a number of system indexes are preserved between reboots, including the interface index, LSP IDs, and path IDs. If persistence is not required and the configuration file is successfully processed, then the system becomes operational. If persistence is required, then a matching x.ndx file must be located and successfully processed before the system can become operational. Matching files (configuration and index files) must have the same filename prefix, such as test123.cfg and test123.ndx, and are created at the same time when a save command is executed. The persistence option must be enabled to deploy the Network Management System (NMS). The default is off.
Traps, logs, and console messages are generated if problems occur, and SNMP shuts down for all SNMP gets and sets; however, traps are issued.
Automatic Discovery Protocol
Automatic Discovery Protocol (ADP) is triggered by a factory-installed boot option and automates the initial commissioning of 7705 SAR nodes. When the 7705 SAR is started for the first time, an ADP keyword in the BOF causes automatic discovery to run as part of the TiMOS application image. Refer to the appropriate chassis installation guide, “Automatic Discovery Protocol”, for more information on ADP.
ADP supports null, dot1q, and qinq encapsulation on:
- all ports on the 8-port Ethernet Adapter card on the 7705 SAR-8 (qinq is not supported on the version 1 card)
- all ports on the 8-port Ethernet Adapter card on the 7705 SAR-18 (the 7705 SAR-18 does not support the version 1 card)
- all ports on the 10-port 1GigE/1-port 10GigE X-Adapter card on the 7705 SAR-18
- all ports on the 6-port Ethernet 10Gbps Adapter card on the 7705 SAR-8 Shelf V2 with CSMv2 and the 7705 SAR-18
- all ports on the 8-port Gigabit Ethernet Adapter card
- all Ethernet ports on the 7705 SAR-F, 7705 SAR-H, 7705 SAR-Hc, 7705 SAR-M (all variants), 7705 SAR-W, and 7705 SAR-Wx (all variants)
- Ethernet ports 5 through 12 on the 7705 SAR-A variant with T1/E1 ports, and Ethernet ports 5 through 8 on the 7705 SAR-A variant without T1/E1 ports
- all DSL or GPON ports on the 7705 SAR-M (variants with module slots), when a GPON, DCM, or xDSL module is installed in the chassis (qinq is not supported)
- the DSL ports on the 7705 SAR-Wx
 | Caution:
On the 7705 SAR-A, ADP will not run successfully if the connection to the network is made from the SFP connector on ports 1 to 4 because the default connector is RJ-45. |
When run on the system, ADP goes through four basic stages:
- self-discovery
- network discovery
- configuration discovery
- test and commit
During the self-discovery stage, all supported adapter cards and CSMs are detected and automatically provisioned. The 7705 SAR then brings up all Ethernet ports. Depending on the physical connectivity of the port, some ports may fail to come up. If at least one port connected to the transport network becomes operationally up, ADP moves to the next stage.
During the network discovery stage, the 7705 SAR sends a DHCP DISCOVER message from all operational ports. Table 16 describes the DHCP DISCOVER message options.
Table 16: DHCP DISCOVER Message Options
Option | Name | Description |
chaddr | Client HW Address | The MAC address of the port |
51 | Lease Time | Always set to Infinite |
60 | Class Identifier | The class of 7705 SAR router: ALU-AD | SAR-8 ALU-AD | SAR-18 ALU-AD | SAR-A ALU-AD | SAR-F ALU-AD | SAR-H ALU-AD | SAR-Hc ALU-AD | SAR-M ALU-AD | SAR-W ALU-AD | SAR-Wx |
61 | Client Identifier | Not sent by default, but can be configured to be the chassis MAC address or an operator-defined string |
82 | Relay Agent Information | Network uplink information, such as circuit ID and gateway address, added by the relay agent, if applicable |
No client identifier is sent by default, but you can configure this option during boot-up, or with the auto-discover command, to be the chassis MAC address or a unique string. During boot-up, you can also configure the VLAN ID for ADP with dot1q or qinq encapsulation.
During the configuration discovery stage, the DHCP server receives the DHCP DISCOVER message and replies with a DHCP OFFER message that contains an IP address assigned to the network interface. Table 17 describes the options included in the DHCP OFFER. If any of the required options are not included, the packet may be dropped and not processed.
Table 17: DHCP OFFER Message Options
Option | Name | Description | Required |
yiaddr | Client Ip-Address | The network interface IP address For network consistency, it is recommended that this IP address be a fixed IP address, not assigned randomly from a DHCP server IP pool | Yes |
1 | Subnet Mask | The network interface subnet mask | Yes |
3 | Router | The network interface default gateway Only the first router is used – all others are ignored | No |
12 | Host Name | The network interface host name | No |
51 | Lease Time | The least time, validated as infinite | Yes |
54 | Server Address | Identifies the DHCP server | No |
67 | Bootfile Name | Contains the ADP instructions or a URL to an ADP instructions file | No |
Option 67 contains further configuration information in the form of keyword text files interpreted by ADP as instructions and executed during the Configuration and Test phases. For basic reachability, option 67 is not mandatory; however, it can be used to send the system IP address of a newly discovered node, making it possible to communicate with the 5620 SAM and complete ADP.
If a system IP address is made available with the DHCP OFFER and a template configuration file is also executed using the load-cfg keyword, then the system IP address specified in the template configuration file is used instead of the one in the DHCP OFFER.
Table 18 describes the keywords used in ADP instructions. A DHCP offer message can contain a maximum of 15 instructions in either the Bootfile Name option, or in an external file referenced by the include keyword. If more than 15 instructions are included, ADP fails to complete and the system generates an error message in the ADP log.
Table 18: ADP Instructions
Keyword | Description | Format |
sys-addr | Specifies the system interface IP address and the system base routing instance subnet | sys-addr 10.10.10.1/32 |
sys-name | Specifies the chassis name | sys-name SITE43_7705 |
sys-loc | Specifies the chassis location | sys-loc 600_MARCH_ROAD |
load-cfg | Specifies the URL of a template configuration file to load into the router's runtime configuration | load-cfg ftp://.....@.../7705.cfg |
test-ip | Specifies an IP address that must be successfully pinged before committing configuration and declaring ADP a success | test-ip 100.20.2.30 |
include | Specifies the URL of a file containing additional ADP instructions | include ftp://.....@.../7705.tmp |
Any BOF keyword | Interpreted as instructions to update the specified field in the BOF | As per BOF |
In order for ADP to be declared successful during the test and commit stage, the discovered configuration must contain an IP address. If the optional test-ip keyword is included in the ADP instructions, the node pings the IP address included in the DHCP OFFER message. If ADP is successful, the system stores the configuration and opens an SSH session to provide remote operators access to the router.
ADP can be controlled, without a connected PC or ASCII terminal, by the ACO/LT button on the Fan module. You can use the ACO/LT button to terminate or restart ADP, or reboot the chassis.
| Note:
The ACO/LT button is not available on the 7705 SAR-A, 7705 SAR-W, or 7705 SAR-W. |
ADP runs in the background to allow continued CLI access for status queries and troubleshooting. Periodic progress updates are sent to the console and can be viewed through a connected PC. Additionally, dump commands are available to display information and detailed logs about ADP during and after running on the system. The logs are not retained over a chassis reboot.
ADP runs only once on a router during initial startup if the automatic discovery is successful. The learned network interface configuration is retained in the local database. On subsequent reboots, the router uses its local database to reload its network configuration. After ADP successfully completes, or if it is manually terminated, the system sends a command to the BOF to remove the ADP keyword. You can terminate ADP at any time while it is running by using the CLI or the ACO/LT button.
Any temporary configuration done by ADP is not stored; however, network configuration and remote access remain enabled to allow the router to be manually provisioned remotely. ADP does not run again on future system reboots unless it is re-enabled via the CLI. If a standby CSM with ADP enabled is inserted into a running system that does not have the ADP keyword in its BOF file, the ADP keyword is automatically removed from the inactive card’s BOF file during reconcile.
Initial System Startup Process Overview
Figure 8 displays the process for starting a system that has a removable compact flash. This example assumes that the boot loader, BOF, and the image and configuration files are successfully located. For a system with a non-removable compact flash, the first step in the Figure 8 does not apply.
Figure 8: System Startup Flow
Boot Loader File Protection
The boot loader file on any 7705 SAR must be upgraded using a specific command. The command is part of a mechanism that protects the boot loader file from accidental overwrites, and that allows a recovery boot loader file to be stored on the flash drive so that it can be used in case the original file becomes corrupted.
The command checks that the new boot.ldr is a valid image and that it is at least a minimum supported variant for the hardware platform on which it is being loaded. Once this has been verified, the command overwrites the boot.ldr file that is stored on the system.
Before Upgrading
Before starting the upgrade, all 7705 SAR OS image files must be copied to the cf3: device on the system. Alcatel-Lucent recommends copying all the image files for a given release into an appropriately named subdirectory off the root directory; for example, cf3:\7705-TiMoS-R6.1.R2. Copying the boot.ldr and other files in a given release to a separate subdirectory ensures that all files for that release are available in case it is necessary to downgrade the software version.
| Note:
On systems that do not have removable flash drives, you can not overwrite the boot.ldr file in the root directory on cf3:. Instead, copy the file into a subdirectory, or allow the update boot-loader command to obtain the file from a network address. Alcatel-Lucent strongly recommends following this process for all 7705 SAR systems. |
Performing the Upgrade
Upgrade the boot loader file using the command admin>update boot-loader source_url, where the source URL specifies the new boot.ldr file name and its location; for example, in the format cf3:\sub_directory\boot.ldr.
 | Warning:
The file upgrade command takes several minutes to complete. Do not reset or power down the system, or insert or remove cards or modules, while the upgrade is in progress, as this could render the system inoperable. |
On systems with redundant CSMs, the upgraded boot.ldr file can be copied to the secondary CSM by using the command admin>redundancy>synchronize boot-env.
Refer to the 7705 SAR OS 6.2.Rx Software Release Notes, part number 3HE09585000XTQZZA, “Standard Software Upgrade Procedure” for complete instructions.
Configuration Notes
The following describes BOF configuration caveats.
- For router initialization on devices with a removable compact flash, the compact flash card must be installed in the compact flash slot.
- The loading sequence is based on the order in which it is placed in the configuration file (not based on service ID, for example) and it is loaded as it is read in at boot time.
Reference Sources
For information on supported IETF drafts and standards as well as standard and proprietary MIBs, refer to Standards and Protocol Support.