Configure DHCP Option Objects in Cyberoam

Applicable to Version 10.01.0286 onwards

DHCP Option Objects, also known as Vendor Extensions, are used to identify the vendor and functionality of a DHCP client. The information is a variable-length string of characters or octets in the Option field of a DHCP message which has a meaning specified by the vendor of the DHCP client.

This article describes the detailed configuration of DHCP Option Objects and its application to the static or dynamic DHCP scopes in Cyberoam. The Cyberoam DHCP server options feature provides support for all DHCP option objects, i.e., 1 to 255. This feature supports the following standards:
 
·         RFC 2131 - Dynamic Host Configuration Protocol
 
·         RFC 2132 - DHCP Options and BOOTP Vendor Extensions Standards

For Further reference, a list of all DHCP Option Objects is given at the end of this article.

In this article, as an example, we have configured option objects 176 and 252 used by the Avaya IP phones. This configuration is to be done from Web Admin Console as well as the Command Line Interface (CLI) using Administrator profile.

Note:

The option object 252 is for private use, and it can be used interchangeably with option 172. Use of Option Object 172 and 252 is recommended.

To Configure DHCP Option Objects for Avaya IP Phones in Cyberoam, follow the steps given below.

STEP 1: Create DHCP Lease Scope

Create a DHCP lease scope named “IPPhone_DHCP” from the Cyberoam GUI.
 
1.     Go to Network à DHCP à Server.
 
 
 
 
2.     Click Add. Specify values for given parameters according to the table given below.
 
 

Parameter

Value

Name

IPPhone_DHCP

Name to identify DHCP server uniquely

Interface

PortD – 192.168.30.1

Select internal interface i.e. Port D or Port A (LAN or DMZ). DHCP service can be configured on virtual subinterface but cannot be configured on Interface alias

Lease Type

Dynamic Selected

Select Lease Type.

Dynamic - Specify range of IP address from which DHCP server must assign to the clients and subnet mask for the IP address range. It is also possible to configure multiple IP range for a same interface. 

Static - If you always want to assign specific IP addresses to some or all clients, you can define static MAC address to IP address mappings. For defining, MAC-IP mapping, you should know the MAC address of the client’s network card. The MAC address is usually specified in hexadecimal digits separated by colons (for example, 00:08:76:16:BC:21). Specify host name, MAC and IP address.

 Click Add icon  to add more than one MAC-IP mapping pair and Remove icon  to delete MAC-IP mapping pair.

Lease IP Range

192.168.30.100 – 192.168.30.200

Specify range of IP address from which DHCP server must assign to the clients

Subnet Mask

/24(255.255.255.0)

Select subnet mask for the server.

Domain Name

IPPhone

Specify domain name that the DHCP server will assign to the DHCP Clients.

Gateway

Use Interface IP as Gateway checked

Specify IP address for default Gateway or click “Use Interface IP as Gateway”

Default Lease Time

1440

Specify default lease time.

Input range - 1 to 43200 minutes (30 days).

Default - 1440 minutes

Max Lease Time

2880

Specify maximum lease time. DHCP client must ask the DHCP server for new settings after the specified maximum lease time. 

Input range - 1 to 43200 minutes (30 days).

Default - 2880 minutes

Conflict Detection

Enabled

Enable IP conflict detection to check the IP before leasing i.e. if enabled the already leased IP will not be leased again.  

Can be configured only if lease type is “Dynamic”

DNS Server

Use Appliance’s DNS settings checked

Click “Use Appliance’s DNS settings” to use Cyberoam DNS or Specify IP address of Primary and Secondary DNS servers.

WINS Server

Specify IP address of Primary and Secondary WINS servers.

 
 
 
 
3.  Click OK to create the new DHCP Lease Scope. It can be seen as below.
 
 
 
 
STEP 2: Configure DHCP Option 176

Configuration of DHCP Options can be done from Cyberoam’s Command Line Interface (CLI).

 

 
1.     Login to CLI using Telnet/SSH.
 
2.     Select option 4 to go to Cyberoam Console.

3.    
Fire the following command to add Object 176 to the list of existing DHCP Option Objects in Cyberoam.
 
     console > cyberoam dhcp dhcp-options add optioncode 176 optionname IPTelephone optiontype string
 
 
 

     To view the list of existing DHCP Option Objects, fire the following command

     console > cyberoam dhcp dhcp-options list
 
 
 
     Note:
 
     Cyberoam displays the option numbers from 1 to 76 only, but it supports all the 255 option objects.
 
 
4.    Bind the newly added Object 176 to the DHCP Lease Scope “IPPhone_DHCP”. The parameters and their values used in the 
     command fired for binding are given in the table below.
 
 
 
Parameters
Values
MCIPADD
192.168.30.99
IP address of the Avaya Call server. This is the server where an Avaya IP phone registers itself.
MCPORT
1719
Avaya IP Phone communicates with the Avaya call server on port 1719 by default. A custom port can be specified if you have it configured on your call server.
TFTPSRVR
192.168.30.201
The TFTP Server address to which IP Phones connect to perform automatic firmware upgrades when the Config file received by the phone has a higher version than the present file.

     The command to be executed is given below.
 
     console > cyberoam  dhcp dhcp-options binding add dhcpname IPPhone_DHCP optionname IPTelephone(176) 
    value ‘MCIPADD=192.168.30.99,MCPORT=1719,
TFTPSRVR=192.168.30.201’

 
 
 
STEP 3: Configure DHCP Option 252
 
Here, a private Option Object 252 is added to the list of existing DHCP Option Objects.

1.   
Fire the following command to add DHCP Option Object 252.

    console > cyberoam dhcp dhcp-options add optioncode 252 optionname httpserver optiontype string
 
 
 
 
2.     Bind the newly added Object 252 to the DHCP Lease Scope “IPPhone_DHCP”. This Option Object defines only one parameter which
     specifies IP of the HTTP server as the IP address of the SIP proxy and the registration server is configured in the Server itself. The parameter 
     and its value used in the command fired for binding are given in the table below.
 
 
Parameters

Values

ConfigHttpServer

192.168.30.102

IP address of the Http Server.


     The command to be executed is given below.
 
     console > cyberoam dhcp dhcp-options binding add dhcpname IPPhone_DHCP optionname httpserver(252) value ‘ConfigHttpSrvr=192.168.30.102’
 




This is the configuration of DHCP Option Objects 176 and 252 for Avaya IP Phones. There are a number of other objects that can be used for various purposes. A list of all DHCP Option Objects is given below for reference
.

 
                        DHCP Option Objects 
 

Code

Description

0

Pad.

1

Subnet Mask.

2

Time Offset (deprecated).

3

Router.

4

Time Server.

5

Name Server.

6

Domain Name Server.

7

Log Server.

8

Quote Server.

9

LPR Server.

10

Impress Server.

11

Resource Location Server.

12

Host Name.

13

Boot File Size.

14

Merit Dump File.

15

Domain Name.

16

Swap Server.

17

Root Path.

18

Extensions Path.

19

IP Forwarding enable/disable.

20

Non-local Source Routing enable/disable.

21

Policy Filter.

22

Maximum Datagram Reassembly Size.

23

Default IP Time-to-live.

24

Path MTU Aging Timeout.

25

Path MTU Plateau Table.

26

Interface MTU.

27

All Subnets are Local.

28

Broadcast Address.

29

Perform Mask Discovery.

30

Mask supplier.

31

Perform router discovery.

32

Router solicitation address.

33

Static routing table.

34

Trailer encapsulation.

35

ARP cache timeout.

36

Ethernet encapsulation.

37

Default TCP TTL.

38

TCP keepalive interval.

39

TCP keepalive garbage.

40

Network Information Service Domain.

41

Network Information Servers.

42

NTP servers.

43

Vendor specific information.

44

NetBIOS over TCP/IP name server.

45

NetBIOS over TCP/IP Datagram Distribution Server.

46

NetBIOS over TCP/IP Node Type.

47

NetBIOS over TCP/IP Scope.

48

X Window System Font Server.

49

X Window System Display Manager.

50

Requested IP Address.

51

IP address lease time.

52

Option overload.

53

DHCP message type.

54

Server identifier.

55

Parameter request list.

56

Message.

57

Maximum DHCP message size.

58

Renew time value.

59

Rebinding time value.

60

Class-identifier.

61

Client-identifier.

62

NetWare/IP Domain Name.

63

NetWare/IP information.

64

Network Information Service+ Domain.

65

Network Information Service+ Servers.

66

TFTP server name.

67

Bootfile name.

68

Mobile IP Home Agent.

69

Simple Mail Transport Protocol Server.

70

Post Office Protocol Server.

71

Network News Transport Protocol Server.

72

Default World Wide Web Server.

73

Default Finger Server.

74

Default Internet Relay Chat Server.

75

StreetTalk Server.

76

StreetTalk Directory Assistance Server.

77

User Class Information.

78

SLP Directory Agent.

79

SLP Service Scope.

80

Rapid Commit.

81

FQDN, Fully Qualified Domain Name.

82

Relay Agent Information.

83

Internet Storage Name Service.

84

85

NDS servers.

86

NDS tree name.

87

NDS context.

88

BCMCS Controller Domain Name list.

89

BCMCS Controller IPv4 address list.

90

Authentication.

91

Client-last-transaction-time.

92

Associated-ip.

93

Client System Architecture Type.

94

Client Network Interface Identifier.

95

LDAP, Lightweight Directory Access Protocol.

96

97

Client Machine Identifier.

98

Open Group's User Authentication.

99

GEOCONF_CIVIC.

100

IEEE 1003.1 TZ String.

101

Reference to the TZ Database.

102-111

112

NetInfo Parent Server Address.

113

NetInfo Parent Server Tag.

114

URL.

115

116

Auto-Configure

117

Name Service Search.

118

Subnet Selection.

119

DNS domain search list.

120

SIP Servers DHCP Option.

121

Classless Static Route Option.

122

CCC, CableLabs Client Configuration.

123

GeoConf.

124

Vendor-Identifying Vendor Class.

125

Vendor-Identifying Vendor-Specific.

126

127

128

TFPT Server IP address.

129

Call Server IP address.

130

Discrimination string.

131

Remote statistics server IP address.

132

802.1P VLAN ID.

133

802.1Q L2 Priority.

134

Diffserv Code Point.

135

HTTP Proxy for phone-specific applications.

136

PANA Authentication Agent.

137

LoST Server.

138

CAPWAP Access Controller addresses.

139

OPTION-IPv4_Address-MoS.

140

OPTION-IPv4_FQDN-MoS.

141

SIP UA Configuration Service Domains.

142

OPTION-IPv4_Address-ANDSF.

143

OPTION-IPv6_Address-ANDSF.

144 – 149

150

TFTP server address.

150

Ether boot. GRUB configuration path name.

151-174

175

Ether boot.

176

IP Telephone.

177

Ether boot. Packet Cable and Cable Home.

178-207

208

pxelinux.magic (string) = F1:00:74:7E (241.0.116.126).

209

pxelinux.configfile (text).

210

pxelinux.pathprefix (text).

211

pxelinux.reboottime (unsigned integer 32 bits).

212

OPTION_6RD.

213

OPTION_V4_ACCESS_DOMAIN.

214-219

220

Subnet Allocation.

221

Virtual Subnet Selection.

222-223

224-254

Private use.

255

End.