![]() |
Network Registrar Help |
|
DHCP administrators manage dynamic host configurations in their network. They do not have complex client classification or DHCP request handling customization requirements. They rather want to use the basic features of the DHCP server to easily configure a large number of devices with their basic IP configuration.
The DHCP administrator usually manages DHCP scopes and policies, and clients and client-classes.
At the local cluster only, this page displays DHCP scopes, if you are assigned the dhcp-admin role. From this page, you can add, edit, and delete scopes, unless you are a read-only administrator. The scopes are listed alphabetically, with their subnet address and mask, and any associated DHCP policies.
If you want to avoid repeating the same properties for multiple scopes, you can create a scope template and then associate it with the scopes.
You can list the scopes sorted by scope name or subnet. To sort by scope name, click the Name column heading. To sort by subnet, click the Subnet column heading.
This page also lets you search for scopes, navigate through the list, and change the display size. Refresh the list every time you make changes and come back to this page.
Field/Choice | Description |
Name | Name of the scope. If you omit a name, the subnet name is used. If entering a name, enter a value that is unique, yet reflects the scope's use. It can be any character string of any length, but it is best to keep it as short as possible while still making it unique. Required. |
Subnet | Enter the network address, in quad format, such as 192.168.50.0, and choose the network prefix mask from the drop-down list. If you choose a mask of 24, for example, the subnet would be 192.168.50.0/24. Required. |
Template | If using a template, click the template name in the drop-down list of predefined templates, as defined by clicking Scope Templates on the Secondary Navigation bar. The default is not to use a template. Optional. |
Top of Page | Top of Section | Close Window |
At the local cluster, only, this page lets you add DHCP scopes for address leases if you did not associate a template for the scope on the List/Add DHCP Scope page. You must specify a name, network address and mask, and policy for each scope. You can also add desired address ranges and lease reservations to the scope. The fields to enter are as follows:
NOTE: You must click Add Scope on this page to finish creating the scope.
Field/Choice | Description |
Name | Name of the scope. Enter a value that is unique, yet reflects the scope's use. It can be any character string of any length, but it is best to keep it as short as possible while still making it unique. Required. |
Subnet | Enter a the network address, in quad format, such as 192.168.50.0, and choose the network prefix mask from the drop-down list. If you choose a mask of 24, for example, the subnet would be 192.168.50.0/24. Required. |
Policy | Policy associated with the scope. Choose from the predefined policies in the drop-down list, as defined by clicking Policies on the Secondary Navigation bar. The default and system-default-policy policies already appear in the list. You can also choose the blank policy value, if desired. Required. The default is the default policy. |
Ranges Start, End |
Address ranges to include in the scope. These ranges do not need to be contiguous, but they must be part of the defined network/mask, and they cannot overlap. Enter either the full network address or just the host part of the address in the Start and End fields, then click Add Range for each range entered. The ranges appear in the order entered below the button. You can delete any range by clicking the Delete icon (![]() |
Reservations IP Address, MAC Address |
Any addresses that have reserved leases. You enter each host address separately, with their associated MAC (hardware) address. Enter the host address in the IP Address field, and the MAC address in the MAC Address field. The MAC address should be in the form 1,6,nn:nn:nn:nn:nn:nn (with the prefix) or nn:nn:nn:nn:nn:nn (without the prefix), with the numbers in hexadecimal, such as 00:d0:ba:d3:bd:3b. Then, click Add Reservation for each reservation entered. The reservations appear in the order entered below the button. (If you add more than ten reservations, they appear on a separate List/Add DHCP Reservations for Scope page accessible by clicking List Reservations.) You can delete any reservation by clicking the Delete icon (![]() |
Selection Tags | A scope selection tag is an arbitrary tag name associated with the scope that you use to determine if a client or client-class should belong to what scope. The tag can be any length of characters, but must be unique. Click Add Selection Tag for each tag entered. They appear in the order entered below the field. To delete any tag, click the Delete icon (![]() |
The optional attributes appear in functional categories. For a description of each attribute, click the attribute name to open a help window.
After you complete these fields, click Add Scope, or Cancel to cancel the operation. You can edit or delete the scope from the List DHCP Scopes page.
Top of Page | Top of Section | Close Window |
When you click a scope's name on the List DHCP Scopes page, you can change any of the scope's attributes on the Edit DHCP Scope page, unless you are a read-only administrator. You can also set an embedded policy and list leases associated with this scope. For a description of the attributes already created that you can modify, see the Adding a DHCP Scope topic.
You can edit the embedded policy for the scope. In the Embedded Policy area of the page, click Edit Embedded Policy. This opens the Edit DHCP Embedded Policy for Scope page. To return from this page, click Modify Embedded Policy or Cancel.
You can list the leases for the scope. Under the Leases section, click List Leases. This opens the List DHCP Leases for Scope page where you can manage the leases.
You can also add and delete reservations. If there are more than ten reservations, they appear on a separate List/Add DHCP Reservations for Scope page accessible by clicking List Reservations.
The optional attributes appear in functional categories. For a description of each attribute, click the attribute name to open a help window.
Top of Page | Top of Section | Close Window |
When you click List Reservations on the Add DHCP Scope or Edit DHCP Scope page, you can view the reservations for the scope, and add or delete any if necessary. To add a new reservation, add its IP address and MAC address, then click Add Reservation. To return to the originating page, click Return to Edit DHCP Scope.
Top of Page | Top of Section | Close Window |
When you click List Leases on the Edit DHCP Scope page, or the View icon from the List/Add DHCP Scopes page, you can view the state of the leases for that scope, and further manage each lease individually, unless you are a read-only administrator. This page includes the following information:
Column | Description |
Address | IP address of the leased client. Click this name to manage the lease. |
State | Lease state of the client. |
MAC Address | MAC address of the client. |
Host Name | Host domain name of the client, if resolvable through DNS. |
Flags | Lease flags for the client. |
Expiration | Expiration date of the reserved lease. |
Click Return to DHCP Scope to return to the Edit DHCP Scope or List/Add DHCP Scopes page.
Top of Page | Top of Section | Close Window |
When you click a lease name on the List DHCP Leases for Scope page, you can manage the lease by viewing its DHCP attributes, forcing its availability if it is made unavailable, de-activating it if it is activated, or activating it if it is de-activated. If you have read-only privileges, you can only view the lease data, and the Force Available and Deactivate or Activate functions are not available.
The lease attributes, their values, and data types appear in categories. The attributes are read-only and none of them have default values. For a description of each attribute, click the attribute name to open a help window.
Top of Page | Top of Section | Close Window |
You can edit the embedded policy for a scope, scope template, client, and client-class, unless you are a read-only administrator. An embedded policy is implicitly created when you create one of these objects.
For example, you can edit a scope's embedded policy by clicking Edit Embedded Policy in the Embedded Policy section of the Edit DHCP Scope page. On the Edit DHCP Embedded Policy page, you need to specify an offer timeout, grace period, and server lease time value for the embedded policy. You can also add DHCP options and further attributes for the embedded policy. The fields to enter are as follows:
Field | Description |
Offer timeout | Time that the DHCP server waits after offering a lease to a client, but the client refuses the lease, and when the server should make the lease available to another client. The default is two minutes (2m). Values can also be in seconds (s), minutes (m), days (d), weeks (w), or years (y), or any combination thereof. |
Grace period | Time between when a lease expires and when the DHCP server should make the lease available to clients again. The default is five minutes (5m). Values can also be in seconds (s), minutes (m), days (d), weeks (w), or years (y), or any combination thereof. |
Options | DHCP options. Choose an option from the Number drop-down list. Then, give the option a value in the Value field. The Web UI validates each option value. For a description of each option, see the Network Registrar User's Guide. You must add each option one at a time, using Add Option. The added option appears below the button. You cannot edit an option once it is created; you must delete and replace it. To delete an option, click the Delete icon (![]() |
The optional attributes appear at the bottom of the page. For a description of each attribute, click the attribute name to open a help window. To unset any of the attribute values, click a check mark in the Unset? column next to the attribute, then click Unset Fields.
After you complete these fields, click Modify Embedded Policy, or click Cancel to cancel the changes.
Top of Page | Previous Section | Close Window |
At the regional and local clusters, this page displays scope templates used to apply certain common attributes to multiple scopes. This and the related pages are available only to administrators assigned the dhcp-management subrole of the central-cfg-admin or regional-addr-admin role.
You can use this page to create, add, edit, and delete scope templates, unless you are a read-only administrator. On the regional cluster, you can view the aggregate list of scope templates from the local servers. You can also pull scope templates from, and push them to, the local servers. On the local cluster, you can only add, edit, and delete scope templates.
Top of Page | Listing Scopes | Close Window |
This page lets you add scope templates. You must specify a name for each template, and you can create a scope based on, and associate a policy with, the template. You can also add desired address ranges and scope selection tags for each template. The fields to enter or choices to make are:
Field/Choice | Description |
Name | Name of the scope template. Enter a value that is unique, yet reflects the template's use. Required. |
Scope Name Expression | Expression of the scope you want to create with this template. For details on expressions, see the Scope Expressions topic. The expression must return a string. Optional. |
Policy | Policy associated with the template. Choose from the predefined policies in the drop-down list, as defined by clicking Policies on the Secondary Navigation bar. The default and system-default-policy policies already appear in the list. You can also choose the blank policy value, if desired. Optional. |
Range Expression | Expression of the address ranges you want to include with this template. For details on expressions, see the Scope Expressions topic. The expression must return a range or list of ranges. Optional. |
Embedded Policy Option Expression | Expression of the options you want to include in the scope's embedded policy. For details on expressions, see the Scope Expressions topic. The expression must return an option or list of options. Optional. |
Scope Selection Tags | A scope selection tag is an arbitrary tag name associated with clients and client-classes to determine what scope they should belong to. The tag can be any length of characters, but must be unique. Click Add Selection Tag for each tag entered. They appear in the order entered above the button. To delete any tag, click the Delete icon (![]() |
The optional attributes appear in functional categories. For a description of each attribute, click the attribute name to open a help window.
After you complete these fields, click Add Scope Template, or click Cancel to cancel the changes. You can edit or delete the template from the List DHCP Scope Templates page.
Top of Page | Top of Section | Close Window |
When you click a scope template name on the List DHCP Scope Templates page, you can change its name, scope name, and policy name, and add or delete scope selection tags, unless you are a read-only administrator. For a description of these attributes, see the Adding a Scope Template topic. For a description of the available expressions to include in the Expression fields, see the Scope Expressions topic.
You can also edit the scope template's embedded policy and add attributes. To edit the template's embedded policy, click Edit Embedded Policy in the Embedded Policy section of the page. This opens the Edit DHCP Embedded Policy for Template page.
The optional attributes appear in categories. For a description of each attribute, click the attribute name to open a help window. To unset any of the attribute values, click a check mark in the Unset? column next to the attribute, then click Unset Fields.
After you modify these fields, click Modify Scope Template, or click Cancel to cancel the modifications. You can delete the scope on the List DHCP Scope Templates page.
Top of Page | Top of Section | Close Window |
The following table describes the scope expression functions you can use on the Add DHCP Scope Template or Edit (or View) DHCP Scope Template page. The functions are not case sensitive.
Expression | Description |
Context Variables | |
bcast-addr | Derived from the broadcast address in the subnet, such as 192.168.50.255. Use in any expression field. |
first-addr | Derived from the first address in the subnet, such as the first address in 192.168.50.64/26 is 192.168.50.65. Use in any expression field. |
last-addr | Derived from the last address in the subnet, such as the last address in 192.168.50.64/26 is 192.168.50.127. Use in any expression field. |
mask-addr | Derived from the network mask address in the subnet, such as 255.255.255.0. Use in any expression field. |
mask-count | Derived from the number of bits in the network address of the subnet, such as 24. Use in the Scope Name Expression or Embedded Policy Option Expression field. |
naddrs | Derived from the number of IP addresses in the subnet, such as 255. Use in the Scope Name Expression field. |
nhosts | Derived number of usable hosts in the subnet, such as 254. Use in any expression field. |
subnet | Derived from the IP address and mask of the subnet, such as 192.168.50.0/24. Use in the Scope Name Expression or Embedded Policy Option Expression field. |
subnet-addr | Derived from the subnet address, such as 192.168.50.0. Use in any expression field. |
template.attribute | Attribute of the scope template, such as template.ping-timeout. Use in the Embedded Policy Option Expression field. |
Arithmetic Operations (unsigned integer arguments only) | |
(+ arg1 arg2) | Adds the two argument values, such as (+ 2 3). |
(- arg1 arg2) | Subtracts the second argument value from the first one, such as with ping-timeout defined as 100, (- template.ping-timeout 10) yields 90. |
(* arg1 arg2) | Multiplies the values of two arguments. |
(/ arg1 arg2) | Divides the value of the first argument by that of the second one (which cannot be zero). |
Concatenation Operation | |
(concat arg1 ... argn) | Concatenates the arguments into a string, to be used in the Scope Name Expression field. Examples: With subnet=192.168.50.0/24 and template.ping-timeout=100:
(concat "ISP-" subnet) yields ISP-192.168.50.0/24 |
Create Option Operation | |
(create-option opt val) | Use this operation in the Embedded Policy Option Expression field. It creates a new DHCP option for the scope. The first argument can be an integer or string to represent the option number or name. The second argument can be a string or blob to give the option a value. Examples:
(create-option "domain-name" "example.com") |
Create Range Operation | |
(create-range start end) | Use this operation in the Range Expression field. It creates an IP address range for the scope. The first argument is the start of the address range and can be an integer or IP address string. The second argument is the end of the range and can be an integer or IP address string. Validation ensures that the range must be in the subnet defined by the template and that the first argument value must be lower than the second. An integer value determines the position of the address in the given subnet. Examples: With subnet=192.168.50.0/26:
(create-range "192.168.50.65" "192.168.50.74") yields 192.168.50.65 - 192.168.50.74 |
Create IP Operation | |
(create-ipaddr net host) | Use this operation in the Embedded Policy Option Expression or Range Expression fields. It creates an IP address string. The net argument is a string or variable. The host argument is an integer. Example:
(create-ipaddr subnet 4) |
List Operation | |
(list oper1 ... opern) | Arguments must all be create-option or create-range operations. Nesting is not supported. Examples:
(list (create-option "routers" "10.10.10.1") (create-option "domain-name" "example.com")) |
Top of Page | Top of Section | Close Window |
At the regional cluster only, this page appears if you click Push Scope Template or Push All Scope Templates on the List DHCP Scope Templates page. It shows the templates to be pushed (or All Scope Templates) and a choice of local clusters to which to push them.
The fields and choices on this page are:
Field/Choice | Description |
Data to Push | Scope template chosen to push to the local clusters, or All Scope Templates. Click the template link to open the View Scope Template page. |
Data Synchronization Mode | Mode to use to synchronize at the regional and local clusters. Required. Click one of the radio buttons:
|
Destination Clusters | List of known local clusters. Move the desired cluster or clusters from the Available field into the Selected field using <<. To choose all the clusters, click Select All, then << to move them. To remove one or more clusters, click its name or names in the Selected list, then click >> to move it or them to the Available list. You must move at least one cluster to Selected to make the push operation work. |
TIP: The cluster choice and radio buttons are persistent, so that any future operations on this page will retain these settings.
After making these choices, click Push Data to Clusters, or Cancel. This opens the View Push Scope Template Data Report page.
Top of Page | Top of Section | Close Window |
At the regional cluster only, this page appears if you click Push Data to Clusters on the Push Scope Template Data to Local Clusters page. It shows a read-only summary of the results of the push operation. Click OK or Cancel to return.
Top of Page | Top of Section | Close Window |
At the regional cluster only, this page appears if you click Pull Replica Scope Templates on the List DHCP Scope Templates page. It shows a tree view of the regional server's replica data for the local clusters' scope templates. The tree has two levels, one for the clusters and one for the scope templates in each cluster.
The columns on this page are:
Column | Description |
Name | Name of the local cluster and its scope templates. If necessary, click the cluster name to open the Edit Server Cluster page. You can also view the template data by clicking its name to open the View DHCP Scope Template page. |
Update Replica Data | To update the replica data for the local cluster on the regional cluster, click the Replica icon (![]() |
Pull Data | To pull a specific scope template, click Pull Scope Template next to its name. To pull all the templates from the cluster, click Pull All Scope Templates from Cluster. |
To complete the operation, click OK, or Cancel to cancel, to return to the List DHCP Scope Templates page.
Top of Page | Top of Section | Close Window |
At the regional cluster only, this page appears when you pull scope templates on the Select Replica DHCP Scope Template Data to Pull page. It shows the changes to be made with the pull operation. Click Run, or Cancel to cancel the operation.
Top of Page | Top of Section | Close Window |
At the regional cluster only, this page appears when you click Run on the Report Pull Replica Scope Templates page. After looking at the report data, click Run to complete the pull operation.
Top of Page | Top of Section | Close Window |
At the regional and local clusters, this page displays any created DHCP policies you can associate with scopes. This and the related pages are available only to administrators assigned the dhcp-management subrole of the central-cfg-admin role. From this page, you can add, edit, and delete policies, unless you are a read-only administrator. The policies are listed alphabetically, with their offer timeout, grace period, and lease time values displayed. The default and system_default_policy policies are predefined.
On the regional cluster, you can view the aggregate list of policies from the local servers. You can also pull policies from, and push them to, the local servers.
This page also lets you search for policies, navigate through the list, and change the display size. Refresh the list every time you make changes and come back to this page.
Top of Page | Listing Scopes | Close Window |
This page lets you add DHCP policies to associate with scopes. You need to specify a name, offer timeout, and grace period. You can also add DHCP options for the policy, such as the dhcp-lease-time. The fields to enter are as follows:
Field/Choice | Description |
Name | Name of the policy. Enter a value that is unique, yet reflects the policy's use. It can be any character string of any length, but it is best to keep it as short as possible while still making it unique. Required. |
Offer timeout | Time the DHCP server waits after offering a lease to a client, but the client refuses the lease, and when the server should make the lease available to another client. The default is two minutes (2m). Values can also be in seconds (s), minutes (m), days (d), weeks (w), or years (y), or any combination thereof. Optional. |
Grace period | Time between when a lease expires and when the DHCP server should make the lease available to clients again. The default is five minutes (5m). Values can also be in seconds (s), minutes (m), days (d), weeks (w), or years (y), or any combination thereof. Optional. |
Options | DHCP options. Choose an option from the Number drop-down list. Then, give the option a value in the Value field. The Web UI validates each option value. For a description of each option, see the Network Registrar User's Guide. One of the more widely used options is option 51 (dhcp-lease-time), a column that appears on the List DHCP Policies page. You must add each option one at a time, using Add Option. The added option appears below the button. You cannot edit an option once created; you must delete and replace. To delete an option, click the Delete icon (![]() |
The optional attributes appear in categories. For a description of each attribute, click the attribute name to open a help window.
After you complete these fields, click Add Policy, or click Cancel to cancel adding it. You can edit or delete the policy on the List DHCP Policies page.
Top of Page | Top of Section | Close Window |
When you click a policy's name on the List DHCP Policies page, you can change any of the policy's attributes and options on the Edit DHCP Policy page, unless you are a read-only administrator. The fields or choices to change are as follows:
Field/Choice | Description |
Name | Name of the policy. This is a read-only value and you cannot change it. |
Offer timeout | Time the DHCP server waits after offering a lease to a client, but the client refuses the lease, and when the server should make the lease available to another client. The default is two minutes (2m). Values can also be in seconds (s), minutes (m), days (d), weeks (w), or years (y), or any combination thereof. Optional. |
Grace period | Time between when a lease expires and when the DHCP server should make the lease available to clients again. The default is five minutes (5m). Values can also be in seconds (s), minutes (m), days (d), weeks (w), or years (y), or any combination thereof. Optional. |
Options | DHCP options. Choose an option from the Number drop-down list. Then, give the option a value in the Value field. The Web UI validates each option value. For a description of each option, see the Network Registrar User's Guide. One of the more widely used options is option 51 (dhcp-lease-time), a column that appears on the List DHCP Policies page. You must add each option one at a time, using Add Option. The added option appears below the button. You cannot edit an option once created; you must delete and replace. To delete an option, click the Delete icon (![]() |
The optional attributes appear at the bottom of the page. For a description of each attribute, click the attribute name to open a help window.
Top of Page | Top of Section | Close Window |
At the regional cluster only, this page appears if you click Push Policy or Push All Policies on the List DHCP Policies page. It shows the policies to be pushed (or All Policies) and a choice of local clusters to which to push them.
The fields and choices on this page are:
Field/Choice | Description |
Data to Push | Policy chosen to push to the local clusters, or All Policies. Click the policy link to open the View DHCP Policy page. |
Data Synchronization Mode | Mode to use to synchronize at the regional and local clusters. Required. Click one of the radio buttons:
|
Destination Clusters | List of known local clusters. Move the desired cluster or clusters from the Available field into the Selected field using <<. To choose all the clusters, click Select All, then << to move them. To remove one or more clusters, click its name or names in the Selected list, then click >> to move it or them to the Available list. You must move at least one cluster to Selected to make the push operation work. |
TIP: The cluster choice and radio buttons are persistent, so that any future operations on this page will retain these settings.
After making these choices, click Push Data to Clusters, or Cancel. This opens the View Push Scope Template Data Report page.
Top of Page | Top of Section | Close Window |
At the regional cluster only, this page appears if you click Push Data to Clusters on the Push DHCP Policy Data to Local Clusters page. It shows a read-only summary of the results of the push operation. Click Cancel to return.
Top of Page | Top of Section | Close Window |
At the regional cluster only, this page appears if you click Pull Replica Policies on the List DHCP Policies page. It shows a tree view of the regional server's replica data for the local clusters' policies. The tree has two levels, one for the clusters and one for the policies in each cluster.
The columns on this page are:
Column | Description |
Name | Name of the local cluster and its policies. If necessary, click the cluster name to open the Edit Server Cluster page. You can also view the policy data by clicking its name to open the View DHCP Policy page. |
Update Replica Data | To update the replica data for the local cluster on the regional cluster, click the Replica icon (![]() |
Pull Data | To pull a specific policy, click Pull Policy next to its name. To pull all the policies from the cluster, click Pull All Policies from Cluster. This opens the Report Pull Replica DHCP Policies page. |
To complete the operation, click OK, or Cancel, to return to the List DHCP Policies page.
Top of Page | Top of Section | Close Window |
At the regional cluster only, this page appears when you pull DHCP policies on the Select Replica DHCP Policy Data to Pull page. It shows the changes to be made with the pull operation. Click Run, or Cancel to cancel the operation.
Top of Page | Top of Section | Close Window |
At the regional cluster only, this page appears when you click Run on the Report Pull Replica DHCP Policies page. After looking at the report data, click Run to complete the pull operation.
Top of Page | Top of Section | Close Window |
At the local cluster only, this page displays any created DHCP clients. From this page, you can add, edit, and delete clients, unless you are a read-only administrator. The clients are listed numerically, with their client-class membership.
This page also lets you search for clients, navigate through the list, and change the display size. Refresh the list every time you make changes and come back to this page.
Top of Page | Client-Classes | Close Window |
Use this page to add DHCP clients. You get to it by adding a client name on the List/Add DHCP Clients page and clicking Add Client. To create a client, you must give it a name and optionally apply client-class, host, domain, and policy names. The fields to enter and choices to make are:
Field/Choice | Description |
Name | MAC address or other unique designator for the client. A MAC address can be in the nn:nn:nn:nn:nn:nn format. The Web UI adds the type and length prefixes. Required |
Client-class name | Client-class to which the client belongs. Choose from the predefined client-classes in the drop-down list. Optional. |
Host name | Host domain name of the client. This host name must exist in the domain. Optional. |
Domain name | Domain in which the host resides. Use the fully qualified domain name, such as the "example.com." domain. Optional. |
Policy name | Policy associated with the client. Choose from the predefined policies in the drop-down list. Optional. |
The optional attributes appear at the bottom of the page. For a description of each attribute, click the attribute name to open a help window.
Click Add Client (you must do this to add the client), or Cancel. You return to the List/Add DHCP Clients page. Click the Refresh icon () on that page to refresh the database.
Top of Page | Top of Section | Close Window |
When you click a client's name on the List/Add DHCP Clients page, you can change any of the client's attributes and options on the Edit DHCP Client page, unless you are a read-only administrator. The fields to edit and choices to change are as follows:
Field/Choice | Description |
Name | MAC address or other unique designator for the client. A MAC address can be in the nn:nn:nn:nn:nn:nn format. The Web UI adds the type and length prefixes. You cannot edit this value. |
Client-class name | Client-class to which the client belongs. Choose from the predefined client-classes in the drop-down list. Optional. |
Host name | Host domain name of the client. This host name must exist in the domain. Optional. |
Domain name | Domain in which the host resides. Give this fully qualified, such as the "example.com." domain. Optional. |
Policy name | Policy associated with the client. Choose from the predefined policies in the drop-down list. Optional. |
You can edit the embedded policy for the client. Under the Embedded Policy section, click Edit Embedded Policy. This opens the Edit DHCP Embedded Policy for Client page. To return from this page, click Modify Embedded Policy or Cancel.
The optional attributes appear at the bottom of the page. For a description of each attribute, click the attribute name to open a help window.
Top of Page | Top of Section | Close Window |
At the regional and local clusters, this page displays any created DHCP client-classes. A client-class is a grouping of clients. This and the related pages are available only to administrators assigned the dhcp-management subrole of the central-cfg-admin role. From this page, you can add, edit, and delete client-classes. The client-classes are listed alphabetically, with their host name, domain name, and associated policies displayed.
On the regional cluster, you can view the aggregate list of client-classes from the local servers. You can also pull client-classes from, and push them to, the local servers.
This page also lets you search for client-classes, navigate through the list, and change the display size. Refresh the list every time you make changes and come back to this page.
Top of Page | Clients | Close Window |
This page lets you add DHCP client-classes. You get there by clicking Add Client-Class on the List DHCP Client-Classes page. You need to specify a name, the client's host name, domain name, and any associated policies. The fields to enter and choices to make are as follows:
Field/Choice | Description |
Name | Name of the client-class. Enter a value that is unique, yet reflects its use. It can be any character string of any length, but it is best to keep it as short as possible while still making it unique. Required. |
Host name | Host domain name of the client-class. This host name must exist in the domain. Optional. |
Domain name | Domain in which the host resides. Give this fully qualified, such as the example.com. domain. Optional. |
Policy name | Policy associated with the client-class. Choose from the predefined policies in the drop-down list, as defined by clicking Policies on the Secondary Navigation bar. Optional. |
The optional attributes appear at the bottom of the page. For a description of each attribute, click the attribute name to open a help window.
After you complete these fields, click Add Client-Class (you must do so to create the client-class), or Cancel. You can edit or delete the client-class on the List DHCP Client-Classes page.
Top of Page | Top of Section | Close Window |
When you click a client-class's name on the List DHCP Client-Classes page, you can change any of the client-class's attributes and options (other than its name) on the Edit DHCP Client-Class page, unless you are a read-only administration. For a description of the attributes and options already created that you can modify, see the Adding a DHCP Client-Class topic.
The optional attributes appear at the bottom of the page. For a description of each attribute, click the attribute name to open a help window.
Top of Page | Top of Section | Close Window |
At the regional cluster only, this page appears if you click Push Client-Class or Push All Client-Classes on the List DHCP Client-Classes page. It shows the client-classes to be pushed and a choice of local clusters to which to push them.
The fields and choices on this page are:
Field/Choice | Description |
Data to Push | Policy chosen to push to the local clusters, or All Policies. Click the client-class link to open the View DHCP Client-Class page. |
Data Synchronization Mode | Mode to use to synchronize at the regional and local clusters. Required. Click one of the radio buttons:
|
Destination Clusters | List of known local clusters. Move the desired cluster or clusters from the Available field into the Selected field using <<. To choose all the clusters, click Select All, then << to move them. To remove one or more clusters, click its name or names in the Selected list, then click >> to move it or them to the Available list. You must move at least one cluster to Selected to make the push operation work. |
TIP: The cluster choices and radio buttons are persistent, so that any future operations on this page will retain these settings.
After making these choices, click Push Data to Clusters, or Cancel. This opens the View Push DHCP Client-Class Data Report page.
Top of Page | Top of Section | Close Window |
At the regional cluster only, this page appears if you click Push Data to Clusters on the Push DHCP Client-Class Data to Local Clusters page. It shows a read-only summary of the results of the push operation. Click OK or Cancel to return.
Top of Page | Top of Section | Close Window |
At the regional cluster only, this page appears if you click Pull Replica Client-Classes on the List DHCP Client-Classes page. It shows a tree view of the regional server's replica data for the local clusters' client-classes. The tree has two levels, one for the clusters and one for the client-classes in each cluster.
The columns on this page are:
Column | Description |
Name | Name of the local cluster and its client-classes. If necessary, click the cluster name to open the Edit Server Cluster page. You can also view the client-class data by clicking its name to open the View DHCP Client-Class page. |
Update Replica Data | To update the replica data for the local cluster on the regional cluster, click the Replica icon (![]() |
Pull Data | To pull a specific client-class, click Pull Client-Class next to its name. To pull all the client-classes from the cluster, click Pull All Client-Classes from Cluster. This opens the Report Pull Replica Client-Classes page. |
To complete the operation, click OK, or Cancel to cancel, to return to the List DHCP Client-Classes page.
Top of Page | Top of Section | Close Window |
At the regional cluster only, this page appears when you pull DHCP client-classes on the Select Replica DHCP Client-Class Data to Pull page. It shows the changes to be made with the pull operation. Click Run, or Cancel to cancel the operation.
Top of Page | Top of Section | Close Window |
At the regional cluster only, this page appears when you click Run on the Report Pull Replica Client-Class page. After looking at the report data, click Run to complete the pull operation.
Top of Page | Top of Section | Close Window |
At the local cluster only, when you create a scope in the Web UI, this creates a network based on the subnet and mask you specified for the scope. Scopes can have overlapping networks, so it is often convenient to show the networks and the scopes associated with them. The Web UI does this on the List Networks page.
This page shows the created networks. Each network has a name that is derived from its subnet and mask, in a hyphenated form, such as 192.168.500-24. You can expand each network to list the scopes associated with it. You can globally expand or collapse all the networks by clicking the Collapse All and Expand All links.
The Subnet column lists the subnet and mask, the Type column identifies whether the item is a network or a subsidiary scope, and the Selection Tags column identifies any scope selection tags associated with the scope or subnet.
On this page, you can also click a network's name to edit it, and you can edit a scope. You cannot add networks on this page; you need to create them by creating scopes.
Top of Page | Previous Section | Close Window |
At the local cluster only, you can edit the network name from what is automatically generated by the subnet and mask for the scope definition, unless you are a read-only administrator. You cannot modify the subnet for the network. When you finish editing the name, click Modify Network, or Cancel to cancel.
Top of Page | Top of Section | Close Window |
At the local cluster only, this page displays DHCP failover server pairs. From this page, you can edit, synchronize, run a report before a synchronization, and manage the servers. The server pairs are listed by a name constructed of the main and backup servers' IP addresses.
Note that failover pairs show up in this list only if they are set up using the server or scope failover attributes when editing the server attributes, or creating or editing a scope. Be sure to set at least the following on the Edit DHCP Server or Edit DHCP Scope page, then reload the DHCP server:
On the local cluster, the name of the failover pair is a hyphenation of the main and backup server IP addresses. On the regional cluster, you can name the failover pair any unique string.
Top of Page | Previous Section | Close Window |
When you click a failover pair's name on the List DHCP Failover Pair page at the local cluster, you can change some of the failover pair's attributes on the Edit DHCP Failover Pair page (in read-only mode, the View DHCP Failover page). These include its name and the failover attributes. You cannot modify the main or backup servers on this page.
The optional attributes appear at the bottom of the page. For a description of each attribute, click the attribute name to open a help window.
Top of Page | Top of Section | Close Window |
When you click the Run icon () in the Synchronize column of the List DHCP Failover Pairs page, the Run Synchronize Failover Pair page shows the list of properties on the two servers that should be synchronized.
When you click the Report icon () in the Report column of the List DHCP Failover Pairs page, the Report Synchronize Failover Pair page lets you run a report on what kind of properties need to be synchronized.
There are three basic operations you can perform:
NOTE: Do not run the Exact operation when setting up a back office failover configuration, to prevent removing the union of properties between the two main servers and the backup server.
These operations perform different functions on each of the failover properties, as listed in the table on the Report Synchronize Failover Pair page. There are essentially four functions:
On this page:
You return to the List DHCP Failover Pairs page. Click the Refresh icon () on that page to refresh the database.
Top of Page | Top of Section | Close Window |
When you click Run or Report on the Run (or Report) Synchronize Failover Pair page, this shows the change sets for the implemented changes to the failover pair based on the synchronization operation. You can show or hide the synchronization details by clicking Show Detail or Hide Detail, respectively.
Return to listing the failover pairs by clicking Return to Failover Pair List.
Top of Page | Top of Section | Close Window |
The following table describes the DHCP attributes affected by an Update synchronization of the server pairs. For a description of each attribute, click its name on the Edit DHCP Server page.
Attribute Value Replaced by Update Synchronization |
append-user-class-id-to-selection-tag |
client-class |
client-class-lookup-id |
defer-lease-extensions |
dynamic-dns-fwd-key |
dynamic-dns-rev-key |
dynamic-dns-tsig |
failover |
failover-backup-percentage |
failover-backup-server |
failover-dynamic-bootp-backup-percentage |
failover-lease-period-factor |
failover-main-server |
failover-recover |
failover-safe-period |
failover-use-safe-period |
force-dns-updates |
map-user-class-id |
skip-client-lookup |
upgrade-unavailable-timeout |
use-ldap-client-data |
validate-client-name-as-mac |
Top of Page | Top of Section | Close Window |
When you click the View icon () in the Manage Servers column of the List DHCP Failover Pair page, you can manage the failover servers as if you were managing the local DHCP server. This includes viewing each of the servers' states, health, statistics, logs; and starting, stopping, and reloading the server. The following table describes each column and possible function.
Column | Description |
Server | Main and Backup. |
IP Address | IP address of each server. |
State | State of the DHCP server, which can be initialized, running, or disabled. If the Web UI cannot determine the state, ? appears. |
Health | Relative health of the DHCP server, as a color indicator:
If the Web UI cannot determine the server's health, ? appears. Note that the server is healthy only if at least one scope of addresses exists. |
Statistics | Click the Statistics icon (![]() ![]() |
View Log | Click the Log icon (![]() ![]() |
Start/Stop/Reload | Click the:
If any of these functions is unsuccessful, a red X appears in the column. |
Top of Page | Top of Section | Close Window |
Unless you are a read-only administrator, you can manage the DHCP server, including viewing its health, statistics; starting, stopping, and reloading it; and editing its attributes.
Column | Description |
Name | Description (if local) or name (if remote) of the DHCP server. Clicking the Related Servers icon (![]() |
State | State of the DHCP server, which can be initialized, running, or disabled. If the Web UI cannot determine the state, ? appears. |
Health | Relative health of the DHCP server, as a color indicator:
If the Web UI cannot determine the server's health, ? appears. Note that the server is healthy only if at least one scope of addresses exists. |
Statistics | Click the Statistics icon (![]() ![]() |
View Log | Click the Log icon (![]() ![]() |
Start/Stop/Reload | Click the:
If any of these functions is unsuccessful, a red X appears in the column. |
To edit the DHCP server attributes, click the name of the server. This opens the Edit DHCP Server page.
Refresh the list of server from time to time. The page indicates when it was last refreshed. To move from this page, click any other Navigation bar choice.
Top of Page | Previous Section | Close Window |
To edit the DHCP server at the local cluster, click the server name on the Manage DHCP Server page. Unless you are a read-only administrator, you can edit DHCP server attributes, which are listed in categories and have their assigned defaults, if any.
For a description of each server attribute, click the attribute name on the page to open a help window.
Top of Page | Top of Section | Close Window |
This page appears if you click the Related Servers icon () on the local cluster's Manage DHCP Server and List DHCP Failover Pairs pages, and the regional cluster's View Tree of Server Clusters and List Failover Pairs pages. It shows any related failover partners, and DNS and LDAP servers.
The columns on this page are:
Column | Description |
Related Server Type | DHCP, DNS, or LDAP. |
Related Server Address | IP address of the related server. For DHCP failover partners, click this link to open the View Failover Related Server page. |
Communications | State of the communication -- None, OK, or Interrupted. |
Requests | For DNS or LDAP related servers only, the number of requests from these servers. |
State | For DHCP failover only, the server's state -- None, Startup, Normal, Communications-interrupted, Partner-down, Potential-conflict, Recover, Paused, Shutdown, or Recover-done. |
Partner Role | For DHCP failover only, the failover role of the partner -- Main or Backup. |
Partner State | For DHCP failover only, the partner's state -- None, Startup, Normal, Communications-interrupted, Partner-down, Potential-conflict, Recover, Paused, Shutdown, or Recover-done. |
Update Response Complete | For DHCP failover only, the percentage of completed update responses, valid only if there are outstanding update responses. |
Top of Page | Top of Section | Close Window |
This page appears if you click the address of the related DHCP failover server on the List Related Servers for DHCP Server page. It shows read-only detailed attribute values for the failover partner.
For the specifics about each attribute, click its name to open a popup help window.
If the partner is in the Communications-interrupted failover state, you can click Set Partner Down in association with an input field for the partner-down date setting. This setting is initialized to the value of the start-of-communications-interrupted attribute. In Normal Web UI mode, you cannot set this date to be an earlier value than the initialized date. In Expert Web UI mode, you can set this value to any date. After clicking Set Partner Down, you return to the List Related Servers for DHCP Server page to view the result of the partner-down action.
To refresh the data, click Refresh Data. To return to the List Related Servers for DHCP Server page, click OK.
Top of Page | Related Section | Close Window |