wlangw
WlanGwQbtUe



public class WlanGwQbtUe

Properties
acctUpdate Specifies the time when the next accounting update for this UE is going to be transmitted.

type=Date
access=read-only
default=0
Displayed(tab/group)=Accounting Update

acctUpdateInterval Specifies the time interval between consecutive Interim Accounting Update messages.

type=long
access=read-only
default=0
Displayed(tab/group)=Interim Accounting Update Interval

apMacAddress Indicates MAC address of the Access Point of this UE.

type=MacAddress
access=read-only
Displayed(tab/group)=Access Point MAC Address

bridgeId Indicates the identifier of the bridge domain associated with this User Equipment.

type=long
access=read-only
Displayed(tab/group)=Bridge ID

creationOrigin

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

dhcpAddrDeprecated Indicates whether the DHCP address is deprecated or not.

type=boolean
access=read-only
Displayed(tab/group)=DHCP Address Deprecated

dhcpV6Addr Indicates the DHCPv6 address.

type=InetAddress
access=read-only
Displayed(tab/group)=DHCPv6 Address (/DHCPv6)

dhcpV6AddrDeprecated Indicates whether the DHCPv6 address is deprecated or not.

type=boolean
access=read-only
Displayed(tab/group)=Address Deprecated (/DHCPv6)

dhcpV6AddrType Indicates the address type for DHCPv6 Address. The only values allowed are 'ipv6(2)'.

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

dhcpV6IAID Indicates the the DHCPv6 Identity Association Identifier IAID.

type=long
access=read-only
Displayed(tab/group)=IAID (/DHCPv6)

dhcpV6IAIDValid Indicates whether the IAID is valid or not.

type=boolean
access=read-only
Displayed(tab/group)=IAID Valid (/DHCPv6)

dhcpV6LeaseExpire Indicates when the lease of the DHCPv6 address will expire.

type=Date
access=read-only
Displayed(tab/group)=Lease Expire (/DHCPv6)

dsmAccountingPlcy Indicates the accounting policy of this UE

type=string
access=read-only
default=
Displayed(tab/group)=Accounting Policy

dsmAppProfile Indicates the application profile of this UE.

type=string
access=read-only
default=
Displayed(tab/group)=Application Profile

dsmIpFilter Specifies the DSM IP filter of this UE.

type=string
access=read-only
default=
Displayed(tab/group)=IP Filter

egrOperCIR Specifies the actual Egress CIR (Committed Information Rate).

type=long
access=read-only
default=0
minimum=-1
maximum=100000000
units=kbps
Displayed(tab/group)=Egress CIR (Transmitted/Received Statistics)

egrOperPIR Specifies the actual Egress PIR (Peak Information Rate).

type=long
access=read-only
default=-1
minimum=-1
maximum=100000000
units=kbps
Displayed(tab/group)=Egress PIR (Transmitted/Received Statistics)

expirationTime Indicates the time when the system context of this UE will expire and be removed from this system, unless it is renewed.

type=Date
access=read-only
Displayed(tab/group)=Expiration Time

httpRedirectPolicy Specifies the identifier of the HTTP redirect policy for this UE

type=string
access=read-only
default=
Displayed(tab/group)=HTTP Redirect

idleTimeout Indicates the time that this UE can remain inactive before its system context will be removed from this system. An idle timeout can be imposed by an AAA server..

type=Date
access=read-only
Displayed(tab/group)=Idle Timeout

ingOperCIR Specifies the actual Ingress CIR (Committed Information Rate).

type=long
access=read-only
default=0
minimum=-1
maximum=100000000
units=kbps
Displayed(tab/group)=Ingress CIR (Transmitted/Received Statistics)

ingOperPIR Specifies the actual Ingress PIR (Peak Information Rate).

type=long
access=read-only
default=-1
minimum=-1
maximum=100000000
units=kbps
Displayed(tab/group)=Ingress PIR (Transmitted/Received Statistics)

isaGroup Specifies the pointer to WLAN GW ISA Group

type=string
access=read-only
default=
Displayed(tab/group)=WLAN GW Group (/WLAN GW Group)

isaGroupId Indicates an identification number for the Wireless Local Access Network Gateway (WLAN GW) Integrated Service Adaptor (ISA) group associated with this UE. The value zero means that no WLAN Gateway ISA Group is defined.

type=int
access=read-only
default=0
minimum=1
maximum=4

isaMember Specifies the pointer to WLAN GW ISA Group Member.

type=string
access=read-only
default=
Displayed(tab/group)=WLAN GW Group Member (/WLAN GW Group)

isaMemberId Indicates an identification number for the WLAN GW ISA Group Member associated with this UE.

type=int
access=read-only
default=0
minimum=1
maximum=4

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

type=Date
access=read-only
Displayed(tab/group)=Last Access Point Move Time

macAddress Specifies the MAC address of this User Equipment.

type=MacAddress
access=read-create
Mandatory on create
Displayed(tab/group)=MAC Address (/Identification)

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
Displayed(tab/group)=MPLS Label

natPolicy Specifies the identifier of the NAT policy for this UE.

type=string
access=read-only
default=
Displayed(tab/group)=NAT

sessionTimeout Indicates the time when this UE's system context will be removed unconditionally. A session timeout can be imposed by an AAA server.

type=Date
access=read-only
Displayed(tab/group)=Session Timeout

siteId Network Element ID where UE is connected to.

type=string
access=read-only
default=
minimum=0
maximum=64
Displayed(tab/group)=Site ID (/Tunnel Router)

slaacAddr1 Indicates the SLAAC address (1 of 3).

type=InetAddress
access=read-only
Displayed(tab/group)=Address 1 (/SLAAC)

slaacAddr2 Indicates the SLAAC address (2 of 3).

type=InetAddress
access=read-only
Displayed(tab/group)=Address 2 (/SLAAC)

slaacAddr3 Indicates the SLAAC address (3 of 3).

type=InetAddress
access=read-only
Displayed(tab/group)=Address 3 (/SLAAC)

slaacAddrType Specifies the address type for SLAAC Addresses. The only values allowed are 'ipv6(2)'.

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

slaacLeaseExpire Indicates when the lease of the SLAAC prefix and addresses will expire.

type=Date
access=read-only
Displayed(tab/group)=Lease Expiration (/SLAAC)

slaacPrefix Indicates the SLAAC Prefix.

type=InetAddress
access=read-only
Displayed(tab/group)=Prefix (/SLAAC)

tuAddrType Specifies the address type for the IP address of remote and local endpoint of this UE 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 tunnel, that is the destination IP address in the tunnel header of received packets.

type=InetAddress
access=read-only
Displayed(tab/group)=Local IP Address (/Tunnel Router)

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
Displayed(tab/group)=Remote IP Address (/Tunnel Router)

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

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

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

type=Pointer
access=read-only
default=
Displayed(tab/group)=Routing Instance (/Tunnel Router)

tuRtrServiceId

type=long
access=read-only
default=0
Displayed(tab/group)=Router Service ID (/Tunnel Router)

ueAddress Specifies the IP address of this UE. NOTE: the current AP IP address is the value of the Remote Address.

type=InetAddress
access=read-only
default=
Displayed(tab/group)=IP Address (/Identification)

ueAddressType Indicates the address type of this UE.

type=rtr.InetAddressType
access=read-only

ueEncapsulation Indicates encapsulation used in this UE tunnel.

type=wlangw.WlanGwEncapType
access=read-only
default=notSpecified
Displayed(tab/group)=Encapsulation Type (/Tunnel Router)

ueRxOctets Indicates the number of octets received from this UE.

type=UInt128
access=read-only
default=0
Displayed(tab/group)=Received Octets (Transmitted/Received Statistics)

ueRxPkts Indicates the number of packets received from this UE.

type=UInt128
access=read-only
default=0
Displayed(tab/group)=Received Frames (Transmitted/Received Statistics)

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

type=string
access=read-only
Displayed(tab/group)=Access Point SSID

ueState Indicates the state of this User Equipment.

type=wlangw.QueryUeState
access=read-only
default=0
Displayed(tab/group)=UE State (/Identification)

ueTxOctets Indicates the number of octets transmitted to this UE.

type=UInt128
access=read-only
default=0
Displayed(tab/group)=Transmitted Octets (Transmitted/Received Statistics)

ueTxPkts Indicates the number of packets transmitted to this UE.

type=UInt128
access=read-only
default=0
Displayed(tab/group)=Transmitted Frames (Transmitted/Received Statistics)

vlanQTag Indicates the VLAN Q-Tag present in the traffic received from this UE. The value can be used to identify the retailer service, by means of the VLAN To Retailer Map. The value -1 indicates that the traffic received from this UE does not have VLAN Q-Tag

type=int
access=read-only
minimum=-2
maximum=4095
Displayed(tab/group)=VLAN Q-tag (/Identification)

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

retrieveWlanGwUeCount

Method to retrieve WLAN GW User Equipment count with specified parameters
Input Parameters:
aUeQueryStruct : wlangw.WlanGwQbtUeQueryStruct -
aInBridgeId : int - (Optional) Specifies the identifier of the bridge domain. Non-bridge domain User Equipment will have Bridge ID 0; And non-zero ID for bridged User Equipments. This is optional parameter. Default value is -1 if not specified.
aInVlanQTag : int - (Optional) Specifies the VLAN Q-tag present in the traffic received from this UE. The value minus one indicates that the traffic received from this UE does not have a VLAN Q-tag This is optional parameter. Default value is -2 if not specified.
timeout : long - (Optional) Specifies the timeout in 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 (300000ms).
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
Output Parameters:
ueObjectCount : long -
Exceptions:
wlangw.WlanGwQbtUe.retrieveWlanGwUeCountException

retrieveWlanGwUes

Method to retrieve WLAN GW User Equipments with specified parameters
Input Parameters:
aUeQueryStruct : wlangw.WlanGwQbtUeQueryStruct -
aInBridgeId : int - (Optional) Specifies the identifier of the bridge domain. Non-bridge domain User Equipment will have Bridge ID 0; And non-zero ID for bridged User Equipments. This is optional parameter. Default value is -1 if not specified.
aInVlanQTag : int - (Optional) Specifies the VLAN Q-tag present in the traffic received from this UE. The value minus one indicates that the traffic received from this UE does not have a VLAN Q-tag This is optional parameter. Default value is -2 if not specified.
timeout : long - (Optional) Specifies the timeout in 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 (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) -
Exceptions:
wlangw.WlanGwQbtUe.retrieveWlanGwUesException

validateQuery

Input Parameters:
siteId : string -
serviceId : long - (Optional)
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
Output Parameters:
validationResponse : Map (string to Any) -
Supported Network Elements
7750 SR Supported from 13.0.R4
  • Excluded chassis types: 7750-SRc12, 7750-SR1, 7750-SRc4, 7750-SRa4, 7750-SRa8, 7750-SR1 Fixed CFM, 7750 SR-1e, 7750 SR-2e, 7750 SR-3e, 7750 SR-7s, 7750 SR-14s, 7750 SR-1s, 7750 SR-2s
Product Specifics
7750 SR 20.0
7750 SR 21.0
7750 SR 22.0
7750 SR 23.0
7750 SR 24.0
7750 SR 25.0