WiNG 5.X Reference DHCP Options Part No. TME-02-2013-22 REV A
MOTOROLA, MOTO, MOTOROLA SOLUTIONS and the Stylized M Logo are trademarks or registered trademarks of Motorola Trademark Holdings, LLC and are used under license. All other trademarks are the property of their respective owners. 2013 Motorola Solutions, Inc. All Rights Reserved.
Table of Contents Table of Contents... 3 1. DHCP Options... 4 1.1 Standard DHCP Options... 4 2. Motorola DHCP Options... 8 2.1 Option 191 Controller Discovery... 8 2.2 AutoInstall... 9 3. DHCP Server Configuration Examples...11 3.1 Cisco Systems IOS DHCP Server...11 3.2 Extreme Networks XOS DHCP Server...11 3.3 Linux ISC DHCP Server...12 3.4 Microsoft DHCP Server...13
1. DHCP Options 1.1 Standard DHCP Options Motorola Access Points and Controllers support the following standard DHCP options: Option Description 1 Subnet Mask 2 Time Offset 3 Router 6 Name Server 12 Host Name 15 Domain Name 28 Broadcast Address 53 DHCP Message Type 55 Parameter Request List 60 Class Identifier Table 1.1 Standard DHCP Options 1.1.1 Option 1 Subnet Mask This option specifies the DHCP client's subnet mask. If both the subnet mask and the router option are specified in a DHCP reply, the subnet mask option MUST be first. Option Description Format Example 1 Subnet Mask IP Address 255.255.255.0 1.1.2 Option 2 Time Offset Table 1.1.1 Option 1 Subnet Mask This option specifies the offset of the DHCP client's subnet in seconds from Coordinated Universal Time (UTC). Option Description Format Example 2 Time Offset Integer 0xFFFFB9B0 (-5 Hours) Table 1.1.2 Option 2 Time Offset Page 4
1.1.3 Option 3 Router This option specifies a list of IP addresses for routers on the DHCP client's subnet. Routers should be listed in order of preference. Option Description Format Example 3 Router IP Address 192.168.11.1 Table 1.1.3 Option 3 Router 1.1.4 Option 6 Name Server This option specifies a list of name servers available to the DHCP client. Servers should be listed in order of preference. Option Description Format Example 6 Name Server IP Address 192.168.10.6 1.1.5 Option 12 Host Name Table 1.1.4 Option 6 Name Server This option specifies the name of the client. Note that WiNG 5 devices will supply their hostname in the DHCP discover. Option Description Format Example 12 Host Name String ap6532-1 Table 1.1.5 Option 12 Host Name 1.1.6 Option 15 Domain Name This option specifies the domain name that client should use when resolving hostnames via the Domain Name System. Option Description Format Example 15 Domain Name String example.com Table 1.1.6 Option 15 Domain Name Page 5
1.1.7 Option 28 Broadcast Address This option specifies the broadcast address in use on the client's subnet. Option Description Format Example 28 Broadcast Address IP Address 192.168.11.255 Table 1.1.7 Option 28 Broadcast Address 1.1.8 Option 53 DHCP Message Type This option is used to convey the type of the DHCP message. Option Description Format Example 53 DHCP Message Type Integer 1 DHCP Discover 2 DHCP Offer 3 DHCP Request 4 DHCP Decline 5 DHCP ACK 6 DHCP NAK 7 DHCP Release Table 1.1.8 Option 53 DHCP Message Type 1.1.9 Option 55 Parameter Request List This option is used by a DHCP client to request values for specified configuration parameters. The list of requested parameters is specified as n octets, where each octet is a valid DHCP option code as defined in this document. The client MAY list the options in order of preference. The DHCP server is not required to return the options in the requested order, but MUST try to insert the requested options in the order requested by the DHCP client. Option Description Format Example 55 Parameter Request List Integer 1 Subnet Mask 28 Broadcast Address.... 191 Controller Discovery 186 AutoInstall FTP / TFTP Server Information 187 AutoInstall Firmware Image Path / Filename 188 AutoInstall Configuration Path / Filename Table 1.1.9 Option 55 Parameter Request List Page 6
1.1.10 Option 60 Class Identifier Motorola Controllers and Access Points implement the IETF standard DHCP option 60 vendor class identifier. The vendor class identifier is forwarded to the DHCP server with DHCP discover and ACK messages and can be optionally used by DHCP server to supply specific DHCP options to the Controllers and Access Points based on their model type. Vendor class identifiers can be implemented for: 1. Deployments leveraging AutoInstall to upgrade the firmware or assign configuration files to Controllers or Access Points. Vendor classes are required to ensure the correct firmware image filename or configuration file is supplied to each device. 2. Globally assigning Motorola DHCP options for Controller discovery. Allows option 191 values to be defined globally for each Access Point model rather than individually to each DHCP scope. 3. Environments where Access Points reside on the same broadcast domain as other hosts that use the same DHCP options but require different values. The following table highlights the standard DHCP option 60 vendor class identifiers supported by each Motorola Access Point and Controller: Motorola Controllers RFS 4000 Controller RFS 6000 Controller RFS 7000 Controller Motorola Access Points AP 621 Dependent Access Point AP 622 Dependent Access Point AP 650 Dependent Access Point AP 6511 Dependent Access Point AP 6521 Dependent Access Point AP 6522 Dependent Access Point AP 6532 Dependent Access Point AP 7131 / AP 7161 Dependent Access Points AP 7181 Dependent Access Point AP 8132 Dependent Access Point Option 60 Vendor Class Identifier MotorolaRFS.RFS4000 MotorolaRFS.RFS6000 MotorolaRFS.RFS7000 Option 60 Vendor Class Identifier MotorolaAP.AP621 MotorolaAP.AP622 MotorolaAP.AP650 MotorolaAP.AP6511 MotorolaAP.AP6521 MotorolaAP.AP6522 MotorolaAP.AP6532 MotorolaAP.AP7131 MotorolaAP.AP7181 MotorolaAP.AP8132 Table 1.1.10 Option 60 Vendor Class Page 7
2. Motorola DHCP Options 2.1 Option 191 Controller Discovery Motorola Access Points support DHCP option 191 to automate Controller Discovery and provide a plug-nplay deployment experience. DHCP option 191 is required by Motorola Access Points for zero touch deployments in layer 3 environments when DHCP is utilized. Option Format Examples 191 ASCII / String pool1=<controller-ip>,<controller-ip>;level=<level>; udp-port=<port>;hellointerval=<value>;adjacency-hold-time=<value> Parameters: <controller-ip> level=<1 2> udp-port=<port> hello-interval=<value> adjacency-hold-time=<value> Defines the IP Address of the Controller(s) in dotted quad notation. Up to two Controller IP addresses can be defined which must be separated by a comma. Optionally defines the MINT link level the Access Point is to use where level 1 MINT links are used for local Controller based deployments and level 2 MINT links are used for centrally managed deployments. If this parameter and value is omitted from the option 191 string, the Access Points will establish a level 1 MINT link to a Controller. Optionally defines a non-default UDP port used for MINT encapsulation over IPv4 (default 24576). If the default MINT UDP port is changed in the default mint policy on the Controller, this parameter and value must be included in the option 191 string so that the Access Points use the correct UDP port to establish their MINT links. If the UDP ports do not match, the Access Points will fail to adopt. If this parameter and value is omitted from the option 191 string, the Access Points will establish a MINT link using the default UDP port 24576. Optionally defines the interval between hello packets exchanged between the Controllers and Access Points (default 15 seconds). Optionally defines the maximum period since the last MINT hello packet was received before the MINT link is considered down (default 45 seconds). Note It is recommended that the hello-interval value be set to 1/3rd the adjacency-hold-time value. For example if the adjacency-hold-time value is set to 60 seconds, the hello-interval must be set to 20 seconds. Note Any hello-interval and adjacency-hold-time values assigned from DHCP option 191 will supersede any values assigned to a device profile or directly to a device as an override. Page 8
2.2 AutoInstall Motorola Controllers and Access Points support an AutoInstall feature that allows administrators to distribute configuration files and firmware images from a FTP or TFTP server based on Motorola DHCP options received from a DHCP server. AutoInstall can be used to ensure the correct firmware or configuration is applied to Controllers or Access Points during pre-stating but can also be used to distribute firmware images to Access Points in standalone or virtual controller based deployments. When AutoInstall is used to automate firmware image upgrades, the Controller or Access Point will check the firmware image version each time they boot to determine if a newer version of firmware resides on the FTP / TFTP server. If a newer version of firmware is present, the Controller or Access Point will download and install the new firmware image and reboot. If the firmware image versions are the same, the Controller or Access will ignore the firmware and will not perform an upgrade. AutoInstall is enabled by default in the default profile assigned to all WiNG 5 devices but is disabled in all user defined profiles. AutoInstall can also be enabled / disabled per device using overrides. Access Points and Controllers will only attempt AutoInstall if it s explicitly enabled on the device: CLI: Context : Profile Mode Command : no autoinstall configuration : no autoinstall firmware : no autoinstall start-interval : autoinstall configuration : autoinstall firmware : autoinstall start-interval WORD Context : Device Mode Command : no autoinstall configuration : no autoinstall firmware : no autoinstall start-interval : autoinstall configuration : autoinstall firmware : autoinstall start-interval WORD : remove-override autoinstall configuration : remove-override autoinstall firmware : remove-override autoinstall start-interval Page 9
Web-UI: Configuration Profiles Profile Name Management Firmware The following table highlights the Motorola DHCP options that are required to enable AutoInstall for Motorola Access Points and Controllers: Option Description Format Example 186 TFTP Server Information ASCII or String <server-ip> 186 FTP Server Information ASCII or String ftp://<username>:<password>@<server-ip> 187 Firmware Image Path & Name ASCII or String <path>/<fw-image-filename> 188 Configuration File Path & Name ASCII or String <path>/<config-filename> Table 2.2 AutoInstall DHCP Options Page 10
3. DHCP Server Configuration Examples 3.1 Cisco Systems IOS DHCP Server The following section provides a configuration example for how to assign Motorola DHCP option 191 to an individual DHCP scope on a Cisco Systems IOS based DHCP Server: Cisco Systems IOS Scope Example:! ip dhcp excluded-address 192.168.11.1 192.168.11.99! ip dhcp pool Access-Point-VLAN! import all network 192.168.11.0 255.255.255.0 domain-name example.com dns-server 192.168.10.6 default-router 192.168.11.1 option 191 ascii pool1=192.168.20.20,192.168.20.21 3.2 Extreme Networks XOS DHCP Server The following section provides a configuration example for how to assign Motorola DHCP option 191 to an individual DHCP scope on an Extreme Networks XOS based DHCP Server: Extreme Network XOS Scope Example: configure vlan AP-VLAN dhcp-address-range 192.168.11.100 192.168.11.254 configure vlan AP-VLAN dhcp-options default-gateway 192.168.11.1 configure vlan AP-VLAN dhcp-options dns-server primary 192.168.10.6 configure vlan AP-VLAN dhcp-options code 191 string pool1=192.168.20.20,192.168.20.21 enable dhcp ports 10-12 vlan AP-VLAN save configuration primary Page 11
3.3 Linux ISC DHCP Server 3.3.1 Global Scope Options The following section provides a configuration example for how to globally define all the Motorola DHCP options in the dhcpd.conf file on an ISC DHCP Server: ISC DHCP Server Global Scope Options: option domain-name "tmelabs.local"; option domain-name-servers 192.168.10.6; option autoinstall-server code 186 = string; option autoinstall-firmware code 187 = string; option autoinstall-config code 188 = string; option controller-discovery code 191 = string; 3.3.2 Assigning Options using Scopes The following section provides a configuration example for how to assign Motorola DHCP option 191 to an individual DHCP scope on an ISC DHCP Server: ISC DHCP Server Scope Example: # APS subnet 192.168.11.0 netmask 255.255.255.0 { authoritative; range 192.168.11.100 192.168.11.254; option routers 192.168.11.1; option controller-discovery "pool1=192.168.20.20,192.168.20.21"; } 3.3.3 Assigning Options using Vendor Class The following section provides a configuration example for how to assign Motorola DHCP option 192 to a specific vendor class on an ISC DHCP Server. Note that in this example the vendor class for an AP 6532 is defined allowing Motorola option 191 to be supplied to the AP 6532 Access Points regardless of the DHCP scope they are assigned: ISC DHCP Server Vendor Class Example: # Vendor Class for Motorola AP6532 Access Points class "MotorolaAP.AP6532" { } match if substring (option vendor-class-identifier, 0, 17) = "MotorolaAP.AP6532"; option controller-discovery "pool1=192.168.20.20,192.168.20.21"; option vendor-class-identifier "MotorolaAP.AP6532"; Page 12
3.4 Microsoft DHCP Server 3.4.1 Pre-Defining Motorola Options The following section provides a step-by-step overview of how to define Motorola DHCP options as scope options on a Microsoft DHCP server: 1 Using the DHCP snap-in, right-click on IPv4 then select Set Predefined Options: 2 Set the Option class to DHCP Standard Options then click Add: Page 13
3 Define the required Option Types: Option 186 AutoInstall Server Option 187 AutoInstall Firmware Option 188 AutoInstall Configuration Option 191 Controller Discovery Page 14
3.4.2 Assigning Motorola Options to Individual Scopes The following section provides a step-by-step overview of how to assign Motorola options and values to individual scopes on a Microsoft DHCP server: 1 Using the DHCP snap-in, expand the IPv4 scope then right-click on Scope Options and select Configure Options: 2 In the Available Options list select desired Motorola options to assign then enter the required values. Click Apply then OK: Page 15
3 The Motorola DHCP option has now been applied to the scope: 3.4.3 Assigning Options using Vendor Class The following section provides a step-by-step overview of how to assign Motorola options to a scope for a specific Access Point model using Vendor Classes on a Microsoft DHCP server: 1 Using the DHCP snap-in, right-click on IPv4 then select Define Vendor Classes: Page 16
2 Click Add: 3 Define a Display name and Description. In the ASCII field enter the require vendor class identifier for the Access Point. In this example the vendor class for an AP 6532 Independent Access Point has been defined. Click OK: Page 17
4 Right-click on IPv4 then select Set Predefined Options: 5 In the Option class field select the vendor class defined in the previous step then click Add: Page 18
6 Define the following Motorola Option Types: Option 186 AutoInstall Server Option 187 AutoInstall Firmware Option 188 AutoInstall Configuration Option 191 Controller Discovery 7 Using the DHCP snap-in, expand the IPv4 scope then right-click on Scope Options and select Configure Options: Page 19
8 Select Advanced then in the Vendor class pull down menu select the vendor class defined earlier. In the Available Options list select desired Motorola options then enter the required values. Click OK then Apply: 9 The Motorola DHCP options have now been applied to the scope for a specific Access Point model: Page 20
Page 21