|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
public interface IPDeviceKeys
The IPDeviceKeys interface specifies constant strings which are used as keys in properties Map objects for IP device provisioning interfaces.
IPDevice.add(com.cisco.provisioning.cpe.api.DeviceType, java.util.List, java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.util.Map) | Field Summary | |
|---|---|
static String |
DROP_IF_MAX_IA_ADDRESSES_EXCEEDED_ENABLE
This property specifies whether the default built-in configuration generation extension point will add a command in the DHCP configuration that drops the DHCPv6 ADVERTISE packet if the maximum number of DHCPv6 IA Address Options has been exceeded. |
static String |
IP_RESERVATION
This property is used to reserve a specific IP address for a device Note: There are some limitations in the lease reservation feature supported in this release. |
static String |
MAX_IA_ADDRESSES
This property specifies the maximum number of DHCPv6 IA Address Options that are permitted in the DHCPv6 ADVERTISE packet. |
static String |
MUST_BE_BEHIND_DEVICE
Set this property if the device should be kicked back to being unprovisioned if the device it is behind is not the one that is specified here. |
static String |
MUST_BE_BEHIND_DEVICE_AUTO_ENABLE
This property enables or disables automatic setting of the IPDeviceKeys.MUST_BE_BEHIND_DEVICE
property. |
static String |
MUST_BE_IN_PROV_GROUP
Set this property if the device should be kicked back to being unprovisioned if the provisioning group it is in is not the one that is specified here. |
static String |
NEW_PROVISIONING_GROUP
Reserved for future use. |
static String |
UNCOMMITTED_CONFIG_TIME_TO_LIVE
This property specifies the amount of time, in milliseconds, a DPE should hold on to a configuration file that has not been committed yet, for this device. |
static String |
USE_VALIDATE_CONTINUE_FOR_CABLELABS_SOFTWARE_VERSION_DHCPV4
This property specifies the validation command to be used for IPDeviceKeys.VALIDATE_CABLELABS_SOFTWARE_VERSION_DHCPV4.If set to
true, a validate continue command will be used and the
DHCP DISCOVER will not be dropped on a failed validation. |
static String |
USE_VALIDATE_CONTINUE_FOR_CABLELABS_SOFTWARE_VERSION_DHCPV6
This property specifies the validation command to be used for IPDeviceKeys.VALIDATE_CABLELABS_SOFTWARE_VERSION_DHCPV6. |
static String |
USE_VALIDATE_CONTINUE_FOR_DHCP_CLASS_IDENTIFIER
This property specifies the validation command to be used for IPDeviceKeys.VALIDATE_DHCP_CLASS_IDENTIFIER.If set to true,
a validate continue command will be used and the DHCP DISCOVER will
not be dropped on a failed validation. |
static String |
USE_VALIDATE_CONTINUE_FOR_DHCP_PARAMETER_REQUEST_LIST
This property specifies the validation command to be used for IPDeviceKeys.VALIDATE_DHCP_PARAMTER_REQUEST_LIST.If set to
true, a validate continue command will be used and the
DHCP DISCOVER will not be dropped on a failed validation. |
static String |
USE_VALIDATE_CONTINUE_FOR_VENDOR_CLASS
This property specifies the validation command to be used for IPDeviceKeys.VALIDATE_VENDOR_CLASS.If set to true,
a validate continue command will be used and the DHCP SOLICT will
not be dropped on a failed validation. |
static String |
VALIDATE_CABLELABS_SOFTWARE_VERSION_DHCPV4
This property specifies whether the default built-in configuration generation extension point will add a validation command in the DHCP configuration that is generated for the DHCPv4 Vendor Specific Options (option 43). |
static String |
VALIDATE_CABLELABS_SOFTWARE_VERSION_DHCPV6
This property specifies whether the default built-in configuration generation extension point will add a validation command in the DHCP configuration that is generated for the DHCPv6 Vendor Specific Option (option 17, sub-option 6). |
static String |
VALIDATE_DHCP_CLASS_IDENTIFIER
This property specifies whether the default common configuration generation extension point will add a validation command in the DHCP configuration that is generated for the dhcp class identifier (option 60). |
static String |
VALIDATE_DHCP_PARAMTER_REQUEST_LIST
This property specifies whether the default common configuration generation extension point will add a validation command in the DHCP configuration that is generated for the dhcp parameter request list (option 55). |
static String |
VALIDATE_VENDOR_CLASS
This property specifies whether the default built-in configuration generation extension point will add a validation command in the DHCP configuration that is generated for the DHCPv6 Vendor Class Option (option 16). |
| Field Detail |
|---|
static final String MUST_BE_BEHIND_DEVICE
IPDevice.changeDefaults.
This property is to be used if a device must be stopped from roaming from behind one device to another.
The value of this property is either a MAC address or DUID.
DataType of associated value is String.
static final String MUST_BE_BEHIND_DEVICE_AUTO_ENABLE
IPDeviceKeys.MUST_BE_BEHIND_DEVICE
property.
When processing a request from the CNR extensions to generate a device
configuration the RDU will create an entry in the database for the
device, if one does not already exist. If this property is set to
"enabled" then when creating an entry in response to a generation
request, the RDU will automatically set a value for the property
IPDeviceKeys.MUST_BE_BEHIND_DEVICE,
if the device is behind another device, and the MAC address of that
device can be determined (the relay agent remote ID has been supplied).
This property is set to "false" by default.
DataTypeof associated value is Boolean.
static final String MUST_BE_IN_PROV_GROUP
IPDevice.changeDefaults
This property is to be used if a device must be stopped from roaming from one provisioning group to another.
The value of this property is a provisioning group name.
DataType of associated value is String.
static final String UNCOMMITTED_CONFIG_TIME_TO_LIVE
If the batch ActivationMode is
ActivationMode.AUTOMATIC and the
ConfirmationMode is anything other than
ConfirmationMode.NO_CONFIRMATION, the value of this property should
allow enough time for the device to reboot and get its configuration from
the DPE.
If a device does not specify this property, the system default uncommited config time to live will be used.
DataType of associated value is Long.
static final String VALIDATE_DHCP_PARAMTER_REQUEST_LIST
The type of validation command used (validate or validate continue) will
depend on the value of IPDeviceKeys.USE_VALIDATE_CONTINUE_FOR_DHCP_PARAMETER_REQUEST_LIST.
The value of this property is a Boolean.
DataType of associated value is Boolean.
static final String VALIDATE_DHCP_CLASS_IDENTIFIER
The type of validation command used (validate or validate continue) will
depend on the value of
IPDeviceKeys.USE_VALIDATE_CONTINUE_FOR_DHCP_CLASS_IDENTIFIER.
The value of this property is a Boolean.
DataType of associated value is Boolean.
static final String VALIDATE_VENDOR_CLASS
The type of validation command used (validate or validate continue) will
depend on the value of
IPDeviceKeys.USE_VALIDATE_CONTINUE_FOR_VENDOR_CLASS.
The value of this property is a Boolean.
DataType of associated value is Boolean.
static final String VALIDATE_CABLELABS_SOFTWARE_VERSION_DHCPV4
The type of validation command used (validate or validate continue) will
depend on the value of
IPDeviceKeys.USE_VALIDATE_CONTINUE_FOR_CABLELABS_SOFTWARE_VERSION_DHCPV4.
The value of this property is a Boolean.
DataType of associated value is Boolean.
static final String VALIDATE_CABLELABS_SOFTWARE_VERSION_DHCPV6
The type of validation command used (validate or validate continue) will
depend on the value of
IPDeviceKeys.USE_VALIDATE_CONTINUE_FOR_CABLELABS_SOFTWARE_VERSION_DHCPV6.
The value of this property is a Boolean.
DataType of associated value is Boolean.
static final String USE_VALIDATE_CONTINUE_FOR_DHCP_PARAMETER_REQUEST_LIST
IPDeviceKeys.VALIDATE_DHCP_PARAMTER_REQUEST_LIST.If set to
true, a validate continue command will be used and the
DHCP DISCOVER will not be dropped on a failed validation. If set
to false, a validate command will be used which will drop
the DHCP DISCOVER on a failed validation.
The value of this property is a Boolean.
DataType of associated value is Boolean.
static final String USE_VALIDATE_CONTINUE_FOR_DHCP_CLASS_IDENTIFIER
IPDeviceKeys.VALIDATE_DHCP_CLASS_IDENTIFIER.If set to true,
a validate continue command will be used and the DHCP DISCOVER will
not be dropped on a failed validation. If set to
false, a validate command will be used which will drop
the DHCP DISCOVER on a failed validation.
The value of this property is a Boolean.
DataType of associated value is Boolean.
static final String USE_VALIDATE_CONTINUE_FOR_VENDOR_CLASS
IPDeviceKeys.VALIDATE_VENDOR_CLASS.If set to true,
a validate continue command will be used and the DHCP SOLICT will
not be dropped on a failed validation. If set to
false, a validate command will be used which will drop
the DHCP SOLICT on a failed validation.
The value of this property is a Boolean.
DataType of associated value is Boolean.
static final String USE_VALIDATE_CONTINUE_FOR_CABLELABS_SOFTWARE_VERSION_DHCPV4
IPDeviceKeys.VALIDATE_CABLELABS_SOFTWARE_VERSION_DHCPV4.If set to
true, a validate continue command will be used and the
DHCP DISCOVER will not be dropped on a failed validation. If set
to false, a validate command will be used which will drop
the DHCP DISCOVER on a failed validation.
The value of this property is a Boolean.
DataType of associated value is Boolean.
static final String USE_VALIDATE_CONTINUE_FOR_CABLELABS_SOFTWARE_VERSION_DHCPV6
IPDeviceKeys.VALIDATE_CABLELABS_SOFTWARE_VERSION_DHCPV6. If set to
true, a validate continue command will be used and the
DHCP SOLICT will not be dropped on a failed validation. If set to
false, a validate command will be used which will drop
the DHCP SOLICT on a failed validation.
The value of this property is a Boolean.
DataType of associated value is Boolean.
static final String DROP_IF_MAX_IA_ADDRESSES_EXCEEDED_ENABLE
The maximum number of IA Address Options will depend on the value of
IPDeviceKeys.MAX_IA_ADDRESSES.
The value of this property is a Boolean.
DataType of associated value is Boolean.
static final String MAX_IA_ADDRESSES
true:
IPDeviceKeys.DROP_IF_MAX_IA_ADDRESSES_EXCEEDED_ENABLE.
The value of this property is a Integer.
DataType of associated value is Integer.
static final String IP_RESERVATION
Note: There are some limitations in the lease reservation feature supported in this release. They are:
The ability to retry add or remove reservation operation when an error is encountered is not supported in this release
The use of selection-criteria exclusion tags is not allowed when adding a IP reservation. Selection-criteria exclusion tags will not be considered during IP reservation.
When performing an IP reservation, with the devices' DHCPCriteria, either of the client-class or the selectiontag will be taken into consideration by the system for CNR IP Reservation SDK-API In case both the arguments are available in the Device's DHCPCriteria then the clientclass will precede the selection tag for CNR IP Reservation request.
The value of this property is a IP address string.
DataType of associated value is String.
static final String NEW_PROVISIONING_GROUP
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||