Overview Package Class Deprecated Help

rtr
GrpItfDhcpRelayCfg

GrpItfDhcpRelayCfg represents information related to DHCP Relay for a group interface (VPRN or IES) in the system.

public class GrpItfDhcpRelayCfg

Stats:
rtr.DhcpRelayStats

Properties
action

type=int
default=keep
Displayed(tab/group)=Action (/Option 82)
enums=
    1: replace - Replace
    2: drop - Drop
    3: keep - Keep
antiSpoofMacAddr The MAC address that is used in anti-spoof entries for the lease states on this interface.

type=MacAddress
default=00-00-00-00-00-00
Displayed(tab/group)=Anti-Spoof MAC Address (/General)
circuitId

type=rtr.DhcpRelayCircuitIdTypes
default=asciiTuple
Displayed(tab/group)=Circuit ID (/Option 82)

valid enums=asciiTuple, ifIndex, none, sapId, vlanAsciiTuple (Where parent is one of (service.GroupInterface))
dhcpFilterId This is the Value of DHCP filter ID.

type=int
default=0
minimum=0
maximum=65535
dhcpFilterPointer This is the DHCP filter Pointer.

type=Pointer
default=
Displayed(tab/group)=dhcpFilterPointer (/DHCP Filter)
l2header Defines if AntiSpoofMacAddress is used in anti-spoof entries for the lease states on this interface. When it is set to false, the client hardware address from the DHCP payload is used. When it is set to true, the behavior depends on the value of AntiSpoofMacAddress. If AntiSpoofMacAddress is set to all zeros, the source MAC address in the L2 header of the DHCP packet is used. If AntiSpoofMacAddress is configured, then its value is used.

type=boolean
default=false
Displayed(tab/group)=L2 Header (/General)
localUserDbPointer Specifies the local user database to authenticate against.

type=Pointer
default=
Displayed(tab/group)=localUserDbPointer (/Local User Database)
matchCircuitId Specifies whether the DHCP relay should use the circuit ID in the option 82 field in DHCP packets to match DHCP messages

type=generic.TruthValue
default=false
Displayed(tab/group)=Match Circuit ID (/General)
relaySiaddrOvrAddr The IP address to use instead of the 'siaddr'.

type=InetAddress
default=0.0.0.0
Displayed(tab/group)=Source IP Override Address (/GI-address)
relaySiaddrOvrAddrType The IP address type for relaySiaddrOvrAddr

type=rtr.InetAddressType
default=ipv4

suppress enums=dns, ipv4Mcast , ipv4z, ipv6, ipv6Mcast , ipv6z (Where parent is one of (service.GroupInterface))
relayUnicastMsg The value of vRtrIfDHCPRelayUnicastMsg specifies whether unicast messages will be relayed. If set to 'none', the system will not relay any messages. If set to 'renew', the system will only relay renew messages. If set to 'releaseUpdSrcIp', the system will relay renew and release messages.

type=rtr.RelayUnicastMsgType
default=none
Displayed(tab/group)=Relay Proxy (Unicast Message) (/GI-address)
remoteId

type=rtr.ModifiedTruthValue
default=false
Displayed(tab/group)=Remote ID (/Option 82)
remoteIdString

type=string
default=
minimum=0
maximum=32
Displayed(tab/group)=Remote ID String (/Option 82)
trusted

type=generic.TruthValue
default=false
Displayed(tab/group)=Trusted (/General)
vendorIncludeOptions

type=rtr.DhcpVendorIncludeOptionsMask
default=none
Displayed(tab/group)=Vendor Specific Options (/Vendor Specific Option)
vendorOptionString

type=string
default=
minimum=0
maximum=32
Displayed(tab/group)=Vendor String (/Vendor Specific Option)
 
Overridden Properties
ipv4AddrType
valid enums=ipv4 (Where parent is one of (service.GroupInterface))
 
Properties inherited from rtr.AbstractDhcpRelayConfiguration
administrativeState, clientApplications, description, emulatedServerAddr, giAddressAsSrc, giIpAddress, giIpAddressType, ipv4AddrType, leasePopulate, leaseTime, leaseTimeDays, leaseTimeHours, leaseTimeMinutes, leaseTimeSeconds, proxyAdminState, proxyLTRadiusOverride, proxyLeaseTime, pythonPolicy, pythonPolicyPointer, server1, server2, server3, server4, server5, server6, server7, server8, subscrAuthPolicyPointer
 
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
7750 SR
7705 SAR Gen 2
7705 SAR Hm
7450 ESS Supported from 8.0.R1 until 10.0.R1
  • Excluded chassis types: 7450-ESS1, 7450-ESS6, 7450-ESS6V
  • Required Capabilities: MixedMode
Supported from 10.0.R1
  • Excluded chassis types: 7450-ESS1
  • Required Capabilities: MixedMode
Product Specifics
7450 ESS 20.0
7450 ESS 21.0
7450 ESS 22.0
7450 ESS 23.0
7450 ESS 24.0
7450 ESS 25.0
7705 SAR Gen 2 25.0
7705 SAR Hm 20.0
7705 SAR Hm 21.0
7705 SAR Hm 22.0
7705 SAR Hm 23.0
7705 SAR Hm 24.0
7705 SAR Hm 25.0
7750 SR 20.0
7750 SR 21.0
7750 SR 22.0
7750 SR 23.0
7750 SR 24.0
7750 SR 25.0