service
GroupInterface

Group interface in an unnumbered interface which is responsible for aggregating the Service Access Points in a IES/VPRN Routed CO solution.



public abstract class GroupInterface

Stats:
rtr.IpInterfaceAdditionalStats

Properties
allowMultipleWANAddresses Specifies if multiple wan addresses from multiple sources are allowed, or if the second addresses are rejected.

type=boolean
default=false

arpPopulate

type=antispoof.ArpPopulateAdminState
default=disabled
Displayed(tab/group)=ARP Populate (Anti-Spoofing)

autoReplyOptions The value of autoReplyOptions specifies the automatic reply to Neighbor Solicitation and Router Solicitation messages, for data-triggered static IPv6 hosts. neighborSolicitation (0) - auto-reply for Neighbor Solicitation routerSolicitation (1) - auto-reply for Router Solicitation.

type=service.AutoReplyOptions
default=0

dataTriggerAdminState Specifies the administrative state of the data triggered host function for this interface.

type=netw.AdministrativeState
default=serviceDown
Displayed(tab/group)=Administrative State (Subscriber Management/Data Triggered)

dhcpV6FilterPointer Specifies the DHCPv6 filter to apply. If no filtering is required, then a value of zero (0) must be set.

type=string
default=

dhcpV6SnpgAdminState Specifies the desired administrative state of the DHCPv6 Snooping

type=int
default=tmnxOutOfService
enums=
    2: tmnxInService - Up
    3: tmnxOutOfService - Down

dhcpV6UserIdent Specifies how subscriber hosts are identified. A value of 'mac' identifies each subscriber by its unique mac-address, and 'macInterfaceId' identifies the subscriber by MAC Address and Interface ID.

type=service.GrpIntfDhcpV6UserIdType
default=mac

diamAppPolicy Specifies the name of the diameter application policy for this group interface

type=Pointer
default=
Displayed(tab/group)=Diameter Application Policy

diamAuthPolicy Specifies the name of the diameter authentication policy for this group interface

type=Pointer
default=
Displayed(tab/group)=Diameter Authentication Policy

enableIngressStats Specifies if ingress statistics gathering is enabled for this interface.

type=boolean
default=false
Displayed(tab/group)=Enable Ingress Stats

iPv6Dhcp6PDManagedRouteNH Specifies the type of nexthop for the pd-managed-route.

type=service.PdManagedRouteNH
default=ipv6

ignoreSapPortState

type=service.IgnoreSapPortStateActionType
default=stop

interfaceOperFlags The value of interfaceOperFlags specifies the reason why the interface is operationally down.

type=service.InterfaceOperFlags
access=read-only
Displayed(tab/group)=Interface Down Reason Ipv4

interfaceOperFlagsIpv6 The value of interfaceOperFlagsIpv6 specifies the reason why the interface is operationally down.

type=service.InterfaceOperFlags
access=read-only
Displayed(tab/group)=Interface Down Reason IPv6

ipMtu The value of IP MTU is used to reflect the MTU size of this interface in the header of an ICMP MTU exceeded message when a packet is too large to be transmitted on this interface. The default size is calculated by subtracting the DLC header size from the physical MTU size of the interface. The range is 0 or between 512 and 9000. When a value of zero (0) is specified, the value is set to the calculated default size.

type=long
default=0
minimum=0
maximum=9000
units=Octets
Displayed(tab/group)=Configured IP MTU (/Frame Size Constraints)

ipOperMtu The value of the operational IP MTU indicates the operational value of the IP MTU on this interface. It is the minimum of the IP MTU and the MTU of the physical port this interface is bound to.

type=long
access=read-only
units=Octets
Displayed(tab/group)=Operational IP MTU (/Frame Size Constraints)

ipoeBridgedModeEnabled Specifies whether IPv6 IPoE Bridged Mode is enabled or not

type=boolean
default=false

ipv6Allowed The value of ipv6Allowed specifies whether IPv6 can be configured on this interface. When the value is 'true', IPv6 can be configured on this interface. When it is 'false', IPv6 cannot be configured.

type=boolean
default=false

lns

type=generic.TruthValue
default=false
Displayed(tab/group)=LNS

numberOfSap

type=int
access=read-only
default=0

operationalStateWhileEmpty The value of iesGrpIfOperUpWhileEmpty specifies the whether that operational status of the the IES group interface, as indicated by iesIfOperStatus, should have a value of 'up' even when there are no SAPs on the group interface. If the value of iesGrpIfOperUpWhileEmpty is 'true', the value of iesIfOperStatus for the IES group interface will be 'up' when there are no SAPs on the group interface. When the value of iesGrpIfOperUpWhileEmpty is 'false', the value of iesIfOperStatus will depend on the operational state of the SAPs on the group interface. The value of iesGrpIfOperUpWhileEmpty will be ignored when there are SAPs on the IES group interface.

type=boolean
default=false
Displayed(tab/group)=Operational State UP While Empty

overrideSlaac Specifies if the wan address received from SLAAC will be removed when a (second) wan address is received from DHCP6, or if the host will keep both.

type=boolean
default=false

parentIfId

type=long
access=read-only
default=0
minimum=2
maximum=16384
Displayed(tab/group)=Subscriber Interface ID

pdManagedRoute Specifies whether DHCP6 delegated prefixes will be installed as managed routes.

type=boolean
default=false

physicalAddress

type=MacAddress
default=00-00-00-00-00-00
Displayed(tab/group)=MAC Address

policyAccountingTemplatePointer The value points to the the policy Accounting template created under Routing policies.

type=Pointer
default=
Displayed(tab/group)=Policy Name (Policies/Routing Ingress Accounting Template)

qosRouteLookupIpv4 QoS classification of the ingress IPv4 packets on a group interface based on the QoS information associated with routes in the forwarding table.

type=rtr.QosLookup
default=none

qosRouteLookupIpv6 QoS classification of the ingress IPv6 packets on a group interface based on the QoS information associated with routes in the forwarding table.

type=rtr.QosLookup
default=none

redundantInterfacePointer

type=Pointer
default=
Displayed(tab/group)=Redundant Interface

rtr.GrpItfDhcpRelayCfg-Set type=Children-Set
rtr.VirtualIfPppCfg-Set type=Children-Set
rtr.VirtualInterfaceArpConfiguration-Set type=Children-Set
rtr.VirtualInterfaceIcmpConfiguration-Set type=Children-Set
rtr.VirtualInterfacePPPoEConfiguration-Set type=Children-Set
service.BondingConfiguration-Set type=Children-Set
service.BondingConnection-Set type=Children-Set
service.GrpIntfBrgConfiguration-Set type=Children-Set
service.GtpConfiguration-Set type=Children-Set
service.IpoeLinkConf-Set type=Children-Set
service.LocalAddressAssignment-Set type=Children-Set
shcvAction Specifies the action to be taken for hosts on this interface whose host connectivity checking fails. "Alarm" will raise an alarm indicating that a host is disconnected on this SAP. "Remove" will raise an alarm and remove the DHCP state and release allocated resources.

type=service.ShcvAction
default=alarm
Displayed(tab/group)=Action (Subscriber Management/Subscriber Host Connectivity Verification (SHCV))

shcvFamily Specifies the number of connectivity check retransmissions. Setting the value to (n) specifies that, for any given host, at most (n+1) probes are done each interval, and (n+1) missed replies are considered as a connectivity failure.

type=service.ShcvFamilyTypes
default=ipv4
Displayed(tab/group)=Family (Subscriber Management/Subscriber Host Connectivity Verification (SHCV))

shcvInterval The interval specifies the time, in minutes, within which hosts on a SAP should be verified. The interval starts for each host individually, when it is created. Dynamic and static hosts are treated in the same way. The actual rate dependents on the number of known hosts and the interval. Interval value '0' means SHCV is administratively disabled.

type=int
default=0
minimum=0
maximum=6000
units=minutes
Displayed(tab/group)=Interval (Subscriber Management/Subscriber Host Connectivity Verification (SHCV))

shcvPolicyIPv4Pointer Specifies the Subscriber Host Connectivity Verification (SHCV) policy for both IPv4 only. A non empty value is only allowed while the value of shcvInterval is equal to zero and while the value of shcvPolicyPointer is empty

type=Pointer
default=
Displayed(tab/group)=IPv4 Policy (Subscriber Management/SHCV Policy)

shcvPolicyIPv6Pointer Specifies the Subscriber Host Connectivity Verification (SHCV) policy for both IPv6 only. A non empty value is only allowed while the value of shcvInterval is equal to zero and while the value of shcvPolicyPointer is empty

type=Pointer
default=
Displayed(tab/group)=IPv6 Policy (Subscriber Management/SHCV Policy)

shcvPolicyPointer Specifies the Subscriber Host Connectivity Verification (SHCV) policy for both IPv4 and IPv6. A non empty value is only allowed while the value of shcvInterval is equal to zero

type=Pointer
default=
Displayed(tab/group)=IPv4/IPv6 Policy (Subscriber Management/SHCV Policy)

shcvRetryCount Specifies the number of connectivity check retransmissions. Setting the value to (n) specifies that, for any given host, at most (n+1) probes are done each interval, and (n+1) missed replies are considered as a connectivity failure.

type=int
default=2
minimum=2
maximum=29
Displayed(tab/group)=Retry Count (Subscriber Management/Subscriber Host Connectivity Verification (SHCV))

shcvRetryTimeout Specifies the timeout in seconds before a connectivity check retransmission.

type=int
default=10
minimum=10
maximum=60
units=seconds
Displayed(tab/group)=Retry Timeout (Subscriber Management/Subscriber Host Connectivity Verification (SHCV))

shcvSource Specifies the source to be used for the generation of Subscriber Host Connectivity Verification (SHCV) packets. Valid values are "VRRP" and "Interface". "VRRP" specifies that the VRRP state should be used to select the proper IP and MAC address. The IP and MAC address are selected as follows: SHCV packets sourced by VRRP IP interface acting as a master will use VRRP VRID MAC address as a source MAC address, and VRRP IP as source IP address. SHCV packets sourced by VRRP IP interface acting as a backup will use IP interface MAC address as a source MAC address, and IP interface as source IP address (to prevent poisoning of host's arp-cache). (Default) "Interface" forces the containing interface's IP and MAC address to be used. As there may be up to 16 possible subnets on an interface, the SHCV tool will always use the subnet to which the host is using. For IES group interfaces, the address of the subscriber interface will be used.

type=service.ShcvSource
default=interface
Displayed(tab/group)=Source (Subscriber Management/Subscriber Host Connectivity Verification (SHCV))

specificType

type=service.GroupIfTypes
access=read-create
default=regular
Displayed(tab/group)=Specific Type

srrpRoutingEnabled Specifies whether SRRP state monitoring for subscriber-management routes and managed routes on this group interface is enabled or not.

type=boolean
default=false
Displayed(tab/group)=Enabled (SRRP/Routing)

srrpRoutingHoldTime Specifies the delay before updating the route state after the last SRRP transition.

type=float
default=0
minimum=0
maximum=5
units=seconds
Displayed(tab/group)=Hold Time (SRRP/Routing)

suppressAaSub Specifies whether or not to suppess Application-Assurance for Enhanced Subscriber Management (ESM) subscribers who are associated with this instance and have applicationAssurancePolicy.appProfile.subSuppressible set to 'enabled (1)'.

type=generic.EnabledDisabled
default=disabled
Displayed(tab/group)=Suppress AA for ESM Subscriber (Subscriber Management/Application Assurance)

uRPFCheckMode Specifies the mode of unicast RPF check for IPv4. It is applicable only when uRPFCheckState is set to 'enabled'."

type=rtr.URPFCheckMode
default=strict
Displayed(tab/group)=URPF Check Mode IPv4 (/Unicast RPF)

uRPFCheckModeIpv6 Specifies the mode of unicast RPF check for IPv6. It is applicable only when uRPFCheckStateIpv6 is set to 'enabled'."

type=rtr.URPFCheckMode
default=strict
Displayed(tab/group)=URPF Check Mode IPv6 (/Unicast RPF)

uRPFCheckState Specifies whether unicast RPF (uRPF) Check is enabled for IPv4 on the interface. The uRPF on Group Interface is only supported on IOM-3s.

type=generic.EnabledDisabled
default=disabled
Displayed(tab/group)=URPF Check State IPv4 (/Unicast RPF)

uRPFCheckStateIpv6 Specifies whether unicast RPF (uRPF) Check is enabled for IPv6 on the interface.

type=generic.EnabledDisabled
default=disabled
Displayed(tab/group)=URPF Check State IPv6 (/Unicast RPF)

wlangw.RetailMap-Set type=Children-Set
wlangw.SapCfg-Set type=Children-Set
wlangw.SoftGreIf-Set type=Children-Set
wlangw.SoftGreIfExtension-Set type=Children-Set
wlangw.WlanGwGrpIfGwAddress-Set type=Children-Set
wlangw.WlanGwL2AccessPoint-Set type=Children-Set
wpp.WppConf-Set type=Children-Set
wppEnabled The value of wppEnabled specifies whether WEB Portal Protocol can be configured on this interface.

type=boolean
default=false
Displayed(tab/group)=Enable WPP

 
Overridden Properties
description

displayedName

id

maximum=16384

 
Properties inherited from service.LogicalInterface
administrativeState, description, displayedName, id, operationalState, routerId, routerName, serviceId, serviceName, serviceType, subscriberId, subscriberName, svcComponentId, templateVersionPointer
 
Properties inherited from netw.LogicalInterface
application, description, displayedName, domain, nodeId, nodeName
 
Properties inherited from ManagedObject
actionMask, children-Set, deploymentState, isFaultSquelched, name, objectFullName, selfAlarmed
 
Methods

cleanUpBondingGroupInterface

The Bonding feature is implemented in release 17.12 and ESM Bonding Group Interfaces only support specific configuration compared to regular Group Interfaces. Previous releases such as 17.9 and 17.3 are not aware of Bonding Group Interfaces and will treat them as unknown Group Interfaces, and generate child objects that are not applicable to Bonding Group Interfaces. CleanUpBondingGroupInterface will delete the non-applicable child objects that were created and not handled during upgrade.
Input Parameters:
deployer : Deployer - the deployment state
synchronousDeploy : boolean - (Optional) Specify whether to block until the changes have been fully deployed to the network. A value of "true" means to block. A value of "false" means to return immediately. Default: false (asynchronous)
clearOnDeployFailure : boolean - (Optional) Specify whether to clear any failed deployers. A value of "true" means to clear. A value of "false" means to leave the failed deployer. Default: false
deployRetries : int - (Optional) The number of times to attempt re-deployment during synchronous deployment. This parameter is meaningless in the asynchronous case. Default: 0
deployRetryInterval : long - (Optional) The number of milliseconds to wait between deployment retries. This parameter is meaningless in the asynchronous case. Default: 0
taskDescription : string - (Optional) A user friendly description of what the operation does. This information will be used by the task manager.
aInGroupInterfacePointer : string - (Optional) Specifies the FDN of the Bonding Group Interface.
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false

cleanUpGtpGroupInterface

The GTP feature is implemented in release 17.12 and ESM GTP Group Interfaces only support specific configuration compared to regular Group Interfaces. Previous releases such as 17.9 and 17.3 are not aware of GTP Group Interfaces and will treat them as unknown Group Interfaces, and generate child objects that are not applicable to GTP Group Interfaces. CleanUpGtpGroupInterface will delete the non-applicable child objects that were created and not handled during upgrade.
Input Parameters:
deployer : Deployer - the deployment state
synchronousDeploy : boolean - (Optional) Specify whether to block until the changes have been fully deployed to the network. A value of "true" means to block. A value of "false" means to return immediately. Default: false (asynchronous)
clearOnDeployFailure : boolean - (Optional) Specify whether to clear any failed deployers. A value of "true" means to clear. A value of "false" means to leave the failed deployer. Default: false
deployRetries : int - (Optional) The number of times to attempt re-deployment during synchronous deployment. This parameter is meaningless in the asynchronous case. Default: 0
deployRetryInterval : long - (Optional) The number of milliseconds to wait between deployment retries. This parameter is meaningless in the asynchronous case. Default: 0
taskDescription : string - (Optional) A user friendly description of what the operation does. This information will be used by the task manager.
aInGroupInterfacePointer : string - (Optional) Specifies the FDN of the GTP Group Interface.
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
Supported Network Elements
7750 SR
7705 SAR Gen 2
7705 SAR Hm
7705 SAR Supported from 7.0.R4
7705 SAR H Supported from 7.0.R4
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