ZHONE-GEN-SUBSCRIBER: View SNMP OID List / Download MIB

The MIB module to describe objects for the Subscriber or End user of the system. The MIB contains tables that define subscriber infomation, data services, and voice mapping. While there is a single data mapping entry for each subscriber there can be multiple voice entries (phone lines) per subscriber.

The next available Subscriber ID (subId) that can be used by the manager when creating a subscriber ID. A Get request to this field causes the current number to be returned and the value to be incremented for the next requester.

The next available index that can be used by the manager when creating protocol specific end point connections. For example, when a new voice subscriber record is being added, the ATM/GR303/etc. protocol specific information is contained in the associated protocol tables (AAL2 mib and GR303 mibs) these indices are used for row creation in these tables. A per protocol type index scheme was not used to allow flexibility in adding additional protocol support. A Get request to this field causes the current number to be returned and the value to be incremented for the next requester.

A table of the top level subscriber information in a PLS system. Each subscriber has an entry in table for each physical connection provisioned for the subscriber, the type of IAD in use and line rate both the provioned line rate (subMaxAllowedLineRate) and the line rate at which the circuit can operate at (subMaxCapableLineRate).

The subscriber table is indexed by the subscriber ID which is a numeric ID used by the system to uniquely identify each subscriber and the LgId which identified the line group (physical) line that is used by the subscriber. A subscriber may have multiple entries, implying that the subscriber has multiple lines or IADs, each entry has a unique line or lgId.

Unique numeric ID used to define a subscriber in the system. It is also used as the index to the subDataConnectionTable and subVoiceConnectionTable.

The line group entry ID is the LgId defined in the Line Group Redundancy MIB. LgId identifies the physical line or line group (primary and redundant secondary) used for data and voice traffic. This is a unique number that is assigned when a line redundancy group is provisioned - this allows the operator to locate the physical lines (defined by the line group entry ID) used by the subscriber. This is used as an index into the subInfoTable, subDataConnectionTable and the subVoiceConnectionTable allowing a subscriber own multiple lines. Required for row creation.

Admninstratively defined name used to aid operators identify subscribers in the system, the name is for operator reference only. Required for row creation.

Unique service provider ID. This value is used throughout the management system to link objects with customers or service providers.

Identifies the type of IAD that is used by the the subscriber. Required for row creation. Enumeration: 'zedgeH2AO': 9, 'zedgeH2A': 8, 'matP': 6, 'zedgeBH2A': 7, 'zedge65': 4, 'other': 1, 'zedge64S': 3, 'zedge64T': 2, 'zedge100': 5.

The maximum line rate that the subscriber is provisioned to receive from the service provider. This value is the total line rate or bandwidth of the subscriber's connection including voice, data and video. This number may be less than or equal to the subMaxCapableLineRate. Required for row creation.

The maximum line rate that can be supported by the subscriber line. This rate is determined by several factors including the distance the subscriber is from the CO, the copper facilities to the subscriber and the type of IAD installed. This value is determined by the service provider. Required for row creation.

The next available connection index which can be used for this subscriber and lgid pair. This is used for the creation of a voice connection entry.

Used to control row creation and deletion. subName, subLgId, subIadType, subMaxAllowedLineRate, subMaxCapableLineRate are required for row creation.

The Subscriber Data Conection Table is used to provision the services and connections that a subscriber requires for IP data services. The key entry in the table is the subDataIfIndex which identifies the specific interface that is providing data connection services. Other entries focus on subscriber specific data options and the status of the subscriber's connection. The table is indexed by subId, subLgId and subDataIfIndex allowing multiple data records to be provisioned per subscriber. Note: the IP data record must be created first prior to this associated subscriber data connection entry

An entry in the Subscriber Data Connection Table

This object should be made equal to the ifIndex used to identify the entry in the interfaceTable that defines the IP record for the interface used by the subscriber.

The current IP operational status of the subscriber's data interface, this status reflects the ifOperStatus of the interface MIB using the identical syntax. up(1) - ready to pass packets down(2) - the admin status is down or there is a fault that prevents the interface from passing packets testing(3) - the interface has been placed is a testing state by the administrator unknown(4) - the status can not be determined for some reason dormant(5) - not definition in the interface MIB notPresent(6) - some component is missing lowerLayerDown(5) - down due to state of lower-layer inteface(s) Enumeration: 'dormant': 5, 'lowerLayerDown': 7, 'unknown': 4, 'testing': 3, 'up': 1, 'down': 2, 'notPresent': 6.

The subscriber or user logon ID. The value of the logon may be managed in different ways depending on the service provider. In some cases the service will not require a logon or password. The default value is a NULL string.

The password is used by the subscriber in conjunction with the subUserLogonID to gain access to features or services provided by the service provider. The password object is only valid if the subUserLogonId is used. The default value is a NULL string.

This value limits the maximum number of IP addresses that can be assigned by the DHCP server to the subscriber's IAD. Allowing multiple addresses to be assigned allows the subscriber to have multiple devices attached to the IAD data port without having to provide DHCP or routing services. The default value is 1. Required for row creation.

This value indicates the number of IP addresses that are currently being used by the subscriber. This value cannot exceed subDataMaxAddrAllowed.

The IP address currently assigned to the subscriber. If more than one address is assigned then this value should indicate the most recently assigned IP address assigned to the subscriber. The full list of addresses assigned to the subscriber can be found in the DHCP tables.

Indicates if stats are enabled for this user for debugging purposes. If the status are enabled the stats can be examined via the IpRec MIB stats table. The stats associated with this subscriber are indicated by the subIpIfIndex. Enumeration: 'disabled': 2, 'enabled': 1.

Use to control row creation and deletion. subDataMaxAddrAllowed is required for row creation.

The Voice Subscriber Mapping Table. This table associates pairs of interface addresses used by a voice subscriber. The mapping table associates two enpoints (endPoint1 and endPoint2) pairs. Each row is indexed by the subscriber id, line group Id along with the voice connection index (see subNextVoiceConnectionIndex described in in the subscriber table. Each row contains the definitions of the two endpoints which at this level, is defined as the protocol type for the endpoint and an index into the associated protocol specific table. Each associated protocol table, contained in the appropriate protocol mib, contains the information required to define the end point (i.e. vpi/vci/cid in the case of AAL2). So, a row can be used to map a subscriber POTS line to a class 5 switch phone number. For example, an AAL2 endpoint is represented by endpoint1 and has defined a type and the index for the AAL2 connection table defined in the AAL2 mib. A GR-303 endpoint2 is represented by the endpoint2 type of GR-303 and an index into the associated GR-303 mib. This mib contains the GR-303 IG name and CRV value (see GR0303 MIB). The admin status is used to enable/disable the connection. This is only used during the creation and deletion process of this entry along with the associated type table entries. The process is a two step approach where the manager creates a voice connection entry with admin status down which causes dummy protocol table entries to be added in the EP1 and EP2 (dummy being row entries with 0/NULL values) protocol tables (since indexes and ep types are specified on the row create), manager sets the appropriate protocol specific entries in the associated mibs, and then changes the admin status to active. All entries (the two protocol specific tables, and the voice connection entry) are tightly coupled and therefore, the deletion process is exactly the same. The manager deletes the voice connection entry and the handler automatically deletes the associated protocol table entries. AdminStatus must be set to down before the deletion can occur. Because of this tight coupling, the EndPoint values (both indexes and types) cannot be modified but must have the row deleted and readded with the appropriate information. The protocol specific tables are always INDEXED as the index defined in either the endpoint1 or endpoint2 index fields. This scheme allows flexibility in defining and expanding the types of connections and allows for use of protocols of the same type to be defined at both endpoints.

Each entry defines a specific voice connection associated with the subscriber/lgid pair. Each entry consists of a connection type and two globally unique indicies which are used to index into protocol specific address tables that contain the logical addresses which make up this voice subscriber's connection. When a connection entry is created, the endpoint values (both type and index) must be valid. 0 values are not allowed.

The connection index is used to indentify this connection pair. The number itself is meaningful only for defining a connection set for this subscriber/lgid pair and no association with particular connection number can be made by a manager. When creating a new voice connection, the next available index is obtained via the subNextVoiceConnectionIndex variable in the subscriber mib.

This describes the connection type between the two end points referred to by the subVoiceEndPointProtocol indices. Where applicable the first endpoint refers to the line or premise side of the connection and the second endpoint refers to the central office side of the connection. The following connection types are defined, more types will added as services are expanded on the BAN, MALC, Sechtor and ZEdge. aal2ToGr303 - aal2 VPI/VCI/CID to Gr303 interface group/ CRV aal2ToV52 - aal2 VPI/VCI/CID to V52 interface/userport. voipToGr303 - VoIP using SIP or MGCP to Gr303 interface group/CRV. potsToAal2 - pots line to aal2 VPI/VCI/CID. isdnToAal2 - isdn to aal2 VPI/VCI/CID. potsToGr303 - pots line to Gr303 interface group/CRV. potsToV52 - pots line to V52 interface/userport. voipToDs1 - VoIP using either SIP or MGCP to channelized voice on a DS1. NOTE!!! sipToGr303 is not supported. Please use voipToGr303. sipToGr303 - VoIP using SIP to Gr303 interface group/CRV. voipToV52 - VoIP using either SIP or MGCP to V52 interface/userport. elcpAal2ToV52 - ELCP Aal2 VPI/VCI/portId/portType to V52. interface/userport. ATM VCC's with no ELCP uses aal2ToV52. type instead. isdnToV52 - Isdn to V52 (ULC to Uplink). ebsToGr303 - EBS to Gr303 (ULC to Uplink). voipToPots - VoIP using either SIP or MGCP to POTS (zedge6200em). isdnsigToVoip - VoIP using either SIP or MGCP to ISDN voipToTr008 - VoIP using either SIP or MGCP to TR-008 tr008Grp/chan isdnToVoip - Isdn to VOIP. Enumeration: 'voipToEbs': 19, 'potsToGr303': 6, 'voipToV52': 10, 'aal2ToV52': 2, 'voipToDs1': 8, 'potsToV52': 7, 'potsToDs1': 16, 'elcpAal2ToV52': 11, 'ebsToGr303': 13, 'isdnsigToVoip': 15, 'isdnToVoip': 20, 'isdnToAal2': 5, 'potsToAal2': 4, 'aal2ToGr303': 1, 'voipToGr303': 3, 'voipToPots': 14, 'sipToGr303': 9, 'voipToTr008': 18, 'isdnToV52': 12.

The index into the associated address table for this end point. EndPoint1 should describe the line or premise side of the connection where applicable. This table contains any specific protocol information required to defined this half of the voice connection. Required for row creation.

The index into the associated address table for this end point. EndPoint2 should describe the central office side of the connection where applicable. This table contains any specific protocol information required to defined this half of the voice connection. Required for row creation

A text string describing this voice call entry.This value is not used by the system and is provided for operator reference only. A common use will be to define the external or public phone number for this voice line as assigned by the class 5 switch. Required for row creation.

The Admin State for this connection. Required for row creation. Enumeration: 'disabled': 2, 'enabled': 1.

Used to control row creation and deletion. A row in this table is created using a single SNMP SET request with varbinds for: a) subVoiceRowStatus set to'CreateAndGo' and the subid, lgid, and connectionindex as an index, b) the following READ-CREATE object(s) without a default value (DEFVAL): * subVoiceEndPoint1AddrIndex * subVoiceEndPoint2AddrIndex * subVoiceConnectionType * subVoiceExtPhoneNumber

Is this connection part of a huntGroup? Currently this is only valid if connection type is sipToDs1 or sipToPots. If this is TRUE then EndPoint2 does not contain any protocol specific information

First set of features that are enabled for the subscriber. Absence of the feature in the list will disable the feature for the subscriber. Bit Feature ^^^ ^^^^^^^ 1 hookflash detection 2 onhook signaling 3 always offhook, call is established as soon as incoming call initiation is made. 4 plar. 5 Call Wait 6 Call Transfer 7 Conference (3-way local conference bridging) 8 Line side supervision through Reverse Battery 9 Voice Only 10 Hotline 11 Warmline 12 Line side supervision through tone 13 DTMF mode as RFC-2833 14 DTMF mode as inband 15 COD - Enable Call on Disconnect for SIP 16 Dataonly 17 Centrex - Enable centrex based features. Bits: 'conference': 6, 'onhooksignaling': 1, 'alwaysoffhook': 2, 'callwait': 4, 'warmline': 10, 'dataonly': 15, 'plar': 3, 'lss-tone': 11, 'hookflash': 0, 'voiceonly': 8, 'dtmf-inband': 13, 'hotline': 9, 'cod': 14, 'dtmf-rfc2833': 12, 'lss-rb': 7, 'centrex': 16, 'calltransfer': 5.

This table provides the AAL2 call information for this specific subscriber, lgid, and call index. A row in this table is automatically created when the subVoiceConnectionType entry requires a aal2 entry.

An entry in the Aal2 table.

The index into this table containing the AAL2 end point information. This index is equal to the index defined for the aal2 endpoint in the subVoiceConnectionTable.

The line group ID for this AAL2 connection.

The aal2 vpi for this connection.

The aal2 vci for this connection.

The aal2 cid for this connection. 1-254 for jetstream. 16-255 for non-jetstream.

This table provides the GR303 call information for this specific subscriber, lgid, and call index. A row in this table is automatically created when the subVoiceConnectionType entry requires a GR303 entry.

An entry in the GR303 table.

The index into this table containing the GR303 end point information. This index is equal to the index defined for the GR303 endpoint in the subVoiceConnectionTable.

The IG name for the associated connection.

The crv for this connection. See the comVoiceGr303 mib.

This table provides the V5.2 call information for this specific subscriber, lgid, and call index. A row in this table is automatically created when the subVoiceConnectionType entry requires a V5.2 entry.

An entry in the V52 table.

The index into this table containing the V5.2 end point information. This index is equal to the index defined for the V5.2 endpoint in the subVoiceConnectionTable.

The Link name for the associated connection.

The user connection entry for this connection. See the comVoiceV52 mib.

The type of user port being defined. Enumeration: 'isdnBChannel': 3, 'pots': 1, 'isdnDChannel': 2.

The ISDN B or D channel used in the case that subVoiceV52UserType is not set to pots.

This table provides the POTS call information for this specific subscriber, lgid, and call index. A row in this table is automatically created when the subVoiceConnectionType entry requires a POTS entry.

An entry in the POTS table.

The index into this table containing the POTS end point information. This index is equal to the index defined for the POTS endpoint in the subVoiceConnectionTable.

The line group ID for the associated connection.

The hunt group this subscriber is part of. Each subscriber can be part of 3 hunt groups. The hunt group endpoint index is endpt2 index of the subscriber-voice connection which has huntgroup as TRUE

The hunt group this subscriber is part of. Each subscriber can be part of 3 hunt groups. The hunt group endpoint index is endpt2 index of the subscriber-voice connection which has huntgroup as TRUE

The hunt group this subscriber is part of. Each subscriber can be part of 3 hunt groups. The hunt group endpoint index is endpt2 index of the subscriber-voice connection which has huntgroup as TRUE

This table provides the ISDN call information for this specific subscriber, lgid, and call index. A row in this table is automatically created when the subVoiceConnectionType entry requires a ISDN entry.

An entry in the ISDN table.

The index into this table containing the ISDN end point information. This index is equal to the index defined for the ISDN endpoint in the subVoiceConnectionTable.

The line group ID for the associated connection.

The type of this channel for this connection. Enumeration: 'isdnBChannel': 2, 'isdnDChannel': 1.

The channel nummber used for this connection.

This group contains objects associated with Zhone Subscriber Records

This table provides the call information for this specific subscriber, lgid, and call index. A row in this table is automatically created when the subVoiceConnectionType entry requires a DS1 entry.

An entry in the subVoiceDs1Table.

The index into this table containing the DS1 end point information. This index is equal to the index defined for the DS1 endpoint in the subVoiceConnectionTable.

The DS0 assigned to this subscriber. The same DS0 channel cannot appear in more than 1 row within this table.

The line group Interface Index of the DS1 interface.

The hunt group this subscriber is part of. Each subscriber can be part of 3 hunt groups. The hunt group endpoint index is endpt2 index of the subscriber-voice connection which has huntgroup as TRUE

The hunt group this subscriber is part of. Each subscriber can be part of 3 hunt groups. The hunt group endpoint index is endpt2 index of the subscriber-voice connection which has huntgroup as TRUE

The hunt group this subscriber is part of. Each subscriber can be part of 3 hunt groups. The hunt group endpoint index is endpt2 index of the subscriber-voice connection which has huntgroup as TRUE

This table provides the call information for this specific subscriber, lgid, and call index. A row in this table is automatically created when the subVoiceConnectionType entry requires a SIP or MGCP entry.

An entry in the subVoiceVoip table.

The index into this table containing either SIP or MGCP end point information. This index is equal to the index defined for either the SIP or MGCP endpoint in the subVoiceConnectionTable.

A unique string that identifies the user in the system. If this string is not unique, error of inconsisten value is returned.

The directory number, e.g., phone number, assigned to this endpoint. Contains only digits. This number must be unique across subscriber-voice-voip in the system If not, error of inconsistent value is returned.

Interface Index of the LP Interface through which the SIP signalling and RTP traffic will flow.

Defines the preferred voice codec to be used for this subscriber.

Indicates whether a subscriber may consume bandwidth by switching to g711, when a fax, modem, b-channel data session is detected.

Indicates the number of voice frames per IP packet.

Indicates the byte order to be used when g.726 voice coding is in use. Cisco uses little endian byte order, whereas the g.726 standard calls for big endian byte order. Enumeration: 'littleEndian': 2, 'bigEndian': 1.

Authentication string needed for call originations through a SIP/MGCP Server. The SIP/MGCP URI acts as the username.

Is this subscriber PLAR (private line automatic ringdown) subscriber. If true we immediately send a INVITE instead of play dialtone, collect digits

This object specifies the type of address contained in the associated instance of subVoiceVoipPlarDestIpAddr.

The destination IP address to send INVITE to in case the subscriber is PLAR

Specifies the UDP Port number for the VOIP Setup messages. 5060 is the IANA Registered SIP port.

Voip Registration Server Address. A number between 1 and 255 which identifies the Voip Server that is responsible for this particular end point. If this value is not 0, a voip-server-entry with this address as the appl must exist. If not, error of wrong value is returned. For plar, this value must be 0, or wrong value is returned. Also, a voip-server-entry with address 255/255 must exist. If not, error of resource unavailable is returned.

Defines t38 fax protocol used for this subscriber

Authorization username used for calculating the credentials, when we receive 401/407 response. This field is optional, if not configured, then it's value is same as username field

The directory number to auto dial when hotline or warmline feature is activated for the subscriber.

Specifies the timer in seconds to wait before dialing hotline DN when hotline or warmline feature is enabled.

This table provides the ELCP AAL2 call information for this specific subscriber, lgid, and call index. A row in this table is automatically created when the subVoiceConnectionType entry requires an ELCP aal2 entry.

An entry in the ELCP Aal2 table.

The index into this table containing the ELCP AAL2 end point information. This index is equal to the index defined for the ELCP aal2 endpoint in the subVoiceConnectionTable.

The line group ID for this ELCP AAL2 connection.

The aal2 vpi for this connection.

The aal2 vci for this connection.

The port ID to identify an IAD port on the CP side. PortId in combination with PortType uniquely identifies a port on the IAD side for this voice connection.

The port type for the CP (IAD) port for the current connection. Enumeration: 'isdnBChannel': 3, 'pots': 1, 'isdnDChannel': 2.

This OID is not applicable to pots ports. For ISDN Bra ports, the ChannelId's for D, B1 and B2 are 0, 1 and 2 respectively.

This table provides the Enhanced Business Service (EBS) call information for this specific subscriber, lgid, and call index.

An entry in the EBS table.

The index into this table containing the EBS end point information. This index is equal to the index defined for the EBS endpoint in the subVoiceConnectionTable.

The line group ID for the associated connection.

This table provides the ISDN signaling call information for this specific subscriber: isdn-signaling-group-index, directory-number, and hunt group info.

Description.

The index into this table containing the ISDN subscriber end point information.

Isdn Signaling index the subscriber belongs to.

Directory Number of the subscriber.

The hunt group this subscriber is part of. Each subscriber can be part of 3 hunt groups. The hunt group endpoint index is endpt2 index of the subscriber-voice connection which has huntgroup as TRUE

The hunt group this subscriber is part of. Each subscriber can be part of 3 hunt groups. The hunt group endpoint index is endpt2 index of the subscriber-voice connection which has huntgroup as TRUE

The hunt group this subscriber is part of. Each subscriber can be part of 3 hunt groups. The hunt group endpoint index is endpt2 index of the subscriber-voice connection which has huntgroup as TRUE

This table provides TR-008 channel information. It contains information about ifIndex of tr-008 if-stack, and tr-008 specific channel number.

An entry in the tr008 table.

The index into this table containing the TR008 end point information. This index is equal to the index defined for the tr-008 endpoint in the subVoiceConnectionTable.

This is the ifIndex of tr-008 ifstack. It is used to lookup the tr-008 shelf group, which this tr-008 channel belongs to.

This field contains a tr-008 channel number. A tr-008 channel number is an index in a shelf group, which can be used to map to specific timeslot.