| Overview | Package | Class | Deprecated | Help |
| Properties | |
|---|---|
| address |
The IP address of this host.
The address can only be configured if the pool contains the empty string and
useGiAddress is 'false(2)'. Size 0|4|16 is supported.
type=InetAddress default=0.0.0.0 Displayed(tab/group)=IP Address (Address) |
| addressType |
The host address type.
type=rtr.InetAddressType access=read-only default=ipv4 |
| administrativeState |
The administrative state of the local user database host.
type=netw.AdministrativeState default=tmnxOutOfService Displayed(tab/group)=Administrative State |
| ancpString |
Specifies the ANCP string which is encoded in the identification strings.
type=string default= minimum=0 maximum=63 Displayed(tab/group)=ANCP String (Identification Strings/Identification Strings) |
| applicationProfileString |
Specifies the application profile string which is encoded in the identification strings.
type=string default= minimum=0 maximum=16 Displayed(tab/group)=Application Profile String (Identification Strings/Identification Strings) |
| categoryMapName |
type=string default= minimum=0 maximum=32 Displayed(tab/group)=Category Map Name (Identification Strings/Identification Strings) |
| circuitId |
The circuit ID to match against. If the value of this object is the empty string,
then it is not used.
type=string default= minimum=0 maximum=254 |
| circuitIdFormat |
The data type represents how the circuit Id is specified.
'ascii (2)': the circuit Id contains seven-bit ASCII characters
'hex (3)': the circuit Id contains octets. It must be displayed in hexadecimal format
because it contains non-printable characters.
type=localuserdb.CircuitIdFormat default=ascii |
| clientMacAddress |
The MAC address to match against. If the value is set to all zeros,
then it is not used.
type=MacAddress default=00-00-00-00-00-00 |
| derivedId |
Specifies a string to be matched with a string that uniquely identifies
a host and is derived by a Python script from packet content available during a PPP setup.
type=string default= minimum=0 maximum=255 |
| groupInterfaceName |
Specifies the name of the group interface where the IPoE or PPP sessions are established.
type=string default= minimum=0 maximum=32 Displayed(tab/group)=Group Interface Name |
| hostName |
The name of the host.
type=string access=read-create minimum=1 maximum=32 Mandatory on create Displayed(tab/group)=Host Name |
| interDestIdString |
Specifies the intermediate destination identifier which is encoded in the identification strings.
type=string default= minimum=0 maximum=32 Displayed(tab/group)=Intermediate Destination ID (Identification Strings/Identification Strings) |
| localUserDbName |
The local user database name.
type=string access=read-only default= |
| localUserDbNamePointer |
A pointer points to local DHCP server.
type=Pointer access=read-only Displayed(tab/group)=Local User Database |
| msapGroupInterfaceName |
type=string default= minimum=0 maximum=32 Displayed(tab/group)=MSAP Group Interface Name (/MSAP Defaults) |
| msapPolicyName |
type=string default= minimum=0 maximum=32 Displayed(tab/group)=MSAP Policy Name (/MSAP Defaults) |
| msapServiceId |
type=long default=0 minimum=0 maximum=2147483648 Displayed(tab/group)=MSAP Service ID (/MSAP Defaults) |
| optionNumber |
The option number that the local DHCP server uses to send the identification strings
to the DHCP or PPPoE clients.
If the value of this object is 0, then no identification strings will be sent.
type=int default=0 minimum=0 maximum=254 Displayed(tab/group)=Option Number (Identification Strings) |
| poolName |
The IP address pool which is used to search for an IP address for this host.
This can only be configured if object addressType is 'unknown(0)'
and object useGiAddress is 'false(2)'.
type=string default= minimum=0 maximum=32 Displayed(tab/group)=IP Address Pool Name (Address/IP Address Pool) |
| poolNameDelimiter |
A delimiter character to combine primary and secondary pool names.
type=string default= minimum=0 maximum=1 Displayed(tab/group)=Pool Name/ Client Pool Delimiter (Address) |
| remoteId |
The remote ID to match against. If the value of this object is the empty string,
then it is not used.
type=string default= minimum=0 maximum=510 |
| remoteIdFormat |
The data type represents how the remote Id is specified.
'ascii (2)': the remote Id contains seven-bit ASCII characters
'hex (3)': the remote Id contains octets. It must be displayed in hexadecimal format
because it contains non-printable characters.
type=localuserdb.CircuitIdFormat default=ascii |
| secondPoolName |
The secondary IP address pool which is used to search for an IP address for this host.
This can only be configured if use gateway interface Address is 'false'.
type=string default= minimum=0 maximum=32 Displayed(tab/group)=Second IP Address Pool Name (Address/IP Address Pool) |
| sessionServiceId |
Specifies the service ID of the service where the IPoE or PPP sessions are established.
type=long default=0 minimum=0 maximum=2147483647 Displayed(tab/group)=Service ID |
| slaProfileString |
Specifies the SLA profile string which is encoded in the identification strings.
type=string default= minimum=0 maximum=16 Displayed(tab/group)=SLA Profile String (Identification Strings/Identification Strings) |
| spiGroupId |
Specifies the SLA profile instance group identifier in the identification strings.
A value of minus one means that there is no group identifier configured."
type=long default=-1 minimum=-1 maximum=65535 Displayed(tab/group)=SLA Profile Instance Group ID (Identification Strings/Identification Strings) |
| subscriberIdString |
Specifies the subscriber ID string which is encoded in the identification strings.
type=string default= minimum=0 maximum=32 Displayed(tab/group)=Subscriber ID (Identification Strings/Identification Strings) |
| subscriberProfileString |
Specifies the subscriber profile string which is encoded in the identification strings.
type=string default= minimum=0 maximum=16 Displayed(tab/group)=Subscriber Profile String (Identification Strings/Identification Strings) |
| useClientPool |
Specifies if the IP address pool used to search for an IP address for this host is to be
indicated by the vendor-specific sub-option 13 of the DHCP option 82.
This object can only be set to 'true (1)' when the value of tmnxLocUsrDbPppoeAddrType is
'unknown (0)' and tmnxLocUsrDbPppoePool contains the empty string."
type=boolean default=false Displayed(tab/group)=Use Pool From Client (Address/Client Pool) |
| useGiAddress |
Specifies whether the GI address is used to search for an IP address for this host.
If the value of this object is set to 'true(1)', then the Gateway IP address is used.
This can only be set to 'true(1)' when the value of addressType is 'unknown(0)'
and poolName contains the empty string.
type=boolean default=false Displayed(tab/group)=Use Gateway Interface (GI) Address (Address) |
| useGiScope |
Specifies whether the GI address selects a single subnet or a pool.
The value of this attribute is only meaningful when the value of
UseGiAddress is set to true
type=localuserdb.GiAddressScopeType default=subnet Displayed(tab/group)=Gateway Interface (GI) Address Scope (Address) |
| Properties inherited from ManagedObject |
|---|
| actionMask, children-Set, deploymentState, isFaultSquelched, name, objectFullName, selfAlarmed |
| 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 | |
| 7705 SAR Gen 2 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 | |