Overview Package Class Deprecated Help

wlangw
WlanGwQbtTunnel

public class WlanGwQbtTunnel

Properties
apMacAddress Indicates the MAC address of the Access Point, as learned by this system. The value all zeroes indicates that the Access Point MAC is not known, either because there was no attempt to learn it, or because an attempt failed.

type=MacAddress
access=read-only
apMacAddressFailed Indicates if the learning of the MAC address of the Access Point failed.

type=boolean
access=read-only
apSapEncap Indicates the value of the label used to identify the SAP of the Access Point, as learned by this system. The value all zeroes indicates that the Access Point SAP is not known, either because there was no attempt to learn it, or because an attempt failed.

type=long
access=read-only
default=0
apSapPortId Indicates the ID of the access port of the Access Point, as learned by this system. The value all zeroes indicates that the Access Point SAP is not known, either because there was no attempt to learn it, or because an attempt failed.

type=long
access=read-only
default=503316480
encap Indicates the tunnel encapsulation. The value is learned from the latest UE associated with this tunnel; when a given Access Point changes its encapsulation, there may be a transition period where the system contexts of some UE of this tunnel already have the new encapsulation, while some other UE still seem to have the previous encapsulation.

type=wlangw.QueryTunnelEncapTypeEnum
access=read-only
default=0
firstMoveTime Indicates the time when this tunnel moved for the first time.

type=Date
access=read-only
grpInterfaceId Indicates the identifier of the group interface associated with this tunnel.

type=int
access=read-only
minimum=0
grpInterfaceServiceId

type=long
access=read-only
localAddr Indicates the IP address of the local endpoint of this tunnel, that is the destination IP address in the tunnel header of received packets.

type=InetAddress
access=read-create
default=
Mandatory on create
localAddrType Indicates the address type of localAddr. The only possible values are 'ipv4' and 'ipv6'.

type=rtr.InetAddressType
access=read-only
numUe Indicates the number of User Equipment's connected to this system through this tunnel.

type=long
access=read-only
minimum=0
maximum=4294967295
numUeDsm Indicates the number of DSM User Equipment's connected to this system through this tunnel.

type=long
access=read-only
numUeEsm Indicates the number of ESM User Equipment's connected to this system through this tunnel.

type=long
access=read-only
numUeL2w Indicates the number of layer-2 wholesale User Equipment's connected to this system through this tunnel.

type=long
access=read-only
numUeMigrant Indicates the number of migrant User Equipment's connected to this system through this tunnel.

type=long
access=read-only
numUeXcon Indicates the number of cross-connect User Equipment's connected to this system through this tunnel.

type=long
access=read-only
remoteAddr Indicates the IP address of the remote endpoint of this tunnel, that is the source IP address in the tunnel header of received packets.

type=InetAddress
access=read-create
default=
Mandatory on create
remoteAddrType Indicates the address type of remoteAddr. The only possible values are 'ipv4' and 'ipv6'.

type=rtr.InetAddressType
access=read-only
remoteUdpPort Indicates the UDP port of the remote endpoint of this tunnel, that is the source UDP port in the tunnel header of received packets. The value of this object is only relevant if the value of encap is equal to 'l2tp'.

type=int
access=read-only
minimum=1
maximum=65535
siteId Network Element ID where the tunneled traffic is routed.

type=string
access=read-only
minimum=0
maximum=64
tunnelServiceId Indicates the identifier of the service corresponding to the virtual router instance where the tunneled traffic is routed.

type=long
access=read-only
default=0
vlanEncapTag1 Indicates the VLAN tag in case of IEEE 802.1Q encapsulation, or the outer tag (service tag, ethertype 0x88a8) in case of IEEE 802.1ad encapsulation. If the value of encap is not equal to 'vlan', the value of vlanEncapTag1 is -1.

type=int
access=read-only
default=-1
minimum=-1
maximum=4095
vlanEncapTag2 Indicates the inner tag (customer tag, ethertype 0x8100) in case of qinq encapsulation. If the value of encap is not equal to 'vlan', the value of vlanEncapTag2 is -1.

type=int
access=read-only
default=-1
minimum=-1
maximum=4095
wlanIsaGroup Indicates the identifier of the WLAN Gateway ISA group that processes this tunnel.

type=int
access=read-only
minimum=0
maximum=4
wlanIsaMember Indicates the identifier of the ISA Group member that processes this tunnel.

type=long
access=read-only
  
Properties inherited from ManagedObject
actionMask, children-Set, deploymentState, isFaultSquelched, name, objectFullName, selfAlarmed
 
Methods

retrieveWlanGwTunnelCount

Method to retrieve WLAN GW Tunnels count with specified parameters
Input Parameters:
siteId : string - Specifies the Network Element to query.
tunnelServiceId : long - (Optional) Specifies the identifier of the service corresponding to the virtual router instance where the tunneled traffic is routed. Valid values are -1 for the Base Routing Instance, or a valid VPRN Service ID.
remoteAddr : string - (Optional) Specifies the IP address of the remote endpoint of the tunnel.
localAddr : string - (Optional) Specifies the IP address of the local endpoint of the tunnel.
addrFamily : rtr.InetAddressType - (Optional) Specifies the address family of the IP layer of the tunnel. The only values allowed are 'ipv4' and 'ipv6'.
encap : wlangw.QueryTunnelEncapType - (Optional) Specifies the encapsulation types present in the traffic received through a tunnel.
vlanEncapTag1 : int - (Optional) Specifies the VLAN tag in case of IEEE 802.1Q encapsulation, or the outer tag (service tag, ethertype 0x88a8) in case of IEEE 802.1ad encapsulation, present in the traffic received through a tunnel. This parameter is only valid when the encap type is 'vlan'. If the encap value is not 'vlan', the value of vlanEncapTag1 must be the default minus one.
vlanEncapTag2 : int - (Optional) Specifies the inner tag (customer tag, ethertype 0x8100) in case of qinq encapsulation present in the traffic received through a tunnel. This parameter is only valid when the encap type is 'vlan'. If the encap value is not 'vlan', the value of vlanEncapTag2 must be the default minus one.
apSapPortId : long - (Optional) Specifies the ID of the access port of the Access Point. If the encap value is not 'vlan', the value of apSapPortId must be the default 'invalid port ID' (503316480). Typically, the values of apSapPortId and apSapEncap are set together.
apSapEncap : long - (Optional) Specifies the value of the label used to identify the SAP of the Access Point. If the encap value is not 'vlan', the value of apSapEncap must be the default zero. Typically, the values of apSapEncap and apSapPortId are set together.
numUeMin : long - (Optional) Specifies the minimum number of UE's in the tunnel.
numUeMax : long - (Optional) Specifies the maximum number of UE's in the tunnel.
apMacAddressFailed : wlangw.QueryTunnelMacAddrFailedType - (Optional) Specifies if the learning of the MAC address of the Access Point failed.
ueType : wlangw.QueryTunnelUeType - (Optional) Specifies the set of UE type values. When the value of ueType is not zero, the response will contain only objects where the number of UE's in one of the states corresponding to ueType is within the range of numUeMin and numUeMax. Typically, numUeMin will have to be set to a non-default value of 1 or higher.
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:
tunnelObjectCount : long -
Exceptions:
wlangw.WlanGwQbtTunnel.retrieveWlanGwTunnelCountException

retrieveWlanGwTunnels

Method to retrieve WLAN GW Tunnels with specified parameters
Input Parameters:
siteId : string - Specifies the Network Element to query.
tunnelServiceId : long - (Optional) Specifies the identifier of the service corresponding to the virtual router instance where the tunneled traffic is routed. Valid values are -1 to indicate Base Routing Instance, or a valid VPRN Service ID.
remoteAddr : string - (Optional) Specifies the IP address of the remote endpoint of the tunnel.
localAddr : string - (Optional) Specifies the IP address of the local endpoint of the tunnel.
addrFamily : rtr.InetAddressType - (Optional) Specifies the address family of the IP layer of the tunnel. The only values allowed are 'ipv4' and 'ipv6'.
encap : wlangw.QueryTunnelEncapType - (Optional) Specifies the encapsulation types present in the traffic received through a tunnel.
vlanEncapTag1 : int - (Optional) Specifies the VLAN tag in case of IEEE 802.1Q encapsulation, or the outer tag (service tag, ethertype 0x88a8) in case of IEEE 802.1ad encapsulation, present in the traffic received through a tunnel. This parameter is only valid when the encap type is 'vlan'. If the encap value is not 'vlan', the value of vlanEncapTag1 must be the default minus one.
vlanEncapTag2 : int - (Optional) Specifies the inner tag (customer tag, ethertype 0x8100) in case of qinq encapsulation present in the traffic received through a tunnel. This parameter is only valid when the encap type is 'vlan'. If the encap value is not 'vlan', the value of vlanEncapTag2 must be the default minus one.
apSapPortId : long - (Optional) Specifies the ID of the access port of the Access Point. If the encap value is not 'vlan', the value of apSapPortId must be the default 'invalid port ID' (503316480).
apSapEncap : long - (Optional) Specifies the value of the label used to identify the SAP of the Access Point. If the encap value is not 'vlan', the value of apSapEncap must be the default zero.
numUeMin : long - (Optional) Specifies the minimum number of UE's in the tunnel.
numUeMax : long - (Optional) Specifies the maximum number of UE's in the tunnel.
apMacAddressFailed : wlangw.QueryTunnelMacAddrFailedType - (Optional) Specifies if the learning of the MAC address of the Access Point failed.
ueType : wlangw.QueryTunnelUeType - (Optional) Specifies the set of UE type values. When the value of ueType is not zero, the response will contain only objects where the number of UE's in one of the states corresponding to ueType is within the range of numUeMin and numUeMax. Typically, numUeMin will have to be set to a non-default value of 1 or higher.
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:
tunnelObjectList : List (generic.CommonManagedEntityInformation) -
Exceptions:
wlangw.WlanGwQbtTunnel.retrieveWlanGwTunnelsException

validateQuery

Input Parameters:
siteId : string - Site ID to be validated against sites managed by NFM-P.
tunnelServiceId : long - (Optional) Optional parameter. Service ID to be validated against services in NFM-P. Valid values are -1 for the Base Routing Instance, or a valid VPRN Service ID.
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 15.0.R1
  • Excluded chassis types: 7750-SRc12, 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