ressubscr
SubscriberBrg

Contains information about Subscriber Bridged Residential Gateway (BRG) instances.



public class SubscriberBrg

Properties
aaSubScope Specifies the scope of the AA subscriber associated with this BRG instance.

type=aapolicy.AaSubScopeType
default=subscriber
Displayed(tab/group)=AA Subscriber Scope

appProfile Specifies the application profile string associated with this BRG instance.

type=string
default=
Displayed(tab/group)=Application Profile

brgIpAddrType Indicates the address type of BRG IP Address

type=rtr.InetAddressType
access=read-only

brgIpAddress Indicates the IP address assigned to this BRG

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

brgProfile Indicates the BRG profile associated with this BRG.

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

connectivityVerification Specifies if periodic connectivity verification is being done for this BRG while none of its hosts are active. When the value of cvRetryTime is zero in the BRG profile associated with this BRG, the value of this property is equal to 'false'.

type=generic.TruthValue
default=false
Displayed(tab/group)=Connectivity Verification

connectivityVerificationLastTime If the value of connectivityVerification is equal to 'true', the value of this property indicates the time that the last connectivity verification test started. Otherwise, the 'year' octets contain zero.

type=Date
default=0
Displayed(tab/group)=Connectivity Verification Time Of Last Attempt

dhcp4EndAddr Indicates the End address of the DHCPv4 pool address range currently allocated to this BRG

type=InetAddress
access=read-only
default=
Displayed(tab/group)=End Address (/DHCP)

dhcp4EndAddrType Indicates the address type of DHCPv4 End Address

type=rtr.InetAddressType
access=read-only

dhcp4StartAddr Indicates the start address of the DHCPv4 pool address range currently allocated to this BRG

type=InetAddress
access=read-only
default=
Displayed(tab/group)=Start Address (/DHCP)

dhcp4StartAddrType Indicates the address type of DHCPv4 Start Address

type=rtr.InetAddressType
access=read-only

dhcp4SubnetAddr Indicates the DHCP IPv4 pool subnet currently allocated to this BRG.

type=InetAddress
access=read-only
default=
Displayed(tab/group)=Subnet Address (/DHCP)

dhcp4SubnetAddrType Indicates the address type of dhcp4SubnetAddr

type=rtr.InetAddressType
access=read-only

dhcp4SubnetPrefixLength Indicates the prefix length of the DHCP IPv4 pool subnet currently allocated to this BRG

type=int
access=read-only
minimum=0
maximum=32
Displayed(tab/group)=Prefix Length (/DHCP)

dhcpStreamAddrType Indicates the address type of DHCP Stream Address

type=rtr.InetAddressType
access=read-only

dhcpStreamAddress Indicates the IP address where this system streams the DHCP messages to that it receives from the hosts associated with this BRG

type=InetAddress
access=read-only
default=
Displayed(tab/group)=Stream Address (/DHCP)

dmzAddrInUse Indicates if the DMZ address assigned for this BRG is currently in use. While the value of dmzAddrType is equal to 'unknown', the value of dmzAddrInUse is not relevant

type=generic.TruthValue
access=read-only
default=false
Displayed(tab/group)=Address In Use (/DMZ)

dmzAddrType Indicates the address type of .

type=rtr.InetAddressType
access=read-only

dmzAddress Indicates the De-Militarized Zone (DMZ) address currently allocated to this BRG. Such a DMZ address is typically used for a server in the subscriber's home.

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

dns1AddrV4Type Indicates the address type of DNS 1 Address V4.

type=rtr.InetAddressType
access=read-only

dns1AddrV6Type Indicates the address type of DNS 1 Address V6.

type=rtr.InetAddressType
access=read-only

dns1AddressV4 Indicates the IP address V4 of the primary DNS server of the hosts associated with this BRG

type=InetAddress
access=read-only
default=
Displayed(tab/group)=Primary IPv4 Address (/DNS Server)

dns1AddressV6 Indicates the IP address V6 of the primary DNS server of the hosts associated with this BRG

type=InetAddress
access=read-only
default=
Displayed(tab/group)=Primary IPv6 Address (/DNS Server)

dns2AddrV4Type Indicates the address type of the secondary DNS 1 Address V4.

type=rtr.InetAddressType
access=read-only

dns2AddrV6Type Indicates the address type of the secondary DNS 1 Address V6.

type=rtr.InetAddressType
access=read-only

dns2AddressV4 Indicates the IP address V4 of the secondary DNS server of the hosts associated with this BRG

type=InetAddress
access=read-only
default=
Displayed(tab/group)=Secondary IPv4 Address (/DNS Server)

dns2AddressV6 Indicates the IP address V6 of the secondary DNS server of the hosts associated with this BRG

type=InetAddress
access=read-only
default=
Displayed(tab/group)=Secondary IPv6 Address (/DNS Server)

egressIpv4Filter Indicates if and how the Egress IP filter specified in the SLA-profile is overruled.

type=long
access=read-only
Displayed(tab/group)=Egress IPv4 (/Override Filters)

egressIpv6Filter Indicates if and how the Egress IPv6 filter specified in the SLA-profile is overruled.

type=long
access=read-only
Displayed(tab/group)=Egress IPv6 (/Override Filters)

ingressIpv4Filter Indicates if and how the Ingress IP filter specified in the SLA-profile is overruled.

type=long
access=read-only
Displayed(tab/group)=Ingress IPv4 (/Override Filters)

ingressIpv6Filter Indicates if and how the Ingress IPv6 filter specified in the SLA-profile is overruled.

type=long
access=read-only
Displayed(tab/group)=Ingress IPv6 (/Override Filters)

leaseTime Indicates the lease time of the hosts associated with this BRG."

type=long
access=read-only
units=seconds
Displayed(tab/group)=Lease Time (/DHCP)

natL2AwHostPortBlkSize Indicates indicates the size of the outside port block allocated to each host of the NAT subscriber associated with this BRG, if per-host port ranges are used for this NAT subscriber; per-host port range allocation is triggered by a RADIUS message with the 'Alc-Per-Host-Port-Range' attribute. Otherwise, all hosts share the same block, and the value of this object is zero.

type=long
access=read-only
Displayed(tab/group)=NAT Per-host Port Block Size

nbns1AddrType Indicates the address type of the primary NBNS server.

type=rtr.InetAddressType
access=read-only

nbns1Address Indicates the IP address of the primary NBNS (Netbios Name Server) server of the hosts associated with this BRG

type=InetAddress
access=read-only
default=
Displayed(tab/group)=Primary IPv4 Address (/NBNS Server)

nbns2AddrType Indicates the address type of the secondary NBNS server.

type=rtr.InetAddressType
access=read-only

nbns2Address Indicates the IP address of the secondary NBNS (Netbios Name Server) server of the hosts associated with this BRG

type=InetAddress
access=read-only
default=
Displayed(tab/group)=Secondary IPv4 Address (/NBNS Server)

proxyAuthenticated Indicates if the BRG was authenticated by the RADIUS proxy.

type=generic.TruthValue
access=read-only
default=false
Displayed(tab/group)=Authentication RADIUS Proxy

remainHoldTime Indicates the time interval until the hold timer expires in seconds. The start value of the hold timer is taken from the hold time configured in BRG profile associated with this Bridged Residential Gateway

type=Time
access=read-only
units=seconds

remainHoldTimeDays Indicates the time interval until the hold timer expires in days

type=int
access=read-only
Displayed(tab/group)=Days (/Remaining Hold Time)

remainHoldTimeHours Indicates the time interval until the hold timer expires in hours

type=int
access=read-only
Displayed(tab/group)=Hours (/Remaining Hold Time)

remainHoldTimeMins Indicates the time interval until the hold timer expires in minutes

type=int
access=read-only
Displayed(tab/group)=Minutes (/Remaining Hold Time)

remainHoldTimeSecs Indicates the time interval until the hold timer expires in seconds

type=int
access=read-only
Displayed(tab/group)=Seconds (/Remaining Hold Time)

remainInitialHoldTime Indicates the time interval until the initial hold timer expires. The start value of the initial hold timer is taken from value configured in BRG profile associated with this Bridged Residential Gateway.

type=Time
access=read-only
units=seconds

remainInitialHoldTimeDays Indicates the time interval until the initial hold timer expires in days.

type=int
access=read-only
Displayed(tab/group)=Days (/Remaining Initial Hold Time)

remainInitialHoldTimeHours Indicates the time interval until the initial hold timer expires in hours.

type=int
access=read-only
Displayed(tab/group)=Hours (/Remaining Initial Hold Time)

remainInitialHoldTimeMins Indicates the time interval until the initial hold timer expires in minutes.

type=int
access=read-only
Displayed(tab/group)=Minutes (/Remaining Initial Hold Time)

remainInitialHoldTimeSecs Indicates the time interval until the initial hold timer expires in seconds.

type=int
access=read-only
Displayed(tab/group)=Seconds (/Remaining Initial Hold Time)

remainUplinkInitWait Specifies the time interval until the uplink initial wait timer expires. The start value of the hold timer is taken from the BRG profile associated with this Bridged Residential Gateway.

type=int
default=0
units=seconds
Displayed(tab/group)=Remaining Uplink Initial Wait

remainUplinkInitWaitDays Specifies the time interval until the uplink initial wait timer expires in Days.

DEPRECATED: 18.12 - Its value will always be zero.Use ressubscr.SubscriberBrg.remainUplinkInitWait instead.
type=int
access=read-only

remainUplinkInitWaitHours Specifies the time interval until the uplink initial wait timer expires in Hours.

DEPRECATED: 18.12 - Its value will always be zero.Use ressubscr.SubscriberBrg.remainUplinkInitWait instead.
type=int
access=read-only

remainUplinkInitWaitMins Specifies the time interval until the uplink initial wait timer expires in Minutes.

DEPRECATED: 18.12 - Its value will always be zero.Use ressubscr.SubscriberBrg.remainUplinkInitWait instead.
type=int
access=read-only

remainUplinkInitWaitSecs Specifies the time interval until the uplink initial wait timer expires in Seconds.

DEPRECATED: 18.12 - Its value will always be zero.Use ressubscr.SubscriberBrg.remainUplinkInitWait instead.
type=int
access=read-only

ressubscr.BrgFilterEntry-Set type=Children-Set
ressubscr.BrgQosOverride-Set type=Children-Set
ressubscr.SubBrgAddressPool-Set type=Children-Set
ressubscr.SubBrgPoolBinding-Set type=Children-Set
ressubscr.SubscriberBrgHost-Set type=Children-Set
rtrAdvPolicy Specifies the name of the router advertisement policy associated with the Bridged Residential Gateway (BRG) instance.

type=string
default=
Displayed(tab/group)=Router Advertisement Policy

siteId Indicates the System IP address of the node where BRG Entry exists.

type=InetAddress
access=read-create
default=
Mandatory on create
Displayed(tab/group)=Site ID

siteIdAddressType

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

siteName

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

slaProfile Indicates the SLA profile associated with this BRG.

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

slaacPool Indicates the SLAAC pool associated with this BRG. A non-empty value originates from the value of a Radius Alc-SLAAC-IPv6-Pool attribute received for this BRG.

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

slaacPrefix Indicates the SLAAC IPv6 prefix configured for the BRG. This is provided by the AAA server, for example with the Framed-IPv6-Prefix attribute in the Radius Access-Accept message. This prefix is unique for each BRG and shared by its hosts

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

slaacPrefixLength Indicates the prefix length of the SLAAC prefix configured for the BRG.

type=int
access=read-only
minimum=0
maximum=128
Displayed(tab/group)=Prefix Length

slaacPrefixState Specifies the state associated with the value of slaacPrefix. The value of this property is 'notApplicable' if the value of slaacPrefixType is equal to 'unknown'. If the SLAAC prefix is valid, hosts can use it; if the SLAAC prefix is expired, no new hosts can start using it, though existing hosts may continue to use it for a while.

type=ressubscr.SlaacPrefixState
default=notApplicable
Displayed(tab/group)=SLAAC Prefix State

slaacPrefixType Indicates the address type of SLAAC prefix

type=rtr.InetAddressType
access=read-only

standbyIpLifetime Indicates the lifetime in seconds of stand-by IP addresses associated with this BRG

type=Time
access=read-only
units=seconds

standbyIpLifetimeDays Indicates the lifetime in days of stand-by IP addresses associated with this BRG

type=int
access=read-only
Displayed(tab/group)=Days (/DHCP/Standby IP Lifetime)

standbyIpLifetimeHours Indicates the lifetime in hours of stand-by IP addresses associated with this BRG

type=int
access=read-only
Displayed(tab/group)=Hours (/DHCP/Standby IP Lifetime)

standbyIpLifetimeMins Indicates the lifetime in minutes of stand-by IP addresses associated with this BRG

type=int
access=read-only
Displayed(tab/group)=Minutes (/DHCP/Standby IP Lifetime)

standbyIpLifetimeSecs Indicates the lifetime in seconds of stand-by IP addresses associated with this BRG

type=int
access=read-only
Displayed(tab/group)=Seconds (/DHCP/Standby IP Lifetime)

state Indicates the state of the BRG: - initialized: init timer is running; waiting for the first host; - operational: normal operating state, with dynamic hosts; - connectivityVerification: no hosts, pinging the residential gateway; - hold: no hosts attached, in hold.

type=ressubscr.StateType
access=read-only
Displayed(tab/group)=State

subBrgId Indicates the string that uniquely identifies this BRG.

type=string
access=read-create
Mandatory on create
Displayed(tab/group)= BRG ID

subscrProfile Indicates the subscriber profile associated with this BRG.

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

upnpPolicyOverride Indicates the RADIUS override of the UPnP policy associated with this BRG. An empty value indicates that there is no such override; a non empty value replaces the value of the object tmnxSubProfUpnpPolicy of the subscriber profile indicated with tmnxSubBrgSubProfile

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

v4PortalUrl Indicates the URL of the IPv4 web portal associated with this BRG.

type=string
access=read-only
default=
Displayed(tab/group)=IPv4 URL (/Web Portal)

v6PortalUrl Indicates the URL of the IPv6 web portal associated with this BRG.

type=string
access=read-only
default=
Displayed(tab/group)=IPv6 URL (/Web Portal)

vasFilter Indicates the VAS filter used by this BRG Instance.

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

wlanGwBridgeId Specifies the Bridge ID of this BRG.

type=long
default=0
Displayed(tab/group)=Bridge ID

  
Properties inherited from ManagedObject
actionMask, children-Set, deploymentState, isFaultSquelched, name, objectFullName, selfAlarmed
 
Supported Network Elements
7750 SR Supported from 14.0.R1
7450 ESS Supported from 14.0.R1
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
7750 SR 20.0
7750 SR 21.0
7750 SR 22.0
7750 SR 23.0
7750 SR 24.0
7750 SR 25.0