Overview Package Class Deprecated Help

nat
DsLiteSubscriber

public class DsLiteSubscriber

Properties
address The inside IPv6 address of the subscriber (the ipv6 tunnel?)

type=InetAddress
access=read-create
Mandatory on create
Displayed(tab/group)=B4 IP Address (/Inside Address)
addressType The address type of address (always IPv6)

type=rtr.InetAddressType
access=read-create
Mandatory on create
creationOrigin

type=svt.L2RouteOriginType
access=read-create
default=manual
nat.LsnBlockAllocated-Set type=Children-Set
nat.LsnSubSession-Set type=Children-Set
prefixLen The Prefix length of the subscriber

type=int
access=read-only
Displayed(tab/group)=B4 IP Address Prefix Length (/Inside Address)
subId the identifier of subscriber

type=long
access=read-create
Mandatory on create
Displayed(tab/group)=Subscriber ID
subInRoutingInstance This is a meaningful description of the hostVRtrId ie: Something like " Routing Instance -1, 38.120.182.228" or " VPRN Service - VPRN550 (38.10.182.227)"

type=string
access=read-only
Displayed(tab/group)=Routing Instance (/Inside Address)
subInsideRoutingInstance This is a meaningful description of the hostVRtrId ie: Something like " Routing Instance -1, 38.120.182.228" or " VPRN Service - VPRN550 (38.10.182.227)"

DEPRECATED: 13.0.R1 - Use subInRoutingInstance instead
The property can be referenced through XML API but such usage might not be compatible with future releases
type=string
access=read-only
subOutAddress Indicates the outside IP address allocated to this NAT subscriber

DEPRECATED: 12.0.R1 - WARNING: property is subject to change.
The property can be referenced through XML API but such usage might not be compatible with future releases
type=InetAddress
access=read-only
Displayed(tab/group)=IP Address (/Outside Address)
subOutAddressType Indicates the outside IP address type of address allocated to this NAT subscriber.

DEPRECATED: 12.0.R1 - WARNING: property is subject to change.
The property can be referenced through XML API but such usage might not be compatible with future releases
type=rtr.InetAddressType
access=read-only
subOutRoutingInstance This is a meaningful description of the subOutVrtrId ie: Something like " Routing Instance -1, 38.120.182.228" or " VPRN Service - VPRN550 (38.10.182.227)"

DEPRECATED: 12.0.R1 - WARNING: Use subOutsideRoutingInstance instead
The property can be referenced through XML API but such usage might not be compatible with future releases
type=string
access=read-only
subOutVrtrId Identifies the outside virtual router instance associated with this NAT subscriber

DEPRECATED: 12.0.R1 - WARNING: property is subject to change.
The property can be referenced through XML API but such usage might not be compatible with future releases
type=long
access=read-only
subOutsideRoutingInstance This is a meaningful description of the subOutVrtrId ie: Something like " Routing Instance -1, 38.120.182.228" or " VPRN Service - VPRN550 (38.10.182.227)"

type=string
access=read-only
Displayed(tab/group)=Routing Instance (/Outside Address)
vrtrId Virtual Router Id

type=long
access=read-only
  
Properties inherited from nat.AbstractLsnSubscriber
isaGroup, isaMemberId, lsnSubId, natPolicyPointer, policy, siteId, siteName
 
Properties inherited from ManagedObject
actionMask, children-Set, deploymentState, isFaultSquelched, name, objectFullName, selfAlarmed
 
Methods

retrieveDsLiteSubscribers

DEPRECATED - 12.0.R1 - WARNING: method is subject to change. {br/}This method can be referenced through XML API but such usage might not be compatible with future releases. It is recommoned to use queryLsnSubscribers() method in AbstractLsnSubscriber class
Method used to query the NE for the DsLite Subscribers that exists for a specified routing instance (Base or VPRN) and the DS Lite Subscriber inside IP Address.
Input Parameters:
aInSiteId : string - Specifies the NE to which the DS Lite Subscriber is connected with.
aInRouterId : int - Specifies inside routing instance ID to get all DS Lite Subscribers attached to this routing instance.
aInSubAddr : string - (Optional) The inside IP address of the DS Lite Subscriber. This is an optional input parameter. If specified as 0.0.0.0, all the DS Lite Subscribers on the routing instance are retrieved.
shouldRetrieveBlockAllocation : boolean - (Optional) If true, the block allocations are retrieved for each DS Lite Subscriber. If false, the block allocations are not retrieved for each DS Lite Subscriber. Default is false.
timeout : long - (Optional) The number of milliseconds to wait before receiving the results. If no results are received in the given time, the method returns. This is an optional input parameter. The default value is 5 minutes (300000).
subInsideAddrPfxL : long - (Optional) The inside address prefix length. Has to be set for 12.0 node if the aInHostAddr is set.
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:
result : List (generic.CommonManagedEntityInformation) -
Exceptions:
nat.DsLiteSubscriber.retrieveDsLiteSubscribersException -
Methods inherited from nat.AbstractLsnSubscriber
queryLsnSubscribers
 
Supported Network Elements
7750 SR Supported from 10.0.R1 until 12.0.R1
  • Excluded chassis types: 7750-SRc12, 7750-SRc4, 7750-SR1 Fixed CFM, 7750 SR-14s, 7750 SR-7s, 7750 SR-1s, 7750 SR-2s
Supported from 12.0.R1 until 13.0.R8
  • Excluded chassis types: 7750-SRc4, 7750-SRa4, 7750-SRa8, 7750 SR-1e, 7750 SR-2e, 7750 SR-3e, 7750-SR1 Fixed CFM, 7750 SR-14s, 7750 SR-7s, 7750 SR-1s, 7750 SR-2s
Supported from 13.0.R8 until 20.5.R1
  • Excluded chassis types: 7750-SRc4, 7750-SRa4, 7750-SRa8, 7750-SR1 Fixed CFM, 7750 SR-14s, 7750 SR-7s, 7750 SR-1s, 7750 SR-2s
Supported from 20.5.R1
  • Excluded chassis types: 7750-SRa4, 7750-SRa8, 7750 SR-14s
7705 SAR Gen 2
7450 ESS Supported from 11.0.R1
  • Excluded chassis types: 7450-ESS1
  • Required Capabilities: MixedMode