service
IPsecInterface

Abstract IPsec interface used by a VPRN/IES service. This IPsec interface provides a ipsec service access point (SAP)



public abstract class IPsecInterface

Stats:
service.SapBaseStats service.SapEgrQosArbiterStats service.SapEgrQosHsmdaCntrStats service.SapEgrQosHsmdaQueueStats service.SapEgrQosPlcyQueueStats service.SapEgrQosPlcyStats service.SapEgrQosPortIdArbiterStats service.SapEgrQosQueueStats service.SapEgrQosSchedStats service.SapEgrSchedPlcyPortStats service.SapEgrSchedPlcyStats service.SapIngQosArbiterStats service.SapIngQosPlcyQueueStats service.SapIngQosPlcyStats service.SapIngQosPortIdArbiterStats service.SapIngQosQueueStats service.SapIngQosSchedStats service.SapIngSchedPlcyPortStats service.SapIngSchedPlcyStats service.ServiceSapIngQosPlcyStats

Properties
adminGroupInclude

type=long
default=0
units=bitmap
Displayed(tab/group)=Groups Included (/Administrative Group)

adminLinkLclAddrPreferred

type=boolean
default=false
Displayed(tab/group)=Admin Link Local Address Preferred

adminLinkLocalAddr

type=InetAddress
default=0:0:0:0:0:0:0:0
Displayed(tab/group)=Admin Link Local Address

adminLinkLocalAddrType

type=rtr.InetAddressType
access=read-create
default=ipv6

adminLinkLocalAddrTypeWithZoneIndex

type=rtr.InetAddressType
access=read-create
default=unknown

adminLinkLocalAddrWithZoneIndex

type=InetAddress
default=
Displayed(tab/group)=Admin Link Local Address

bfdConfigured

type=boolean
access=read-only
default=false

bfdv6Configured

type=boolean
access=read-only
default=false

cflowd.CflowdSampling-Set type=Children-Set
cflowdType This attribute is deprecated for 7750/7450/7950 13.0 and above nodes. Please use cflowd.CflowdSampling instead.

type=service.CflowdTypes
default=none
Displayed(tab/group)=Cflowd Type

delayedDownPeriod The value of delayedDownPeriod specifies the time in seconds that is used to bring down the IPv4 interface. In other words, the value of delayedDownPeriod indicates the hold up time before the interface is going down.

type=long
default=0
minimum=0
maximum=1200
units=seconds
Displayed(tab/group)=Hold Up Period (/Hold Time IPv4)

delayedDownPeriodIpv6 The value of delayedDownPeriodIpv6 specifies the time in seconds that is used to bring down the IPv6 interface. In other words, the value of delayedDownPeriodIpv6 indicates the hold up time before the interface is going down.

type=long
default=0
minimum=0
maximum=1200
units=seconds
Displayed(tab/group)=Hold Up Period (/Hold Time IPv6)

delayedTimerIpv6 The value of delayedTimerIpv6 indicates the time left before the interface comes up or goes down, depending on the ongoing transition state of the interface.

type=long
access=read-only
default=-1
minimum=-1
maximum=1200
units=seconds
Displayed(tab/group)=Delayed Timer (/Hold Time IPv6)

delayedUpPeriod The value of delayedUpPeriod specifies the time in seconds that is used to bring up the IPv4 interface. In other words, the value of delayedUpPeriod indicates the hold down time before the interface is coming up. When interface comes up, it will not become operational until after the specified delay.

type=long
default=0
minimum=0
maximum=65535
units=seconds
Displayed(tab/group)=Hold Down Period (/Hold Time IPv4)

delayedUpPeriodIpv6 The value of delayedUpPeriodIpv6 specifies the time in seconds that is used to bring up the IPv6 interface. In other words, the value of delayedUpPeriodIpv6 indicates the hold down time before the interface is coming up. When interface comes up, it will not become operational until after the specified delay.

type=long
default=0
minimum=0
maximum=1200
units=seconds
Displayed(tab/group)=Hold Down Period (/Hold Time IPv6)

delayedUpTimer The value of delayedUpTimer indicates the time left before the IPv4 interface comes up when delayedUpPeriod is configured to a non-zero value. From SR 14.0.R1, the value of delayedUpTimer also indicates the time left before the IPv4 interface goes down when delayedDownPeriod is configured to a non-zero value.

type=long
access=read-only
default=-1
minimum=-1
maximum=65535
units=seconds
Displayed(tab/group)=Delayed Timer (/Hold Time IPv4)

dynamicTnlRedNHAddr Specifies the IP address of the redundant next-hop for dynamic ISA tunnels on this interface

type=InetAddress
default=0.0.0.0
Displayed(tab/group)=Redundant Next-Hop IP Address for Dynamic ISA Tunnels (/Redundant Next Hop Addresses)

dynamicTnlRedNHAddrType Address type of the redundant next-hop address for dynamic ISA tunnels on this interface (dynamicTnlRedNHAddr)

type=rtr.InetAddressType
default=ipv4

enableStaticNatInside The value of the object aluVrtrIfStaticNatType specifies the interface to be consider inside(private) or outside(public) for static 1:1 nat feature

type=boolean
default=false
Displayed(tab/group)=Enable Static NAT inside

id

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

initDelayEnable When the value initDelayEnable is set to 'false', everytime the system attempts to bring the IPv4 interface operationally up, it will be delayed by the value of delayedUpPeriod. When the value initDelayEnable is set to 'true', only the next time the system attempts to bring the interface operationally up, it will be delayed by the value of delayedUpPeriod.

type=boolean
default=false
Displayed(tab/group)=Delay on Init Only (/Hold Time IPv4)

initDelayEnableIpv6 When the value initDelayEnableIpv6 is set to 'false', everytime the system attempts to bring the IPv6 interface operationally up, it will be delayed by the value of delayedUpPeriodIpv6. When the value initDelayEnableIpv6 is set to 'true', only the next time the system attempts to bring the interface operationally up, it will be delayed by the value of delayedUpPeriodIpv6.

type=boolean
default=false
Displayed(tab/group)=Delay on Init Only (/Hold Time IPv6)

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 9786. When a value of zero (0) is specified, the value is set to the calculated default size.

type=long
default=0
minimum=0
maximum=9786
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)

ipsecInterfaceAdministrativeState

type=netw.AdministrativeState
default=serviceUp
Displayed(tab/group)=Administrative State

ipsecInterfaceDescription

type=string
default=
minimum=0
maximum=255
Displayed(tab/group)=Description

ipv6Allowed

type=boolean
default=false
Displayed(tab/group)=IPv6 Allowed

ipv6OperationalState

type=netw.OperationalState
access=read-only
default=serviceUnknown
Displayed(tab/group)=IPv6 Operational State

lastOperStateChange indicates the sysUpTime when the operational state of this interface last changed

type=Date
access=read-only
default=0
Displayed(tab/group)=Last Operational State Change

linkLocalAddress

type=InetAddress
access=read-only
default=0.0.0.0
Displayed(tab/group)=Link Local Address

linkLocalAddressState

type=rtr.IPv6AddressState
access=read-only
default=unknown
Displayed(tab/group)=Link Local Address State

linkLocalAddressType

type=rtr.InetAddressType
access=read-only
default=unknown

multiChassisShuntingProfile Specifies the profile name to be used for MC shunting

type=string
default=
Displayed(tab/group)=Profile Name (/Multi-Chassis Shunting Profile)

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

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

rtr.DirectInterfaceCtp-Set type=Children-Set
rtr.VirtualInterfaceIcmpConfiguration-Set type=Children-Set
service.EgressAccessPolicyQueueOverride-Set type=Children-Set
service.EgressSchedulerPolicyEntryOverride-Set type=Children-Set
service.IngressAccessPolicyQueueOverride-Set type=Children-Set
service.IngressSchedulerPolicyEntryOverride-Set type=Children-Set
sharedRiskLinkGroupPointers Set of shared risk link groups this interface is associated with.

type=Set (Pointer)

staticTnlRedNHAddr Specifies the IP address of the redundant next-hop for static ISA tunnels on this interface

type=InetAddress
default=0.0.0.0
Displayed(tab/group)=Redundant Next-Hop IP Address for Static ISA Tunnels (/Redundant Next Hop Addresses)

staticTnlRedNHAddrType Address type of the redundant next-hop IP address for static ISA tunnels on this interface (staticTnlRedNHAddr)

type=rtr.InetAddressType
default=ipv4

tcpMss This property specifies the TCP maximum segment size(MSS) for TCP connections originated from the associated IP interface. The valid range is 0|384..9158. For SROS 19.10.R1 onwards it is 0|384..9746.

type=int
default=0
minimum=0
maximum=9746
Displayed(tab/group)=TCP-MSS IPv4

tcpMssIpv6 This property specifies the TCP maximum segment size(MSS) for TCP connections originated from the associated IPv6 interface. The valid range is 0|1220..9138. For SROS 19.10.R1 onwards it is 0|1220..9726.

type=int
default=0
minimum=0
maximum=9726
Displayed(tab/group)=TCP-MSS IPv6

usesMultipointShared

type=generic.TruthValue
default=false
Displayed(tab/group)=Use Multipoint Shared Queue (QoS/Shared Queue)

 
Overridden Properties
description

maximum=160

displayedName

minimum=1
maximum=32

outerEncapValue The value of -1 represents "auto-assign" when Encap Type is 'Dot1 Q'. For SAPs that have an Ethernet Tunnel Endpoint as the Terminating Port, the value of 8191 represents a control SAP. If set to 8191, the value of the 'ethTunnelControlSap' property is set to true.

maximum=4094

 
Properties inherited from service.AccessInterface
aarpPointer, aarpServRefType, accountingOn, accountingPolicyId, accountingPolicyName, accountingPolicyObjectPointer, administrativeState, aggregation, aggregationSchedulerName, aggregationSchedulerObjectPointer, alarmProfile, atm.SapAtmConfiguration-Set, ccagSnmpPortId, dCpuProtectionPolicyPointer, dependantOlcState, displayedName, dosProtection, egressAggCIR, egressAggRateLUB, egressAggRateLimit, egressAggRateLimitCIR, egressAggRateLimitEnabled, egressAggRateLimitPIR, egressAggregateFilterId, egressAggregateFilterName, egressAtmPolicyId, egressCirPercent, egressFilterId, egressFilterName, egressFilterPointer, egressFilterType, egressFrameBaseAccounting, egressIpFilterId, egressIpv6FilterId, egressIpv6FilterName, egressIpv6FilterPointer, egressMacFilterId, egressPirPercent, egressPolicerPolicyPointer, egressPolicyId, egressPolicyName, egressPolicyObjectPointer, egressPortQueueGroupPointer, egressQinqMarkTopBitsOnly, egressQueueAccountingOn, egressRedirectListQueueGroup, egressRemarkPolicyObjectPointer, egressRemarkingPolicyObjectPointer, egressSchedulerMode, egressSchedulerName, egressSchedulerObjectPointer, egressShaperGrpName, egressShaperGrpPointer, egressVlanQosPolicyObjectPointer, hsEgrSecondaryShaper, hsmdaEgrQosPackByteOffOvrd, hsmdaEgrQosWrrPlcyOvrd, hsmdaEgrSecondaryShaper, ingressAggCIR, ingressAggRateLimit, ingressAggregateFilterId, ingressAggregateFilterName, ingressAtmPolicyId, ingressFilterId, ingressFilterName, ingressFilterPointer, ingressFilterType, ingressInstanceId, ingressIpFilterId, ingressIpv6FilterId, ingressIpv6FilterName, ingressIpv6FilterPointer, ingressMacFilterId, ingressMatchQinqDot1pBits, ingressPolicerAccountingOn, ingressPolicerPolicyPointer, ingressPolicyId, ingressPolicyName, ingressPolicyObjectPointer, ingressQueueGroupName, ingressRedirectListQueueGroup, ingressSchedulerMode, ingressSchedulerName, ingressSchedulerObjectPointer, ingressShaperGrpName, ingressShaperGrpPointer, innerEncapValue, lockOlcState, macLearnOptions, mirrorStatus, mprvlanId, olcState, operationalFlags, outerEncapValue, pmonPolicy, pmonPolicyId, portDescription, rateType, rowStatus, sapEgressAggregateShaperRate, sapEgressStatsEnable, sapEgressStatsPktsMode, sapEgressVlanQosPlcyPortRedirect, sapIngressAggregateShaperRate, sapIngressCounterMode, sapIngressCounterType, sapIngressStatsEnable, scpPointer, scpPointers, serviceDescription, serviceId, serviceIdString, serviceName, serviceType, sharedPolicerPolicyObjectPointer, sharedQueueOn, subscriberId, subscriberName, svcComponentId, templateVersionPointer, transitIpPolicyPointer, transitPrefixPolicyPointer, vPortName
 
Properties inherited from netw.PortClientInterface
terminationParticipationType
 
Properties inherited from netw.PortTerminatingInterface
innerEncapValue, outerEncapValue, portIdentifyingName, portPointer
 
Properties inherited from netw.StatefullConnectableInterface
administrativeState, compositeState, encapType, operationalState, resourceState, underlyingResourceState
 
Properties inherited from netw.ConnectableInterface
actualMtu, ctpPointer, encapType, isExclusiveTermination, mtuMismatch, portId, portName, provisionedMtu, routerId, routerName, terminatedObjectId, terminatedObjectName, terminatedObjectPointer, terminatedPortClassName, terminatedPortCombinedEncapValue, terminatedPortInnerEncapValue, terminatedPortOuterEncapValue, terminatedPortPointer, terminationParticipationType
 
Properties inherited from netw.LogicalInterface
application, description, displayedName, domain, nodeId, nodeName
 
Properties inherited from ManagedObject
actionMask, children-Set, deploymentState, isFaultSquelched, name, objectFullName, selfAlarmed
 
Methods

requestPolicyAccountStatsClear

Request clearing of Policy Accounting Statistics on this interface. When this method returns resources for the clear have been allocated but the clear has not been performed yet. To retrieve the result eventually, use the returned request handle as input param of the retrieveClearRequest method of the clear.ClearCommandManager.
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.
instanceFullName : string - the full name of the object.
aInAcctType : int - The Account Type of the Accounting Statistics. A '0' will clear entries related to source class. A '1' will clear entries related to destination class.
aInAcctIndex : int - The Account Index of the Accounting Statistics. The valid range is [1-255].
aInClearAll : boolean - A 'true' value will clear all Policy Account statistics for this interface. A 'false' value will consider the other two parameters to clear entries. If this is 'true' then other parameters are ignored.
resultFilter : ResultFilter - (Optional) Filter for narrowing down the information returned per object
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
Output Parameters:
aOutResult : clear.RequestHandleStruct - A request handle which allows the retrieval of the request (and its result when it becomes available) through the ClearCommandManager's retrieveClearRequest method.

shutDown

Used to administratively disable the access interface.
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.
instanceFullName : string - the full name of the object.
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false

turnUp

Used to administratively enable the access interface.
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.
instanceFullName : string - the full name of the object.
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
Methods inherited from service.AccessInterface
findSitesFor, moveSapToAnotherService
 
Supported Network Elements
7750 SR Supported from 10.0.R1 until 13.0.R13
  • Excluded chassis types: 7750-SR1, 7750-SRc4, 7750 SR-1e, 7750 SR-2e, 7750 SR-3e
Supported from 13.0.R13 until 14.0.R1
  • Excluded chassis types: 7750-SRc4
Supported from 14.0.R1 until 14.0.R4
  • Excluded chassis types: 7750-SRc4, 7750 SR-1e, 7750 SR-2e, 7750 SR-3e
Supported from 14.0.R4
  • Excluded chassis types: 7750-SRc4
7705 SAR Gen 2
7705 SAR Hm
7450 ESS Supported from 11.0.R1
  • Excluded chassis types: 7450-ESS1
  • Required Capabilities: MixedMode
7705 SAR Supported from 6.1.R1
  • Excluded chassis types: 7705-SARM ASAP, 7705-SARM, 7705-SARM ASAP FL, 7705-SARM FL, 7705 SAR-A T1/E1, 7705 SAR-A, 7705-SARF
7705 SAR H Supported from 6.1.R1
7950 XRS Supported from 14.0.R4
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 H 20.0
7705 SAR H 21.0
7705 SAR H 22.0
7705 SAR H 23.0
7705 SAR H 24.0
7705 SAR H 25.0
7705 SAR H 9.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
7705 SAR 20.0
7705 SAR 21.0
7705 SAR 22.0
7705 SAR 23.0
7705 SAR 24.0
7705 SAR 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
7950 XRS 20.0
7950 XRS 21.0
7950 XRS 22.0
7950 XRS 23.0
7950 XRS 24.0
7950 XRS 25.0