.. _example_service_dhcp-server_options_custom-options:

##############
Custom-Options
##############

These scenarios test custom DHCP options and vendor-encapsulated-options.
Custom options allow administrators to define non-standard DHCP options
for vendor-specific configurations or custom network requirements.

Custom options can use:
- Hex data: Raw hexadecimal values
- ASCII data: Text strings
- IP addresses: IPv4 address lists

Vendor-encapsulated-options (Option 43) allow vendor-specific data
to be sent to clients, commonly used for IP phones, wireless controllers,
and other specialized network equipment.
Verification is done via the client extended-detail command to confirm
the options are received and stored in monitoring-db.

***************************
Test Custom Option Hex Data
***************************

Description
===========

This scenario tests custom DHCP options with hexadecimal data.
Custom options use option codes 224-254 (private use range).
Hexadecimal data is specified as colon-separated octets (e.g., 0a:0b:0c:0d).
This is commonly used for vendor-specific binary configuration data.
Verification is done via extended-detail to confirm the client receives and stores the option.

Scenario
========

.. include:: custom-options/testcustomoptionhexdata

.. raw:: html

  <hr>

*****************************
Test Custom Option ASCII Data
*****************************

Description
===========

This scenario tests custom DHCP options with ASCII string data.
ASCII data is sent as text strings, automatically converted to hex
by the DHCP server. This is useful for sending human-readable
configuration strings like model numbers, firmware versions, or
vendor-specific text parameters.
Verification is done via extended-detail to confirm the client receives and stores the option.

Scenario
========

.. include:: custom-options/testcustomoptionasciidata

.. raw:: html

  <hr>

*****************************
Test Custom Option IP Address
*****************************

Description
===========

This scenario tests custom DHCP options with IP address data.
IP address options allow sending lists of IPv4 addresses for
custom services or endpoints. Common uses include proprietary
management servers, backup servers, or vendor-specific service IPs.
Multiple IP addresses can be configured for redundancy.
Verification is done via extended-detail to confirm the client receives and stores the option.

Scenario
========

.. include:: custom-options/testcustomoptionipaddress

.. raw:: html

  <hr>

************************************
Test Vendor Encapsulated Options Hex
************************************

Description
===========

This scenario tests vendor-encapsulated-options (DHCP Option 43) with hex data.
Option 43 is reserved for vendor-specific information and is commonly used by:
- Cisco IP phones for TFTP server discovery
- Aruba wireless controllers for AP provisioning
- Microsoft WSUS servers for client configuration
Hex data format allows sending binary vendor-specific payloads.
Verification is done via extended-detail to confirm the client receives and stores the option.

Scenario
========

.. include:: custom-options/testvendorencapsulatedoptionshex

.. raw:: html

  <hr>

**************************************
Test Vendor Encapsulated Options ASCII
**************************************

Description
===========

This scenario tests vendor-encapsulated-options with ASCII data.
ASCII format is convenient when the vendor option contains text data
like device identifiers, model names, or configuration strings.
The DHCP server automatically converts ASCII to the hex format required
by Option 43.
Verification is done via extended-detail to confirm the client receives and stores the option.

Scenario
========

.. include:: custom-options/testvendorencapsulatedoptionsascii

.. raw:: html

  <hr>