Overview Package Class Deprecated Help

rtr
DhcpClient

DhcpClientAutoConfig represents information related to DHCP Client for a virtual router interface (network) in the system.Maximum instances allowed are 1 per interface.

public class DhcpClient

Stats:
rtr.DHCPClientStats

Properties
administrativeState

type=netw.AdministrativeState
default=tmnxOutOfService
Displayed(tab/group)=Client State
clientId

type=string
minimum=0
maximum=254
Displayed(tab/group)=Client ID
clientIdFormat

type=int
default=2
Displayed(tab/group)=Client ID Format
enums=
    2: ascii - ASCII
    3: hex - Hex
clientIdOrigin

type=int
default=0
Displayed(tab/group)=Client ID Origin
enums=
    0: useMac - Use MAC
    1: interface - Interface
    2: configured - Configured
clientOptions

type=rtr.DhcpClRequestOptions
default=none
Displayed(tab/group)=Client Request Options
description The value of description indicates the description of the status of this DHCP client

type=string
access=read-only
default=
Displayed(tab/group)=Client Description (/Status)
dhcpLeaseTime

type=long
default=86400
minimum=10
maximum=4294967295
units=seconds
Displayed(tab/group)=Lease Time
serviceId Service Id

type=long
access=read-only
state The value of state indicates the DHCP protocol state the DHCP client is in

type=int
access=read-only
default=0
Displayed(tab/group)=Client State (/Status)
enums=
    0: init - Init
    1: init_reboot - Init-Reboot
    2: rebooting - Rebooting
    3: selecting - Selecting
    4: requesting - Requesting
    5: rebinding - Rebinding
    6: bound - Bound
    7: renewing - Renewing
stateClientAddress The value of stateClientAddress indicates the client IP address.

type=InetAddress
access=read-only
default=0.0.0.0
Displayed(tab/group)=Client Address (/Status)
stateClientAddressMaskLen The value of stateClientAddressMaskLen indicates the length of the subnet mask for a DHCP lease, or the prefix length for a DHCPv6 lease

type=int
access=read-only
Displayed(tab/group)=Client Address Mask Length (/Status)
stateClientAddressType The value of stateClientAddressType indicates the address type of stateClientAddress

type=rtr.InetAddressType
access=read-only
default=ipv4
stateClientMacAddress The value of stateClientMacAddress indicates the MAC address of the client

type=MacAddress
access=read-only
default=00-00-00-00-00-00
Displayed(tab/group)=Client Address MAC Address (/Status)
stateDnsPrimaryAddress The value of stateDnsPrimaryAddress indicates the address of the primary DNS server.

type=InetAddress
access=read-only
default=0.0.0.0
Displayed(tab/group)=DNS Primary Address (/Status)
stateDnsPrimaryAddressType The value of stateDnsPrimaryAddressType indicates the address type of stateDnsPrimaryAddress

type=rtr.InetAddressType
access=read-only
default=ipv4
stateDnsSecondaryAddress The value of stateDnsSecondaryAddress indicates the address of the secondary DNS server

type=InetAddress
access=read-only
default=0.0.0.0
Displayed(tab/group)=DNS Secondary Address (/Status)
stateDnsSecondaryAddressType The value of stateDnsSecondaryAddressType indicates the address type of stateDnsSecondaryAddress

type=rtr.InetAddressType
access=read-only
default=ipv4
stateDnsTertiaryAddress The value of stateDnsTertiaryAddress indicates the address of the tertiary DNS server

type=InetAddress
access=read-only
default=0.0.0.0
Displayed(tab/group)=DNS Tertiary Address (/Status)
stateDnsTertiaryAddressType The value of stateDnsTertiaryAddressType indicates the address type of stateDnsTertiaryAddress

type=rtr.InetAddressType
access=read-only
default=ipv4
stateLeaseAcquired

type=string
access=read-only
Displayed(tab/group)=State Lease Acquired (/Status)
stateLeaseEnd

type=string
access=read-only
Displayed(tab/group)=State Lease End (/Status)
stateLeaseRebind

type=string
access=read-only
Displayed(tab/group)=State Lease Rebind (/Status)
stateLeaseRenew

type=string
access=read-only
Displayed(tab/group)=State Lease Renew (/Status)
stateRouterAddress The value of stateRouterAddress indicates the router IP address.

type=InetAddress
access=read-only
default=0.0.0.0
Displayed(tab/group)=Router Address (/Status)
stateRouterAddressType The value of stateRouterAddressType indicates the address type of stateRouterAddress.

type=rtr.InetAddressType
access=read-only
default=ipv4
stateServerAddress The value of stateServerAddress indicates Server Identifier

type=InetAddress
access=read-only
default=0.0.0.0
Displayed(tab/group)=Server Address (/Status)
stateServerAddressType The value of stateServerAddressType indicates the address type of stateServerAddress

type=rtr.InetAddressType
access=read-only
default=ipv4
stateStatus The value of stateStatus indicates the status of the DHCP client

type=int
access=read-only
default=0
Displayed(tab/group)=Client Status (/Status)
enums=
    0: disabled - Disabled
    1: initializing - Initializing
    2: requesting - Requesting
    3: lost - Lost
    4: established - Established
    5: failed - Failed
vendorClassId

type=string
minimum=0
maximum=254
Displayed(tab/group)=Vendor Class ID
vendorClassIdFormat

type=int
default=2
Displayed(tab/group)=Vendor Class ID Format
enums=
    2: ascii - ASCII
    3: hex - Hex
  
Properties inherited from rtr.VirtualInterfaceConfiguration
routerId, routerName, siteId, siteName, virtualInterfaceId, virtualInterfaceName
 
Properties inherited from ManagedObject
actionMask, children-Set, deploymentState, isFaultSquelched, name, objectFullName, selfAlarmed
 
Supported Network Elements
7705 SAR Hm Supported from 21.5.R1 until 22.2.R1
  • Excluded chassis types: 7705 SAR-Hmc
Supported from 22.2.R1