Working With DHCP Macros (Task Map)

DHCP macros are containers of DHCP options. The Solaris DHCP service uses macros to gather options that should be passed to clients. DHCP Manager and the dhcpconfig utility create a number of macros automatically when you configure the server. See About DHCP Macros for background information about macros. See Chapter 14, Configuring the DHCP Service (Tasks) for information about macros created by default.

You might find that when changes occur on your network, you need to make changes to the configuration information that is passed to clients. To change configuration information, you need to work with DHCP macros. You can view, create, modify, duplicate, and delete DHCP macros.

When you work with macros, you must know about DHCP standard options, which are described in the dhcp_inittab(4) man page.

The following task map lists tasks to help you view, create, modify, and delete DHCP macros.

Task	Description	For Instructions
View DHCP macros.	Display a list of all the macros that are defined on the DHCP server.	How to View Macros Defined on a DHCP Server (DHCP Manager) How to View Macros Defined on a DHCP Server (dhtadm)
Create DHCP macros.	Create new macros to support DHCP clients.	How to Create a DHCP Macro (DHCP Manager) How to Create a DHCP Macro (dhtadm)
Modify values that are passed in macros to DHCP clients.	Change macros by modifying existing options, adding options to macros, or removing options from macros.	How to Change Values for Options in a DHCP Macro (DHCP Manager) How to Change Values for Options in a DHCP Macro (dhtadm) How to Add Options to a DHCP Macro (DHCP Manager) How to Add Options to a DHCP Macro (dhtadm) How to Delete Options From a DHCP Macro (DHCP Manager) How to Delete Options From a DHCP Macro (dhtadm)
Delete DHCP macros.	Remove DHCP macros that are no longer used.	How to Delete a DHCP Macro (DHCP Manager) How to Delete a DHCP Macro (dhtadm)

The following figure shows the Macros tab in the DHCP Manager window.

Figure 15-14 DHCP Manager's Macros Tab

How to View Macros Defined on a DHCP Server (DHCP Manager)

1. In DHCP Manager, select the Macros tab.

   See How to Start and Stop DHCP Manager for information about DHCP Manager.

   The Macros area on the left side of the window displays, in alphabetical order, all the macros defined on the DHCP server. Macros preceded by a folder icon include references to other macros, whereas macros preceded by a document icon do not reference other macros.

2. To open a macro folder, click the handle icon to the left of the folder icon.

   The macros that are included in the selected macro are listed.

3. To view the content of a macro, click the macro name.

   Options and their assigned values are displayed.

How to View Macros Defined on a DHCP Server (dhtadm)

1. Become superuser or assume a role or user name that is assigned to the DHCP Management profile.

   For more information about the DHCP Management profile, see Setting Up User Access to DHCP Commands.

   Roles contain authorizations and privileged commands. For more information about roles, see Configuring RBAC (Task Map) in System Administration Guide: Security Services.

2. Display the macros by typing the following command:

   # dhtadm -P

   This command prints to standard output the formatted contents of the dhcptab table, including all macros and symbols defined on the DHCP server.

Modifying DHCP Macros

You might need to modify macros when some aspect of your network changes and one or more DHCP clients need to know about the change. For example, you might add a router or an NIS server, create a new subnet, or change the lease policy.

Before you modify a macro, determine the name of the DHCP option you want to change, add, or delete. The standard DHCP options are listed in the DHCP Manager help and in the dhcp_inittab(4) man page.

You can use the dhtadm -M -m command or DHCP Manager to modify macros. See the dhtadm(1M) man page for more information about dhtadm.

The following figure shows DHCP Manager's Macro Properties dialog box.

Figure 15-15 Macro Properties Dialog Box in DHCP Manager

How to Change Values for Options in a DHCP Macro (DHCP Manager)

1. In DHCP Manager, select the Macros tab.

   See How to Start and Stop DHCP Manager for information about DHCP Manager.

2. Select the macro that you want to change.
3. Choose Properties from the Edit menu.

   The Macro Properties dialog box opens.

4. In the table of Options, select the option that you want to change.

   The option's name and its value are displayed in the Option Name and Option Value fields.

5. In the Option Value field, select the old value and type the new value for the option.
6. Click Modify.

   The new value is displayed in the options table.

7. Select Notify DHCP Server of Change.

   This selection tells the DHCP server to reread the dhcptab table to put the change into effect immediately after you click OK.

8. Click OK.

How to Change Values for Options in a DHCP Macro (dhtadm)

1. Become superuser or assume a role or user name that is assigned to the DHCP Management profile.

   For more information about the DHCP Management profile, see Setting Up User Access to DHCP Commands.

   Roles contain authorizations and privileged commands. For more information about roles, see Configuring RBAC (Task Map) in System Administration Guide: Security Services.

2. Change option values by typing a command of the following format:

   # dhtadm -M -m macroname -e 'option=value:option=value' -g

   For example, to change the lease time and the Universal Time Offset in the macro bluenote, you would type:

   # dhtadm -M -m bluenote -e 'LeaseTim=43200:UTCOffst=28800' -g

How to Add Options to a DHCP Macro (DHCP Manager)

1. In DHCP Manager, select the Macros tab.

   See How to Start and Stop DHCP Manager for information about DHCP Manager.

2. Select the macro that you want to change.
3. Choose Properties from the Edit menu.

   The Macro Properties dialog box opens.

4. In the Option Name field, specify the name of an option by using one of the following methods:
   • Click the Select button next to the Option Name field to select an option to add to the macro.

     The Select Option dialog box displays an alphabetized list of names of standard category options and descriptions. If you want to add an option that is not in the standard category, use the Category list to select a category.

     See About DHCP Macros for more information about macro categories.

   • Type Include if you want to include a reference to an existing macro in the new macro.
5. Type the value for the option in the Option Value field.

   If you typed Include as the option name, you must specify the name of an existing macro in the Option Value field.

6. Click Add.

   The option is added to the bottom of the list of options in this macro. To change the option's position in the macro, select the option and click the arrow buttons to move the option up or down in the list.

7. Select Notify DHCP Server of Change.

   This selection tells the DHCP server to reread the dhcptab table to put the change into effect immediately after you click OK.

8. Click OK.

How to Add Options to a DHCP Macro (dhtadm)

1. Become superuser or assume a role or user name that is assigned to the DHCP Management profile.

   For more information about the DHCP Management profile, see Setting Up User Access to DHCP Commands.

   Roles contain authorizations and privileged commands. For more information about roles, see Configuring RBAC (Task Map) in System Administration Guide: Security Services.

2. Add options to a macro by typing a command of the following format:

   # dhtadm -M -m macroname -e 'option=value' -g

   For example, to add the ability to negotiate leases in the macro bluenote, you would type the following command:

   # dhtadm -M -m bluenote -e 'LeaseNeg=_NULL_VALUE' -g

   Note that if an option does not require a value, you must use _NULL_VALUE as the value for the option.

How to Delete Options From a DHCP Macro (DHCP Manager)

1. In DHCP Manager, select the Macros tab.

   See How to Start and Stop DHCP Manager for information about DHCP Manager.

2. Select the macro that you want to change.
3. Choose Properties from the Edit menu.

   The Macro Properties dialog box opens.

4. Select the option that you want to remove from the macro.
5. Click Delete.

   The option is removed from the list of options for this macro.

6. Select Notify DHCP Server of Change.

   This selection tells the DHCP server to reread the dhcptab table to put the change into effect immediately after you click OK.

7. Click OK.

How to Delete Options From a DHCP Macro (dhtadm)

1. Become superuser or assume a role or user name that is assigned to the DHCP Management profile.

   For more information about the DHCP Management profile, see Setting Up User Access to DHCP Commands.

   Roles contain authorizations and privileged commands. For more information about roles, see Configuring RBAC (Task Map) in System Administration Guide: Security Services.

2. Delete an option from a macro by typing a command of the following format:

   # dhtadm -M -m macroname -e 'option=' -g

   For example, to remove the ability to negotiate leases in the macro bluenote, you would type the following command:

   # dhtadm -M -m bluenote -e 'LeaseNeg=' -g

   If an option is specified with no value, the option is removed from the macro.

Creating DHCP Macros

You might want to add new macros to your DHCP service to support clients with specific needs. You can use the dhtadm -A -m command or DHCP Manager's Create Macro dialog box to add macros. See the dhtadm(1M) man page for more information about the dhtadm command.

The following figure shows DHCP Manager's Create Macro dialog box.

Figure 15-16 Create Macro Dialog Box in DHCP Manager

How to Create a DHCP Macro (DHCP Manager)

1. In DHCP Manager, select the Macros tab.

   See How to Start and Stop DHCP Manager for information about DHCP Manager.

2. Choose Create from the Edit menu.

   The Create Macro dialog box opens.

3. Type a unique name for the macro.

   The name can be up to 128 alphanumeric characters. If you use a name that matches a vendor class identifier, network address, or client ID, the macro is processed automatically for appropriate clients. If you use a different name, the macro is not processed automatically. The macro must be assigned to a specific IP address or included in another macro that is processed automatically. See Macro Processing by the DHCP Server for more detailed information.

4. Click the Select button, which is next to the Option Name field.

   The Select Option dialog box displays an alphabetized list of names of standard category options and their descriptions. If you want to add an option that is not in the standard category, use the Category list. Select the category that you want from the Category list. See About DHCP Options for more information about option categories.

5. Select the option to add to the macro, and click OK.

   The Macro Properties dialog box displays the selected option in the Option Name field.

6. Type the value for the option in the Option Value field, and click Add.

   The option is added to the bottom of the list of options in this macro. To change the option's position in the macro, select the option and click the arrow buttons to move the option up or down in the list.

7. Repeat Step 5 and Step 6 for each option you want to add to the macro.
8. Select Notify DHCP Server of Change when you are finished adding options.

   This selection tells the DHCP server to reread the dhcptab table to put the change into effect immediately after you click OK.

9. Click OK.

How to Create a DHCP Macro (dhtadm)

1. Become superuser or assume a role or user name that is assigned to the DHCP Management profile.

   For more information about the DHCP Management profile, see Setting Up User Access to DHCP Commands.

   Roles contain authorizations and privileged commands. For more information about roles, see Configuring RBAC (Task Map) in System Administration Guide: Security Services.

2. Create a macro by typing a command of the following format:

   # dhtadm -A -m macroname -d ':option=value:option=value:option=value:' -g

   There is no limit to the number of option=value pairs that can be included in the argument to -d. The argument must begin and end with colons, with colons between each option=value pair. The complete string must be enclosed in quotation marks.

   For example, to create the macro bluenote, type the following command:

   # dhtadm -A -m bluenote -d ':Router=10.63.6.121\ :LeaseNeg=_NULL_VALUE:DNSserv=10.63.28.12:' -g

   Note that if an option does not require a value, you must use _NULL_VALUE as the value for the option.

Deleting DHCP Macros

You might want to delete a macro from the DHCP service. For example, if you delete a network from the DHCP service, you can also delete the associated network macro.

You can use the dhtadm -D -m command or DHCP Manager to delete macros.

How to Delete a DHCP Macro (DHCP Manager)

1. In DHCP Manager, select the Macros tab.

   See How to Start and Stop DHCP Manager for information about DHCP Manager.

2. Select the macro to delete.

   The Delete Macro dialog box prompts you to confirm that you want to delete the specified macro.

3. Select Notify DHCP Server of Change.

   This selection tells the DHCP server to reread the dhcptab table to put the change into effect immediately after you click OK.

4. Click OK.

How to Delete a DHCP Macro (dhtadm)

1. Become superuser or assume a role or user name that is assigned to the DHCP Management profile.

   For more information about the DHCP Management profile, see Setting Up User Access to DHCP Commands.

   Roles contain authorizations and privileged commands. For more information about roles, see Configuring RBAC (Task Map) in System Administration Guide: Security Services.

2. Delete a macro by typing a command of the following format:

   # dhtadm -D -m macroname -g

   For example, to delete the macro bluenote, you would type the following command:

   # dhtadm -D -m bluenote -g