com.cisco.provisioning.cpe.constants
Interface DeviceDetailsKeys

public interface DeviceDetailsKeys

The DeviceDetailsKeys interface specifies constant strings that are used as keys in Map objects returned by query methods on IP devices.

See Also:

IPDevice.getDetails(DeviceID, List)

Field Summary

static String	ACCESS Selected type of access for the queried device.
static String	CLASS_OF_SERVICE Class of Service for the queried device.
static String	CLASS_OF_SERVICE_SELECTED Selected Class of Service for the queried device.
static String	CLIENT_CLASS DHCP Criteria for the queried device.
static String	DEVICE_TYPE Device type for the queried device.
static String	DHCP_CRITERIA DHCP Criteria for the queried device.
static String	DHCP_CRITERIA_SELECTED Selected DHCP Criteria for the queried device.
static String	DISCOVERED_DATA_DHCPV4 IPv4 DHCP discovered data.
static String	DISCOVERED_DATA_DHCPV6 IPv6 DHCP discovered data.
static String	DISCOVERED_DATA_RAW_DHCPV4 IPv4 DHCP discovered data in raw ASCII HEX form.
static String	DISCOVERED_DATA_RAW_DHCPV6 IPv6 DHCP discovered data in raw ASCII HEX form.
static String	DOCSIS_VERSION DOCSIS Version for the queried device.
static String	DOMAIN Domain name for the queried device DataType of associated value is String.
static String	DUID DUID for the queried device.
static String	EXPLANATION Explanation for selecting the access granted for the queried device.
static String	FQDN FQDN (fully qualified domain name) for the queried device.
static String	HOST Host name for the queried device DataType of associated value is String.
static String	IS_BEHIND_REQUIRED_DEVICE A value of true indicates the device has booted and is behind its required relay agent, or no required relay agent was specified.
static String	IS_IN_REQUIRED_PROV_GROUP A value of true indicates the device has booted and is in its required provisioning group, or no required provisioning group was specified.
static String	IS_PROVISIONED Provisioned state for this device.
static String	IS_REGISTERED Registered state for this device.
static String	LEASE_QUERY_DATA_DHCPV4 DHCP IPv4 lease data.
static String	LEASE_QUERY_DATA_DHCPV6 DHCP IPv6 lease data.
static String	MAC_ADDRESS MAC Address for the queried device.
static String	NODE_DETAILS Node membership information for the selected device.
static String	OWNER_ID Owner ID for the queried device.
static String	PROPERTIES Properties for the queried device.
static String	PROPERTIES_DETECTED Detected properties for the queried device.
static String	PROPERTIES_SELECTED Selected properties for the queried device.
static String	PROV_GROUP Prov group for the queried device.
static String	REASON Reason for selecting the access granted for the queried device.
static String	RELAY_AGENT_DUID Device this device is behind as determined by device detection.
static String	RELAY_AGENT_MAC Device this device is behind as determined by device detection.

Field Detail

DEVICE_TYPE

static final String DEVICE_TYPE

Device type for the queried device.

DataType of associated value is DeviceTypeValues.

See Also:

DeviceTypeValues, Constant Field Values

OWNER_ID

static final String OWNER_ID

Owner ID for the queried device.

DataType of associated value is String.

See Also:

Constant Field Values

PROPERTIES

static final String PROPERTIES

Properties for the queried device. Value is embedded map of properties.

DataType of associated value is Map.

See Also:

Constant Field Values

NODE_DETAILS

static final String NODE_DETAILS

Node membership information for the selected device. Value is List of Node objects representing the nodes to which this device is related to.

DataType of associated value is List.

See Also:

Constant Field Values

MAC_ADDRESS

static final String MAC_ADDRESS

MAC Address for the queried device.

DataType of associated value is String.

See Also:

Constant Field Values

DUID

static final String DUID

DUID for the queried device.

DataType of associated value is String.

See Also:

Constant Field Values

FQDN

static final String FQDN

FQDN (fully qualified domain name) for the queried device.

DataType of associated value is String.

See Also:

Constant Field Values

HOST

static final String HOST

Host name for the queried device

DataType of associated value is String.

See Also:

Constant Field Values

DOMAIN

static final String DOMAIN

Domain name for the queried device

DataType of associated value is String.

See Also:

Constant Field Values

DOCSIS_VERSION

static final String DOCSIS_VERSION

DOCSIS Version for the queried device.

DataType of associated value is String.

See Also:

Constant Field Values

RELAY_AGENT_MAC

static final String RELAY_AGENT_MAC

Device this device is behind as determined by device detection. The value of this property is a MAC address.

DataType of associated value is String.

See Also:

Constant Field Values

RELAY_AGENT_DUID

static final String RELAY_AGENT_DUID

Device this device is behind as determined by device detection. The value of this property is a DUID address.

DataType of associated value is String.

See Also:

Constant Field Values

PROPERTIES_DETECTED

static final String PROPERTIES_DETECTED

Detected properties for the queried device. This feature allows custom device detection extensions to store information about the detected device that could then be used by custom selection and generation extensions. The default built-in device detection extension does not set any properties.

The value is a map containing properties set on the device by the device detection extension.

DataType of associated value is Map.

See Also:

Constant Field Values

IS_BEHIND_REQUIRED_DEVICE

static final String IS_BEHIND_REQUIRED_DEVICE

A value of true indicates the device has booted and is behind its required relay agent, or no required relay agent was specified. A value of false indicates the device has not booted, or the device has booted, a required relay agent was specified, and the device was not behind the required relay agent.

DataType of associated value is Boolean.

See Also:

IPDeviceKeys.MUST_BE_BEHIND_DEVICE, Constant Field Values

IS_IN_REQUIRED_PROV_GROUP

static final String IS_IN_REQUIRED_PROV_GROUP

A value of true indicates the device has booted and is in its required provisioning group, or no required provisioning group was specified. A value of false indicates the device has not booted, or the device has booted, a required provisioning group was specified, and the device was not in the required provisioning group.

DataType of associated value is Boolean.

See Also:

IPDeviceKeys.MUST_BE_IN_PROV_GROUP, Constant Field Values

IS_REGISTERED

static final String IS_REGISTERED

Registered state for this device. A value of false indicates an unregistered device. A value of true indicates a registered device.

A device is registered if it has been added to the system via the provisioning API.

DataType of associated value is Boolean.

See Also:

Constant Field Values

IS_PROVISIONED

static final String IS_PROVISIONED

Provisioned state for this device. A value of false indicates an unprovisioned device. A value of true indicates a provisioned device.

A device is provisioned if it is registered and has booted and obtained its configuration from BPR.

DataType of associated value is Boolean.

See Also:

Constant Field Values

DHCP_CRITERIA

static final String DHCP_CRITERIA

DHCP Criteria for the queried device.

DataType of associated value is String.

See Also:

Constant Field Values

CLIENT_CLASS

static final String CLIENT_CLASS

DHCP Criteria for the queried device. This is the same as DHCP_CRITERIA and is provided for backward compatibility with DPR.

DataType of associated value is String.

See Also:

Constant Field Values

PROV_GROUP

static final String PROV_GROUP

Prov group for the queried device.

DataType of associated value is String.

See Also:

Constant Field Values

CLASS_OF_SERVICE

static final String CLASS_OF_SERVICE

Class of Service for the queried device.

DataType of associated value is String.

See Also:

Constant Field Values

ACCESS

static final String ACCESS

Selected type of access for the queried device.

DataType of associated value is String.

See Also:

Constant Field Values

CLASS_OF_SERVICE_SELECTED

static final String CLASS_OF_SERVICE_SELECTED

Selected Class of Service for the queried device.

This is the Class of Service that was selected by the service level selection extension during configuration generation.

DataType of associated value is String.

See Also:

Constant Field Values

DHCP_CRITERIA_SELECTED

static final String DHCP_CRITERIA_SELECTED

Selected DHCP Criteria for the queried device.

This is the Class of Service that was selected by the service level selection extension during configuration generation.

DataType of associated value is String.

See Also:

Constant Field Values

EXPLANATION

static final String EXPLANATION

Explanation for selecting the access granted for the queried device.

This is the explanation returned by the service level selection extension during configuration generation for selecting the access (default, registered, promiscuous) granted to the device.

DataType of associated value is String.

See Also:

Constant Field Values

PROPERTIES_SELECTED

static final String PROPERTIES_SELECTED

Selected properties for the queried device.

The value is a map containing properties set on the device by the service level selection extension.

DataType of associated value is Map.

See Also:

Constant Field Values

REASON

static final String REASON

Reason for selecting the access granted for the queried device.

DataType of associated value is String.

See Also:

Constant Field Values

LEASE_QUERY_DATA_DHCPV4

static final String LEASE_QUERY_DATA_DHCPV4

DHCP IPv4 lease data.

DataType of associated value is Map.

See Also:

Constant Field Values

LEASE_QUERY_DATA_DHCPV6

static final String LEASE_QUERY_DATA_DHCPV6

DHCP IPv6 lease data.

DataType of associated value is Map.

See Also:

Constant Field Values

DISCOVERED_DATA_DHCPV4

static final String DISCOVERED_DATA_DHCPV4

IPv4 DHCP discovered data.

DataType of associated value is Map.

See Also:

Constant Field Values

DISCOVERED_DATA_DHCPV6

static final String DISCOVERED_DATA_DHCPV6

IPv6 DHCP discovered data.

DataType of associated value is Map.

See Also:

Constant Field Values

DISCOVERED_DATA_RAW_DHCPV4

static final String DISCOVERED_DATA_RAW_DHCPV4

IPv4 DHCP discovered data in raw ASCII HEX form.

DataType of associated value is Map.

See Also:

Constant Field Values

DISCOVERED_DATA_RAW_DHCPV6

static final String DISCOVERED_DATA_RAW_DHCPV6

IPv6 DHCP discovered data in raw ASCII HEX form.

DataType of associated value is Map.

See Also:

Constant Field Values