DHCPSpecialValue (BACC Extension API Documentation )

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | ENUM CONSTANTS | FIELD | METHOD

DETAIL: ENUM CONSTANTS | FIELD | METHOD

com.cisco.provisioning.cpe.extensions.configuration
Enum DHCPSpecialValue

java.lang.Object
  java.lang.Enum<DHCPSpecialValue>
      com.cisco.provisioning.cpe.extensions.configuration.DHCPSpecialValue

All Implemented Interfaces:: Serializable, Comparable<DHCPSpecialValue>

public enum DHCPSpecialValue
extends Enum<DHCPSpecialValue>
extends Enum<DHCPSpecialValue>

Enumerated type for specifying DHCPConfig special values including values for mixing in the IP address of the DPE.

Enum Constant Summary
`BLOB_BPR_PROPERTY` DHCPConfig special value: mix in a BPR property value as a null terminated, colon delimited hex string (CNR blob format).
`BLOB_BPR_PROPERTY_OPTIONAL` DHCPConfig special value: optionally mix in a BPR property value.
`BLOB_DPE_FQDN` DHCPConfig special value: mix in the FQDN of the DPE encoded as a hex string (CNR blob format).
`BLOB_DPE_FQDN_DNS` DHCPConfig special value: mix in the FQDN of the DPE in DNS format (RFC 1035) encoded as a hex string (CNR blob format).
`BLOB_DPE_FQDN_PREFIXED_DNS` DHCPConfig special value: mix in the FQDN of the DPE in prefixed DNS format (RFC 3495) encoded as a hex string (CNR blob format).
`BLOB_DPE_IP_ADDRESS_BIN` DHCPConfig special value: mix in IP address of DPE in binary byte format encoded as a hex string (CNR blob format).
`BLOB_DPE_IP_ADDRESS_DOTTED_DECIMAL` DHCPConfig special value: mix in IP address of DPE in dotted decimal format encoded as a hex string (CNR blob format).
`BYTES_BPR_PROPERTY` DHCPConfig special value: mix in a BPR property value as binary bytes.
`BYTES_BPR_PROPERTY_DNS` DHCPConfig special value: mix in a BPR property value as binary bytes in DNS format (RFC 1035).
`BYTES_BPR_PROPERTY_IP_ADDRESS_BIN` DHCPConfig special value: mix in a BPR property value as binary bytes after interpreting the value as an IPv4 address and converting the address to bytes in network order.
`BYTES_BPR_PROPERTY_OPTIONAL` DHCPConfig special value: optionally mix in a BPR property value.
`BYTES_BPR_PROPERTY_OPTIONAL_DNS` DHCPConfig special value: optionally mix in a BPR property value as binary bytes in DNS format (RFC 1035).
`BYTES_BPR_PROPERTY_OPTIONAL_IP_ADDRESS_BIN` DHCPConfig special value: optionally mix in a BPR property value as binary bytes after interpreting the value as an IPv4 address and converting the address to bytes in network order.
`BYTES_BPR_PROPERTY_OPTIONAL_UNSIGNED_INTEGER_BIN` DHCPConfig special value: mix in a BPR property value as binary bytes after interpreting the value as an unsigned integer and converting the value to bytes in network order.
`BYTES_BPR_PROPERTY_UNSIGNED_INTEGER_BIN` DHCPConfig special value: mix in a BPR property value as binary bytes after interpreting the value as an unsigned integer and converting the value to bytes in network order.
`BYTES_DEVICE_IP_ADDRESS_BIN` DHCPConfig special value: device IP address in binary byte format.
`BYTES_DPE_FQDN` DHCPConfig special value: mix in the FQDN of the DPE as bytes.
`BYTES_DPE_FQDN_DNS` DHCPConfig special value: mix in the FQDN of the DPE in DNS format (RFC 1035) as bytes.
`BYTES_DPE_FQDN_PREFIXED_DNS` DHCPConfig special value: mix in the FQDN of the DPE in prefixed DNS format (RFC 3495) as bytes.
`BYTES_DPE_IP_ADDRESS_BIN` DHCPConfig special value: mix in IP address of DPE in binary byte format.
`BYTES_DPE_IP_ADDRESS_DOTTED_DECIMAL` DHCPConfig special value: mix in IP address of DPE in dotted decimal format directly as bytes.
`BYTES_DPE_IPV6_ADDRESS_BIN` DHCPConfig special value: mix in IPv6 address of DPE in binary byte format.
`DPE_IP_ADDRESS` DHCPConfig special value: mix in IP address of DPE in dotted decimal format.
`RESERVED_0` Reserved for future use.
`STR_BPR_PROPERTY` DHCPConfig special value: mix in a BPR property value as a string.
`STR_BPR_PROPERTY_OPTIONAL` DHCPConfig special value: optionally mix in a BPR property value.
`STR_DPE_FQDN` DHCPConfig special value: mix in the FQDN of the DPE as a string.

Method Summary
`boolean`	`isAvailable(Capabilities capabilities)` Returns true if this DHCPSpecialValue is available in the given provisioning group.
`boolean`	`requiresSpecialParameter()` Returns true if this special option value requires a parameter.
`static DHCPSpecialValue`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static DHCPSpecialValue[]`	`values()` Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum
`compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf`

Methods inherited from class java.lang.Object
`getClass, notify, notifyAll, wait, wait, wait`

Enum Constant Detail

RESERVED_0

public static final DHCPSpecialValue RESERVED_0

Reserved for future use.

DPE_IP_ADDRESS

public static final DHCPSpecialValue DPE_IP_ADDRESS

DHCPConfig special value: mix in IP address of DPE in dotted decimal format. For example, "255.255.255.255".