wlangw
WlanGwBdUe

Represents information about a WLAN Gateway Bridge Domain User Equipment (UE).



public class WlanGwBdUe

Properties
bridgeId Specifies the Bridge Identifier of this User Equipment.

type=long
access=read-create
Mandatory on create

creationOrigin

type=svt.L2RouteOriginType
access=read-create
default=manual

lastApMoveTime Indicates the time of the most recent Access Point move of this UE.

type=Date
access=read-only

macAddress Specifies the MAC address of this User Equipment.

type=MacAddress
access=read-create
Mandatory on create

mplsLabel Indicates the MPLS label present in the traffic received from this UE. The value zero indicates that the traffic received from this UE does not have an MPLS label.

type=long
access=read-only
minimum=0
maximum=4294967295

prevApIpAddress Specifies the IP address of the previous Access Point (AP) of this UE. NOTE: the current AP IP address is the value of the Remote Address.

type=InetAddress
access=read-only
default=

prevApIpAddressType Indicates the address type of the previous Access Point (AP) of this UE.

type=rtr.InetAddressType
access=read-only

qosRetailService Indicates the identifier of the retail service. The value zero indicates that this UE's tunnel has per-tunnel QoS.

type=long
access=read-only

retailServicePtr Indicates pointer to the retail service to be used. The value zero specifies that this UE's tunnel has per-tunnel QoS.

type=Pointer
default=

siteId Indicates Network Element where this User Equipment is connected to.

type=string
access=read-only
default=
minimum=0
maximum=64

subscrSapEncapValue Indicates the value of the encapsulation of the (internal) SAP associated with this UE. While no subscriber is associated with this UE, it is set to zero.

type=long
access=read-only
default=0
minimum=0
maximum=4294967295

subscrSapInnerEncap Inner encapsulation value of the (internal) SAP associated with this UE. While no subscriber is associated with this UE, it is set to zero.

type=long
access=read-only
default=0
minimum=0
maximum=4094

subscrSapOuterEncap Outer encapsulation value of the (internal) SAP associated with this UE. While no subscriber is associated with this UE, it is set to zero.

type=long
access=read-only
default=0
minimum=0
maximum=4094

subscrSapPortId Indicates the port ID of the (internal) SAP associated with this UE. While no subscriber is associated with this UE, it is set to 0.

type=long
access=read-only
default=0

subscrSapPortPointer

type=string
access=read-only
default=

subscrSvcId Indicates the service identifier of the (internal) SAP associated with this UE. While a subscriber is associated with this UE, that SAP is where its subscriber hosts can be found. Zero means no subscriber is associated with this UE.

type=long
access=read-only

subscrSvcPointer FDN of the service of the (internal) SAP associated with this UE.

type=string
access=read-only
default=

tuAddrType Specifies the address type for the IP address of remote and local endpoint of this UE's tunnel. The only values allowed are 'ipv4(1)' and 'ipv6(2)'.

type=rtr.InetAddressType
access=read-only

tuLocalAddress Specifies the IP address of the local endpoint of this UE's tunnel, that is the destination IP address in the tunnel header of received packets.

type=InetAddress
access=read-only

tuRemoteAddress Specifies the IP address of the remote endpoint of this WLAN GW tunnel. That is the source IP address in the tunnel header of received packets.

type=InetAddress
access=read-only

tuRouterId Specifies the Identifier of the virtual router instance where the tunneled User Equipment traffic is routed.

type=int
access=read-only
default=1
minimum=1
maximum=10240

tuRoutingInstancePointer Indicate FDN of the routing instance object where the tunnel is created.

type=Pointer
access=read-only
default=

tuRtrServiceId Specifies service ID of the virtual router instance where the tunneled User Equipment traffic is routed.

type=long
access=read-only
default=0

ueIMSI Indicates the IMSI (International Mobile Subscriber Identity) of this UE.

type=string
access=read-only
default=
maximum=15

ueSSID Indicates the Service Set ID (SSID) of this UE.

type=string
access=read-only

vlanQTag Indicates the VLAN Q-tag present in the traffic received from this UE. The value of this object can be used to identify the retailer service. The value minus one indicates that the traffic received from this UE does not have a VLAN Q-tag

type=int
access=read-only
minimum=-1
maximum=4095

  
Properties inherited from ManagedObject
actionMask, children-Set, deploymentState, isFaultSquelched, name, objectFullName, selfAlarmed
 
Methods

retrieveWlanGwBdUesPerTunnel

Method retrieve all User Equipments resides on the specified tunnel (Base or VPRN).
Input Parameters:
aInSiteId : string - Specifies the Network Element to query. This is mandatory parameter.
aInRouterId : int - Specifies the Routing Instance ID to query. Use "1" for Base Routing Instance, or any integer for service ID. This is mandatory parameter.
aInRemoteAddr : string - Specifies the IP Address of the remote endpoint of this UE's tunnel, i.e. the tunnel's Source IP Address. This is mandatory parameter.
aInLocalAddr : string - (Optional) Specifies the IP Address of the local endpoint of this UE's tunnel, i.e. the tunnel's Destination IP Address. This is optional parameter.
aInBridgeId : long - (Optional) Specifies Bridge Identifier of the User Equipment. This is optional parameter. Searching with aInBridgeId requires aInLocalAddr to be specified.
aInMacAddr : string - (Optional) Specifies the MAC Address of this UE. This is optional parameter. Searching with aInMacAddr requires aInLocalAddr and aInBridgeId to be specified.
aInTimeout : long - (Optional) Specifies the maximum waiting duration in milliseconds before the retrieval request timed out. This is an optional input parameter. The default value is 5 minutes (300000ms).
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:
ueObjectList : List (generic.CommonManagedEntityInformation) -

retrieveWlanGwUesPerBd

Method retrieves all User Equipments of a given Bridge Identified on the specific Network Element.
Input Parameters:
aInSiteId : string - Specifies the Network Element to query. This is mandatory parameter.
aInBridgeId : long - Specifies the Bridge Identifier of this UE to query. This is mandatory parameter.
aInMacAddr : string - (Optional) Specifies the MAC Address of this UE to query. This is optional parameter.
aInTimeout : long - (Optional) Specifies the maximum waiting duration in milliseconds before the retrieval request timed out. This is an optional input parameter. The default value is 5 minutes (300000ms).
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:
ueObjectList : List (generic.CommonManagedEntityInformation) -
Supported Network Elements
7750 SR Supported from 15.0.R6
  • Excluded chassis types: 7750-SRc12, 7750-SRc4, 7750-SRa4, 7750-SRa8, 7750-SR1 Fixed CFM, 7750 SR-1e, 7750 SR-2e, 7750 SR-3e