dhcpV4Properties
dhcpV4Properties - describe/view DHCP properties for an interface entry
SYNOPSIS
dhcpV4Properties sub-command options
DESCRIPTION
The dhcpV4Properties command is used in two contexts:
- When a new interfaceEntry is added to the interfaceTable, the values from this command are associated with the entry.
- When an existing interface is retrieved with interfaceTable get*Interface and the enableDhcp option in the interfaceEntry is true. The values associated with the interface entry are made available in this command.
Four standard DHCP options are set in the STANDARD OPTIONS below, others may be set as TLVs using dhcpV4Tlv and the addTlv sub-command.
STANDARD OPTIONS
clientId
The client identifier, which must be unique for the subnet that the interface is connected to. If this is not set, the MAC address of the protocol interface entry is used. (default = "")
renewTimer
The requested value for the renewal time, in seconds. The actual value used in the lower of this value and the release time set by the DHCP server. (default = 0)
relayAgentAddress
The IP address of the DHCPv4 relay agent. This is only valid for unconnected interfaces.
relayDestination
Address
The destination IP address for DHCPv4 relay messages. This is only valid for unconnected interfaces.
retryCount
The configurable retry count of the DHCP server. (default = 4)
serverId
If specified as a non-zero value, DHCP negotiation only occurs with a particular server. This entry should be specified as an IPv4 address. (default = 0.0.0.0)
vendorId
The vendor Id associated with the client. (default = "")
COMMANDS
The dhcpV4Properties command is invoked with the following sub-commands. If no sub-command is specified, returns a list of all sub-commands available.
dhcpV4Properties addTlv
The DHCP TLV specified in dhcpV4Tlv is added to this property set. Specific errors are:
- Invalid TLV parameters.
dhcpV4Properties cget option
Returns the current value of the configuration option given by option. Option may have any of the values accepted by the dhcpV4Properties command.
dhcpV4Properties config option value
Modify the configuration options of the dhcpV4Properties. If no option is specified, returns a list describing all of the available options (see STANDARD OPTIONS) for dhcpV4Properties.
dhcpV4Properties delTlv index
The TLV associated with this DHCP property set at the specified index is deleted. The index of the first entry is 1. The values are available in the dhcpV4Tlv command. Specific errors are:
- The index'd entry does not exist in the list.
- Invalid index.
dhcpV4Properties getFirstTlv
The first TLV associated with this DHCP property set is retrieved. The values are available in the dhcpV4Tlv command. Specific errors are:
- There are no entries in the list.
dhcpV4Properties getNextTlv
The next TLV associated with this DHCP property set is retrieved. The values are available in the dhcpV4Tlv command. Specific errors are:
- There are no more entries in the list.
dhcpV4Properties getTlv index
The TLV associated with this DHCP property set at the specified index is retrieved. The index of the first entry is 1. The values are available in the dhcpV4Tlv command. Specific errors are:
- The index'd entry does not exist in the list.
dhcpV4Properties removeAllTlvs
Deletes all of the TLVs associated with this DHCP property set.
dhcpV4Properties setDefault
Sets to IxTclHal default values for all configuration options.
EXAMPLES
See example under interfaceTable