| Overview | Package | Class | Deprecated | Help |
| Properties | |
|---|---|
| administrativeState |
The administrative state of the local user database.
type=netw.AdministrativeState default=tmnxOutOfService Displayed(tab/group)=Administrative State |
| description |
A user provided description for the local user database.
type=string default= minimum=0 maximum=80 Displayed(tab/group)=Description |
| dhcpCidMaskPreNum |
The dhcpCidMaskPreNum specifies the number of characters to remove
from the start of the incoming circuit ID before it is matched against
the value configured in DHCP Circuit ID.
type=long default=0 minimum=0 maximum=127 |
| dhcpCidMaskPreStr |
The dhcpCidMaskPreStr specifies a substring that is stripped of the
start of the incoming circuit ID before it is matched against the value
configured in DHCP Circuit ID.
This string can only contain printable ASCII characters.
Character '*' is a wildcard that matches any substring. It can be
escaped by character '\'.
type=string default= minimum=0 maximum=127 |
| dhcpCidMaskSufNum |
The dhcpCidMaskSufNum specifies the number of characters to
remove from the end of the incoming circuit ID before it is matched
against the value configured in configured in DHCP Circuit ID.
type=long default=0 minimum=0 maximum=127 |
| dhcpCidMaskSufStr |
The dhcpCidMaskSufStr specifies a substring that is stripped of
the end of the incoming circuit ID before it is matched against the
value configured in configured in DHCP Circuit ID.
This string can only contain printable ASCII characters.
Character '*' is a wildcard that matches any substring. It can be
escaped by character '\'.
type=string default= minimum=0 maximum=127 |
| displayedName |
The local user database name.
type=string access=read-create default= minimum=1 maximum=32 Mandatory on create Displayed(tab/group)=Displayed Name |
| hostCount |
The host count indicates how many hosts are configured
in this local user database.
type=long access=read-only default=0 minimum=0 maximum=315446399 Displayed(tab/group)=Host Counts |
| localuserdb.DhcpHost-Set |
type=Children-Set |
| localuserdb.DhcpUnmatchedHost-Set |
type=Children-Set |
| localuserdb.LocalUserDbDhcpMask-Set |
type=Children-Set |
| localuserdb.LocalUserDbPppMask-Set |
type=Children-Set |
| localuserdb.PppHost-Set |
type=Children-Set |
| localuserdb.PppUnmatchedHost-Set |
type=Children-Set |
| matchTypeDhcp1 |
Specifies the type of the first user match criterion.
The order of the user match criteria in the LocalUserDb
specifies the evaluation order.
The values of the matchTypeDhcp1,2,3,4 must be set consistently,
such that, if the value of matchTypeDhcp(i) is equal to 'none',
all subsequentmatchTypeDhcp(j) objects are also equal to 'none'.
type=localuserdb.DHCPMatchTypes default=none Displayed(tab/group)=Match Type IPoE 1 (IPoE.Match List) |
| matchTypeDhcp2 |
Specifies the type of the second user match criterion.
type=localuserdb.DHCPMatchTypes default=none Displayed(tab/group)=Match Type IPoE 2 (IPoE.Match List) |
| matchTypeDhcp3 |
Specifies the type of the third user match criterion.
type=localuserdb.DHCPMatchTypes default=none Displayed(tab/group)=Match Type IPoE 3 (IPoE.Match List) |
| matchTypeDhcp4 |
Specifies the type of the fourth user match criterion.
type=localuserdb.DHCPMatchTypes default=none Displayed(tab/group)=Match Type IPoE 4 (IPoE.Match List) |
| matchTypePpp1 |
Specifies the type of the first user match criterion.
The order of the user match criteria in the LocalUserDb
specifies the evaluation order.
The values of the matchTypePpp1,2,3 must be set consistently,
such that, if the value of matchTypePpp(i) is equal to 'none',
all subsequent matchTypeDhcp(j) objects are also equal to 'none'.
A replacement property for matchTypePppoe1.
type=localuserdb.PPPoEMatchTypes default=none Displayed(tab/group)=Match Type PPP 1 (PPP.Match List) |
| matchTypePpp2 |
Specifies the type of the second user match criterion. A replacement property for matchTypePppoe2.
type=localuserdb.PPPoEMatchTypes default=none Displayed(tab/group)=Match Type PPP 2 (PPP.Match List) |
| matchTypePpp3 |
Specifies the type of the third user match criterion. A replacement property for matchTypePppoe3.
type=localuserdb.PPPoEMatchTypes default=none Displayed(tab/group)=Match Type PPP 3 (PPP.Match List) |
| matchTypePppoe1 |
Specifies the type of the first user match criterion.
The order of the user match criteria in the LocalUserDb
specifies the evaluation order.
The values of the matchTypePppoe1,2,3 must be set consistently,
such that, if the value of matchTypePppoe(i) is equal to 'none',
all subsequentmatchTypeDhcp(j) objects are also equal to 'none'.
DEPRECATED: 9.0.R4 - replaced by matchTypePpp1 for Network Elements of Version 9.0R4 and Up type=localuserdb.PPPoEMatchTypes default=none |
| matchTypePppoe2 |
Specifies the type of the second user match criterion.
DEPRECATED: 9.0.R4 - replaced by matchTypePpp2 for Network Elements of Version 9.0R4 and Up type=localuserdb.PPPoEMatchTypes default=none |
| matchTypePppoe3 |
Specifies the type of the third user match criterion.
DEPRECATED: 9.0.R4 - replaced by matchTypePpp3 for Network Elements of Version 9.0R4 and Up type=localuserdb.PPPoEMatchTypes default=none |
| pppoeCidMaskPreNum |
The pppoeCidMaskPreNum specifies the number of characters to remove
from the start of the incoming circuit ID before it is matched against
the value configured in PPPoE Circuit ID.
type=long default=0 minimum=0 maximum=127 Displayed(tab/group)=PPPoE Circuit ID Mask Prefix Length (PPPoE.Circuit ID Mask) |
| pppoeCidMaskPreStr |
The pppoeCidMaskPreStr specifies a substring that is stripped of the
start of the incoming circuit ID before it is matched against the value
configured in PPPoE Circuit ID.
This string can only contain printable ASCII characters.
Character '*' is a wildcard that matches any substring. It can be
escaped by character '\'.
type=string default= minimum=0 maximum=127 Displayed(tab/group)=PPPoE Circuit ID Mask Prefix String (PPPoE.Circuit ID Mask) |
| pppoeCidMaskSufNum |
The pppoeCidMaskSufNum specifies the number of characters to
remove from the end of the incoming circuit ID before it is matched
against the value configured in PPPoE Circuit ID.
type=long default=0 minimum=0 maximum=127 Displayed(tab/group)=PPPoE Circuit ID Mask Suffix Length (PPPoE.Circuit ID Mask) |
| pppoeCidMaskSufStr |
The pppoeCidMaskSufStr specifies a substring that is stripped of
the end of the incoming circuitId before it is matched against the
value configured in configured in PPPoE Circuit ID.
This string can only contain printable ASCII characters.
Character '*' is a wildcard that matches any substring. It can be
escaped by character '\'."
type=string default= minimum=0 maximum=127 Displayed(tab/group)=PPPoE Circuit ID Mask Suffix String (PPPoE.Circuit ID Mask) |
| siteId |
The system address of a network element.
type=string access=read-create minimum=1 maximum=64 Mandatory on create Displayed(tab/group)=Site ID (/Site) |
| Properties inherited from ManagedObject |
|---|
| actionMask, children-Set, deploymentState, isFaultSquelched, name, objectFullName, selfAlarmed |
| Methods |
|---|
aInSiteId
: string -
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
result
: List (generic.CommonManagedEntityInformation) - The number of local user databases.
localuserdb.LocalUserDb.retrieveLocalUserDatabasesException
| Supported Network Elements | |
|---|---|
| 7750 SR | |
| 7705 SAR Gen 2 | |
| 7705 SAR Hm | |
| 7450 ESS |
Supported from 8.0.R1 until 10.0.R1
|
| 7210 SAS K |
Supported from 9.0.R3
|
| 7250 IXR | Supported from 13.1.R8 |
| Product Specifics | |
| 7210 SAS K 20.0 | |
| 7210 SAS K 21.0 | |
| 7210 SAS K 22.0 | |
| 7210 SAS K 23.0 | |
| 7210 SAS K 24.0 | |
| 7210 SAS K 25.0 | |
| 7450 ESS 20.0 | |
| 7450 ESS 21.0 | |
| 7450 ESS 22.0 | |
| 7450 ESS 23.0 | |
| 7450 ESS 24.0 | |
| 7450 ESS 25.0 | |